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