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