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<boost::shared_ptr<Content> > c)
 123         : Content (film, c)
 124 {
 125         /* XXX: this should look at c to decide which of video/audio/subtitle
 126            get created.
 127         */
 128         video.reset (new VideoContent (this, c));
 129         audio.reset (new AudioContent (this, c));
 130         subtitle.reset (new SubtitleContent (this, c));
 131
 132         shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
 133         DCPOMATIC_ASSERT (ref);
 134
 135         for (size_t i = 0; i < c.size(); ++i) {
 136                 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
 137                 if (fc->subtitle->use() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
 138                         throw JoinError (_("Content to be joined must use the same subtitle stream."));
 139                 }
 140         }
 141
 142         /* XXX: should probably check that more of the stuff below is the same in *this and ref */
 143
 144         _subtitle_streams = ref->subtitle_streams ();
 145         _subtitle_stream = ref->subtitle_stream ();
 146         _first_video = ref->_first_video;
 147         _filters = ref->_filters;
 148         _color_range = ref->_color_range;
 149         _color_primaries = ref->_color_primaries;
 150         _color_trc = ref->_color_trc;
 151         _colorspace = ref->_colorspace;
 152         _bits_per_pixel = ref->_bits_per_pixel;
 153 }
 154
 155 void
 156 FFmpegContent::as_xml (xmlpp::Node* node) const
 157 {
 158         node->add_child("Type")->add_child_text ("FFmpeg");
 159         Content::as_xml (node);
 160
 161         if (video) {
 162                 video->as_xml (node);
 163         }
 164
 165         if (audio) {
 166                 audio->as_xml (node);
 167
 168                 BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
 169                         shared_ptr<FFmpegAudioStream> f = dynamic_pointer_cast<FFmpegAudioStream> (i);
 170                         DCPOMATIC_ASSERT (f);
 171                         f->as_xml (node->add_child("AudioStream"));
 172                 }
 173         }
 174
 175         if (subtitle) {
 176                 subtitle->as_xml (node);
 177         }
 178
 179         boost::mutex::scoped_lock lm (_mutex);
 180
 181         for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
 182                 xmlpp::Node* t = node->add_child("SubtitleStream");
 183                 if (_subtitle_stream && *i == _subtitle_stream) {
 184                         t->add_child("Selected")->add_child_text("1");
 185                 }
 186                 (*i)->as_xml (t);
 187         }
 188
 189         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 190                 node->add_child("Filter")->add_child_text ((*i)->id ());
 191         }
 192
 193         if (_first_video) {
 194                 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
 195         }
 196
 197         node->add_child("ColorRange")->add_child_text (raw_convert<string> (_color_range));
 198         node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (_color_primaries));
 199         node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (_color_trc));
 200         node->add_child("Colorspace")->add_child_text (raw_convert<string> (_colorspace));
 201         if (_bits_per_pixel) {
 202                 node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (_bits_per_pixel.get ()));
 203         }
 204 }
 205
 206 void
 207 FFmpegContent::examine (shared_ptr<Job> job)
 208 {
 209         job->set_progress_unknown ();
 210
 211         Content::examine (job);
 212
 213         shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
 214
 215         if (examiner->has_video ()) {
 216                 video.reset (new VideoContent (this));
 217                 video->take_from_examiner (examiner);
 218                 set_default_colour_conversion ();
 219         }
 220
 221         boost::filesystem::path first_path = path (0);
 222
 223         {
 224                 boost::mutex::scoped_lock lm (_mutex);
 225
 226                 if (examiner->has_video ()) {
 227                         _first_video = examiner->first_video ();
 228                         _color_range = examiner->color_range ();
 229                         _color_primaries = examiner->color_primaries ();
 230                         _color_trc = examiner->color_trc ();
 231                         _colorspace = examiner->colorspace ();
 232                         _bits_per_pixel = examiner->bits_per_pixel ();
 233                 }
 234
 235                 if (!examiner->audio_streams().empty ()) {
 236                         audio.reset (new AudioContent (this));
 237
 238                         BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, examiner->audio_streams ()) {
 239                                 audio->add_stream (i);
 240                         }
 241
 242                         AudioStreamPtr as = audio->streams().front();
 243                         AudioMapping m = as->mapping ();
 244                         film()->make_audio_mapping_default (m, first_path);
 245                         as->set_mapping (m);
 246                 }
 247
 248                 _subtitle_streams = examiner->subtitle_streams ();
 249                 if (!_subtitle_streams.empty ()) {
 250                         subtitle.reset (new SubtitleContent (this));
 251                         _subtitle_stream = _subtitle_streams.front ();
 252                 }
 253
 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         SafeStringStream s;
 364
 365         s << Content::identifier();
 366
 367         if (video) {
 368                 s << "_" << video->identifier();
 369         }
 370
 371         if (subtitle) {
 372                 s << "_" << subtitle->identifier();
 373         }
 374
 375         boost::mutex::scoped_lock lm (_mutex);
 376
 377         if (_subtitle_stream) {
 378                 s << "_" << _subtitle_stream->identifier ();
 379         }
 380
 381         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 382                 s << "_" << (*i)->id ();
 383         }
 384
 385         return s.str ();
 386 }
 387
 388 list<ContentTimePeriod>
 389 FFmpegContent::image_subtitles_during (ContentTimePeriod period, bool starting) const
 390 {
 391         shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
 392         if (!stream) {
 393                 return list<ContentTimePeriod> ();
 394         }
 395
 396         return stream->image_subtitles_during (period, starting);
 397 }
 398
 399 list<ContentTimePeriod>
 400 FFmpegContent::text_subtitles_during (ContentTimePeriod period, bool starting) const
 401 {
 402         shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
 403         if (!stream) {
 404                 return list<ContentTimePeriod> ();
 405         }
 406
 407         return stream->text_subtitles_during (period, starting);
 408 }
 409
 410 void
 411 FFmpegContent::set_default_colour_conversion ()
 412 {
 413         DCPOMATIC_ASSERT (video);
 414
 415         dcp::Size const s = video->size ();
 416
 417         boost::mutex::scoped_lock lm (_mutex);
 418
 419         if (s.width < 1080) {
 420                 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
 421         } else {
 422                 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
 423         }
 424 }
 425
 426 void
 427 FFmpegContent::add_properties (list<UserProperty>& p) const
 428 {
 429         Content::add_properties (p);
 430
 431         if (video) {
 432                 video->add_properties (p);
 433
 434                 if (_bits_per_pixel) {
 435                         int const sub = 219 * pow (2, _bits_per_pixel.get() - 8);
 436                         int const total = pow (2, _bits_per_pixel.get());
 437
 438                         switch (_color_range) {
 439                         case AVCOL_RANGE_UNSPECIFIED:
 440                                 /// TRANSLATORS: this means that the range of pixel values used in this
 441                                 /// file is unknown (not specified in the file).
 442                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
 443                                 break;
 444                         case AVCOL_RANGE_MPEG:
 445                                 /// TRANSLATORS: this means that the range of pixel values used in this
 446                                 /// file is limited, so that not all possible values are valid.
 447                                 p.push_back (
 448                                         UserProperty (
 449                                                 UserProperty::VIDEO, _("Colour range"), String::compose (_("Limited (%1-%2)"), (total - sub) / 2, (total + sub) / 2)
 450                                                 )
 451                                         );
 452                                 break;
 453                         case AVCOL_RANGE_JPEG:
 454                                 /// TRANSLATORS: this means that the range of pixel values used in this
 455                                 /// file is full, so that all possible pixel values are valid.
 456                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), String::compose (_("Full (0-%1)"), total)));
 457                                 break;
 458                         default:
 459                                 DCPOMATIC_ASSERT (false);
 460                         }
 461                 } else {
 462                         switch (_color_range) {
 463                         case AVCOL_RANGE_UNSPECIFIED:
 464                                 /// TRANSLATORS: this means that the range of pixel values used in this
 465                                 /// file is unknown (not specified in the file).
 466                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
 467                                 break;
 468                         case AVCOL_RANGE_MPEG:
 469                                 /// TRANSLATORS: this means that the range of pixel values used in this
 470                                 /// file is limited, so that not all possible values are valid.
 471                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Limited")));
 472                                 break;
 473                         case AVCOL_RANGE_JPEG:
 474                                 /// TRANSLATORS: this means that the range of pixel values used in this
 475                                 /// file is full, so that all possible pixel values are valid.
 476                                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Full")));
 477                                 break;
 478                         default:
 479                                 DCPOMATIC_ASSERT (false);
 480                         }
 481                 }
 482
 483                 char const * primaries[] = {
 484                         _("Unspecified"),
 485                         _("BT709"),
 486                         _("Unspecified"),
 487                         _("Unspecified"),
 488                         _("BT470M"),
 489                         _("BT470BG"),
 490                         _("SMPTE 170M (BT601)"),
 491                         _("SMPTE 240M"),
 492                         _("Film"),
 493                         _("BT2020"),
 494                         _("SMPTE ST 428-1 (CIE 1931 XYZ)")
 495                 };
 496
 497                 DCPOMATIC_ASSERT (AVCOL_PRI_NB <= 11);
 498                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour primaries"), primaries[_color_primaries]));
 499
 500                 char const * transfers[] = {
 501                         _("Unspecified"),
 502                         _("BT709"),
 503                         _("Unspecified"),
 504                         _("Unspecified"),
 505                         _("Gamma 22 (BT470M)"),
 506                         _("Gamma 28 (BT470BG)"),
 507                         _("SMPTE 170M (BT601)"),
 508                         _("SMPTE 240M"),
 509                         _("Linear"),
 510                         _("Logarithmic (100:1 range)"),
 511                         _("Logarithmic (316:1 range)"),
 512                         _("IEC61966-2-4"),
 513                         _("BT1361 extended colour gamut"),
 514                         _("IEC61966-2-1 (sRGB or sYCC)"),
 515                         _("BT2020 for a 10-bit system"),
 516                         _("BT2020 for a 12-bit system"),
 517                         _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
 518                         _("SMPTE ST 428-1")
 519                 };
 520
 521                 DCPOMATIC_ASSERT (AVCOL_TRC_NB <= 18);
 522                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour transfer characteristic"), transfers[_color_trc]));
 523
 524                 char const * spaces[] = {
 525                         _("RGB / sRGB (IEC61966-2-1)"),
 526                         _("BT709"),
 527                         _("Unspecified"),
 528                         _("Unspecified"),
 529                         _("FCC"),
 530                         _("BT470BG (BT601-6)"),
 531                         _("SMPTE 170M (BT601-6)"),
 532                         _("SMPTE 240M"),
 533                         _("YCOCG"),
 534                         _("BT2020 non-constant luminance"),
 535                         _("BT2020 constant luminance"),
 536                 };
 537
 538                 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 11);
 539                 p.push_back (UserProperty (UserProperty::VIDEO, _("Colourspace"), spaces[_colorspace]));
 540
 541                 if (_bits_per_pixel) {
 542                         p.push_back (UserProperty (UserProperty::VIDEO, _("Bits per pixel"), raw_convert<string> (_bits_per_pixel.get ())));
 543                 }
 544         }
 545
 546         if (audio) {
 547                 audio->add_properties (p);
 548         }
 549 }
 550
 551 /** Our subtitle streams have colour maps, which can be changed, but
 552  *  they have no way of signalling that change.  As a hack, we have this
 553  *  method which callers can use when they've modified one of our subtitle
 554  *  streams.
 555  */
 556 void
 557 FFmpegContent::signal_subtitle_stream_changed ()
 558 {
 559         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 560 }
 561
 562 vector<shared_ptr<FFmpegAudioStream> >
 563 FFmpegContent::ffmpeg_audio_streams () const
 564 {
 565         vector<shared_ptr<FFmpegAudioStream> > fa;
 566
 567         if (audio) {
 568                 BOOST_FOREACH (AudioStreamPtr i, audio->streams()) {
 569                         fa.push_back (dynamic_pointer_cast<FFmpegAudioStream> (i));
 570                 }
 571         }
 572
 573         return fa;
 574 }