src/lib/ffmpeg_content.cc

   1 /*
   2     Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 extern "C" {
  21 #include <libavformat/avformat.h>
  22 }
  23 #include <libcxml/cxml.h>
  24 #include "ffmpeg_content.h"
  25 #include "ffmpeg_examiner.h"
  26 #include "compose.hpp"
  27 #include "job.h"
  28 #include "util.h"
  29 #include "filter.h"
  30 #include "film.h"
  31 #include "log.h"
  32 #include "exceptions.h"
  33
  34 #include "i18n.h"
  35
  36 using std::string;
  37 using std::stringstream;
  38 using std::vector;
  39 using std::list;
  40 using std::cout;
  41 using std::pair;
  42 using boost::shared_ptr;
  43 using boost::lexical_cast;
  44 using boost::dynamic_pointer_cast;
  45
  46 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
  47 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
  48 int const FFmpegContentProperty::AUDIO_STREAMS = 102;
  49 int const FFmpegContentProperty::AUDIO_STREAM = 103;
  50 int const FFmpegContentProperty::FILTERS = 104;
  51
  52 FFmpegContent::FFmpegContent (shared_ptr<const Film> f, boost::filesystem::path p)
  53         : Content (f, p)
  54         , VideoContent (f, p)
  55         , AudioContent (f, p)
  56         , SubtitleContent (f, p)
  57 {
  58
  59 }
  60
  61 FFmpegContent::FFmpegContent (shared_ptr<const Film> f, shared_ptr<const cxml::Node> node, int version, list<string>& notes)
  62         : Content (f, node)
  63         , VideoContent (f, node, version)
  64         , AudioContent (f, node)
  65         , SubtitleContent (f, node, version)
  66 {
  67         list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
  68         for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
  69                 _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i)));
  70                 if ((*i)->optional_number_child<int> ("Selected")) {
  71                         _subtitle_stream = _subtitle_streams.back ();
  72                 }
  73         }
  74
  75         c = node->node_children ("AudioStream");
  76         for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
  77                 _audio_streams.push_back (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream (*i, version)));
  78                 if ((*i)->optional_number_child<int> ("Selected")) {
  79                         _audio_stream = _audio_streams.back ();
  80                 }
  81         }
  82
  83         c = node->node_children ("Filter");
  84         for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
  85                 Filter const * f = Filter::from_id ((*i)->content ());
  86                 if (f) {
  87                         _filters.push_back (f);
  88                 } else {
  89                         notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), (*i)->content()));
  90                 }
  91         }
  92
  93         _first_video = node->optional_number_child<double> ("FirstVideo");
  94 }
  95
  96 FFmpegContent::FFmpegContent (shared_ptr<const Film> f, vector<boost::shared_ptr<Content> > c)
  97         : Content (f, c)
  98         , VideoContent (f, c)
  99         , AudioContent (f, c)
 100         , SubtitleContent (f, c)
 101 {
 102         shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
 103         assert (ref);
 104
 105         for (size_t i = 0; i < c.size(); ++i) {
 106                 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
 107                 if (f->with_subtitles() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
 108                         throw JoinError (_("Content to be joined must use the same subtitle stream."));
 109                 }
 110
 111                 if (*(fc->_audio_stream.get()) != *(ref->_audio_stream.get())) {
 112                         throw JoinError (_("Content to be joined must use the same audio stream."));
 113                 }
 114         }
 115
 116         _subtitle_streams = ref->subtitle_streams ();
 117         _subtitle_stream = ref->subtitle_stream ();
 118         _audio_streams = ref->audio_streams ();
 119         _audio_stream = ref->audio_stream ();
 120         _first_video = ref->_first_video;
 121 }
 122
 123 void
 124 FFmpegContent::as_xml (xmlpp::Node* node) const
 125 {
 126         node->add_child("Type")->add_child_text ("FFmpeg");
 127         Content::as_xml (node);
 128         VideoContent::as_xml (node);
 129         AudioContent::as_xml (node);
 130         SubtitleContent::as_xml (node);
 131
 132         boost::mutex::scoped_lock lm (_mutex);
 133
 134         for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
 135                 xmlpp::Node* t = node->add_child("SubtitleStream");
 136                 if (_subtitle_stream && *i == _subtitle_stream) {
 137                         t->add_child("Selected")->add_child_text("1");
 138                 }
 139                 (*i)->as_xml (t);
 140         }
 141
 142         for (vector<shared_ptr<FFmpegAudioStream> >::const_iterator i = _audio_streams.begin(); i != _audio_streams.end(); ++i) {
 143                 xmlpp::Node* t = node->add_child("AudioStream");
 144                 if (_audio_stream && *i == _audio_stream) {
 145                         t->add_child("Selected")->add_child_text("1");
 146                 }
 147                 (*i)->as_xml (t);
 148         }
 149
 150         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 151                 node->add_child("Filter")->add_child_text ((*i)->id ());
 152         }
 153
 154         if (_first_video) {
 155                 node->add_child("FirstVideo")->add_child_text (lexical_cast<string> (_first_video.get().get()));
 156         }
 157 }
 158
 159 void
 160 FFmpegContent::examine (shared_ptr<Job> job)
 161 {
 162         job->set_progress_unknown ();
 163
 164         Content::examine (job);
 165
 166         shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this ()));
 167         take_from_video_examiner (examiner);
 168
 169         ContentTime video_length = examiner->video_length ();
 170
 171         shared_ptr<const Film> film = _film.lock ();
 172         assert (film);
 173         film->log()->log (String::compose ("Video length obtained from header as %1 frames", video_length.frames (video_frame_rate ())));
 174
 175         {
 176                 boost::mutex::scoped_lock lm (_mutex);
 177
 178                 _video_length = video_length;
 179
 180                 _subtitle_streams = examiner->subtitle_streams ();
 181                 if (!_subtitle_streams.empty ()) {
 182                         _subtitle_stream = _subtitle_streams.front ();
 183                 }
 184
 185                 _audio_streams = examiner->audio_streams ();
 186                 if (!_audio_streams.empty ()) {
 187                         _audio_stream = _audio_streams.front ();
 188                 }
 189
 190                 _first_video = examiner->first_video ();
 191         }
 192
 193         signal_changed (ContentProperty::LENGTH);
 194         signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
 195         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 196         signal_changed (FFmpegContentProperty::AUDIO_STREAMS);
 197         signal_changed (FFmpegContentProperty::AUDIO_STREAM);
 198         signal_changed (AudioContentProperty::AUDIO_CHANNELS);
 199 }
 200
 201 string
 202 FFmpegContent::summary () const
 203 {
 204         /* Get the string() here so that the name does not have quotes around it */
 205         return String::compose (_("%1 [movie]"), path_summary ());
 206 }
 207
 208 string
 209 FFmpegContent::technical_summary () const
 210 {
 211         string as = "none";
 212         if (_audio_stream) {
 213                 as = _audio_stream->technical_summary ();
 214         }
 215
 216         string ss = "none";
 217         if (_subtitle_stream) {
 218                 ss = _subtitle_stream->technical_summary ();
 219         }
 220
 221         string filt = Filter::ffmpeg_string (_filters);
 222
 223         return Content::technical_summary() + " - "
 224                 + VideoContent::technical_summary() + " - "
 225                 + AudioContent::technical_summary() + " - "
 226                 + String::compose (
 227                         "ffmpeg: audio %1, subtitle %2, filters %3", as, ss, filt
 228                         );
 229 }
 230
 231 string
 232 FFmpegContent::information () const
 233 {
 234         if (video_length() == ContentTime (0) || video_frame_rate() == 0) {
 235                 return "";
 236         }
 237
 238         stringstream s;
 239
 240         s << String::compose (_("%1 frames; %2 frames per second"), video_length_after_3d_combine().frames (video_frame_rate()), video_frame_rate()) << "\n";
 241         s << VideoContent::information ();
 242
 243         return s.str ();
 244 }
 245
 246 void
 247 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
 248 {
 249         {
 250                 boost::mutex::scoped_lock lm (_mutex);
 251                 _subtitle_stream = s;
 252         }
 253
 254         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 255 }
 256
 257 void
 258 FFmpegContent::set_audio_stream (shared_ptr<FFmpegAudioStream> s)
 259 {
 260         {
 261                 boost::mutex::scoped_lock lm (_mutex);
 262                 _audio_stream = s;
 263         }
 264
 265         signal_changed (FFmpegContentProperty::AUDIO_STREAM);
 266 }
 267
 268 ContentTime
 269 FFmpegContent::audio_length () const
 270 {
 271         if (!audio_stream ()) {
 272                 return ContentTime ();
 273         }
 274
 275         return video_length ();
 276 }
 277
 278 int
 279 FFmpegContent::audio_channels () const
 280 {
 281         boost::mutex::scoped_lock lm (_mutex);
 282
 283         if (!_audio_stream) {
 284                 return 0;
 285         }
 286
 287         return _audio_stream->channels;
 288 }
 289
 290 int
 291 FFmpegContent::content_audio_frame_rate () const
 292 {
 293         boost::mutex::scoped_lock lm (_mutex);
 294
 295         if (!_audio_stream) {
 296                 return 0;
 297         }
 298
 299         return _audio_stream->frame_rate;
 300 }
 301
 302 int
 303 FFmpegContent::output_audio_frame_rate () const
 304 {
 305         shared_ptr<const Film> film = _film.lock ();
 306         assert (film);
 307
 308         /* Resample to a DCI-approved sample rate */
 309         double t = dcp_audio_frame_rate (content_audio_frame_rate ());
 310
 311         FrameRateChange frc (video_frame_rate(), film->video_frame_rate());
 312
 313         /* Compensate if the DCP is being run at a different frame rate
 314            to the source; that is, if the video is run such that it will
 315            look different in the DCP compared to the source (slower or faster).
 316         */
 317
 318         if (frc.change_speed) {
 319                 t /= frc.speed_up;
 320         }
 321
 322         return rint (t);
 323 }
 324
 325 bool
 326 operator== (FFmpegStream const & a, FFmpegStream const & b)
 327 {
 328         return a._id == b._id;
 329 }
 330
 331 bool
 332 operator!= (FFmpegStream const & a, FFmpegStream const & b)
 333 {
 334         return a._id != b._id;
 335 }
 336
 337 FFmpegStream::FFmpegStream (shared_ptr<const cxml::Node> node)
 338         : name (node->string_child ("Name"))
 339         , _id (node->number_child<int> ("Id"))
 340 {
 341
 342 }
 343
 344 void
 345 FFmpegStream::as_xml (xmlpp::Node* root) const
 346 {
 347         root->add_child("Name")->add_child_text (name);
 348         root->add_child("Id")->add_child_text (lexical_cast<string> (_id));
 349 }
 350
 351 FFmpegAudioStream::FFmpegAudioStream (shared_ptr<const cxml::Node> node, int version)
 352         : FFmpegStream (node)
 353         , mapping (node->node_child ("Mapping"), version)
 354 {
 355         frame_rate = node->number_child<int> ("FrameRate");
 356         channels = node->number_child<int64_t> ("Channels");
 357         first_audio = node->optional_number_child<double> ("FirstAudio");
 358 }
 359
 360 void
 361 FFmpegAudioStream::as_xml (xmlpp::Node* root) const
 362 {
 363         FFmpegStream::as_xml (root);
 364         root->add_child("FrameRate")->add_child_text (lexical_cast<string> (frame_rate));
 365         root->add_child("Channels")->add_child_text (lexical_cast<string> (channels));
 366         if (first_audio) {
 367                 root->add_child("FirstAudio")->add_child_text (lexical_cast<string> (first_audio.get().get()));
 368         }
 369         mapping.as_xml (root->add_child("Mapping"));
 370 }
 371
 372 bool
 373 FFmpegStream::uses_index (AVFormatContext const * fc, int index) const
 374 {
 375         size_t i = 0;
 376         while (i < fc->nb_streams) {
 377                 if (fc->streams[i]->id == _id) {
 378                         return int (i) == index;
 379                 }
 380                 ++i;
 381         }
 382
 383         return false;
 384 }
 385
 386 AVStream *
 387 FFmpegStream::stream (AVFormatContext const * fc) const
 388 {
 389         size_t i = 0;
 390         while (i < fc->nb_streams) {
 391                 if (fc->streams[i]->id == _id) {
 392                         return fc->streams[i];
 393                 }
 394                 ++i;
 395         }
 396
 397         assert (false);
 398         return 0;
 399 }
 400
 401 /** Construct a SubtitleStream from a value returned from to_string().
 402  *  @param t String returned from to_string().
 403  *  @param v State file version.
 404  */
 405 FFmpegSubtitleStream::FFmpegSubtitleStream (shared_ptr<const cxml::Node> node)
 406         : FFmpegStream (node)
 407 {
 408
 409 }
 410
 411 void
 412 FFmpegSubtitleStream::as_xml (xmlpp::Node* root) const
 413 {
 414         FFmpegStream::as_xml (root);
 415 }
 416
 417 DCPTime
 418 FFmpegContent::full_length () const
 419 {
 420         shared_ptr<const Film> film = _film.lock ();
 421         assert (film);
 422         return DCPTime (video_length_after_3d_combine(), FrameRateChange (video_frame_rate (), film->video_frame_rate ()));
 423 }
 424
 425 AudioMapping
 426 FFmpegContent::audio_mapping () const
 427 {
 428         boost::mutex::scoped_lock lm (_mutex);
 429
 430         if (!_audio_stream) {
 431                 return AudioMapping ();
 432         }
 433
 434         return _audio_stream->mapping;
 435 }
 436
 437 void
 438 FFmpegContent::set_filters (vector<Filter const *> const & filters)
 439 {
 440         {
 441                 boost::mutex::scoped_lock lm (_mutex);
 442                 _filters = filters;
 443         }
 444
 445         signal_changed (FFmpegContentProperty::FILTERS);
 446 }
 447
 448 void
 449 FFmpegContent::set_audio_mapping (AudioMapping m)
 450 {
 451         audio_stream()->mapping = m;
 452         AudioContent::set_audio_mapping (m);
 453 }
 454
 455 string
 456 FFmpegContent::identifier () const
 457 {
 458         stringstream s;
 459
 460         s << VideoContent::identifier();
 461
 462         boost::mutex::scoped_lock lm (_mutex);
 463
 464         if (_subtitle_stream) {
 465                 s << "_" << _subtitle_stream->identifier ();
 466         }
 467
 468         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 469                 s << "_" << (*i)->id ();
 470         }
 471
 472         return s.str ();
 473 }
 474
 475 boost::filesystem::path
 476 FFmpegContent::audio_analysis_path () const
 477 {
 478         shared_ptr<const Film> film = _film.lock ();
 479         if (!film) {
 480                 return boost::filesystem::path ();
 481         }
 482
 483         /* We need to include the stream ID in this path so that we get different
 484            analyses for each stream.
 485         */
 486
 487         boost::filesystem::path p = film->audio_analysis_dir ();
 488         string name = digest ();
 489         if (audio_stream ()) {
 490                 name += "_" + audio_stream()->identifier ();
 491         }
 492         p /= name;
 493         return p;
 494 }