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 (caption) {
 152                 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.reset (new CaptionContent (this));
 246                         _subtitle_stream = _subtitle_streams.front ();
 247                 }
 248
 249         }
 250
 251         if (examiner->has_video ()) {
 252                 set_default_colour_conversion ();
 253         }
 254
 255         signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
 256         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 257 }
 258
 259 string
 260 FFmpegContent::summary () const
 261 {
 262         if (video && audio) {
 263                 return String::compose (_("%1 [movie]"), path_summary ());
 264         } else if (video) {
 265                 return String::compose (_("%1 [video]"), path_summary ());
 266         } else if (audio) {
 267                 return String::compose (_("%1 [audio]"), path_summary ());
 268         }
 269
 270         return path_summary ();
 271 }
 272
 273 string
 274 FFmpegContent::technical_summary () const
 275 {
 276         string as = "";
 277         BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
 278                 as += i->technical_summary () + " " ;
 279         }
 280
 281         if (as.empty ()) {
 282                 as = "none";
 283         }
 284
 285         string ss = "none";
 286         if (_subtitle_stream) {
 287                 ss = _subtitle_stream->technical_summary ();
 288         }
 289
 290         string filt = Filter::ffmpeg_string (_filters);
 291
 292         string s = Content::technical_summary ();
 293
 294         if (video) {
 295                 s += " - " + video->technical_summary ();
 296         }
 297
 298         if (audio) {
 299                 s += " - " + audio->technical_summary ();
 300         }
 301
 302         return s + String::compose (
 303                 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
 304                 );
 305 }
 306
 307 void
 308 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
 309 {
 310         {
 311                 boost::mutex::scoped_lock lm (_mutex);
 312                 _subtitle_stream = s;
 313         }
 314
 315         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 316 }
 317
 318 bool
 319 operator== (FFmpegStream const & a, FFmpegStream const & b)
 320 {
 321         return a._id == b._id;
 322 }
 323
 324 bool
 325 operator!= (FFmpegStream const & a, FFmpegStream const & b)
 326 {
 327         return a._id != b._id;
 328 }
 329
 330 DCPTime
 331 FFmpegContent::full_length () const
 332 {
 333         FrameRateChange const frc (active_video_frame_rate (), film()->video_frame_rate ());
 334         if (video) {
 335                 return DCPTime::from_frames (llrint (video->length_after_3d_combine() * frc.factor()), film()->video_frame_rate());
 336         }
 337
 338         DCPOMATIC_ASSERT (audio);
 339
 340         DCPTime longest;
 341         BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
 342                 longest = max (longest, DCPTime::from_frames (llrint (i->length() / frc.speed_up), i->frame_rate()));
 343         }
 344
 345         return longest;
 346 }
 347
 348 void
 349 FFmpegContent::set_filters (vector<Filter const *> const & filters)
 350 {
 351         {
 352                 boost::mutex::scoped_lock lm (_mutex);
 353                 _filters = filters;
 354         }
 355
 356         signal_changed (FFmpegContentProperty::FILTERS);
 357 }
 358
 359 string
 360 FFmpegContent::identifier () const
 361 {
 362         string s = Content::identifier();
 363
 364         if (video) {
 365                 s += "_" + video->identifier();
 366         }
 367
 368         if (caption && caption->use() && caption->burn()) {
 369                 s += "_" + caption->identifier();
 370         }
 371
 372         boost::mutex::scoped_lock lm (_mutex);
 373
 374         if (_subtitle_stream) {
 375                 s += "_" + _subtitle_stream->identifier ();
 376         }
 377
 378         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 379                 s += "_" + (*i)->id ();
 380         }
 381
 382         return s;
 383 }
 384
 385 void
 386 FFmpegContent::set_default_colour_conversion ()
 387 {
 388         DCPOMATIC_ASSERT (video);
 389
 390         dcp::Size const s = video->size ();
 391
 392         boost::mutex::scoped_lock lm (_mutex);
 393
 394         switch (_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)) {
 395         case AVCOL_SPC_RGB:
 396                 video->set_colour_conversion (PresetColourConversion::from_id ("srgb").conversion);
 397                 break;
 398         case AVCOL_SPC_BT709:
 399                 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
 400                 break;
 401         case AVCOL_SPC_BT470BG:
 402         case AVCOL_SPC_SMPTE170M:
 403         case AVCOL_SPC_SMPTE240M:
 404                 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
 405                 break;
 406         case AVCOL_SPC_BT2020_CL:
 407         case AVCOL_SPC_BT2020_NCL:
 408                 video->set_colour_conversion (PresetColourConversion::from_id ("rec2020").conversion);
 409                 break;
 410         default:
 411                 if (s.width < 1080) {
 412                         video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
 413                 } else {
 414                         video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
 415                 }
 416                 break;
 417         }
 418 }
 419
 420 void
 421 FFmpegContent::add_properties (list<UserProperty>& p) const
 422 {
 423         Content::add_properties (p);
 424
 425         if (video) {
 426                 video->add_properties (p);
 427
 428                 if (_bits_per_pixel) {
 429                         int const sub = 219 * pow (2, _bits_per_pixel.get() - 8);
 430                         int const total = pow (2, _bits_per_pixel.get());
 431
 432                         switch (_color_range.get_value_or(AVCOL_RANGE_UNSPECIFIED)) {
 433                         case AVCOL_RANGE_UNSPECIFIED:
 434                                 /// TRANSLATORS: this means that the range of pixel values used in this
 435                                 /// file is unknown (not specified in the file).
 436                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
 437                                 break;
 438                         case AVCOL_RANGE_MPEG:
 439                                 /// TRANSLATORS: this means that the range of pixel values used in this
 440                                 /// file is limited, so that not all possible values are valid.
 441                                 p.push_back (
 442                                         UserProperty (
 443                                                 UserProperty::VIDEO, _("Colour range"), String::compose (_("Limited (%1-%2)"), (total - sub) / 2, (total + sub) / 2)
 444                                                 )
 445                                         );
 446                                 break;
 447                         case AVCOL_RANGE_JPEG:
 448                                 /// TRANSLATORS: this means that the range of pixel values used in this
 449                                 /// file is full, so that all possible pixel values are valid.
 450                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), String::compose (_("Full (0-%1)"), total)));
 451                                 break;
 452                         default:
 453                                 DCPOMATIC_ASSERT (false);
 454                         }
 455                 } else {
 456                         switch (_color_range.get_value_or(AVCOL_RANGE_UNSPECIFIED)) {
 457                         case AVCOL_RANGE_UNSPECIFIED:
 458                                 /// TRANSLATORS: this means that the range of pixel values used in this
 459                                 /// file is unknown (not specified in the file).
 460                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
 461                                 break;
 462                         case AVCOL_RANGE_MPEG:
 463                                 /// TRANSLATORS: this means that the range of pixel values used in this
 464                                 /// file is limited, so that not all possible values are valid.
 465                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Limited")));
 466                                 break;
 467                         case AVCOL_RANGE_JPEG:
 468                                 /// TRANSLATORS: this means that the range of pixel values used in this
 469                                 /// file is full, so that all possible pixel values are valid.
 470                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Full")));
 471                                 break;
 472                         default:
 473                                 DCPOMATIC_ASSERT (false);
 474                         }
 475                 }
 476
 477                 char const * primaries[] = {
 478                         _("Unspecified"),
 479                         _("BT709"),
 480                         _("Unspecified"),
 481                         _("Unspecified"),
 482                         _("BT470M"),
 483                         _("BT470BG"),
 484                         _("SMPTE 170M (BT601)"),
 485                         _("SMPTE 240M"),
 486                         _("Film"),
 487                         _("BT2020"),
 488                         _("SMPTE ST 428-1 (CIE 1931 XYZ)"),
 489                         _("SMPTE ST 431-2 (2011)"),
 490                         _("SMPTE ST 432-1 D65 (2010)"), // 12
 491                         "", // 13
 492                         "", // 14
 493                         "", // 15
 494                         "", // 16
 495                         "", // 17
 496                         "", // 18
 497                         "", // 19
 498                         "", // 20
 499                         "", // 21
 500                         _("JEDEC P22")
 501                 };
 502
 503                 DCPOMATIC_ASSERT (AVCOL_PRI_NB <= 23);
 504                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour primaries"), primaries[_color_primaries.get_value_or(AVCOL_PRI_UNSPECIFIED)]));
 505
 506                 char const * transfers[] = {
 507                         _("Unspecified"),
 508                         _("BT709"),
 509                         _("Unspecified"),
 510                         _("Unspecified"),
 511                         _("Gamma 22 (BT470M)"),
 512                         _("Gamma 28 (BT470BG)"),
 513                         _("SMPTE 170M (BT601)"),
 514                         _("SMPTE 240M"),
 515                         _("Linear"),
 516                         _("Logarithmic (100:1 range)"),
 517                         _("Logarithmic (316:1 range)"),
 518                         _("IEC61966-2-4"),
 519                         _("BT1361 extended colour gamut"),
 520                         _("IEC61966-2-1 (sRGB or sYCC)"),
 521                         _("BT2020 for a 10-bit system"),
 522                         _("BT2020 for a 12-bit system"),
 523                         _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
 524                         _("SMPTE ST 428-1"),
 525                         _("ARIB STD-B67 ('Hybrid log-gamma')")
 526                 };
 527
 528                 DCPOMATIC_ASSERT (AVCOL_TRC_NB <= 19);
 529                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour transfer characteristic"), transfers[_color_trc.get_value_or(AVCOL_TRC_UNSPECIFIED)]));
 530
 531                 char const * spaces[] = {
 532                         _("RGB / sRGB (IEC61966-2-1)"),
 533                         _("BT709"),
 534                         _("Unspecified"),
 535                         _("Unspecified"),
 536                         _("FCC"),
 537                         _("BT470BG (BT601-6)"),
 538                         _("SMPTE 170M (BT601-6)"),
 539                         _("SMPTE 240M"),
 540                         _("YCOCG"),
 541                         _("BT2020 non-constant luminance"),
 542                         _("BT2020 constant luminance"),
 543                         _("SMPTE 2085, Y'D'zD'x"),
 544                         _("Chroma-derived non-constant luminance"),
 545                         _("Chroma-derived constant luminance"),
 546                         _("BT2100")
 547                 };
 548
 549                 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 15);
 550                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colourspace"), spaces[_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)]));
 551
 552                 if (_bits_per_pixel) {
 553                         p.push_back (UserProperty (UserProperty::VIDEO, _("Bits per pixel"), *_bits_per_pixel));
 554                 }
 555         }
 556
 557         if (audio) {
 558                 audio->add_properties (p);
 559         }
 560 }
 561
 562 /** Our subtitle streams have colour maps, which can be changed, but
 563  *  they have no way of signalling that change.  As a hack, we have this
 564  *  method which callers can use when they've modified one of our subtitle
 565  *  streams.
 566  */
 567 void
 568 FFmpegContent::signal_subtitle_stream_changed ()
 569 {
 570         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 571 }
 572
 573 vector<shared_ptr<FFmpegAudioStream> >
 574 FFmpegContent::ffmpeg_audio_streams () const
 575 {
 576         vector<shared_ptr<FFmpegAudioStream> > fa;
 577
 578         if (audio) {
 579                 BOOST_FOREACH (AudioStreamPtr i, audio->streams()) {
 580                         fa.push_back (dynamic_pointer_cast<FFmpegAudioStream> (i));
 581                 }
 582         }
 583
 584         return fa;
 585 }
 586
 587 void
 588 FFmpegContent::take_settings_from (shared_ptr<const Content> c)
 589 {
 590         shared_ptr<const FFmpegContent> fc = dynamic_pointer_cast<const FFmpegContent> (c);
 591         if (!fc) {
 592                 return;
 593                 }
 594
 595         Content::take_settings_from (c);
 596         _filters = fc->_filters;
 597 }