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 "ffmpeg_content.h"
23 #include "video_content.h"
24 #include "audio_content.h"
25 #include "ffmpeg_examiner.h"
26 #include "ffmpeg_subtitle_stream.h"
27 #include "ffmpeg_audio_stream.h"
28 #include "compose.hpp"
35 #include "exceptions.h"
36 #include "frame_rate_change.h"
37 #include "text_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 Filter const * f = Filter::from_id(i->content());
120 _filters.push_back (f);
122 notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), 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::Node* node, bool with_paths) const
203 node->add_child("Type")->add_child_text("FFmpeg");
204 Content::as_xml (node, with_paths);
207 video->as_xml (node);
211 audio->as_xml (node);
213 for (auto i: audio->streams()) {
214 auto f = dynamic_pointer_cast<FFmpegAudioStream> (i);
215 DCPOMATIC_ASSERT (f);
216 f->as_xml (node->add_child("AudioStream"));
221 only_text()->as_xml (node);
224 boost::mutex::scoped_lock lm (_mutex);
226 for (auto i: _subtitle_streams) {
227 auto t = node->add_child("SubtitleStream");
228 if (_subtitle_stream && i == _subtitle_stream) {
229 t->add_child("Selected")->add_child_text("1");
234 for (auto i: _filters) {
235 node->add_child("Filter")->add_child_text(i->id());
239 node->add_child("FirstVideo")->add_child_text(raw_convert<string>(_first_video.get().get()));
243 node->add_child("ColorRange")->add_child_text(raw_convert<string>(static_cast<int>(*_color_range)));
245 if (_color_primaries) {
246 node->add_child("ColorPrimaries")->add_child_text(raw_convert<string>(static_cast<int>(*_color_primaries)));
249 node->add_child("ColorTransferCharacteristic")->add_child_text(raw_convert<string>(static_cast<int>(*_color_trc)));
252 node->add_child("Colorspace")->add_child_text(raw_convert<string>(static_cast<int>(*_colorspace)));
254 if (_bits_per_pixel) {
255 node->add_child("BitsPerPixel")->add_child_text(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 (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 } else if (fabs (rot - 270) < 1.0) {
300 _filters.push_back (Filter::from_id ("90anticlock"));
305 if (!examiner->audio_streams().empty()) {
306 audio = make_shared<AudioContent>(this);
308 for (auto i: examiner->audio_streams()) {
309 audio->add_stream (i);
312 auto as = audio->streams().front();
313 auto m = as->mapping ();
314 m.make_default (film ? film->audio_processor() : 0, first_path);
318 _subtitle_streams = examiner->subtitle_streams ();
319 if (!_subtitle_streams.empty ()) {
321 text.push_back (make_shared<TextContent>(this, TextType::OPEN_SUBTITLE, TextType::UNKNOWN));
322 _subtitle_stream = _subtitle_streams.front ();
326 if (examiner->has_video ()) {
327 set_default_colour_conversion ();
330 if (examiner->has_video() && examiner->pulldown() && video_frame_rate() && fabs(*video_frame_rate() - 29.97) < 0.001) {
331 /* FFmpeg has detected this file as 29.97 and the examiner thinks it is using "soft" 2:3 pulldown (telecine).
332 * This means we can treat it as a 23.976fps file.
334 set_video_frame_rate (24000.0 / 1001);
335 video->set_length (video->length() * 24.0 / 30);
341 FFmpegContent::summary () const
343 if (video && audio) {
344 return String::compose (_("%1 [movie]"), path_summary());
346 return String::compose (_("%1 [video]"), path_summary());
348 return String::compose (_("%1 [audio]"), path_summary());
351 return path_summary ();
356 FFmpegContent::technical_summary () const
359 for (auto i: ffmpeg_audio_streams ()) {
360 as += i->technical_summary () + " " ;
368 if (_subtitle_stream) {
369 ss = _subtitle_stream->technical_summary ();
372 auto filt = Filter::ffmpeg_string (_filters);
374 auto s = Content::technical_summary ();
377 s += " - " + video->technical_summary ();
381 s += " - " + audio->technical_summary ();
384 return s + String::compose (
385 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
391 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
393 ContentChangeSignaller cc (this, FFmpegContentProperty::SUBTITLE_STREAM);
396 boost::mutex::scoped_lock lm (_mutex);
397 _subtitle_stream = s;
403 operator== (FFmpegStream const & a, FFmpegStream const & b)
405 return a._id == b._id;
410 operator!= (FFmpegStream const & a, FFmpegStream const & b)
412 return a._id != b._id;
417 FFmpegContent::full_length (shared_ptr<const Film> film) const
419 FrameRateChange const frc (film, shared_from_this());
421 return DCPTime::from_frames (llrint (video->length_after_3d_combine() * frc.factor()), film->video_frame_rate());
426 for (auto i: audio->streams()) {
427 longest = max (longest, DCPTime::from_frames(llrint(i->length() / frc.speed_up), i->frame_rate()));
432 /* XXX: subtitle content? */
439 FFmpegContent::approximate_length () const
442 return DCPTime::from_frames (video->length_after_3d_combine(), 24);
445 DCPOMATIC_ASSERT (audio);
448 for (auto i: audio->streams()) {
449 longest = max (longest, Frame(llrint(i->length())));
452 return DCPTime::from_frames (longest, 24);
457 FFmpegContent::set_filters (vector<Filter const *> const & filters)
459 ContentChangeSignaller cc (this, FFmpegContentProperty::FILTERS);
462 boost::mutex::scoped_lock lm (_mutex);
469 FFmpegContent::identifier () const
471 string s = Content::identifier();
474 s += "_" + video->identifier();
477 if (only_text() && only_text()->use() && only_text()->burn()) {
478 s += "_" + only_text()->identifier();
481 boost::mutex::scoped_lock lm (_mutex);
483 if (_subtitle_stream) {
484 s += "_" + _subtitle_stream->identifier ();
487 for (auto i: _filters) {
496 FFmpegContent::set_default_colour_conversion ()
498 DCPOMATIC_ASSERT (video);
500 auto const s = video->size ();
502 boost::mutex::scoped_lock lm (_mutex);
504 switch (_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)) {
506 video->set_colour_conversion (PresetColourConversion::from_id ("srgb").conversion);
508 case AVCOL_SPC_BT709:
509 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
511 case AVCOL_SPC_BT470BG:
512 case AVCOL_SPC_SMPTE170M:
513 case AVCOL_SPC_SMPTE240M:
514 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
516 case AVCOL_SPC_BT2020_CL:
517 case AVCOL_SPC_BT2020_NCL:
518 video->set_colour_conversion (PresetColourConversion::from_id ("rec2020").conversion);
521 if (s.width < 1080) {
522 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
524 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
532 FFmpegContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
534 Content::add_properties (film, p);
537 video->add_properties (p);
539 if (_bits_per_pixel) {
540 /* Assuming there's three components, so bits per pixel component is _bits_per_pixel / 3 */
541 int const lim_start = pow(2, _bits_per_pixel.get() / 3 - 4);
542 int const lim_end = 235 * pow(2, _bits_per_pixel.get() / 3 - 8);
543 int const total = pow(2, _bits_per_pixel.get() / 3);
545 switch (_color_range.get_value_or(AVCOL_RANGE_UNSPECIFIED)) {
546 case AVCOL_RANGE_UNSPECIFIED:
547 /// TRANSLATORS: this means that the range of pixel values used in this
548 /// file is unknown (not specified in the file).
549 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
551 case AVCOL_RANGE_MPEG:
552 /// TRANSLATORS: this means that the range of pixel values used in this
553 /// file is limited, so that not all possible values are valid.
556 UserProperty::VIDEO, _("Colour range"), String::compose(_("Limited (%1-%2)"), lim_start, lim_end)
560 case AVCOL_RANGE_JPEG:
561 /// TRANSLATORS: this means that the range of pixel values used in this
562 /// file is full, so that all possible pixel values are valid.
563 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), String::compose (_("Full (0-%1)"), total)));
566 DCPOMATIC_ASSERT (false);
569 switch (_color_range.get_value_or(AVCOL_RANGE_UNSPECIFIED)) {
570 case AVCOL_RANGE_UNSPECIFIED:
571 /// TRANSLATORS: this means that the range of pixel values used in this
572 /// file is unknown (not specified in the file).
573 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
575 case AVCOL_RANGE_MPEG:
576 /// TRANSLATORS: this means that the range of pixel values used in this
577 /// file is limited, so that not all possible values are valid.
578 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Limited")));
580 case AVCOL_RANGE_JPEG:
581 /// TRANSLATORS: this means that the range of pixel values used in this
582 /// file is full, so that all possible pixel values are valid.
583 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Full")));
586 DCPOMATIC_ASSERT (false);
590 char const * primaries[] = {
597 _("SMPTE 170M (BT601)"),
601 _("SMPTE ST 428-1 (CIE 1931 XYZ)"),
602 _("SMPTE ST 431-2 (2011)"),
603 _("SMPTE ST 432-1 D65 (2010)"), // 12
616 DCPOMATIC_ASSERT (AVCOL_PRI_NB <= 23);
617 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour primaries"), primaries[_color_primaries.get_value_or(AVCOL_PRI_UNSPECIFIED)]));
619 char const * transfers[] = {
624 _("Gamma 22 (BT470M)"),
625 _("Gamma 28 (BT470BG)"),
626 _("SMPTE 170M (BT601)"),
629 _("Logarithmic (100:1 range)"),
630 _("Logarithmic (316:1 range)"),
632 _("BT1361 extended colour gamut"),
633 _("IEC61966-2-1 (sRGB or sYCC)"),
634 _("BT2020 for a 10-bit system"),
635 _("BT2020 for a 12-bit system"),
636 _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
638 _("ARIB STD-B67 ('Hybrid log-gamma')")
641 DCPOMATIC_ASSERT (AVCOL_TRC_NB <= 19);
642 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour transfer characteristic"), transfers[_color_trc.get_value_or(AVCOL_TRC_UNSPECIFIED)]));
644 char const * spaces[] = {
645 _("RGB / sRGB (IEC61966-2-1)"),
650 _("BT470BG (BT601-6)"),
651 _("SMPTE 170M (BT601-6)"),
654 _("BT2020 non-constant luminance"),
655 _("BT2020 constant luminance"),
656 _("SMPTE 2085, Y'D'zD'x"),
657 _("Chroma-derived non-constant luminance"),
658 _("Chroma-derived constant luminance"),
662 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 15);
663 p.push_back (UserProperty (UserProperty::VIDEO, _("Colourspace"), spaces[_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)]));
665 if (_bits_per_pixel) {
666 p.push_back (UserProperty (UserProperty::VIDEO, _("Bits per pixel"), *_bits_per_pixel));
671 audio->add_properties (film, p);
676 /** Our subtitle streams have colour maps, which can be changed, but
677 * they have no way of signalling that change. As a hack, we have this
678 * method which callers can use when they've modified one of our subtitle
682 FFmpegContent::signal_subtitle_stream_changed ()
684 /* XXX: this is too late; really it should be before the change */
685 ContentChangeSignaller cc (this, FFmpegContentProperty::SUBTITLE_STREAM);
689 vector<shared_ptr<FFmpegAudioStream>>
690 FFmpegContent::ffmpeg_audio_streams () const
692 vector<shared_ptr<FFmpegAudioStream>> fa;
695 for (auto i: audio->streams()) {
696 fa.push_back (dynamic_pointer_cast<FFmpegAudioStream>(i));
705 FFmpegContent::take_settings_from (shared_ptr<const Content> c)
707 auto fc = dynamic_pointer_cast<const FFmpegContent> (c);
712 Content::take_settings_from (c);
713 _filters = fc->_filters;