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"
37 #include "video_content.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>
57 using std::make_shared;
58 using std::shared_ptr;
59 using std::dynamic_pointer_cast;
60 using boost::optional;
61 using dcp::raw_convert;
62 using namespace dcpomatic;
65 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
66 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
67 int const FFmpegContentProperty::FILTERS = 102;
68 int const FFmpegContentProperty::KDM = 103;
71 FFmpegContent::FFmpegContent (boost::filesystem::path p)
80 get_optional_enum (cxml::ConstNodePtr node, string name)
82 auto const v = node->optional_number_child<int>(name);
86 return static_cast<T>(*v);
90 FFmpegContent::FFmpegContent (cxml::ConstNodePtr node, int version, list<string>& notes)
93 _color_range = get_optional_enum<AVColorRange>(node, "ColorRange");
95 VideoRange const video_range_hint = (_color_range && *_color_range == AVCOL_RANGE_JPEG) ? VideoRange::FULL : VideoRange::VIDEO;
97 video = VideoContent::from_xml (this, node, version, video_range_hint);
98 audio = AudioContent::from_xml (this, node, version);
99 text = TextContent::from_xml (this, node, version, notes);
101 for (auto i: node->node_children("SubtitleStream")) {
102 _subtitle_streams.push_back (make_shared<FFmpegSubtitleStream>(i, version));
103 if (i->optional_number_child<int>("Selected")) {
104 _subtitle_stream = _subtitle_streams.back ();
108 for (auto i: node->node_children("AudioStream")) {
109 auto as = make_shared<FFmpegAudioStream>(i, version);
110 audio->add_stream (as);
111 if (version < 11 && !i->optional_node_child ("Selected")) {
112 /* This is an old file and this stream is not selected, so un-map it */
113 as->set_mapping (AudioMapping (as->channels (), MAX_DCP_AUDIO_CHANNELS));
117 for (auto i: node->node_children("Filter")) {
118 if (auto filter = Filter::from_id(i->content())) {
119 _filters.push_back(*filter);
121 notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), i->content()));
125 auto const f = node->optional_number_child<ContentTime::Type> ("FirstVideo");
127 _first_video = ContentTime (f.get ());
130 _color_primaries = get_optional_enum<AVColorPrimaries>(node, "ColorPrimaries");
131 _color_trc = get_optional_enum<AVColorTransferCharacteristic>(node, "ColorTransferCharacteristic");
132 _colorspace = get_optional_enum<AVColorSpace>(node, "Colorspace");
133 _bits_per_pixel = node->optional_number_child<int> ("BitsPerPixel");
137 FFmpegContent::FFmpegContent (vector<shared_ptr<Content>> c)
142 bool need_video = false;
143 bool need_audio = false;
144 bool need_text = false;
147 need_video = static_cast<bool> ((*i)->video);
148 need_audio = static_cast<bool> ((*i)->audio);
149 need_text = !(*i)->text.empty();
152 while (i != c.end ()) {
153 if (need_video != static_cast<bool> ((*i)->video)) {
154 throw JoinError (_("Content to be joined must all have or not have video"));
156 if (need_audio != static_cast<bool> ((*i)->audio)) {
157 throw JoinError (_("Content to be joined must all have or not have audio"));
159 if (need_text != !(*i)->text.empty()) {
160 throw JoinError (_("Content to be joined must all have or not have subtitles or captions"));
166 video = make_shared<VideoContent>(this, c);
169 audio = make_shared<AudioContent>(this, c);
172 text.push_back (make_shared<TextContent>(this, c));
175 auto ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
176 DCPOMATIC_ASSERT (ref);
178 for (size_t i = 0; i < c.size(); ++i) {
179 auto fc = dynamic_pointer_cast<FFmpegContent>(c[i]);
180 if (fc->only_text() && fc->only_text()->use() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
181 throw JoinError (_("Content to be joined must use the same subtitle stream."));
185 /* XXX: should probably check that more of the stuff below is the same in *this and ref */
187 _subtitle_streams = ref->subtitle_streams ();
188 _subtitle_stream = ref->subtitle_stream ();
189 _first_video = ref->_first_video;
190 _filters = ref->_filters;
191 _color_range = ref->_color_range;
192 _color_primaries = ref->_color_primaries;
193 _color_trc = ref->_color_trc;
194 _colorspace = ref->_colorspace;
195 _bits_per_pixel = ref->_bits_per_pixel;
200 FFmpegContent::as_xml (xmlpp::Node* node, bool with_paths) const
202 node->add_child("Type")->add_child_text("FFmpeg");
203 Content::as_xml (node, with_paths);
206 video->as_xml (node);
210 audio->as_xml (node);
212 for (auto i: audio->streams()) {
213 auto f = dynamic_pointer_cast<FFmpegAudioStream> (i);
214 DCPOMATIC_ASSERT (f);
215 f->as_xml (node->add_child("AudioStream"));
220 only_text()->as_xml (node);
223 boost::mutex::scoped_lock lm (_mutex);
225 for (auto i: _subtitle_streams) {
226 auto t = node->add_child("SubtitleStream");
227 if (_subtitle_stream && i == _subtitle_stream) {
228 t->add_child("Selected")->add_child_text("1");
233 for (auto i: _filters) {
234 node->add_child("Filter")->add_child_text(i.id());
238 node->add_child("FirstVideo")->add_child_text(raw_convert<string>(_first_video.get().get()));
242 node->add_child("ColorRange")->add_child_text(raw_convert<string>(static_cast<int>(*_color_range)));
244 if (_color_primaries) {
245 node->add_child("ColorPrimaries")->add_child_text(raw_convert<string>(static_cast<int>(*_color_primaries)));
248 node->add_child("ColorTransferCharacteristic")->add_child_text(raw_convert<string>(static_cast<int>(*_color_trc)));
251 node->add_child("Colorspace")->add_child_text(raw_convert<string>(static_cast<int>(*_colorspace)));
253 if (_bits_per_pixel) {
254 node->add_child("BitsPerPixel")->add_child_text(raw_convert<string>(*_bits_per_pixel));
260 FFmpegContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
262 ContentChangeSignaller cc1 (this, FFmpegContentProperty::SUBTITLE_STREAMS);
263 ContentChangeSignaller cc2 (this, FFmpegContentProperty::SUBTITLE_STREAM);
266 job->set_progress_unknown ();
269 Content::examine (film, job);
271 auto examiner = make_shared<FFmpegExaminer>(shared_from_this (), job);
273 if (examiner->has_video ()) {
274 video.reset (new VideoContent (this));
275 video->take_from_examiner(film, examiner);
278 auto first_path = path (0);
281 boost::mutex::scoped_lock lm (_mutex);
283 if (examiner->has_video ()) {
284 _first_video = examiner->first_video ();
285 _color_range = examiner->color_range ();
286 _color_primaries = examiner->color_primaries ();
287 _color_trc = examiner->color_trc ();
288 _colorspace = examiner->colorspace ();
289 _bits_per_pixel = examiner->bits_per_pixel ();
291 if (examiner->rotation()) {
292 auto rot = *examiner->rotation ();
293 if (fabs (rot - 180) < 1.0) {
294 _filters.push_back(*Filter::from_id("vflip"));
295 _filters.push_back(*Filter::from_id("hflip"));
296 } else if (fabs (rot - 90) < 1.0) {
297 _filters.push_back(*Filter::from_id("90clock"));
298 video->rotate_size();
299 } else if (fabs (rot - 270) < 1.0) {
300 _filters.push_back(*Filter::from_id("90anticlock"));
301 video->rotate_size();
304 if (examiner->has_alpha()) {
305 _filters.push_back(*Filter::from_id("premultiply"));
309 if (!examiner->audio_streams().empty()) {
310 audio = make_shared<AudioContent>(this);
312 for (auto i: examiner->audio_streams()) {
313 audio->add_stream (i);
316 auto as = audio->streams().front();
317 auto m = as->mapping ();
318 m.make_default (film ? film->audio_processor() : 0, first_path);
322 _subtitle_streams = examiner->subtitle_streams ();
323 if (!_subtitle_streams.empty ()) {
325 text.push_back (make_shared<TextContent>(this, TextType::OPEN_SUBTITLE, TextType::UNKNOWN));
326 _subtitle_stream = _subtitle_streams.front ();
327 text.front()->add_font(make_shared<dcpomatic::Font>(""));
331 if (examiner->has_video ()) {
332 set_default_colour_conversion ();
335 if (examiner->has_video() && examiner->pulldown() && video_frame_rate() && fabs(*video_frame_rate() - 29.97) < 0.001) {
336 /* FFmpeg has detected this file as 29.97 and the examiner thinks it is using "soft" 2:3 pulldown (telecine).
337 * This means we can treat it as a 23.976fps file.
339 set_video_frame_rate(film, 24000.0 / 1001);
340 video->set_length (video->length() * 24.0 / 30);
346 FFmpegContent::summary () const
348 if (video && audio) {
349 return String::compose (_("%1 [movie]"), path_summary());
351 return String::compose (_("%1 [video]"), path_summary());
353 return String::compose (_("%1 [audio]"), path_summary());
356 return path_summary ();
361 FFmpegContent::technical_summary () const
364 for (auto i: ffmpeg_audio_streams ()) {
365 as += i->technical_summary () + " " ;
373 if (_subtitle_stream) {
374 ss = _subtitle_stream->technical_summary ();
377 auto filt = Filter::ffmpeg_string (_filters);
379 auto s = Content::technical_summary ();
382 s += " - " + video->technical_summary ();
386 s += " - " + audio->technical_summary ();
389 return s + String::compose (
390 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
396 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
398 ContentChangeSignaller cc (this, FFmpegContentProperty::SUBTITLE_STREAM);
401 boost::mutex::scoped_lock lm (_mutex);
402 _subtitle_stream = s;
408 operator== (FFmpegStream const & a, FFmpegStream const & b)
410 return a._id == b._id;
415 operator!= (FFmpegStream const & a, FFmpegStream const & b)
417 return a._id != b._id;
422 FFmpegContent::full_length (shared_ptr<const Film> film) const
424 FrameRateChange const frc (film, shared_from_this());
426 return DCPTime::from_frames (llrint (video->length_after_3d_combine() * frc.factor()), film->video_frame_rate());
431 for (auto i: audio->streams()) {
432 longest = max (longest, DCPTime::from_frames(llrint(i->length() / frc.speed_up), i->frame_rate()));
437 /* XXX: subtitle content? */
444 FFmpegContent::approximate_length () const
447 return DCPTime::from_frames (video->length_after_3d_combine(), 24);
450 DCPOMATIC_ASSERT (audio);
453 for (auto i: audio->streams()) {
454 longest = max (longest, Frame(llrint(i->length())));
457 return DCPTime::from_frames (longest, 24);
462 FFmpegContent::set_filters(vector<Filter> const& filters)
464 ContentChangeSignaller cc (this, FFmpegContentProperty::FILTERS);
467 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 (auto i: _filters) {
501 FFmpegContent::set_default_colour_conversion ()
503 DCPOMATIC_ASSERT (video);
505 auto const s = video->size ();
507 boost::mutex::scoped_lock lm (_mutex);
509 switch (_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)) {
511 video->set_colour_conversion (PresetColourConversion::from_id ("srgb").conversion);
513 case AVCOL_SPC_BT709:
514 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
516 case AVCOL_SPC_BT470BG:
517 case AVCOL_SPC_SMPTE170M:
518 case AVCOL_SPC_SMPTE240M:
519 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
521 case AVCOL_SPC_BT2020_CL:
522 case AVCOL_SPC_BT2020_NCL:
523 video->set_colour_conversion (PresetColourConversion::from_id ("rec2020").conversion);
526 if (s && s->width < 1080) {
527 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
529 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
537 FFmpegContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
539 Content::add_properties (film, p);
542 video->add_properties (p);
544 if (_bits_per_pixel) {
545 auto pixel_quanta_product = video->pixel_quanta().x * video->pixel_quanta().y;
546 auto bits_per_main_pixel = pixel_quanta_product * _bits_per_pixel.get() / (pixel_quanta_product + 2);
548 int const lim_start = pow(2, bits_per_main_pixel - 4);
549 int const lim_end = 235 * pow(2, bits_per_main_pixel - 8);
550 int const total = pow(2, bits_per_main_pixel);
552 switch (_color_range.get_value_or(AVCOL_RANGE_UNSPECIFIED)) {
553 case AVCOL_RANGE_UNSPECIFIED:
554 /// TRANSLATORS: this means that the range of pixel values used in this
555 /// file is unknown (not specified in the file).
556 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
558 case AVCOL_RANGE_MPEG:
559 /// TRANSLATORS: this means that the range of pixel values used in this
560 /// file is limited, so that not all possible values are valid.
563 UserProperty::VIDEO, _("Colour range"), String::compose(_("Limited / video (%1-%2)"), lim_start, lim_end)
567 case AVCOL_RANGE_JPEG:
568 /// TRANSLATORS: this means that the range of pixel values used in this
569 /// file is full, so that all possible pixel values are valid.
570 p.push_back(UserProperty(UserProperty::VIDEO, _("Colour range"), String::compose(_("Full (0-%1)"), total - 1)));
573 DCPOMATIC_ASSERT (false);
576 switch (_color_range.get_value_or(AVCOL_RANGE_UNSPECIFIED)) {
577 case AVCOL_RANGE_UNSPECIFIED:
578 /// TRANSLATORS: this means that the range of pixel values used in this
579 /// file is unknown (not specified in the file).
580 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
582 case AVCOL_RANGE_MPEG:
583 /// TRANSLATORS: this means that the range of pixel values used in this
584 /// file is limited, so that not all possible values are valid.
585 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Limited")));
587 case AVCOL_RANGE_JPEG:
588 /// TRANSLATORS: this means that the range of pixel values used in this
589 /// file is full, so that all possible pixel values are valid.
590 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Full")));
593 DCPOMATIC_ASSERT (false);
597 char const * primaries[] = {
604 _("SMPTE 170M (BT601)"),
608 _("SMPTE ST 428-1 (CIE 1931 XYZ)"),
609 _("SMPTE ST 431-2 (2011)"),
610 _("SMPTE ST 432-1 D65 (2010)"), // 12
623 DCPOMATIC_ASSERT (AVCOL_PRI_NB <= 23);
624 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour primaries"), primaries[_color_primaries.get_value_or(AVCOL_PRI_UNSPECIFIED)]));
626 char const * transfers[] = {
631 _("Gamma 22 (BT470M)"),
632 _("Gamma 28 (BT470BG)"),
633 _("SMPTE 170M (BT601)"),
636 _("Logarithmic (100:1 range)"),
637 _("Logarithmic (316:1 range)"),
639 _("BT1361 extended colour gamut"),
640 _("IEC61966-2-1 (sRGB or sYCC)"),
641 _("BT2020 for a 10-bit system"),
642 _("BT2020 for a 12-bit system"),
643 _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
645 _("ARIB STD-B67 ('Hybrid log-gamma')")
648 DCPOMATIC_ASSERT (AVCOL_TRC_NB <= 19);
649 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour transfer characteristic"), transfers[_color_trc.get_value_or(AVCOL_TRC_UNSPECIFIED)]));
651 char const * spaces[] = {
652 _("RGB / sRGB (IEC61966-2-1)"),
657 _("BT470BG (BT601-6)"),
658 _("SMPTE 170M (BT601-6)"),
661 _("BT2020 non-constant luminance"),
662 _("BT2020 constant luminance"),
663 _("SMPTE 2085, Y'D'zD'x"),
664 _("Chroma-derived non-constant luminance"),
665 _("Chroma-derived constant luminance"),
669 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 15);
670 p.push_back (UserProperty (UserProperty::VIDEO, _("Colourspace"), spaces[_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)]));
672 if (_bits_per_pixel) {
673 p.push_back (UserProperty (UserProperty::VIDEO, _("Bits per pixel"), *_bits_per_pixel));
678 audio->add_properties (film, p);
683 /** Our subtitle streams have colour maps, which can be changed, but
684 * they have no way of signalling that change. As a hack, we have this
685 * method which callers can use when they've modified one of our subtitle
689 FFmpegContent::signal_subtitle_stream_changed ()
691 /* XXX: this is too late; really it should be before the change */
692 ContentChangeSignaller cc (this, FFmpegContentProperty::SUBTITLE_STREAM);
696 vector<shared_ptr<FFmpegAudioStream>>
697 FFmpegContent::ffmpeg_audio_streams () const
699 vector<shared_ptr<FFmpegAudioStream>> fa;
702 for (auto i: audio->streams()) {
703 fa.push_back (dynamic_pointer_cast<FFmpegAudioStream>(i));
712 FFmpegContent::take_settings_from (shared_ptr<const Content> c)
714 auto fc = dynamic_pointer_cast<const FFmpegContent> (c);
719 Content::take_settings_from (c);
720 _filters = fc->_filters;