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