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