src/lib/ffmpeg_content.cc

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