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 "safe_stringstream.h"
  36 #include "raw_convert.h"
  37 #include "subtitle_content.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
  62 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
  63 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
  64 int const FFmpegContentProperty::FILTERS = 102;
  65
  66 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, boost::filesystem::path p)
  67         : Content (film, p)
  68 {
  69
  70 }
  71
  72 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
  73         : Content (film, node)
  74 {
  75         video = VideoContent::from_xml (this, node, version);
  76         audio = AudioContent::from_xml (this, node, version);
  77         subtitle = SubtitleContent::from_xml (this, node, version);
  78
  79         list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
  80         for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
  81                 _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i, version)));
  82                 if ((*i)->optional_number_child<int> ("Selected")) {
  83                         _subtitle_stream = _subtitle_streams.back ();
  84                 }
  85         }
  86
  87         c = node->node_children ("AudioStream");
  88         for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
  89                 shared_ptr<FFmpegAudioStream> as (new FFmpegAudioStream (*i, version));
  90                 audio->add_stream (as);
  91                 if (version < 11 && !(*i)->optional_node_child ("Selected")) {
  92                         /* This is an old file and this stream is not selected, so un-map it */
  93                         as->set_mapping (AudioMapping (as->channels (), MAX_DCP_AUDIO_CHANNELS));
  94                 }
  95         }
  96
  97         c = node->node_children ("Filter");
  98         for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
  99                 Filter const * f = Filter::from_id ((*i)->content ());
 100                 if (f) {
 101                         _filters.push_back (f);
 102                 } else {
 103                         notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), (*i)->content()));
 104                 }
 105         }
 106
 107         optional<ContentTime::Type> const f = node->optional_number_child<ContentTime::Type> ("FirstVideo");
 108         if (f) {
 109                 _first_video = ContentTime (f.get ());
 110         }
 111
 112         _color_range = static_cast<AVColorRange> (node->optional_number_child<int>("ColorRange").get_value_or (AVCOL_RANGE_UNSPECIFIED));
 113         _color_primaries = static_cast<AVColorPrimaries> (node->optional_number_child<int>("ColorPrimaries").get_value_or (AVCOL_PRI_UNSPECIFIED));
 114         _color_trc = static_cast<AVColorTransferCharacteristic> (
 115                 node->optional_number_child<int>("ColorTransferCharacteristic").get_value_or (AVCOL_TRC_UNSPECIFIED)
 116                 );
 117         _colorspace = static_cast<AVColorSpace> (node->optional_number_child<int>("Colorspace").get_value_or (AVCOL_SPC_UNSPECIFIED));
 118         _bits_per_pixel = node->optional_number_child<int> ("BitsPerPixel");
 119
 120 }
 121
 122 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
 123         : Content (film, c)
 124 {
 125         vector<shared_ptr<Content> >::const_iterator i = c.begin ();
 126
 127         bool need_video = false;
 128         bool need_audio = false;
 129         bool need_subtitle = false;
 130
 131         if (i != c.end ()) {
 132                 need_video = static_cast<bool> ((*i)->video);
 133                 need_audio = static_cast<bool> ((*i)->audio);
 134                 need_subtitle = static_cast<bool> ((*i)->subtitle);
 135         }
 136
 137         while (i != c.end ()) {
 138                 if (need_video != static_cast<bool> ((*i)->video)) {
 139                         throw JoinError (_("Content to be joined must all have or not have video"));
 140                 }
 141                 if (need_audio != static_cast<bool> ((*i)->audio)) {
 142                         throw JoinError (_("Content to be joined must all have or not have audio"));
 143                 }
 144                 if (need_subtitle != static_cast<bool> ((*i)->subtitle)) {
 145                         throw JoinError (_("Content to be joined must all have or not have subtitles"));
 146                 }
 147                 ++i;
 148         }
 149
 150         if (need_video) {
 151                 video.reset (new VideoContent (this, c));
 152         }
 153         if (need_audio) {
 154                 audio.reset (new AudioContent (this, c));
 155         }
 156         if (need_subtitle) {
 157                 subtitle.reset (new SubtitleContent (this, c));
 158         }
 159
 160         shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
 161         DCPOMATIC_ASSERT (ref);
 162
 163         for (size_t i = 0; i < c.size(); ++i) {
 164                 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
 165                 if (fc->subtitle && fc->subtitle->use() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
 166                         throw JoinError (_("Content to be joined must use the same subtitle stream."));
 167                 }
 168         }
 169
 170         /* XXX: should probably check that more of the stuff below is the same in *this and ref */
 171
 172         _subtitle_streams = ref->subtitle_streams ();
 173         _subtitle_stream = ref->subtitle_stream ();
 174         _first_video = ref->_first_video;
 175         _filters = ref->_filters;
 176         _color_range = ref->_color_range;
 177         _color_primaries = ref->_color_primaries;
 178         _color_trc = ref->_color_trc;
 179         _colorspace = ref->_colorspace;
 180         _bits_per_pixel = ref->_bits_per_pixel;
 181 }
 182
 183 void
 184 FFmpegContent::as_xml (xmlpp::Node* node) const
 185 {
 186         node->add_child("Type")->add_child_text ("FFmpeg");
 187         Content::as_xml (node);
 188
 189         if (video) {
 190                 video->as_xml (node);
 191         }
 192
 193         if (audio) {
 194                 audio->as_xml (node);
 195
 196                 BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
 197                         shared_ptr<FFmpegAudioStream> f = dynamic_pointer_cast<FFmpegAudioStream> (i);
 198                         DCPOMATIC_ASSERT (f);
 199                         f->as_xml (node->add_child("AudioStream"));
 200                 }
 201         }
 202
 203         if (subtitle) {
 204                 subtitle->as_xml (node);
 205         }
 206
 207         boost::mutex::scoped_lock lm (_mutex);
 208
 209         for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
 210                 xmlpp::Node* t = node->add_child("SubtitleStream");
 211                 if (_subtitle_stream && *i == _subtitle_stream) {
 212                         t->add_child("Selected")->add_child_text("1");
 213                 }
 214                 (*i)->as_xml (t);
 215         }
 216
 217         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 218                 node->add_child("Filter")->add_child_text ((*i)->id ());
 219         }
 220
 221         if (_first_video) {
 222                 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
 223         }
 224
 225         node->add_child("ColorRange")->add_child_text (raw_convert<string> (_color_range));
 226         node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (_color_primaries));
 227         node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (_color_trc));
 228         node->add_child("Colorspace")->add_child_text (raw_convert<string> (_colorspace));
 229         if (_bits_per_pixel) {
 230                 node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (_bits_per_pixel.get ()));
 231         }
 232 }
 233
 234 void
 235 FFmpegContent::examine (shared_ptr<Job> job)
 236 {
 237         job->set_progress_unknown ();
 238
 239         Content::examine (job);
 240
 241         shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
 242
 243         if (examiner->has_video ()) {
 244                 video.reset (new VideoContent (this));
 245                 video->take_from_examiner (examiner);
 246                 set_default_colour_conversion ();
 247         }
 248
 249         boost::filesystem::path first_path = path (0);
 250
 251         {
 252                 boost::mutex::scoped_lock lm (_mutex);
 253
 254                 if (examiner->has_video ()) {
 255                         _first_video = examiner->first_video ();
 256                         _color_range = examiner->color_range ();
 257                         _color_primaries = examiner->color_primaries ();
 258                         _color_trc = examiner->color_trc ();
 259                         _colorspace = examiner->colorspace ();
 260                         _bits_per_pixel = examiner->bits_per_pixel ();
 261                 }
 262
 263                 if (!examiner->audio_streams().empty ()) {
 264                         audio.reset (new AudioContent (this));
 265
 266                         BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, examiner->audio_streams ()) {
 267                                 audio->add_stream (i);
 268                         }
 269
 270                         AudioStreamPtr as = audio->streams().front();
 271                         AudioMapping m = as->mapping ();
 272                         film()->make_audio_mapping_default (m, first_path);
 273                         as->set_mapping (m);
 274                 }
 275
 276                 _subtitle_streams = examiner->subtitle_streams ();
 277                 if (!_subtitle_streams.empty ()) {
 278                         subtitle.reset (new SubtitleContent (this));
 279                         _subtitle_stream = _subtitle_streams.front ();
 280                 }
 281
 282         }
 283
 284         signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
 285         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 286 }
 287
 288 string
 289 FFmpegContent::summary () const
 290 {
 291         if (video && audio) {
 292                 return String::compose (_("%1 [movie]"), path_summary ());
 293         } else if (video) {
 294                 return String::compose (_("%1 [video]"), path_summary ());
 295         } else if (audio) {
 296                 return String::compose (_("%1 [audio]"), path_summary ());
 297         }
 298
 299         return path_summary ();
 300 }
 301
 302 string
 303 FFmpegContent::technical_summary () const
 304 {
 305         string as = "";
 306         BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
 307                 as += i->technical_summary () + " " ;
 308         }
 309
 310         if (as.empty ()) {
 311                 as = "none";
 312         }
 313
 314         string ss = "none";
 315         if (_subtitle_stream) {
 316                 ss = _subtitle_stream->technical_summary ();
 317         }
 318
 319         string filt = Filter::ffmpeg_string (_filters);
 320
 321         string s = Content::technical_summary ();
 322
 323         if (video) {
 324                 s += " - " + video->technical_summary ();
 325         }
 326
 327         if (audio) {
 328                 s += " - " + audio->technical_summary ();
 329         }
 330
 331         return s + String::compose (
 332                 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
 333                 );
 334 }
 335
 336 void
 337 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
 338 {
 339         {
 340                 boost::mutex::scoped_lock lm (_mutex);
 341                 _subtitle_stream = s;
 342         }
 343
 344         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 345 }
 346
 347 bool
 348 operator== (FFmpegStream const & a, FFmpegStream const & b)
 349 {
 350         return a._id == b._id;
 351 }
 352
 353 bool
 354 operator!= (FFmpegStream const & a, FFmpegStream const & b)
 355 {
 356         return a._id != b._id;
 357 }
 358
 359 DCPTime
 360 FFmpegContent::full_length () const
 361 {
 362         FrameRateChange const frc (active_video_frame_rate (), film()->video_frame_rate ());
 363         if (video) {
 364                 return DCPTime::from_frames (llrint (video->length_after_3d_combine() * frc.factor()), film()->video_frame_rate());
 365         }
 366
 367         DCPOMATIC_ASSERT (audio);
 368
 369         DCPTime longest;
 370         BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
 371                 longest = max (longest, DCPTime::from_frames (llrint (i->length() / frc.speed_up), i->frame_rate()));
 372         }
 373
 374         return longest;
 375 }
 376
 377 void
 378 FFmpegContent::set_filters (vector<Filter const *> const & filters)
 379 {
 380         {
 381                 boost::mutex::scoped_lock lm (_mutex);
 382                 _filters = filters;
 383         }
 384
 385         signal_changed (FFmpegContentProperty::FILTERS);
 386 }
 387
 388 string
 389 FFmpegContent::identifier () const
 390 {
 391         SafeStringStream s;
 392
 393         s << Content::identifier();
 394
 395         if (video) {
 396                 s << "_" << video->identifier();
 397         }
 398
 399         if (subtitle) {
 400                 s << "_" << subtitle->identifier();
 401         }
 402
 403         boost::mutex::scoped_lock lm (_mutex);
 404
 405         if (_subtitle_stream) {
 406                 s << "_" << _subtitle_stream->identifier ();
 407         }
 408
 409         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 410                 s << "_" << (*i)->id ();
 411         }
 412
 413         return s.str ();
 414 }
 415
 416 list<ContentTimePeriod>
 417 FFmpegContent::image_subtitles_during (ContentTimePeriod period, bool starting) const
 418 {
 419         shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
 420         if (!stream) {
 421                 return list<ContentTimePeriod> ();
 422         }
 423
 424         return stream->image_subtitles_during (period, starting);
 425 }
 426
 427 list<ContentTimePeriod>
 428 FFmpegContent::text_subtitles_during (ContentTimePeriod period, bool starting) const
 429 {
 430         shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
 431         if (!stream) {
 432                 return list<ContentTimePeriod> ();
 433         }
 434
 435         return stream->text_subtitles_during (period, starting);
 436 }
 437
 438 void
 439 FFmpegContent::set_default_colour_conversion ()
 440 {
 441         DCPOMATIC_ASSERT (video);
 442
 443         dcp::Size const s = video->size ();
 444
 445         boost::mutex::scoped_lock lm (_mutex);
 446
 447         if (s.width < 1080) {
 448                 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
 449         } else {
 450                 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
 451         }
 452 }
 453
 454 void
 455 FFmpegContent::add_properties (list<UserProperty>& p) const
 456 {
 457         Content::add_properties (p);
 458
 459         if (video) {
 460                 video->add_properties (p);
 461
 462                 if (_bits_per_pixel) {
 463                         int const sub = 219 * pow (2, _bits_per_pixel.get() - 8);
 464                         int const total = pow (2, _bits_per_pixel.get());
 465
 466                         switch (_color_range) {
 467                         case AVCOL_RANGE_UNSPECIFIED:
 468                                 /// TRANSLATORS: this means that the range of pixel values used in this
 469                                 /// file is unknown (not specified in the file).
 470                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
 471                                 break;
 472                         case AVCOL_RANGE_MPEG:
 473                                 /// TRANSLATORS: this means that the range of pixel values used in this
 474                                 /// file is limited, so that not all possible values are valid.
 475                                 p.push_back (
 476                                         UserProperty (
 477                                                 UserProperty::VIDEO, _("Colour range"), String::compose (_("Limited (%1-%2)"), (total - sub) / 2, (total + sub) / 2)
 478                                                 )
 479                                         );
 480                                 break;
 481                         case AVCOL_RANGE_JPEG:
 482                                 /// TRANSLATORS: this means that the range of pixel values used in this
 483                                 /// file is full, so that all possible pixel values are valid.
 484                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), String::compose (_("Full (0-%1)"), total)));
 485                                 break;
 486                         default:
 487                                 DCPOMATIC_ASSERT (false);
 488                         }
 489                 } else {
 490                         switch (_color_range) {
 491                         case AVCOL_RANGE_UNSPECIFIED:
 492                                 /// TRANSLATORS: this means that the range of pixel values used in this
 493                                 /// file is unknown (not specified in the file).
 494                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
 495                                 break;
 496                         case AVCOL_RANGE_MPEG:
 497                                 /// TRANSLATORS: this means that the range of pixel values used in this
 498                                 /// file is limited, so that not all possible values are valid.
 499                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Limited")));
 500                                 break;
 501                         case AVCOL_RANGE_JPEG:
 502                                 /// TRANSLATORS: this means that the range of pixel values used in this
 503                                 /// file is full, so that all possible pixel values are valid.
 504                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Full")));
 505                                 break;
 506                         default:
 507                                 DCPOMATIC_ASSERT (false);
 508                         }
 509                 }
 510
 511                 char const * primaries[] = {
 512                         _("Unspecified"),
 513                         _("BT709"),
 514                         _("Unspecified"),
 515                         _("Unspecified"),
 516                         _("BT470M"),
 517                         _("BT470BG"),
 518                         _("SMPTE 170M (BT601)"),
 519                         _("SMPTE 240M"),
 520                         _("Film"),
 521                         _("BT2020"),
 522                         _("SMPTE ST 428-1 (CIE 1931 XYZ)")
 523                 };
 524
 525                 DCPOMATIC_ASSERT (AVCOL_PRI_NB <= 11);
 526                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour primaries"), primaries[_color_primaries]));
 527
 528                 char const * transfers[] = {
 529                         _("Unspecified"),
 530                         _("BT709"),
 531                         _("Unspecified"),
 532                         _("Unspecified"),
 533                         _("Gamma 22 (BT470M)"),
 534                         _("Gamma 28 (BT470BG)"),
 535                         _("SMPTE 170M (BT601)"),
 536                         _("SMPTE 240M"),
 537                         _("Linear"),
 538                         _("Logarithmic (100:1 range)"),
 539                         _("Logarithmic (316:1 range)"),
 540                         _("IEC61966-2-4"),
 541                         _("BT1361 extended colour gamut"),
 542                         _("IEC61966-2-1 (sRGB or sYCC)"),
 543                         _("BT2020 for a 10-bit system"),
 544                         _("BT2020 for a 12-bit system"),
 545                         _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
 546                         _("SMPTE ST 428-1")
 547                 };
 548
 549                 DCPOMATIC_ASSERT (AVCOL_TRC_NB <= 18);
 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"), raw_convert<string> (_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 }