src/lib/ffmpeg_content.cc

   1 /*
   2     Copyright (C) 2013-2015 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)));
  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         _subtitle_streams = ref->subtitle_streams ();
 135         _subtitle_stream = ref->subtitle_stream ();
 136         _audio_streams = ref->ffmpeg_audio_streams ();
 137         _first_video = ref->_first_video;
 138 }
 139
 140 void
 141 FFmpegContent::as_xml (xmlpp::Node* node) const
 142 {
 143         node->add_child("Type")->add_child_text ("FFmpeg");
 144         Content::as_xml (node);
 145         VideoContent::as_xml (node);
 146         AudioContent::as_xml (node);
 147         SubtitleContent::as_xml (node);
 148
 149         boost::mutex::scoped_lock lm (_mutex);
 150
 151         for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
 152                 xmlpp::Node* t = node->add_child("SubtitleStream");
 153                 if (_subtitle_stream && *i == _subtitle_stream) {
 154                         t->add_child("Selected")->add_child_text("1");
 155                 }
 156                 (*i)->as_xml (t);
 157         }
 158
 159         for (vector<shared_ptr<FFmpegAudioStream> >::const_iterator i = _audio_streams.begin(); i != _audio_streams.end(); ++i) {
 160                 (*i)->as_xml (node->add_child("AudioStream"));
 161         }
 162
 163         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 164                 node->add_child("Filter")->add_child_text ((*i)->id ());
 165         }
 166
 167         if (_first_video) {
 168                 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
 169         }
 170
 171         node->add_child("ColorRange")->add_child_text (raw_convert<string> (_color_range));
 172         node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (_color_primaries));
 173         node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (_color_trc));
 174         node->add_child("Colorspace")->add_child_text (raw_convert<string> (_colorspace));
 175         if (_bits_per_pixel) {
 176                 node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (_bits_per_pixel.get ()));
 177         }
 178 }
 179
 180 void
 181 FFmpegContent::examine (shared_ptr<Job> job)
 182 {
 183         job->set_progress_unknown ();
 184
 185         Content::examine (job);
 186
 187         shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
 188         take_from_video_examiner (examiner);
 189
 190         {
 191                 boost::mutex::scoped_lock lm (_mutex);
 192
 193                 _subtitle_streams = examiner->subtitle_streams ();
 194                 if (!_subtitle_streams.empty ()) {
 195                         _subtitle_stream = _subtitle_streams.front ();
 196                 }
 197
 198                 _audio_streams = examiner->audio_streams ();
 199
 200                 if (!_audio_streams.empty ()) {
 201                         AudioMapping m = _audio_streams.front()->mapping ();
 202                         film()->make_audio_mapping_default (m);
 203                         _audio_streams.front()->set_mapping (m);
 204                 }
 205
 206                 _first_video = examiner->first_video ();
 207
 208                 _color_range = examiner->color_range ();
 209                 _color_primaries = examiner->color_primaries ();
 210                 _color_trc = examiner->color_trc ();
 211                 _colorspace = examiner->colorspace ();
 212                 _bits_per_pixel = examiner->bits_per_pixel ();
 213         }
 214
 215         signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
 216         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 217         signal_changed (AudioContentProperty::AUDIO_STREAMS);
 218 }
 219
 220 string
 221 FFmpegContent::summary () const
 222 {
 223         /* Get the string() here so that the name does not have quotes around it */
 224         return String::compose (_("%1 [movie]"), path_summary ());
 225 }
 226
 227 string
 228 FFmpegContent::technical_summary () const
 229 {
 230         string as = "";
 231         BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
 232                 as += i->technical_summary () + " " ;
 233         }
 234
 235         if (as.empty ()) {
 236                 as = "none";
 237         }
 238
 239         string ss = "none";
 240         if (_subtitle_stream) {
 241                 ss = _subtitle_stream->technical_summary ();
 242         }
 243
 244         string filt = Filter::ffmpeg_string (_filters);
 245
 246         return Content::technical_summary() + " - "
 247                 + VideoContent::technical_summary() + " - "
 248                 + AudioContent::technical_summary() + " - "
 249                 + String::compose (
 250                         "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
 251                         );
 252 }
 253
 254 void
 255 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
 256 {
 257         {
 258                 boost::mutex::scoped_lock lm (_mutex);
 259                 _subtitle_stream = s;
 260         }
 261
 262         signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
 263 }
 264
 265 bool
 266 operator== (FFmpegStream const & a, FFmpegStream const & b)
 267 {
 268         return a._id == b._id;
 269 }
 270
 271 bool
 272 operator!= (FFmpegStream const & a, FFmpegStream const & b)
 273 {
 274         return a._id != b._id;
 275 }
 276
 277 DCPTime
 278 FFmpegContent::full_length () const
 279 {
 280         FrameRateChange const frc (video_frame_rate (), film()->video_frame_rate ());
 281         return DCPTime::from_frames (llrint (video_length_after_3d_combine() * frc.factor()), film()->video_frame_rate());
 282 }
 283
 284 void
 285 FFmpegContent::set_filters (vector<Filter const *> const & filters)
 286 {
 287         {
 288                 boost::mutex::scoped_lock lm (_mutex);
 289                 _filters = filters;
 290         }
 291
 292         signal_changed (FFmpegContentProperty::FILTERS);
 293 }
 294
 295 string
 296 FFmpegContent::identifier () const
 297 {
 298         SafeStringStream s;
 299
 300         s << VideoContent::identifier() << "_"
 301           << SubtitleContent::identifier();
 302
 303         boost::mutex::scoped_lock lm (_mutex);
 304
 305         if (_subtitle_stream) {
 306                 s << "_" << _subtitle_stream->identifier ();
 307         }
 308
 309         for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
 310                 s << "_" << (*i)->id ();
 311         }
 312
 313         return s.str ();
 314 }
 315
 316 list<ContentTimePeriod>
 317 FFmpegContent::subtitles_during (ContentTimePeriod period, bool starting) const
 318 {
 319         shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
 320         if (!stream) {
 321                 return list<ContentTimePeriod> ();
 322         }
 323
 324         return stream->subtitles_during (period, starting);
 325 }
 326
 327 bool
 328 FFmpegContent::has_text_subtitles () const
 329 {
 330         return false;
 331 }
 332
 333 bool
 334 FFmpegContent::has_image_subtitles () const
 335 {
 336         return !subtitle_streams().empty ();
 337 }
 338
 339 void
 340 FFmpegContent::set_default_colour_conversion ()
 341 {
 342         dcp::Size const s = video_size ();
 343
 344         boost::mutex::scoped_lock lm (_mutex);
 345
 346         if (s.width < 1080) {
 347                 _colour_conversion = PresetColourConversion::from_id ("rec601").conversion;
 348         } else {
 349                 _colour_conversion = PresetColourConversion::from_id ("rec709").conversion;
 350         }
 351 }
 352
 353 vector<AudioStreamPtr>
 354 FFmpegContent::audio_streams () const
 355 {
 356         boost::mutex::scoped_lock lm (_mutex);
 357
 358         vector<AudioStreamPtr> s;
 359         copy (_audio_streams.begin(), _audio_streams.end(), back_inserter (s));
 360         return s;
 361 }
 362
 363 void
 364 FFmpegContent::add_properties (list<pair<string, string> >& p) const
 365 {
 366         VideoContent::add_properties (p);
 367
 368         if (_bits_per_pixel) {
 369                 int const sub = 219 * pow (2, _bits_per_pixel.get() - 8);
 370                 int const total = pow (2, _bits_per_pixel.get());
 371
 372                 switch (_color_range) {
 373                 case AVCOL_RANGE_UNSPECIFIED:
 374                         /// TRANSLATORS: this means that the range of pixel values used in this
 375                         /// file is unknown (not specified in the file).
 376                         p.push_back (make_pair (_("Colour range"), _("Unspecified")));
 377                         break;
 378                 case AVCOL_RANGE_MPEG:
 379                         /// TRANSLATORS: this means that the range of pixel values used in this
 380                         /// file is limited, so that not all possible values are valid.
 381                         p.push_back (make_pair (_("Colour range"), String::compose (_("Limited (%1-%2)"), (total - sub) / 2, (total + sub) / 2)));
 382                         break;
 383                 case AVCOL_RANGE_JPEG:
 384                         /// TRANSLATORS: this means that the range of pixel values used in this
 385                         /// file is full, so that all possible pixel values are valid.
 386                         p.push_back (make_pair (_("Colour range"), String::compose (_("Full (0-%1)"), total)));
 387                         break;
 388                 default:
 389                         DCPOMATIC_ASSERT (false);
 390                 }
 391         } else {
 392                 switch (_color_range) {
 393                 case AVCOL_RANGE_UNSPECIFIED:
 394                         /// TRANSLATORS: this means that the range of pixel values used in this
 395                         /// file is unknown (not specified in the file).
 396                         p.push_back (make_pair (_("Colour range"), _("Unspecified")));
 397                         break;
 398                 case AVCOL_RANGE_MPEG:
 399                         /// TRANSLATORS: this means that the range of pixel values used in this
 400                         /// file is limited, so that not all possible values are valid.
 401                         p.push_back (make_pair (_("Colour range"), _("Limited")));
 402                         break;
 403                 case AVCOL_RANGE_JPEG:
 404                         /// TRANSLATORS: this means that the range of pixel values used in this
 405                         /// file is full, so that all possible pixel values are valid.
 406                         p.push_back (make_pair (_("Colour range"), _("Full")));
 407                         break;
 408                 default:
 409                         DCPOMATIC_ASSERT (false);
 410                 }
 411         }
 412
 413         char const * primaries[] = {
 414                 _("Unspecified"),
 415                 _("BT709"),
 416                 _("Unspecified"),
 417                 _("Unspecified"),
 418                 _("BT470M"),
 419                 _("BT470BG"),
 420                 _("SMPTE 170M (BT601)"),
 421                 _("SMPTE 240M"),
 422                 _("Film"),
 423                 _("BT2020")
 424         };
 425
 426         DCPOMATIC_ASSERT (AVCOL_PRI_NB == 10);
 427         p.push_back (make_pair (_("Colour primaries"), primaries[_color_primaries]));
 428
 429         char const * transfers[] = {
 430                 _("Unspecified"),
 431                 _("BT709"),
 432                 _("Unspecified"),
 433                 _("Unspecified"),
 434                 _("Gamma 22 (BT470M)"),
 435                 _("Gamma 28 (BT470BG)"),
 436                 _("SMPTE 170M (BT601)"),
 437                 _("SMPTE 240M"),
 438                 _("Linear"),
 439                 _("Logarithmic (100:1 range)"),
 440                 _("Logarithmic (316:1 range)"),
 441                 _("IEC61966-2-4"),
 442                 _("BT1361 extended colour gamut"),
 443                 _("IEC61966-2-1 (sRGB or sYCC)"),
 444                 _("BT2020 for a 10-bit system"),
 445                 _("BT2020 for a 12-bit system")
 446         };
 447
 448         DCPOMATIC_ASSERT (AVCOL_TRC_NB == 16);
 449         p.push_back (make_pair (_("Colour transfer characteristic"), transfers[_color_trc]));
 450
 451         char const * spaces[] = {
 452                 _("RGB / sRGB (IEC61966-2-1)"),
 453                 _("BT709"),
 454                 _("Unspecified"),
 455                 _("Unspecified"),
 456                 _("FCC"),
 457                 _("BT470BG (BT601-6)"),
 458                 _("SMPTE 170M (BT601-6)"),
 459                 _("SMPTE 240M"),
 460                 _("YCOCG"),
 461                 _("BT2020 non-constant luminance"),
 462                 _("BT2020 constant luminance"),
 463         };
 464
 465         DCPOMATIC_ASSERT (AVCOL_SPC_NB == 11);
 466         p.push_back (make_pair (_("Colourspace"), spaces[_colorspace]));
 467
 468         if (_bits_per_pixel) {
 469                 p.push_back (make_pair (_("Bits per pixel"), raw_convert<string> (_bits_per_pixel.get ())));
 470         }
 471 }