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