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)
  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                 _filters.push_back (Filter::from_id ((*i)->content ()));
  86         }
  87
  88         _first_video = node->optional_number_child<double> ("FirstVideo");
  89 }
  90
  91 FFmpegContent::FFmpegContent (shared_ptr<const Film> f, vector<boost::shared_ptr<Content> > c)
  92         : Content (f, c)
  93         , VideoContent (f, c)
  94         , AudioContent (f, c)
  95         , SubtitleContent (f, c)
  96 {
  97         shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
  98         assert (ref);
  99
 100         for (size_t i = 0; i < c.size(); ++i) {
 101                 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
 102                 if (f->with_subtitles() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
 103                         throw JoinError (_("Content to be joined must use the same subtitle stream."));
 104                 }
 105
 106                 if (*(fc->_audio_stream.get()) != *(ref->_audio_stream.get())) {
 107                         throw JoinError (_("Content to be joined must use the same audio stream."));
 108                 }
 109         }
 110
 111         _subtitle_streams = ref->subtitle_streams ();
 112         _subtitle_stream = ref->subtitle_stream ();
 113         _audio_streams = ref->audio_streams ();
 114         _audio_stream = ref->audio_stream ();
 115         _first_video = ref->_first_video;
 116 }
 117
 118 void
 119 FFmpegContent::as_xml (xmlpp::Node* node) const
 120 {
 121         node->add_child("Type")->add_child_text ("FFmpeg");
 122         Content::as_xml (node);
 123         VideoContent::as_xml (node);
 124         AudioContent::as_xml (node);
 125         SubtitleContent::as_xml (node);
 126
 127         boost::mutex::scoped_lock lm (_mutex);
 128
 129         for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
 130                 xmlpp::Node* t = node->add_child("SubtitleStream");
 131                 if (_subtitle_stream && *i == _subtitle_stream) {
 132                         t->add_child("Selected")->add_child_text("1");
 133                 }
 134                 (*i)->as_xml (t);
 135         }
 136
 137         for (vector<shared_ptr<FFmpegAudioStream> >::const_iterator i = _audio_streams.begin(); i != _audio_streams.end(); ++i) {
 138                 xmlpp::Node* t = node->add_child("AudioStream");
 139                 if (_audio_stream && *i == _audio_stream) {
 140                         t->add_child("Selected")->add_child_text("1");
 141                 }
 142                 (*i)->as_xml (t);
 143         }
 144
 145         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 146                 node->add_child("Filter")->add_child_text ((*i)->id ());
 147         }
 148
 149         if (_first_video) {
 150                 node->add_child("FirstVideo")->add_child_text (lexical_cast<string> (_first_video.get().get()));
 151         }
 152 }
 153
 154 void
 155 FFmpegContent::examine (shared_ptr<Job> job)
 156 {
 157         job->set_progress_unknown ();
 158
 159         Content::examine (job);
 160
 161         shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this ()));
 162         take_from_video_examiner (examiner);
 163
 164         ContentTime video_length = examiner->video_length ();
 165
 166         shared_ptr<const Film> film = _film.lock ();
 167         assert (film);
 168         film->log()->log (String::compose ("Video length obtained from header as %1 frames", video_length.frames (video_frame_rate ())));
 169
 170         {
 171                 boost::mutex::scoped_lock lm (_mutex);
 172
 173                 _video_length = video_length;
 174
 175                 _subtitle_streams = examiner->subtitle_streams ();
 176                 if (!_subtitle_streams.empty ()) {
 177                         _subtitle_stream = _subtitle_streams.front ();
 178                 }
 179
 180                 _audio_streams = examiner->audio_streams ();
 181                 if (!_audio_streams.empty ()) {
 182                         _audio_stream = _audio_streams.front ();
 183                 }
 184
 185                 _first_video = examiner->first_video ();
 186         }
 187
 188         signal_changed (ContentProperty::LENGTH);
 189         signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
 190         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 191         signal_changed (FFmpegContentProperty::AUDIO_STREAMS);
 192         signal_changed (FFmpegContentProperty::AUDIO_STREAM);
 193         signal_changed (AudioContentProperty::AUDIO_CHANNELS);
 194 }
 195
 196 string
 197 FFmpegContent::summary () const
 198 {
 199         /* Get the string() here so that the name does not have quotes around it */
 200         return String::compose (_("%1 [movie]"), path_summary ());
 201 }
 202
 203 string
 204 FFmpegContent::technical_summary () const
 205 {
 206         string as = "none";
 207         if (_audio_stream) {
 208                 as = _audio_stream->technical_summary ();
 209         }
 210
 211         string ss = "none";
 212         if (_subtitle_stream) {
 213                 ss = _subtitle_stream->technical_summary ();
 214         }
 215
 216         pair<string, string> filt = Filter::ffmpeg_strings (_filters);
 217
 218         return Content::technical_summary() + " - "
 219                 + VideoContent::technical_summary() + " - "
 220                 + AudioContent::technical_summary() + " - "
 221                 + String::compose (
 222                         "ffmpeg: audio %1, subtitle %2, filters %3 %4", as, ss, filt.first, filt.second
 223                         );
 224 }
 225
 226 string
 227 FFmpegContent::information () const
 228 {
 229         if (video_length() == ContentTime (0) || video_frame_rate() == 0) {
 230                 return "";
 231         }
 232
 233         stringstream s;
 234
 235         s << String::compose (_("%1 frames; %2 frames per second"), video_length().frames (video_frame_rate()), video_frame_rate()) << "\n";
 236         s << VideoContent::information ();
 237
 238         return s.str ();
 239 }
 240
 241 void
 242 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
 243 {
 244         {
 245                 boost::mutex::scoped_lock lm (_mutex);
 246                 _subtitle_stream = s;
 247         }
 248
 249         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 250 }
 251
 252 void
 253 FFmpegContent::set_audio_stream (shared_ptr<FFmpegAudioStream> s)
 254 {
 255         {
 256                 boost::mutex::scoped_lock lm (_mutex);
 257                 _audio_stream = s;
 258         }
 259
 260         signal_changed (FFmpegContentProperty::AUDIO_STREAM);
 261 }
 262
 263 ContentTime
 264 FFmpegContent::audio_length () const
 265 {
 266         {
 267                 boost::mutex::scoped_lock lm (_mutex);
 268                 if (!_audio_stream) {
 269                         return ContentTime ();
 270                 }
 271         }
 272
 273         return video_length();
 274 }
 275
 276 int
 277 FFmpegContent::audio_channels () const
 278 {
 279         boost::mutex::scoped_lock lm (_mutex);
 280
 281         if (!_audio_stream) {
 282                 return 0;
 283         }
 284
 285         return _audio_stream->channels;
 286 }
 287
 288 int
 289 FFmpegContent::content_audio_frame_rate () const
 290 {
 291         boost::mutex::scoped_lock lm (_mutex);
 292
 293         if (!_audio_stream) {
 294                 return 0;
 295         }
 296
 297         return _audio_stream->frame_rate;
 298 }
 299
 300 int
 301 FFmpegContent::output_audio_frame_rate () const
 302 {
 303         shared_ptr<const Film> film = _film.lock ();
 304         assert (film);
 305
 306         /* Resample to a DCI-approved sample rate */
 307         double t = dcp_audio_frame_rate (content_audio_frame_rate ());
 308
 309         FrameRateChange frc (video_frame_rate(), film->video_frame_rate());
 310
 311         /* Compensate if the DCP is being run at a different frame rate
 312            to the source; that is, if the video is run such that it will
 313            look different in the DCP compared to the source (slower or faster).
 314         */
 315
 316         if (frc.change_speed) {
 317                 t /= frc.speed_up;
 318         }
 319
 320         return rint (t);
 321 }
 322
 323 bool
 324 operator== (FFmpegStream const & a, FFmpegStream const & b)
 325 {
 326         return a._id == b._id;
 327 }
 328
 329 bool
 330 operator!= (FFmpegStream const & a, FFmpegStream const & b)
 331 {
 332         return a._id != b._id;
 333 }
 334
 335 FFmpegStream::FFmpegStream (shared_ptr<const cxml::Node> node)
 336         : name (node->string_child ("Name"))
 337         , _id (node->number_child<int> ("Id"))
 338 {
 339
 340 }
 341
 342 void
 343 FFmpegStream::as_xml (xmlpp::Node* root) const
 344 {
 345         root->add_child("Name")->add_child_text (name);
 346         root->add_child("Id")->add_child_text (lexical_cast<string> (_id));
 347 }
 348
 349 FFmpegAudioStream::FFmpegAudioStream (shared_ptr<const cxml::Node> node, int version)
 350         : FFmpegStream (node)
 351         , mapping (node->node_child ("Mapping"), version)
 352 {
 353         frame_rate = node->number_child<int> ("FrameRate");
 354         channels = node->number_child<int64_t> ("Channels");
 355         first_audio = node->optional_number_child<double> ("FirstAudio");
 356 }
 357
 358 void
 359 FFmpegAudioStream::as_xml (xmlpp::Node* root) const
 360 {
 361         FFmpegStream::as_xml (root);
 362         root->add_child("FrameRate")->add_child_text (lexical_cast<string> (frame_rate));
 363         root->add_child("Channels")->add_child_text (lexical_cast<string> (channels));
 364         if (first_audio) {
 365                 root->add_child("FirstAudio")->add_child_text (lexical_cast<string> (first_audio.get().get()));
 366         }
 367         mapping.as_xml (root->add_child("Mapping"));
 368 }
 369
 370 bool
 371 FFmpegStream::uses_index (AVFormatContext const * fc, int index) const
 372 {
 373         size_t i = 0;
 374         while (i < fc->nb_streams) {
 375                 if (fc->streams[i]->id == _id) {
 376                         return int (i) == index;
 377                 }
 378                 ++i;
 379         }
 380
 381         return false;
 382 }
 383
 384 AVStream *
 385 FFmpegStream::stream (AVFormatContext const * fc) const
 386 {
 387         size_t i = 0;
 388         while (i < fc->nb_streams) {
 389                 if (fc->streams[i]->id == _id) {
 390                         return fc->streams[i];
 391                 }
 392                 ++i;
 393         }
 394
 395         assert (false);
 396         return 0;
 397 }
 398
 399 /** Construct a SubtitleStream from a value returned from to_string().
 400  *  @param t String returned from to_string().
 401  *  @param v State file version.
 402  */
 403 FFmpegSubtitleStream::FFmpegSubtitleStream (shared_ptr<const cxml::Node> node)
 404         : FFmpegStream (node)
 405 {
 406
 407 }
 408
 409 void
 410 FFmpegSubtitleStream::as_xml (xmlpp::Node* root) const
 411 {
 412         FFmpegStream::as_xml (root);
 413 }
 414
 415 DCPTime
 416 FFmpegContent::full_length () const
 417 {
 418         shared_ptr<const Film> film = _film.lock ();
 419         assert (film);
 420         return DCPTime (video_length(), FrameRateChange (video_frame_rate (), film->video_frame_rate ()));
 421 }
 422
 423 AudioMapping
 424 FFmpegContent::audio_mapping () const
 425 {
 426         boost::mutex::scoped_lock lm (_mutex);
 427
 428         if (!_audio_stream) {
 429                 return AudioMapping ();
 430         }
 431
 432         return _audio_stream->mapping;
 433 }
 434
 435 void
 436 FFmpegContent::set_filters (vector<Filter const *> const & filters)
 437 {
 438         {
 439                 boost::mutex::scoped_lock lm (_mutex);
 440                 _filters = filters;
 441         }
 442
 443         signal_changed (FFmpegContentProperty::FILTERS);
 444 }
 445
 446 void
 447 FFmpegContent::set_audio_mapping (AudioMapping m)
 448 {
 449         audio_stream()->mapping = m;
 450         signal_changed (AudioContentProperty::AUDIO_MAPPING);
 451 }
 452
 453 string
 454 FFmpegContent::identifier () const
 455 {
 456         stringstream s;
 457
 458         s << VideoContent::identifier();
 459
 460         boost::mutex::scoped_lock lm (_mutex);
 461
 462         if (_subtitle_stream) {
 463                 s << "_" << _subtitle_stream->identifier ();
 464         }
 465
 466         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 467                 s << "_" << (*i)->id ();
 468         }
 469
 470         return s.str ();
 471 }
 472