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