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 <dcp/raw_convert.h>
38 #include <libcxml/cxml.h>
40 #include <libavformat/avformat.h>
41 #include <libavutil/pixdesc.h>
43 #include <libxml++/libxml++.h>
55 using std::shared_ptr;
56 using std::dynamic_pointer_cast;
57 using boost::optional;
58 using dcp::raw_convert;
59 using namespace dcpomatic;
61 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
62 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
63 int const FFmpegContentProperty::FILTERS = 102;
64 int const FFmpegContentProperty::KDM = 103;
66 FFmpegContent::FFmpegContent (boost::filesystem::path p)
74 get_optional_enum (cxml::ConstNodePtr node, string name)
76 optional<int> const v = node->optional_number_child<int>(name);
80 return static_cast<T>(*v);
83 FFmpegContent::FFmpegContent (cxml::ConstNodePtr node, int version, list<string>& notes)
86 video = VideoContent::from_xml (this, node, version);
87 audio = AudioContent::from_xml (this, node, version);
88 text = TextContent::from_xml (this, node, version);
90 list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
91 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
92 _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i, version)));
93 if ((*i)->optional_number_child<int> ("Selected")) {
94 _subtitle_stream = _subtitle_streams.back ();
98 c = node->node_children ("AudioStream");
99 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
100 shared_ptr<FFmpegAudioStream> as (new FFmpegAudioStream (*i, version));
101 audio->add_stream (as);
102 if (version < 11 && !(*i)->optional_node_child ("Selected")) {
103 /* This is an old file and this stream is not selected, so un-map it */
104 as->set_mapping (AudioMapping (as->channels (), MAX_DCP_AUDIO_CHANNELS));
108 c = node->node_children ("Filter");
109 for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
110 Filter const * f = Filter::from_id ((*i)->content ());
112 _filters.push_back (f);
114 notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), (*i)->content()));
118 optional<ContentTime::Type> const f = node->optional_number_child<ContentTime::Type> ("FirstVideo");
120 _first_video = ContentTime (f.get ());
123 _color_range = get_optional_enum<AVColorRange>(node, "ColorRange");
124 _color_primaries = get_optional_enum<AVColorPrimaries>(node, "ColorPrimaries");
125 _color_trc = get_optional_enum<AVColorTransferCharacteristic>(node, "ColorTransferCharacteristic");
126 _colorspace = get_optional_enum<AVColorSpace>(node, "Colorspace");
127 _bits_per_pixel = node->optional_number_child<int> ("BitsPerPixel");
130 FFmpegContent::FFmpegContent (vector<shared_ptr<Content> > c)
133 vector<shared_ptr<Content> >::const_iterator i = c.begin ();
135 bool need_video = false;
136 bool need_audio = false;
137 bool need_text = false;
140 need_video = static_cast<bool> ((*i)->video);
141 need_audio = static_cast<bool> ((*i)->audio);
142 need_text = !(*i)->text.empty();
145 while (i != c.end ()) {
146 if (need_video != static_cast<bool> ((*i)->video)) {
147 throw JoinError (_("Content to be joined must all have or not have video"));
149 if (need_audio != static_cast<bool> ((*i)->audio)) {
150 throw JoinError (_("Content to be joined must all have or not have audio"));
152 if (need_text != !(*i)->text.empty()) {
153 throw JoinError (_("Content to be joined must all have or not have subtitles or captions"));
159 video.reset (new VideoContent (this, c));
162 audio.reset (new AudioContent (this, c));
165 text.push_back (shared_ptr<TextContent> (new TextContent (this, c)));
168 shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
169 DCPOMATIC_ASSERT (ref);
171 for (size_t i = 0; i < c.size(); ++i) {
172 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
173 if (fc->only_text() && fc->only_text()->use() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
174 throw JoinError (_("Content to be joined must use the same subtitle stream."));
178 /* XXX: should probably check that more of the stuff below is the same in *this and ref */
180 _subtitle_streams = ref->subtitle_streams ();
181 _subtitle_stream = ref->subtitle_stream ();
182 _first_video = ref->_first_video;
183 _filters = ref->_filters;
184 _color_range = ref->_color_range;
185 _color_primaries = ref->_color_primaries;
186 _color_trc = ref->_color_trc;
187 _colorspace = ref->_colorspace;
188 _bits_per_pixel = ref->_bits_per_pixel;
192 FFmpegContent::as_xml (xmlpp::Node* node, bool with_paths) const
194 node->add_child("Type")->add_child_text ("FFmpeg");
195 Content::as_xml (node, with_paths);
198 video->as_xml (node);
202 audio->as_xml (node);
204 for (auto i: audio->streams ()) {
205 shared_ptr<FFmpegAudioStream> f = dynamic_pointer_cast<FFmpegAudioStream> (i);
206 DCPOMATIC_ASSERT (f);
207 f->as_xml (node->add_child("AudioStream"));
212 only_text()->as_xml (node);
215 boost::mutex::scoped_lock lm (_mutex);
217 for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
218 xmlpp::Node* t = node->add_child("SubtitleStream");
219 if (_subtitle_stream && *i == _subtitle_stream) {
220 t->add_child("Selected")->add_child_text("1");
225 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
226 node->add_child("Filter")->add_child_text ((*i)->id ());
230 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
234 node->add_child("ColorRange")->add_child_text (raw_convert<string> (static_cast<int> (*_color_range)));
236 if (_color_primaries) {
237 node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (static_cast<int> (*_color_primaries)));
240 node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (static_cast<int> (*_color_trc)));
243 node->add_child("Colorspace")->add_child_text (raw_convert<string> (static_cast<int> (*_colorspace)));
245 if (_bits_per_pixel) {
246 node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (*_bits_per_pixel));
251 FFmpegContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
253 ChangeSignaller<Content> cc1 (this, FFmpegContentProperty::SUBTITLE_STREAMS);
254 ChangeSignaller<Content> cc2 (this, FFmpegContentProperty::SUBTITLE_STREAM);
257 job->set_progress_unknown ();
260 Content::examine (film, job);
262 shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
264 if (examiner->has_video ()) {
265 video.reset (new VideoContent (this));
266 video->take_from_examiner (examiner);
269 boost::filesystem::path first_path = path (0);
272 boost::mutex::scoped_lock lm (_mutex);
274 if (examiner->has_video ()) {
275 _first_video = examiner->first_video ();
276 _color_range = examiner->color_range ();
277 _color_primaries = examiner->color_primaries ();
278 _color_trc = examiner->color_trc ();
279 _colorspace = examiner->colorspace ();
280 _bits_per_pixel = examiner->bits_per_pixel ();
282 if (examiner->rotation()) {
283 double rot = *examiner->rotation ();
284 if (fabs (rot - 180) < 1.0) {
285 _filters.push_back (Filter::from_id ("vflip"));
286 _filters.push_back (Filter::from_id ("hflip"));
287 } else if (fabs (rot - 90) < 1.0) {
288 _filters.push_back (Filter::from_id ("90clock"));
289 } else if (fabs (rot - 270) < 1.0) {
290 _filters.push_back (Filter::from_id ("90anticlock"));
295 if (!examiner->audio_streams().empty ()) {
296 audio.reset (new AudioContent (this));
298 for (auto i: examiner->audio_streams ()) {
299 audio->add_stream (i);
302 AudioStreamPtr as = audio->streams().front();
303 AudioMapping m = as->mapping ();
304 m.make_default (film ? film->audio_processor() : 0, first_path);
308 _subtitle_streams = examiner->subtitle_streams ();
309 if (!_subtitle_streams.empty ()) {
311 text.push_back (shared_ptr<TextContent> (new TextContent (this, TEXT_OPEN_SUBTITLE, TEXT_UNKNOWN)));
312 _subtitle_stream = _subtitle_streams.front ();
316 if (examiner->has_video ()) {
317 set_default_colour_conversion ();
320 if (examiner->has_video() && examiner->pulldown() && video_frame_rate() && fabs(*video_frame_rate() - 29.97) < 0.001) {
321 /* FFmpeg has detected this file as 29.97 and the examiner thinks it is using "soft" 2:3 pulldown (telecine).
322 * This means we can treat it as a 23.976fps file.
324 set_video_frame_rate (24000.0 / 1001);
325 video->set_length (video->length() * 24.0 / 30);
330 FFmpegContent::summary () const
332 if (video && audio) {
333 return String::compose (_("%1 [movie]"), path_summary ());
335 return String::compose (_("%1 [video]"), path_summary ());
337 return String::compose (_("%1 [audio]"), path_summary ());
340 return path_summary ();
344 FFmpegContent::technical_summary () const
347 for (auto i: ffmpeg_audio_streams ()) {
348 as += i->technical_summary () + " " ;
356 if (_subtitle_stream) {
357 ss = _subtitle_stream->technical_summary ();
360 string filt = Filter::ffmpeg_string (_filters);
362 string s = Content::technical_summary ();
365 s += " - " + video->technical_summary ();
369 s += " - " + audio->technical_summary ();
372 return s + String::compose (
373 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
378 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
380 ChangeSignaller<Content> cc (this, FFmpegContentProperty::SUBTITLE_STREAM);
383 boost::mutex::scoped_lock lm (_mutex);
384 _subtitle_stream = s;
389 operator== (FFmpegStream const & a, FFmpegStream const & b)
391 return a._id == b._id;
395 operator!= (FFmpegStream const & a, FFmpegStream const & b)
397 return a._id != b._id;
401 FFmpegContent::full_length (shared_ptr<const Film> film) const
403 FrameRateChange const frc (film, shared_from_this());
405 return DCPTime::from_frames (llrint (video->length_after_3d_combine() * frc.factor()), film->video_frame_rate());
410 for (auto i: audio->streams()) {
411 longest = max (longest, DCPTime::from_frames(llrint(i->length() / frc.speed_up), i->frame_rate()));
416 /* XXX: subtitle content? */
422 FFmpegContent::approximate_length () const
425 return DCPTime::from_frames (video->length_after_3d_combine(), 24);
428 DCPOMATIC_ASSERT (audio);
431 for (auto i: audio->streams()) {
432 longest = max (longest, Frame(llrint(i->length())));
435 return DCPTime::from_frames (longest, 24);
439 FFmpegContent::set_filters (vector<Filter const *> const & filters)
441 ChangeSignaller<Content> cc (this, FFmpegContentProperty::FILTERS);
444 boost::mutex::scoped_lock lm (_mutex);
450 FFmpegContent::identifier () const
452 string s = Content::identifier();
455 s += "_" + video->identifier();
458 if (only_text() && only_text()->use() && only_text()->burn()) {
459 s += "_" + only_text()->identifier();
462 boost::mutex::scoped_lock lm (_mutex);
464 if (_subtitle_stream) {
465 s += "_" + _subtitle_stream->identifier ();
468 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
469 s += "_" + (*i)->id ();
476 FFmpegContent::set_default_colour_conversion ()
478 DCPOMATIC_ASSERT (video);
480 dcp::Size const s = video->size ();
482 boost::mutex::scoped_lock lm (_mutex);
484 switch (_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)) {
486 video->set_colour_conversion (PresetColourConversion::from_id ("srgb").conversion);
488 case AVCOL_SPC_BT709:
489 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
491 case AVCOL_SPC_BT470BG:
492 case AVCOL_SPC_SMPTE170M:
493 case AVCOL_SPC_SMPTE240M:
494 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
496 case AVCOL_SPC_BT2020_CL:
497 case AVCOL_SPC_BT2020_NCL:
498 video->set_colour_conversion (PresetColourConversion::from_id ("rec2020").conversion);
501 if (s.width < 1080) {
502 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
504 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
511 FFmpegContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
513 Content::add_properties (film, p);
516 video->add_properties (p);
518 if (_bits_per_pixel) {
519 /* Assuming there's three components, so bits per pixel component is _bits_per_pixel / 3 */
520 int const lim_start = pow(2, _bits_per_pixel.get() / 3 - 4);
521 int const lim_end = 235 * pow(2, _bits_per_pixel.get() / 3 - 8);
522 int const total = pow(2, _bits_per_pixel.get() / 3);
524 switch (_color_range.get_value_or(AVCOL_RANGE_UNSPECIFIED)) {
525 case AVCOL_RANGE_UNSPECIFIED:
526 /// TRANSLATORS: this means that the range of pixel values used in this
527 /// file is unknown (not specified in the file).
528 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
530 case AVCOL_RANGE_MPEG:
531 /// TRANSLATORS: this means that the range of pixel values used in this
532 /// file is limited, so that not all possible values are valid.
535 UserProperty::VIDEO, _("Colour range"), String::compose(_("Limited (%1-%2)"), lim_start, lim_end)
539 case AVCOL_RANGE_JPEG:
540 /// TRANSLATORS: this means that the range of pixel values used in this
541 /// file is full, so that all possible pixel values are valid.
542 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), String::compose (_("Full (0-%1)"), total)));
545 DCPOMATIC_ASSERT (false);
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.
557 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Limited")));
559 case AVCOL_RANGE_JPEG:
560 /// TRANSLATORS: this means that the range of pixel values used in this
561 /// file is full, so that all possible pixel values are valid.
562 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Full")));
565 DCPOMATIC_ASSERT (false);
569 char const * primaries[] = {
576 _("SMPTE 170M (BT601)"),
580 _("SMPTE ST 428-1 (CIE 1931 XYZ)"),
581 _("SMPTE ST 431-2 (2011)"),
582 _("SMPTE ST 432-1 D65 (2010)"), // 12
595 DCPOMATIC_ASSERT (AVCOL_PRI_NB <= 23);
596 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour primaries"), primaries[_color_primaries.get_value_or(AVCOL_PRI_UNSPECIFIED)]));
598 char const * transfers[] = {
603 _("Gamma 22 (BT470M)"),
604 _("Gamma 28 (BT470BG)"),
605 _("SMPTE 170M (BT601)"),
608 _("Logarithmic (100:1 range)"),
609 _("Logarithmic (316:1 range)"),
611 _("BT1361 extended colour gamut"),
612 _("IEC61966-2-1 (sRGB or sYCC)"),
613 _("BT2020 for a 10-bit system"),
614 _("BT2020 for a 12-bit system"),
615 _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
617 _("ARIB STD-B67 ('Hybrid log-gamma')")
620 DCPOMATIC_ASSERT (AVCOL_TRC_NB <= 19);
621 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour transfer characteristic"), transfers[_color_trc.get_value_or(AVCOL_TRC_UNSPECIFIED)]));
623 char const * spaces[] = {
624 _("RGB / sRGB (IEC61966-2-1)"),
629 _("BT470BG (BT601-6)"),
630 _("SMPTE 170M (BT601-6)"),
633 _("BT2020 non-constant luminance"),
634 _("BT2020 constant luminance"),
635 _("SMPTE 2085, Y'D'zD'x"),
636 _("Chroma-derived non-constant luminance"),
637 _("Chroma-derived constant luminance"),
641 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 15);
642 p.push_back (UserProperty (UserProperty::VIDEO, _("Colourspace"), spaces[_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)]));
644 if (_bits_per_pixel) {
645 p.push_back (UserProperty (UserProperty::VIDEO, _("Bits per pixel"), *_bits_per_pixel));
650 audio->add_properties (film, p);
654 /** Our subtitle streams have colour maps, which can be changed, but
655 * they have no way of signalling that change. As a hack, we have this
656 * method which callers can use when they've modified one of our subtitle
660 FFmpegContent::signal_subtitle_stream_changed ()
662 /* XXX: this is too late; really it should be before the change */
663 ChangeSignaller<Content> cc (this, FFmpegContentProperty::SUBTITLE_STREAM);
666 vector<shared_ptr<FFmpegAudioStream> >
667 FFmpegContent::ffmpeg_audio_streams () const
669 vector<shared_ptr<FFmpegAudioStream> > fa;
672 for (auto i: audio->streams()) {
673 fa.push_back (dynamic_pointer_cast<FFmpegAudioStream> (i));
681 FFmpegContent::take_settings_from (shared_ptr<const Content> c)
683 shared_ptr<const FFmpegContent> fc = dynamic_pointer_cast<const FFmpegContent> (c);
688 Content::take_settings_from (c);
689 _filters = fc->_filters;