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