src/lib/ffmpeg_content.cc

   1 /*
   2     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #include "ffmpeg_content.h"
  22 #include "video_content.h"
  23 #include "audio_content.h"
  24 #include "ffmpeg_examiner.h"
  25 #include "ffmpeg_subtitle_stream.h"
  26 #include "ffmpeg_audio_stream.h"
  27 #include "compose.hpp"
  28 #include "job.h"
  29 #include "util.h"
  30 #include "filter.h"
  31 #include "film.h"
  32 #include "log.h"
  33 #include "exceptions.h"
  34 #include "frame_rate_change.h"
  35 #include "subtitle_content.h"
  36 #include "locale_convert.h"
  37 #include <dcp/raw_convert.h>
  38 #include <libcxml/cxml.h>
  39 extern "C" {
  40 #include <libavformat/avformat.h>
  41 #include <libavutil/pixdesc.h>
  42 }
  43 #include <libxml++/libxml++.h>
  44 #include <boost/foreach.hpp>
  45 #include <iostream>
  46
  47 #include "i18n.h"
  48
  49 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
  50
  51 using std::string;
  52 using std::vector;
  53 using std::list;
  54 using std::cout;
  55 using std::pair;
  56 using std::make_pair;
  57 using std::max;
  58 using boost::shared_ptr;
  59 using boost::dynamic_pointer_cast;
  60 using boost::optional;
  61 using dcp::raw_convert;
  62
  63 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
  64 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
  65 int const FFmpegContentProperty::FILTERS = 102;
  66
  67 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, boost::filesystem::path p)
  68         : Content (film, p)
  69 {
  70
  71 }
  72
  73 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
  74         : Content (film, node)
  75 {
  76         video = VideoContent::from_xml (this, node, version);
  77         audio = AudioContent::from_xml (this, node, version);
  78         subtitle = SubtitleContent::from_xml (this, node, version);
  79
  80         list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
  81         for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
  82                 _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i, version)));
  83                 if ((*i)->optional_number_child<int> ("Selected")) {
  84                         _subtitle_stream = _subtitle_streams.back ();
  85                 }
  86         }
  87
  88         c = node->node_children ("AudioStream");
  89         for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
  90                 shared_ptr<FFmpegAudioStream> as (new FFmpegAudioStream (*i, version));
  91                 audio->add_stream (as);
  92                 if (version < 11 && !(*i)->optional_node_child ("Selected")) {
  93                         /* This is an old file and this stream is not selected, so un-map it */
  94                         as->set_mapping (AudioMapping (as->channels (), MAX_DCP_AUDIO_CHANNELS));
  95                 }
  96         }
  97
  98         c = node->node_children ("Filter");
  99         for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
 100                 Filter const * f = Filter::from_id ((*i)->content ());
 101                 if (f) {
 102                         _filters.push_back (f);
 103                 } else {
 104                         notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), (*i)->content()));
 105                 }
 106         }
 107
 108         optional<ContentTime::Type> const f = node->optional_number_child<ContentTime::Type> ("FirstVideo");
 109         if (f) {
 110                 _first_video = ContentTime (f.get ());
 111         }
 112
 113         _color_range = static_cast<AVColorRange> (node->optional_number_child<int>("ColorRange").get_value_or (AVCOL_RANGE_UNSPECIFIED));
 114         _color_primaries = static_cast<AVColorPrimaries> (node->optional_number_child<int>("ColorPrimaries").get_value_or (AVCOL_PRI_UNSPECIFIED));
 115         _color_trc = static_cast<AVColorTransferCharacteristic> (
 116                 node->optional_number_child<int>("ColorTransferCharacteristic").get_value_or (AVCOL_TRC_UNSPECIFIED)
 117                 );
 118         _colorspace = static_cast<AVColorSpace> (node->optional_number_child<int>("Colorspace").get_value_or (AVCOL_SPC_UNSPECIFIED));
 119         _bits_per_pixel = node->optional_number_child<int> ("BitsPerPixel");
 120
 121 }
 122
 123 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
 124         : Content (film, c)
 125 {
 126         vector<shared_ptr<Content> >::const_iterator i = c.begin ();
 127
 128         bool need_video = false;
 129         bool need_audio = false;
 130         bool need_subtitle = false;
 131
 132         if (i != c.end ()) {
 133                 need_video = static_cast<bool> ((*i)->video);
 134                 need_audio = static_cast<bool> ((*i)->audio);
 135                 need_subtitle = static_cast<bool> ((*i)->subtitle);
 136         }
 137
 138         while (i != c.end ()) {
 139                 if (need_video != static_cast<bool> ((*i)->video)) {
 140                         throw JoinError (_("Content to be joined must all have or not have video"));
 141                 }
 142                 if (need_audio != static_cast<bool> ((*i)->audio)) {
 143                         throw JoinError (_("Content to be joined must all have or not have audio"));
 144                 }
 145                 if (need_subtitle != static_cast<bool> ((*i)->subtitle)) {
 146                         throw JoinError (_("Content to be joined must all have or not have subtitles"));
 147                 }
 148                 ++i;
 149         }
 150
 151         if (need_video) {
 152                 video.reset (new VideoContent (this, c));
 153         }
 154         if (need_audio) {
 155                 audio.reset (new AudioContent (this, c));
 156         }
 157         if (need_subtitle) {
 158                 subtitle.reset (new SubtitleContent (this, c));
 159         }
 160
 161         shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
 162         DCPOMATIC_ASSERT (ref);
 163
 164         for (size_t i = 0; i < c.size(); ++i) {
 165                 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
 166                 if (fc->subtitle && fc->subtitle->use() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
 167                         throw JoinError (_("Content to be joined must use the same subtitle stream."));
 168                 }
 169         }
 170
 171         /* XXX: should probably check that more of the stuff below is the same in *this and ref */
 172
 173         _subtitle_streams = ref->subtitle_streams ();
 174         _subtitle_stream = ref->subtitle_stream ();
 175         _first_video = ref->_first_video;
 176         _filters = ref->_filters;
 177         _color_range = ref->_color_range;
 178         _color_primaries = ref->_color_primaries;
 179         _color_trc = ref->_color_trc;
 180         _colorspace = ref->_colorspace;
 181         _bits_per_pixel = ref->_bits_per_pixel;
 182 }
 183
 184 void
 185 FFmpegContent::as_xml (xmlpp::Node* node) const
 186 {
 187         node->add_child("Type")->add_child_text ("FFmpeg");
 188         Content::as_xml (node);
 189
 190         if (video) {
 191                 video->as_xml (node);
 192         }
 193
 194         if (audio) {
 195                 audio->as_xml (node);
 196
 197                 BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
 198                         shared_ptr<FFmpegAudioStream> f = dynamic_pointer_cast<FFmpegAudioStream> (i);
 199                         DCPOMATIC_ASSERT (f);
 200                         f->as_xml (node->add_child("AudioStream"));
 201                 }
 202         }
 203
 204         if (subtitle) {
 205                 subtitle->as_xml (node);
 206         }
 207
 208         boost::mutex::scoped_lock lm (_mutex);
 209
 210         for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
 211                 xmlpp::Node* t = node->add_child("SubtitleStream");
 212                 if (_subtitle_stream && *i == _subtitle_stream) {
 213                         t->add_child("Selected")->add_child_text("1");
 214                 }
 215                 (*i)->as_xml (t);
 216         }
 217
 218         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 219                 node->add_child("Filter")->add_child_text ((*i)->id ());
 220         }
 221
 222         if (_first_video) {
 223                 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
 224         }
 225
 226         node->add_child("ColorRange")->add_child_text (raw_convert<string> (_color_range));
 227         node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (_color_primaries));
 228         node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (_color_trc));
 229         node->add_child("Colorspace")->add_child_text (raw_convert<string> (_colorspace));
 230         if (_bits_per_pixel) {
 231                 node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (_bits_per_pixel.get ()));
 232         }
 233 }
 234
 235 void
 236 FFmpegContent::examine (shared_ptr<Job> job)
 237 {
 238         job->set_progress_unknown ();
 239
 240         Content::examine (job);
 241
 242         shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
 243
 244         if (examiner->has_video ()) {
 245                 video.reset (new VideoContent (this));
 246                 video->take_from_examiner (examiner);
 247                 set_default_colour_conversion ();
 248         }
 249
 250         boost::filesystem::path first_path = path (0);
 251
 252         {
 253                 boost::mutex::scoped_lock lm (_mutex);
 254
 255                 if (examiner->has_video ()) {
 256                         _first_video = examiner->first_video ();
 257                         _color_range = examiner->color_range ();
 258                         _color_primaries = examiner->color_primaries ();
 259                         _color_trc = examiner->color_trc ();
 260                         _colorspace = examiner->colorspace ();
 261                         _bits_per_pixel = examiner->bits_per_pixel ();
 262                 }
 263
 264                 if (!examiner->audio_streams().empty ()) {
 265                         audio.reset (new AudioContent (this));
 266
 267                         BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, examiner->audio_streams ()) {
 268                                 audio->add_stream (i);
 269                         }
 270
 271                         AudioStreamPtr as = audio->streams().front();
 272                         AudioMapping m = as->mapping ();
 273                         film()->make_audio_mapping_default (m, first_path);
 274                         as->set_mapping (m);
 275                 }
 276
 277                 _subtitle_streams = examiner->subtitle_streams ();
 278                 if (!_subtitle_streams.empty ()) {
 279                         subtitle.reset (new SubtitleContent (this));
 280                         _subtitle_stream = _subtitle_streams.front ();
 281                 }
 282
 283         }
 284
 285         signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
 286         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 287 }
 288
 289 string
 290 FFmpegContent::summary () const
 291 {
 292         if (video && audio) {
 293                 return String::compose (_("%1 [movie]"), path_summary ());
 294         } else if (video) {
 295                 return String::compose (_("%1 [video]"), path_summary ());
 296         } else if (audio) {
 297                 return String::compose (_("%1 [audio]"), path_summary ());
 298         }
 299
 300         return path_summary ();
 301 }
 302
 303 string
 304 FFmpegContent::technical_summary () const
 305 {
 306         string as = "";
 307         BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
 308                 as += i->technical_summary () + " " ;
 309         }
 310
 311         if (as.empty ()) {
 312                 as = "none";
 313         }
 314
 315         string ss = "none";
 316         if (_subtitle_stream) {
 317                 ss = _subtitle_stream->technical_summary ();
 318         }
 319
 320         string filt = Filter::ffmpeg_string (_filters);
 321
 322         string s = Content::technical_summary ();
 323
 324         if (video) {
 325                 s += " - " + video->technical_summary ();
 326         }
 327
 328         if (audio) {
 329                 s += " - " + audio->technical_summary ();
 330         }
 331
 332         return s + String::compose (
 333                 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
 334                 );
 335 }
 336
 337 void
 338 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
 339 {
 340         {
 341                 boost::mutex::scoped_lock lm (_mutex);
 342                 _subtitle_stream = s;
 343         }
 344
 345         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 346 }
 347
 348 bool
 349 operator== (FFmpegStream const & a, FFmpegStream const & b)
 350 {
 351         return a._id == b._id;
 352 }
 353
 354 bool
 355 operator!= (FFmpegStream const & a, FFmpegStream const & b)
 356 {
 357         return a._id != b._id;
 358 }
 359
 360 DCPTime
 361 FFmpegContent::full_length () const
 362 {
 363         FrameRateChange const frc (active_video_frame_rate (), film()->video_frame_rate ());
 364         if (video) {
 365                 return DCPTime::from_frames (llrint (video->length_after_3d_combine() * frc.factor()), film()->video_frame_rate());
 366         }
 367
 368         DCPOMATIC_ASSERT (audio);
 369
 370         DCPTime longest;
 371         BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
 372                 longest = max (longest, DCPTime::from_frames (llrint (i->length() / frc.speed_up), i->frame_rate()));
 373         }
 374
 375         return longest;
 376 }
 377
 378 void
 379 FFmpegContent::set_filters (vector<Filter const *> const & filters)
 380 {
 381         {
 382                 boost::mutex::scoped_lock lm (_mutex);
 383                 _filters = filters;
 384         }
 385
 386         signal_changed (FFmpegContentProperty::FILTERS);
 387 }
 388
 389 string
 390 FFmpegContent::identifier () const
 391 {
 392         string s = Content::identifier();
 393
 394         if (video) {
 395                 s += "_" + video->identifier();
 396         }
 397
 398         if (subtitle) {
 399                 s += "_" + subtitle->identifier();
 400         }
 401
 402         boost::mutex::scoped_lock lm (_mutex);
 403
 404         if (_subtitle_stream) {
 405                 s += "_" + _subtitle_stream->identifier ();
 406         }
 407
 408         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 409                 s += "_" + (*i)->id ();
 410         }
 411
 412         return s;
 413 }
 414
 415 list<ContentTimePeriod>
 416 FFmpegContent::image_subtitles_during (ContentTimePeriod period, bool starting) const
 417 {
 418         shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
 419         if (!stream) {
 420                 return list<ContentTimePeriod> ();
 421         }
 422
 423         return stream->image_subtitles_during (period, starting);
 424 }
 425
 426 list<ContentTimePeriod>
 427 FFmpegContent::text_subtitles_during (ContentTimePeriod period, bool starting) const
 428 {
 429         shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
 430         if (!stream) {
 431                 return list<ContentTimePeriod> ();
 432         }
 433
 434         return stream->text_subtitles_during (period, starting);
 435 }
 436
 437 void
 438 FFmpegContent::set_default_colour_conversion ()
 439 {
 440         DCPOMATIC_ASSERT (video);
 441
 442         dcp::Size const s = video->size ();
 443
 444         boost::mutex::scoped_lock lm (_mutex);
 445
 446         if (s.width < 1080) {
 447                 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
 448         } else {
 449                 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
 450         }
 451 }
 452
 453 void
 454 FFmpegContent::add_properties (list<UserProperty>& p) const
 455 {
 456         Content::add_properties (p);
 457
 458         if (video) {
 459                 video->add_properties (p);
 460
 461                 if (_bits_per_pixel) {
 462                         int const sub = 219 * pow (2, _bits_per_pixel.get() - 8);
 463                         int const total = pow (2, _bits_per_pixel.get());
 464
 465                         switch (_color_range) {
 466                         case AVCOL_RANGE_UNSPECIFIED:
 467                                 /// TRANSLATORS: this means that the range of pixel values used in this
 468                                 /// file is unknown (not specified in the file).
 469                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
 470                                 break;
 471                         case AVCOL_RANGE_MPEG:
 472                                 /// TRANSLATORS: this means that the range of pixel values used in this
 473                                 /// file is limited, so that not all possible values are valid.
 474                                 p.push_back (
 475                                         UserProperty (
 476                                                 UserProperty::VIDEO, _("Colour range"), String::compose (_("Limited (%1-%2)"), (total - sub) / 2, (total + sub) / 2)
 477                                                 )
 478                                         );
 479                                 break;
 480                         case AVCOL_RANGE_JPEG:
 481                                 /// TRANSLATORS: this means that the range of pixel values used in this
 482                                 /// file is full, so that all possible pixel values are valid.
 483                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), String::compose (_("Full (0-%1)"), total)));
 484                                 break;
 485                         default:
 486                                 DCPOMATIC_ASSERT (false);
 487                         }
 488                 } else {
 489                         switch (_color_range) {
 490                         case AVCOL_RANGE_UNSPECIFIED:
 491                                 /// TRANSLATORS: this means that the range of pixel values used in this
 492                                 /// file is unknown (not specified in the file).
 493                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
 494                                 break;
 495                         case AVCOL_RANGE_MPEG:
 496                                 /// TRANSLATORS: this means that the range of pixel values used in this
 497                                 /// file is limited, so that not all possible values are valid.
 498                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Limited")));
 499                                 break;
 500                         case AVCOL_RANGE_JPEG:
 501                                 /// TRANSLATORS: this means that the range of pixel values used in this
 502                                 /// file is full, so that all possible pixel values are valid.
 503                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Full")));
 504                                 break;
 505                         default:
 506                                 DCPOMATIC_ASSERT (false);
 507                         }
 508                 }
 509
 510                 char const * primaries[] = {
 511                         _("Unspecified"),
 512                         _("BT709"),
 513                         _("Unspecified"),
 514                         _("Unspecified"),
 515                         _("BT470M"),
 516                         _("BT470BG"),
 517                         _("SMPTE 170M (BT601)"),
 518                         _("SMPTE 240M"),
 519                         _("Film"),
 520                         _("BT2020"),
 521                         _("SMPTE ST 428-1 (CIE 1931 XYZ)")
 522                 };
 523
 524                 DCPOMATIC_ASSERT (AVCOL_PRI_NB <= 11);
 525                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour primaries"), primaries[_color_primaries]));
 526
 527                 char const * transfers[] = {
 528                         _("Unspecified"),
 529                         _("BT709"),
 530                         _("Unspecified"),
 531                         _("Unspecified"),
 532                         _("Gamma 22 (BT470M)"),
 533                         _("Gamma 28 (BT470BG)"),
 534                         _("SMPTE 170M (BT601)"),
 535                         _("SMPTE 240M"),
 536                         _("Linear"),
 537                         _("Logarithmic (100:1 range)"),
 538                         _("Logarithmic (316:1 range)"),
 539                         _("IEC61966-2-4"),
 540                         _("BT1361 extended colour gamut"),
 541                         _("IEC61966-2-1 (sRGB or sYCC)"),
 542                         _("BT2020 for a 10-bit system"),
 543                         _("BT2020 for a 12-bit system"),
 544                         _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
 545                         _("SMPTE ST 428-1"),
 546                         _("ARIB STD-B67 ('Hybrid log-gamma')")
 547                 };
 548
 549                 DCPOMATIC_ASSERT (AVCOL_TRC_NB <= 19);
 550                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour transfer characteristic"), transfers[_color_trc]));
 551
 552                 char const * spaces[] = {
 553                         _("RGB / sRGB (IEC61966-2-1)"),
 554                         _("BT709"),
 555                         _("Unspecified"),
 556                         _("Unspecified"),
 557                         _("FCC"),
 558                         _("BT470BG (BT601-6)"),
 559                         _("SMPTE 170M (BT601-6)"),
 560                         _("SMPTE 240M"),
 561                         _("YCOCG"),
 562                         _("BT2020 non-constant luminance"),
 563                         _("BT2020 constant luminance"),
 564                 };
 565
 566                 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 11);
 567                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colourspace"), spaces[_colorspace]));
 568
 569                 if (_bits_per_pixel) {
 570                         p.push_back (UserProperty (UserProperty::VIDEO, _("Bits per pixel"), _bits_per_pixel.get ()));
 571                 }
 572         }
 573
 574         if (audio) {
 575                 audio->add_properties (p);
 576         }
 577 }
 578
 579 /** Our subtitle streams have colour maps, which can be changed, but
 580  *  they have no way of signalling that change.  As a hack, we have this
 581  *  method which callers can use when they've modified one of our subtitle
 582  *  streams.
 583  */
 584 void
 585 FFmpegContent::signal_subtitle_stream_changed ()
 586 {
 587         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 588 }
 589
 590 vector<shared_ptr<FFmpegAudioStream> >
 591 FFmpegContent::ffmpeg_audio_streams () const
 592 {
 593         vector<shared_ptr<FFmpegAudioStream> > fa;
 594
 595         if (audio) {
 596                 BOOST_FOREACH (AudioStreamPtr i, audio->streams()) {
 597                         fa.push_back (dynamic_pointer_cast<FFmpegAudioStream> (i));
 598                 }
 599         }
 600
 601         return fa;
 602 }