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