2 Copyright (C) 2013-2019 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #include "ffmpeg_content.h"
22 #include "video_content.h"
23 #include "audio_content.h"
24 #include "ffmpeg_examiner.h"
25 #include "ffmpeg_subtitle_stream.h"
26 #include "ffmpeg_audio_stream.h"
27 #include "compose.hpp"
34 #include "exceptions.h"
35 #include "frame_rate_change.h"
36 #include "text_content.h"
37 #include "decrypted_ecinema_kdm.h"
38 #include <dcp/raw_convert.h>
39 #include <libcxml/cxml.h>
41 #include <libavformat/avformat.h>
42 #include <libavutil/pixdesc.h>
44 #include <libxml++/libxml++.h>
45 #include <boost/foreach.hpp>
57 using boost::shared_ptr;
58 using boost::dynamic_pointer_cast;
59 using boost::optional;
60 using dcp::raw_convert;
61 using namespace dcpomatic;
63 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
64 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
65 int const FFmpegContentProperty::FILTERS = 102;
66 int const FFmpegContentProperty::KDM = 103;
68 FFmpegContent::FFmpegContent (boost::filesystem::path p)
70 #ifdef DCPOMATIC_VARIANT_SWAROOP
79 get_optional_enum (cxml::ConstNodePtr node, string name)
81 optional<int> const v = node->optional_number_child<int>(name);
85 return static_cast<T>(*v);
88 FFmpegContent::FFmpegContent (cxml::ConstNodePtr node, int version, list<string>& notes)
91 video = VideoContent::from_xml (this, node, version);
92 audio = AudioContent::from_xml (this, node, version);
93 text = TextContent::from_xml (this, node, version);
95 list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
96 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
97 _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i, version)));
98 if ((*i)->optional_number_child<int> ("Selected")) {
99 _subtitle_stream = _subtitle_streams.back ();
103 c = node->node_children ("AudioStream");
104 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
105 shared_ptr<FFmpegAudioStream> as (new FFmpegAudioStream (*i, version));
106 audio->add_stream (as);
107 if (version < 11 && !(*i)->optional_node_child ("Selected")) {
108 /* This is an old file and this stream is not selected, so un-map it */
109 as->set_mapping (AudioMapping (as->channels (), MAX_DCP_AUDIO_CHANNELS));
113 c = node->node_children ("Filter");
114 for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
115 Filter const * f = Filter::from_id ((*i)->content ());
117 _filters.push_back (f);
119 notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), (*i)->content()));
123 optional<ContentTime::Type> const f = node->optional_number_child<ContentTime::Type> ("FirstVideo");
125 _first_video = ContentTime (f.get ());
128 _color_range = get_optional_enum<AVColorRange>(node, "ColorRange");
129 _color_primaries = get_optional_enum<AVColorPrimaries>(node, "ColorPrimaries");
130 _color_trc = get_optional_enum<AVColorTransferCharacteristic>(node, "ColorTransferCharacteristic");
131 _colorspace = get_optional_enum<AVColorSpace>(node, "Colorspace");
132 _bits_per_pixel = node->optional_number_child<int> ("BitsPerPixel");
133 #ifdef DCPOMATIC_VARIANT_SWAROOP
134 _encrypted = node->optional_bool_child("Encrypted").get_value_or(false);
138 FFmpegContent::FFmpegContent (vector<shared_ptr<Content> > c)
141 vector<shared_ptr<Content> >::const_iterator i = c.begin ();
143 bool need_video = false;
144 bool need_audio = false;
145 bool need_text = false;
148 need_video = static_cast<bool> ((*i)->video);
149 need_audio = static_cast<bool> ((*i)->audio);
150 need_text = !(*i)->text.empty();
153 while (i != c.end ()) {
154 if (need_video != static_cast<bool> ((*i)->video)) {
155 throw JoinError (_("Content to be joined must all have or not have video"));
157 if (need_audio != static_cast<bool> ((*i)->audio)) {
158 throw JoinError (_("Content to be joined must all have or not have audio"));
160 if (need_text != !(*i)->text.empty()) {
161 throw JoinError (_("Content to be joined must all have or not have subtitles or captions"));
167 video.reset (new VideoContent (this, c));
170 audio.reset (new AudioContent (this, c));
173 text.push_back (shared_ptr<TextContent> (new TextContent (this, c)));
176 shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
177 DCPOMATIC_ASSERT (ref);
179 for (size_t i = 0; i < c.size(); ++i) {
180 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
181 if (fc->only_text() && fc->only_text()->use() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
182 throw JoinError (_("Content to be joined must use the same subtitle stream."));
186 /* XXX: should probably check that more of the stuff below is the same in *this and ref */
188 _subtitle_streams = ref->subtitle_streams ();
189 _subtitle_stream = ref->subtitle_stream ();
190 _first_video = ref->_first_video;
191 _filters = ref->_filters;
192 _color_range = ref->_color_range;
193 _color_primaries = ref->_color_primaries;
194 _color_trc = ref->_color_trc;
195 _colorspace = ref->_colorspace;
196 _bits_per_pixel = ref->_bits_per_pixel;
197 #ifdef DCPOMATIC_VARIANT_SWAROOP
198 _encrypted = ref->_encrypted;
203 FFmpegContent::as_xml (xmlpp::Node* node, bool with_paths) const
205 node->add_child("Type")->add_child_text ("FFmpeg");
206 Content::as_xml (node, with_paths);
209 video->as_xml (node);
213 audio->as_xml (node);
215 BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
216 shared_ptr<FFmpegAudioStream> f = dynamic_pointer_cast<FFmpegAudioStream> (i);
217 DCPOMATIC_ASSERT (f);
218 f->as_xml (node->add_child("AudioStream"));
223 only_text()->as_xml (node);
226 boost::mutex::scoped_lock lm (_mutex);
228 for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
229 xmlpp::Node* t = node->add_child("SubtitleStream");
230 if (_subtitle_stream && *i == _subtitle_stream) {
231 t->add_child("Selected")->add_child_text("1");
236 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
237 node->add_child("Filter")->add_child_text ((*i)->id ());
241 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
245 node->add_child("ColorRange")->add_child_text (raw_convert<string> (static_cast<int> (*_color_range)));
247 if (_color_primaries) {
248 node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (static_cast<int> (*_color_primaries)));
251 node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (static_cast<int> (*_color_trc)));
254 node->add_child("Colorspace")->add_child_text (raw_convert<string> (static_cast<int> (*_colorspace)));
256 if (_bits_per_pixel) {
257 node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (*_bits_per_pixel));
259 #ifdef DCPOMATIC_VARIANT_SWAROOP
261 node->add_child("Encypted")->add_child_text ("1");
267 FFmpegContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
269 ChangeSignaller<Content> cc1 (this, FFmpegContentProperty::SUBTITLE_STREAMS);
270 ChangeSignaller<Content> cc2 (this, FFmpegContentProperty::SUBTITLE_STREAM);
273 job->set_progress_unknown ();
276 Content::examine (film, job);
278 shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
280 if (examiner->has_video ()) {
281 video.reset (new VideoContent (this));
282 video->take_from_examiner (examiner);
285 boost::filesystem::path first_path = path (0);
288 boost::mutex::scoped_lock lm (_mutex);
290 if (examiner->has_video ()) {
291 _first_video = examiner->first_video ();
292 _color_range = examiner->color_range ();
293 _color_primaries = examiner->color_primaries ();
294 _color_trc = examiner->color_trc ();
295 _colorspace = examiner->colorspace ();
296 _bits_per_pixel = examiner->bits_per_pixel ();
298 if (examiner->rotation()) {
299 double rot = *examiner->rotation ();
300 if (fabs (rot - 180) < 1.0) {
301 _filters.push_back (Filter::from_id ("vflip"));
302 _filters.push_back (Filter::from_id ("hflip"));
303 } else if (fabs (rot - 90) < 1.0) {
304 _filters.push_back (Filter::from_id ("90clock"));
305 } else if (fabs (rot - 270) < 1.0) {
306 _filters.push_back (Filter::from_id ("90anticlock"));
311 if (!examiner->audio_streams().empty ()) {
312 audio.reset (new AudioContent (this));
314 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, examiner->audio_streams ()) {
315 audio->add_stream (i);
318 AudioStreamPtr as = audio->streams().front();
319 AudioMapping m = as->mapping ();
320 m.make_default (film ? film->audio_processor() : 0, first_path);
324 _subtitle_streams = examiner->subtitle_streams ();
325 if (!_subtitle_streams.empty ()) {
327 text.push_back (shared_ptr<TextContent> (new TextContent (this, TEXT_OPEN_SUBTITLE, TEXT_UNKNOWN)));
328 _subtitle_stream = _subtitle_streams.front ();
331 #ifdef DCPOMATIC_VARIANT_SWAROOP
332 _encrypted = first_path.extension() == ".ecinema";
336 if (examiner->has_video ()) {
337 set_default_colour_conversion ();
340 if (examiner->has_video() && examiner->pulldown() && video_frame_rate() && fabs(*video_frame_rate() - 29.97) < 0.001) {
341 /* FFmpeg has detected this file as 29.97 and the examiner thinks it is using "soft" 2:3 pulldown (telecine).
342 * This means we can treat it as a 23.976fps file.
344 set_video_frame_rate (24000.0 / 1001);
345 video->set_length (video->length() * 24.0 / 30);
348 #ifdef DCPOMATIC_VARIANT_SWAROOP
349 _id = examiner->id ();
354 FFmpegContent::summary () const
356 if (video && audio) {
357 return String::compose (_("%1 [movie]"), path_summary ());
359 return String::compose (_("%1 [video]"), path_summary ());
361 return String::compose (_("%1 [audio]"), path_summary ());
364 return path_summary ();
368 FFmpegContent::technical_summary () const
371 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
372 as += i->technical_summary () + " " ;
380 if (_subtitle_stream) {
381 ss = _subtitle_stream->technical_summary ();
384 string filt = Filter::ffmpeg_string (_filters);
386 string s = Content::technical_summary ();
389 s += " - " + video->technical_summary ();
393 s += " - " + audio->technical_summary ();
396 return s + String::compose (
397 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
402 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
404 ChangeSignaller<Content> cc (this, FFmpegContentProperty::SUBTITLE_STREAM);
407 boost::mutex::scoped_lock lm (_mutex);
408 _subtitle_stream = s;
413 operator== (FFmpegStream const & a, FFmpegStream const & b)
415 return a._id == b._id;
419 operator!= (FFmpegStream const & a, FFmpegStream const & b)
421 return a._id != b._id;
425 FFmpegContent::full_length (shared_ptr<const Film> film) const
427 FrameRateChange const frc (film, shared_from_this());
429 return DCPTime::from_frames (llrint (video->length_after_3d_combine() * frc.factor()), film->video_frame_rate());
434 BOOST_FOREACH (AudioStreamPtr i, audio->streams()) {
435 longest = max (longest, DCPTime::from_frames(llrint(i->length() / frc.speed_up), i->frame_rate()));
440 /* XXX: subtitle content? */
446 FFmpegContent::approximate_length () const
449 return DCPTime::from_frames (video->length_after_3d_combine(), 24);
452 DCPOMATIC_ASSERT (audio);
455 BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
456 longest = max (longest, Frame(llrint(i->length())));
459 return DCPTime::from_frames (longest, 24);
463 FFmpegContent::set_filters (vector<Filter const *> const & filters)
465 ChangeSignaller<Content> cc (this, FFmpegContentProperty::FILTERS);
468 boost::mutex::scoped_lock lm (_mutex);
474 FFmpegContent::identifier () const
476 string s = Content::identifier();
479 s += "_" + video->identifier();
482 if (only_text() && only_text()->use() && only_text()->burn()) {
483 s += "_" + only_text()->identifier();
486 boost::mutex::scoped_lock lm (_mutex);
488 if (_subtitle_stream) {
489 s += "_" + _subtitle_stream->identifier ();
492 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
493 s += "_" + (*i)->id ();
500 FFmpegContent::set_default_colour_conversion ()
502 DCPOMATIC_ASSERT (video);
504 dcp::Size const s = video->size ();
506 boost::mutex::scoped_lock lm (_mutex);
508 switch (_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)) {
510 video->set_colour_conversion (PresetColourConversion::from_id ("srgb").conversion);
512 case AVCOL_SPC_BT709:
513 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
515 case AVCOL_SPC_BT470BG:
516 case AVCOL_SPC_SMPTE170M:
517 case AVCOL_SPC_SMPTE240M:
518 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
520 case AVCOL_SPC_BT2020_CL:
521 case AVCOL_SPC_BT2020_NCL:
522 video->set_colour_conversion (PresetColourConversion::from_id ("rec2020").conversion);
525 if (s.width < 1080) {
526 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
528 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
535 FFmpegContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
537 Content::add_properties (film, p);
540 video->add_properties (p);
542 if (_bits_per_pixel) {
543 /* Assuming there's three components, so bits per pixel component is _bits_per_pixel / 3 */
544 int const lim_start = pow(2, _bits_per_pixel.get() / 3 - 4);
545 int const lim_end = 235 * pow(2, _bits_per_pixel.get() / 3 - 8);
546 int const total = pow(2, _bits_per_pixel.get() / 3);
548 switch (_color_range.get_value_or(AVCOL_RANGE_UNSPECIFIED)) {
549 case AVCOL_RANGE_UNSPECIFIED:
550 /// TRANSLATORS: this means that the range of pixel values used in this
551 /// file is unknown (not specified in the file).
552 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
554 case AVCOL_RANGE_MPEG:
555 /// TRANSLATORS: this means that the range of pixel values used in this
556 /// file is limited, so that not all possible values are valid.
559 UserProperty::VIDEO, _("Colour range"), String::compose(_("Limited (%1-%2)"), lim_start, lim_end)
563 case AVCOL_RANGE_JPEG:
564 /// TRANSLATORS: this means that the range of pixel values used in this
565 /// file is full, so that all possible pixel values are valid.
566 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), String::compose (_("Full (0-%1)"), total)));
569 DCPOMATIC_ASSERT (false);
572 switch (_color_range.get_value_or(AVCOL_RANGE_UNSPECIFIED)) {
573 case AVCOL_RANGE_UNSPECIFIED:
574 /// TRANSLATORS: this means that the range of pixel values used in this
575 /// file is unknown (not specified in the file).
576 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
578 case AVCOL_RANGE_MPEG:
579 /// TRANSLATORS: this means that the range of pixel values used in this
580 /// file is limited, so that not all possible values are valid.
581 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Limited")));
583 case AVCOL_RANGE_JPEG:
584 /// TRANSLATORS: this means that the range of pixel values used in this
585 /// file is full, so that all possible pixel values are valid.
586 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Full")));
589 DCPOMATIC_ASSERT (false);
593 char const * primaries[] = {
600 _("SMPTE 170M (BT601)"),
604 _("SMPTE ST 428-1 (CIE 1931 XYZ)"),
605 _("SMPTE ST 431-2 (2011)"),
606 _("SMPTE ST 432-1 D65 (2010)"), // 12
619 DCPOMATIC_ASSERT (AVCOL_PRI_NB <= 23);
620 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour primaries"), primaries[_color_primaries.get_value_or(AVCOL_PRI_UNSPECIFIED)]));
622 char const * transfers[] = {
627 _("Gamma 22 (BT470M)"),
628 _("Gamma 28 (BT470BG)"),
629 _("SMPTE 170M (BT601)"),
632 _("Logarithmic (100:1 range)"),
633 _("Logarithmic (316:1 range)"),
635 _("BT1361 extended colour gamut"),
636 _("IEC61966-2-1 (sRGB or sYCC)"),
637 _("BT2020 for a 10-bit system"),
638 _("BT2020 for a 12-bit system"),
639 _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
641 _("ARIB STD-B67 ('Hybrid log-gamma')")
644 DCPOMATIC_ASSERT (AVCOL_TRC_NB <= 19);
645 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour transfer characteristic"), transfers[_color_trc.get_value_or(AVCOL_TRC_UNSPECIFIED)]));
647 char const * spaces[] = {
648 _("RGB / sRGB (IEC61966-2-1)"),
653 _("BT470BG (BT601-6)"),
654 _("SMPTE 170M (BT601-6)"),
657 _("BT2020 non-constant luminance"),
658 _("BT2020 constant luminance"),
659 _("SMPTE 2085, Y'D'zD'x"),
660 _("Chroma-derived non-constant luminance"),
661 _("Chroma-derived constant luminance"),
665 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 15);
666 p.push_back (UserProperty (UserProperty::VIDEO, _("Colourspace"), spaces[_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)]));
668 if (_bits_per_pixel) {
669 p.push_back (UserProperty (UserProperty::VIDEO, _("Bits per pixel"), *_bits_per_pixel));
674 audio->add_properties (film, p);
678 /** Our subtitle streams have colour maps, which can be changed, but
679 * they have no way of signalling that change. As a hack, we have this
680 * method which callers can use when they've modified one of our subtitle
684 FFmpegContent::signal_subtitle_stream_changed ()
686 /* XXX: this is too late; really it should be before the change */
687 ChangeSignaller<Content> cc (this, FFmpegContentProperty::SUBTITLE_STREAM);
690 vector<shared_ptr<FFmpegAudioStream> >
691 FFmpegContent::ffmpeg_audio_streams () const
693 vector<shared_ptr<FFmpegAudioStream> > fa;
696 BOOST_FOREACH (AudioStreamPtr i, audio->streams()) {
697 fa.push_back (dynamic_pointer_cast<FFmpegAudioStream> (i));
705 FFmpegContent::take_settings_from (shared_ptr<const Content> c)
707 shared_ptr<const FFmpegContent> fc = dynamic_pointer_cast<const FFmpegContent> (c);
712 Content::take_settings_from (c);
713 _filters = fc->_filters;
716 #ifdef DCPOMATIC_VARIANT_SWAROOP
718 FFmpegContent::add_kdm (EncryptedECinemaKDM kdm)
720 ChangeSignaller<Content> cc (this, FFmpegContentProperty::KDM);
721 boost::mutex::scoped_lock lm (_mutex);
727 FFmpegContent::kdm_timing_window_valid () const
733 DCPOMATIC_ASSERT (Config::instance()->decryption_chain()->key());
735 DecryptedECinemaKDM decrypted (*_kdm, *Config::instance()->decryption_chain()->key());
738 return (!decrypted.not_valid_before() || *decrypted.not_valid_before() < now) &&
739 (!decrypted.not_valid_after() || now < *decrypted.not_valid_after());