2 Copyright (C) 2013-2021 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/>.
22 #include "audio_content.h"
23 #include "compose.hpp"
25 #include "constants.h"
26 #include "exceptions.h"
27 #include "ffmpeg_audio_stream.h"
28 #include "ffmpeg_content.h"
29 #include "ffmpeg_examiner.h"
30 #include "ffmpeg_subtitle_stream.h"
33 #include "frame_rate_change.h"
36 #include "text_content.h"
38 #include "video_content.h"
39 #include <dcp/raw_convert.h>
40 #include <libcxml/cxml.h>
42 #include <libavformat/avformat.h>
43 #include <libavutil/pixdesc.h>
45 #include <libxml++/libxml++.h>
58 using std::make_shared;
59 using std::shared_ptr;
60 using std::dynamic_pointer_cast;
61 using boost::optional;
62 using dcp::raw_convert;
63 using namespace dcpomatic;
66 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
67 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
68 int const FFmpegContentProperty::FILTERS = 102;
69 int const FFmpegContentProperty::KDM = 103;
72 FFmpegContent::FFmpegContent (boost::filesystem::path p)
81 get_optional_enum (cxml::ConstNodePtr node, string name)
83 auto const v = node->optional_number_child<int>(name);
87 return static_cast<T>(*v);
91 FFmpegContent::FFmpegContent (cxml::ConstNodePtr node, int version, list<string>& notes)
94 _color_range = get_optional_enum<AVColorRange>(node, "ColorRange");
96 VideoRange const video_range_hint = (_color_range && *_color_range == AVCOL_RANGE_JPEG) ? VideoRange::FULL : VideoRange::VIDEO;
98 video = VideoContent::from_xml (this, node, version, video_range_hint);
99 audio = AudioContent::from_xml (this, node, version);
100 text = TextContent::from_xml (this, node, version, notes);
102 for (auto i: node->node_children("SubtitleStream")) {
103 _subtitle_streams.push_back (make_shared<FFmpegSubtitleStream>(i, version));
104 if (i->optional_number_child<int>("Selected")) {
105 _subtitle_stream = _subtitle_streams.back ();
109 for (auto i: node->node_children("AudioStream")) {
110 auto as = make_shared<FFmpegAudioStream>(i, version);
111 audio->add_stream (as);
112 if (version < 11 && !i->optional_node_child ("Selected")) {
113 /* This is an old file and this stream is not selected, so un-map it */
114 as->set_mapping (AudioMapping (as->channels (), MAX_DCP_AUDIO_CHANNELS));
118 for (auto i: node->node_children("Filter")) {
119 if (auto filter = Filter::from_id(i->content())) {
120 _filters.push_back(*filter);
122 notes.push_back(String::compose(_("%1 no longer supports the `%2' filter, so it has been turned off."), variant::dcpomatic(), i->content()));
126 auto const f = node->optional_number_child<ContentTime::Type> ("FirstVideo");
128 _first_video = ContentTime (f.get ());
131 _color_primaries = get_optional_enum<AVColorPrimaries>(node, "ColorPrimaries");
132 _color_trc = get_optional_enum<AVColorTransferCharacteristic>(node, "ColorTransferCharacteristic");
133 _colorspace = get_optional_enum<AVColorSpace>(node, "Colorspace");
134 _bits_per_pixel = node->optional_number_child<int> ("BitsPerPixel");
138 FFmpegContent::FFmpegContent (vector<shared_ptr<Content>> c)
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 = make_shared<VideoContent>(this, c);
170 audio = make_shared<AudioContent>(this, c);
173 text.push_back (make_shared<TextContent>(this, c));
176 auto ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
177 DCPOMATIC_ASSERT (ref);
179 for (size_t i = 0; i < c.size(); ++i) {
180 auto 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;
201 FFmpegContent::as_xml(xmlpp::Element* element, bool with_paths) const
203 cxml::add_text_child(element, "Type", "FFmpeg");
204 Content::as_xml(element, with_paths);
207 video->as_xml(element);
211 audio->as_xml(element);
213 for (auto i: audio->streams()) {
214 auto f = dynamic_pointer_cast<FFmpegAudioStream> (i);
215 DCPOMATIC_ASSERT (f);
216 f->as_xml(cxml::add_child(element, "AudioStream"));
221 only_text()->as_xml(element);
224 boost::mutex::scoped_lock lm (_mutex);
226 for (auto i: _subtitle_streams) {
227 auto t = cxml::add_child(element, "SubtitleStream");
228 if (_subtitle_stream && i == _subtitle_stream) {
229 cxml::add_text_child(t, "Selected", "1");
234 for (auto i: _filters) {
235 cxml::add_text_child(element, "Filter", i.id());
239 cxml::add_text_child(element, "FirstVideo", raw_convert<string>(_first_video.get().get()));
243 cxml::add_text_child(element, "ColorRange", raw_convert<string>(static_cast<int>(*_color_range)));
245 if (_color_primaries) {
246 cxml::add_text_child(element, "ColorPrimaries", raw_convert<string>(static_cast<int>(*_color_primaries)));
249 cxml::add_text_child(element, "ColorTransferCharacteristic", raw_convert<string>(static_cast<int>(*_color_trc)));
252 cxml::add_text_child(element, "Colorspace", raw_convert<string>(static_cast<int>(*_colorspace)));
254 if (_bits_per_pixel) {
255 cxml::add_text_child(element, "BitsPerPixel", raw_convert<string>(*_bits_per_pixel));
261 FFmpegContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
263 ContentChangeSignaller cc1 (this, FFmpegContentProperty::SUBTITLE_STREAMS);
264 ContentChangeSignaller cc2 (this, FFmpegContentProperty::SUBTITLE_STREAM);
267 job->set_progress_unknown ();
270 Content::examine (film, job);
272 auto examiner = make_shared<FFmpegExaminer>(shared_from_this (), job);
274 if (examiner->has_video ()) {
275 video.reset (new VideoContent (this));
276 video->take_from_examiner(film, examiner);
279 auto first_path = path (0);
282 boost::mutex::scoped_lock lm (_mutex);
284 if (examiner->has_video ()) {
285 _first_video = examiner->first_video ();
286 _color_range = examiner->color_range ();
287 _color_primaries = examiner->color_primaries ();
288 _color_trc = examiner->color_trc ();
289 _colorspace = examiner->colorspace ();
290 _bits_per_pixel = examiner->bits_per_pixel ();
292 if (examiner->rotation()) {
293 auto rot = *examiner->rotation ();
294 if (fabs (rot - 180) < 1.0) {
295 _filters.push_back(*Filter::from_id("vflip"));
296 _filters.push_back(*Filter::from_id("hflip"));
297 } else if (fabs (rot - 90) < 1.0) {
298 _filters.push_back(*Filter::from_id("90clock"));
299 video->rotate_size();
300 } else if (fabs (rot - 270) < 1.0) {
301 _filters.push_back(*Filter::from_id("90anticlock"));
302 video->rotate_size();
305 if (examiner->has_alpha()) {
306 _filters.push_back(*Filter::from_id("premultiply"));
310 if (!examiner->audio_streams().empty()) {
311 audio = make_shared<AudioContent>(this);
313 for (auto i: examiner->audio_streams()) {
314 audio->add_stream (i);
317 auto as = audio->streams().front();
318 auto m = as->mapping ();
319 m.make_default (film ? film->audio_processor() : 0, first_path);
323 _subtitle_streams = examiner->subtitle_streams ();
324 if (!_subtitle_streams.empty ()) {
326 text.push_back (make_shared<TextContent>(this, TextType::OPEN_SUBTITLE, TextType::UNKNOWN));
327 _subtitle_stream = _subtitle_streams.front ();
328 text.front()->add_font(make_shared<dcpomatic::Font>(""));
332 if (examiner->has_video ()) {
333 set_default_colour_conversion ();
336 if (examiner->has_video() && examiner->pulldown() && video_frame_rate() && fabs(*video_frame_rate() - 29.97) < 0.001) {
337 /* FFmpeg has detected this file as 29.97 and the examiner thinks it is using "soft" 2:3 pulldown (telecine).
338 * This means we can treat it as a 23.976fps file.
340 set_video_frame_rate(film, 24000.0 / 1001);
341 video->set_length (video->length() * 24.0 / 30);
347 FFmpegContent::summary () const
349 if (video && audio) {
350 return String::compose (_("%1 [movie]"), path_summary());
352 return String::compose (_("%1 [video]"), path_summary());
354 return String::compose (_("%1 [audio]"), path_summary());
357 return path_summary ();
362 FFmpegContent::technical_summary () const
365 for (auto i: ffmpeg_audio_streams ()) {
366 as += i->technical_summary () + " " ;
374 if (_subtitle_stream) {
375 ss = _subtitle_stream->technical_summary ();
378 auto filt = Filter::ffmpeg_string (_filters);
380 auto s = Content::technical_summary ();
383 s += " - " + video->technical_summary ();
387 s += " - " + audio->technical_summary ();
390 return s + String::compose (
391 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
397 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
399 ContentChangeSignaller cc (this, FFmpegContentProperty::SUBTITLE_STREAM);
402 boost::mutex::scoped_lock lm (_mutex);
403 _subtitle_stream = s;
409 operator== (FFmpegStream const & a, FFmpegStream const & b)
411 return a._id == b._id;
416 operator!= (FFmpegStream const & a, FFmpegStream const & b)
418 return a._id != b._id;
423 FFmpegContent::full_length (shared_ptr<const Film> film) const
425 FrameRateChange const frc (film, shared_from_this());
427 return DCPTime::from_frames (llrint (video->length_after_3d_combine() * frc.factor()), film->video_frame_rate());
432 for (auto i: audio->streams()) {
433 longest = max (longest, DCPTime::from_frames(llrint(i->length() / frc.speed_up), i->frame_rate()));
438 /* XXX: subtitle content? */
445 FFmpegContent::approximate_length () const
448 return DCPTime::from_frames (video->length_after_3d_combine(), 24);
451 DCPOMATIC_ASSERT (audio);
454 for (auto i: audio->streams()) {
455 longest = max (longest, Frame(llrint(i->length())));
458 return DCPTime::from_frames (longest, 24);
463 FFmpegContent::set_filters(vector<Filter> const& filters)
465 ContentChangeSignaller cc (this, FFmpegContentProperty::FILTERS);
468 boost::mutex::scoped_lock lm (_mutex);
475 FFmpegContent::identifier () const
477 string s = Content::identifier();
480 s += "_" + video->identifier();
483 if (only_text() && only_text()->use() && only_text()->burn()) {
484 s += "_" + only_text()->identifier();
487 boost::mutex::scoped_lock lm (_mutex);
489 if (_subtitle_stream) {
490 s += "_" + _subtitle_stream->identifier ();
493 for (auto i: _filters) {
502 FFmpegContent::set_default_colour_conversion ()
504 DCPOMATIC_ASSERT (video);
506 auto const s = video->size ();
508 boost::mutex::scoped_lock lm (_mutex);
510 switch (_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)) {
512 video->set_colour_conversion (PresetColourConversion::from_id ("srgb").conversion);
514 case AVCOL_SPC_BT709:
515 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
517 case AVCOL_SPC_BT470BG:
518 case AVCOL_SPC_SMPTE170M:
519 case AVCOL_SPC_SMPTE240M:
520 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
522 case AVCOL_SPC_BT2020_CL:
523 case AVCOL_SPC_BT2020_NCL:
524 video->set_colour_conversion (PresetColourConversion::from_id ("rec2020").conversion);
527 if (s && s->width < 1080) {
528 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
530 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
538 FFmpegContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
540 Content::add_properties (film, p);
543 video->add_properties (p);
545 if (_bits_per_pixel) {
546 auto pixel_quanta_product = video->pixel_quanta().x * video->pixel_quanta().y;
547 auto bits_per_main_pixel = pixel_quanta_product * _bits_per_pixel.get() / (pixel_quanta_product + 2);
549 int const lim_start = pow(2, bits_per_main_pixel - 4);
550 int const lim_end = 235 * pow(2, bits_per_main_pixel - 8);
551 int const total = pow(2, bits_per_main_pixel);
553 switch (_color_range.get_value_or(AVCOL_RANGE_UNSPECIFIED)) {
554 case AVCOL_RANGE_UNSPECIFIED:
555 /// TRANSLATORS: this means that the range of pixel values used in this
556 /// file is unknown (not specified in the file).
557 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
559 case AVCOL_RANGE_MPEG:
560 /// TRANSLATORS: this means that the range of pixel values used in this
561 /// file is limited, so that not all possible values are valid.
564 UserProperty::VIDEO, _("Colour range"), String::compose(_("Limited / video (%1-%2)"), lim_start, lim_end)
568 case AVCOL_RANGE_JPEG:
569 /// TRANSLATORS: this means that the range of pixel values used in this
570 /// file is full, so that all possible pixel values are valid.
571 p.push_back(UserProperty(UserProperty::VIDEO, _("Colour range"), String::compose(_("Full (0-%1)"), total - 1)));
574 DCPOMATIC_ASSERT (false);
577 switch (_color_range.get_value_or(AVCOL_RANGE_UNSPECIFIED)) {
578 case AVCOL_RANGE_UNSPECIFIED:
579 /// TRANSLATORS: this means that the range of pixel values used in this
580 /// file is unknown (not specified in the file).
581 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
583 case AVCOL_RANGE_MPEG:
584 /// TRANSLATORS: this means that the range of pixel values used in this
585 /// file is limited, so that not all possible values are valid.
586 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Limited")));
588 case AVCOL_RANGE_JPEG:
589 /// TRANSLATORS: this means that the range of pixel values used in this
590 /// file is full, so that all possible pixel values are valid.
591 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Full")));
594 DCPOMATIC_ASSERT (false);
598 char const * primaries[] = {
605 _("SMPTE 170M (BT601)"),
609 _("SMPTE ST 428-1 (CIE 1931 XYZ)"),
610 _("SMPTE ST 431-2 (2011)"),
611 _("SMPTE ST 432-1 D65 (2010)"), // 12
624 DCPOMATIC_ASSERT (AVCOL_PRI_NB <= 23);
625 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour primaries"), primaries[_color_primaries.get_value_or(AVCOL_PRI_UNSPECIFIED)]));
627 char const * transfers[] = {
632 _("Gamma 22 (BT470M)"),
633 _("Gamma 28 (BT470BG)"),
634 _("SMPTE 170M (BT601)"),
637 _("Logarithmic (100:1 range)"),
638 _("Logarithmic (316:1 range)"),
640 _("BT1361 extended colour gamut"),
641 _("IEC61966-2-1 (sRGB or sYCC)"),
642 _("BT2020 for a 10-bit system"),
643 _("BT2020 for a 12-bit system"),
644 _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
646 _("ARIB STD-B67 ('Hybrid log-gamma')")
649 DCPOMATIC_ASSERT (AVCOL_TRC_NB <= 19);
650 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour transfer characteristic"), transfers[_color_trc.get_value_or(AVCOL_TRC_UNSPECIFIED)]));
652 char const * spaces[] = {
653 _("RGB / sRGB (IEC61966-2-1)"),
658 _("BT470BG (BT601-6)"),
659 _("SMPTE 170M (BT601-6)"),
662 _("BT2020 non-constant luminance"),
663 _("BT2020 constant luminance"),
664 _("SMPTE 2085, Y'D'zD'x"),
665 _("Chroma-derived non-constant luminance"),
666 _("Chroma-derived constant luminance"),
670 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 15);
671 p.push_back (UserProperty (UserProperty::VIDEO, _("Colourspace"), spaces[_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)]));
673 if (_bits_per_pixel) {
674 p.push_back (UserProperty (UserProperty::VIDEO, _("Bits per pixel"), *_bits_per_pixel));
679 audio->add_properties (film, p);
684 /** Our subtitle streams have colour maps, which can be changed, but
685 * they have no way of signalling that change. As a hack, we have this
686 * method which callers can use when they've modified one of our subtitle
690 FFmpegContent::signal_subtitle_stream_changed ()
692 /* XXX: this is too late; really it should be before the change */
693 ContentChangeSignaller cc (this, FFmpegContentProperty::SUBTITLE_STREAM);
697 vector<shared_ptr<FFmpegAudioStream>>
698 FFmpegContent::ffmpeg_audio_streams () const
700 vector<shared_ptr<FFmpegAudioStream>> fa;
703 for (auto i: audio->streams()) {
704 fa.push_back (dynamic_pointer_cast<FFmpegAudioStream>(i));
713 FFmpegContent::take_settings_from (shared_ptr<const Content> c)
715 auto fc = dynamic_pointer_cast<const FFmpegContent> (c);
720 Content::take_settings_from (c);
721 _filters = fc->_filters;