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>
44 #include <boost/foreach.hpp>
56 using boost::shared_ptr;
57 using boost::dynamic_pointer_cast;
58 using boost::optional;
59 using dcp::raw_convert;
60 using namespace dcpomatic;
62 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
63 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
64 int const FFmpegContentProperty::FILTERS = 102;
65 int const FFmpegContentProperty::KDM = 103;
67 FFmpegContent::FFmpegContent (boost::filesystem::path p)
75 get_optional_enum (cxml::ConstNodePtr node, string name)
77 optional<int> const v = node->optional_number_child<int>(name);
81 return static_cast<T>(*v);
84 FFmpegContent::FFmpegContent (cxml::ConstNodePtr node, int version, list<string>& notes)
87 video = VideoContent::from_xml (this, node, version);
88 audio = AudioContent::from_xml (this, node, version);
89 text = TextContent::from_xml (this, node, version);
91 list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
92 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
93 _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i, version)));
94 if ((*i)->optional_number_child<int> ("Selected")) {
95 _subtitle_stream = _subtitle_streams.back ();
99 c = node->node_children ("AudioStream");
100 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
101 shared_ptr<FFmpegAudioStream> as (new FFmpegAudioStream (*i, version));
102 audio->add_stream (as);
103 if (version < 11 && !(*i)->optional_node_child ("Selected")) {
104 /* This is an old file and this stream is not selected, so un-map it */
105 as->set_mapping (AudioMapping (as->channels (), MAX_DCP_AUDIO_CHANNELS));
109 c = node->node_children ("Filter");
110 for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
111 Filter const * f = Filter::from_id ((*i)->content ());
113 _filters.push_back (f);
115 notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), (*i)->content()));
119 optional<ContentTime::Type> const f = node->optional_number_child<ContentTime::Type> ("FirstVideo");
121 _first_video = ContentTime (f.get ());
124 _color_range = get_optional_enum<AVColorRange>(node, "ColorRange");
125 _color_primaries = get_optional_enum<AVColorPrimaries>(node, "ColorPrimaries");
126 _color_trc = get_optional_enum<AVColorTransferCharacteristic>(node, "ColorTransferCharacteristic");
127 _colorspace = get_optional_enum<AVColorSpace>(node, "Colorspace");
128 _bits_per_pixel = node->optional_number_child<int> ("BitsPerPixel");
131 FFmpegContent::FFmpegContent (vector<shared_ptr<Content> > c)
134 vector<shared_ptr<Content> >::const_iterator i = c.begin ();
136 bool need_video = false;
137 bool need_audio = false;
138 bool need_text = false;
141 need_video = static_cast<bool> ((*i)->video);
142 need_audio = static_cast<bool> ((*i)->audio);
143 need_text = !(*i)->text.empty();
146 while (i != c.end ()) {
147 if (need_video != static_cast<bool> ((*i)->video)) {
148 throw JoinError (_("Content to be joined must all have or not have video"));
150 if (need_audio != static_cast<bool> ((*i)->audio)) {
151 throw JoinError (_("Content to be joined must all have or not have audio"));
153 if (need_text != !(*i)->text.empty()) {
154 throw JoinError (_("Content to be joined must all have or not have subtitles or captions"));
160 video.reset (new VideoContent (this, c));
163 audio.reset (new AudioContent (this, c));
166 text.push_back (shared_ptr<TextContent> (new TextContent (this, c)));
169 shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
170 DCPOMATIC_ASSERT (ref);
172 for (size_t i = 0; i < c.size(); ++i) {
173 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
174 if (fc->only_text() && fc->only_text()->use() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
175 throw JoinError (_("Content to be joined must use the same subtitle stream."));
179 /* XXX: should probably check that more of the stuff below is the same in *this and ref */
181 _subtitle_streams = ref->subtitle_streams ();
182 _subtitle_stream = ref->subtitle_stream ();
183 _first_video = ref->_first_video;
184 _filters = ref->_filters;
185 _color_range = ref->_color_range;
186 _color_primaries = ref->_color_primaries;
187 _color_trc = ref->_color_trc;
188 _colorspace = ref->_colorspace;
189 _bits_per_pixel = ref->_bits_per_pixel;
193 FFmpegContent::as_xml (xmlpp::Node* node, bool with_paths) const
195 node->add_child("Type")->add_child_text ("FFmpeg");
196 Content::as_xml (node, with_paths);
199 video->as_xml (node);
203 audio->as_xml (node);
205 BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
206 shared_ptr<FFmpegAudioStream> f = dynamic_pointer_cast<FFmpegAudioStream> (i);
207 DCPOMATIC_ASSERT (f);
208 f->as_xml (node->add_child("AudioStream"));
213 only_text()->as_xml (node);
216 boost::mutex::scoped_lock lm (_mutex);
218 for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
219 xmlpp::Node* t = node->add_child("SubtitleStream");
220 if (_subtitle_stream && *i == _subtitle_stream) {
221 t->add_child("Selected")->add_child_text("1");
226 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
227 node->add_child("Filter")->add_child_text ((*i)->id ());
231 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
235 node->add_child("ColorRange")->add_child_text (raw_convert<string> (static_cast<int> (*_color_range)));
237 if (_color_primaries) {
238 node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (static_cast<int> (*_color_primaries)));
241 node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (static_cast<int> (*_color_trc)));
244 node->add_child("Colorspace")->add_child_text (raw_convert<string> (static_cast<int> (*_colorspace)));
246 if (_bits_per_pixel) {
247 node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (*_bits_per_pixel));
252 FFmpegContent::examine (shared_ptr<const Film> film, shared_ptr<Job> job)
254 ChangeSignaller<Content> cc1 (this, FFmpegContentProperty::SUBTITLE_STREAMS);
255 ChangeSignaller<Content> cc2 (this, FFmpegContentProperty::SUBTITLE_STREAM);
258 job->set_progress_unknown ();
261 Content::examine (film, job);
263 shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
265 if (examiner->has_video ()) {
266 video.reset (new VideoContent (this));
267 video->take_from_examiner (examiner);
270 boost::filesystem::path first_path = path (0);
273 boost::mutex::scoped_lock lm (_mutex);
275 if (examiner->has_video ()) {
276 _first_video = examiner->first_video ();
277 _color_range = examiner->color_range ();
278 _color_primaries = examiner->color_primaries ();
279 _color_trc = examiner->color_trc ();
280 _colorspace = examiner->colorspace ();
281 _bits_per_pixel = examiner->bits_per_pixel ();
283 if (examiner->rotation()) {
284 double rot = *examiner->rotation ();
285 if (fabs (rot - 180) < 1.0) {
286 _filters.push_back (Filter::from_id ("vflip"));
287 _filters.push_back (Filter::from_id ("hflip"));
288 } else if (fabs (rot - 90) < 1.0) {
289 _filters.push_back (Filter::from_id ("90clock"));
290 } else if (fabs (rot - 270) < 1.0) {
291 _filters.push_back (Filter::from_id ("90anticlock"));
296 if (!examiner->audio_streams().empty ()) {
297 audio.reset (new AudioContent (this));
299 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, examiner->audio_streams ()) {
300 audio->add_stream (i);
303 AudioStreamPtr as = audio->streams().front();
304 AudioMapping m = as->mapping ();
305 m.make_default (film ? film->audio_processor() : 0, first_path);
309 _subtitle_streams = examiner->subtitle_streams ();
310 if (!_subtitle_streams.empty ()) {
312 text.push_back (shared_ptr<TextContent> (new TextContent (this, TEXT_OPEN_SUBTITLE, TEXT_UNKNOWN)));
313 _subtitle_stream = _subtitle_streams.front ();
317 if (examiner->has_video ()) {
318 set_default_colour_conversion ();
321 if (examiner->has_video() && examiner->pulldown() && video_frame_rate() && fabs(*video_frame_rate() - 29.97) < 0.001) {
322 /* FFmpeg has detected this file as 29.97 and the examiner thinks it is using "soft" 2:3 pulldown (telecine).
323 * This means we can treat it as a 23.976fps file.
325 set_video_frame_rate (24000.0 / 1001);
326 video->set_length (video->length() * 24.0 / 30);
331 FFmpegContent::summary () const
333 if (video && audio) {
334 return String::compose (_("%1 [movie]"), path_summary ());
336 return String::compose (_("%1 [video]"), path_summary ());
338 return String::compose (_("%1 [audio]"), path_summary ());
341 return path_summary ();
345 FFmpegContent::technical_summary () const
348 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
349 as += i->technical_summary () + " " ;
357 if (_subtitle_stream) {
358 ss = _subtitle_stream->technical_summary ();
361 string filt = Filter::ffmpeg_string (_filters);
363 string s = Content::technical_summary ();
366 s += " - " + video->technical_summary ();
370 s += " - " + audio->technical_summary ();
373 return s + String::compose (
374 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
379 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
381 ChangeSignaller<Content> cc (this, FFmpegContentProperty::SUBTITLE_STREAM);
384 boost::mutex::scoped_lock lm (_mutex);
385 _subtitle_stream = s;
390 operator== (FFmpegStream const & a, FFmpegStream const & b)
392 return a._id == b._id;
396 operator!= (FFmpegStream const & a, FFmpegStream const & b)
398 return a._id != b._id;
402 FFmpegContent::full_length (shared_ptr<const Film> film) const
404 FrameRateChange const frc (film, shared_from_this());
406 return DCPTime::from_frames (llrint (video->length_after_3d_combine() * frc.factor()), film->video_frame_rate());
411 BOOST_FOREACH (AudioStreamPtr i, audio->streams()) {
412 longest = max (longest, DCPTime::from_frames(llrint(i->length() / frc.speed_up), i->frame_rate()));
417 /* XXX: subtitle content? */
423 FFmpegContent::approximate_length () const
426 return DCPTime::from_frames (video->length_after_3d_combine(), 24);
429 DCPOMATIC_ASSERT (audio);
432 BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
433 longest = max (longest, Frame(llrint(i->length())));
436 return DCPTime::from_frames (longest, 24);
440 FFmpegContent::set_filters (vector<Filter const *> const & filters)
442 ChangeSignaller<Content> cc (this, FFmpegContentProperty::FILTERS);
445 boost::mutex::scoped_lock lm (_mutex);
451 FFmpegContent::identifier () const
453 string s = Content::identifier();
456 s += "_" + video->identifier();
459 if (only_text() && only_text()->use() && only_text()->burn()) {
460 s += "_" + only_text()->identifier();
463 boost::mutex::scoped_lock lm (_mutex);
465 if (_subtitle_stream) {
466 s += "_" + _subtitle_stream->identifier ();
469 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
470 s += "_" + (*i)->id ();
477 FFmpegContent::set_default_colour_conversion ()
479 DCPOMATIC_ASSERT (video);
481 dcp::Size const s = video->size ();
483 boost::mutex::scoped_lock lm (_mutex);
485 switch (_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)) {
487 video->set_colour_conversion (PresetColourConversion::from_id ("srgb").conversion);
489 case AVCOL_SPC_BT709:
490 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
492 case AVCOL_SPC_BT470BG:
493 case AVCOL_SPC_SMPTE170M:
494 case AVCOL_SPC_SMPTE240M:
495 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
497 case AVCOL_SPC_BT2020_CL:
498 case AVCOL_SPC_BT2020_NCL:
499 video->set_colour_conversion (PresetColourConversion::from_id ("rec2020").conversion);
502 if (s.width < 1080) {
503 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
505 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
512 FFmpegContent::add_properties (shared_ptr<const Film> film, list<UserProperty>& p) const
514 Content::add_properties (film, p);
517 video->add_properties (p);
519 if (_bits_per_pixel) {
520 /* Assuming there's three components, so bits per pixel component is _bits_per_pixel / 3 */
521 int const lim_start = pow(2, _bits_per_pixel.get() / 3 - 4);
522 int const lim_end = 235 * pow(2, _bits_per_pixel.get() / 3 - 8);
523 int const total = pow(2, _bits_per_pixel.get() / 3);
525 switch (_color_range.get_value_or(AVCOL_RANGE_UNSPECIFIED)) {
526 case AVCOL_RANGE_UNSPECIFIED:
527 /// TRANSLATORS: this means that the range of pixel values used in this
528 /// file is unknown (not specified in the file).
529 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
531 case AVCOL_RANGE_MPEG:
532 /// TRANSLATORS: this means that the range of pixel values used in this
533 /// file is limited, so that not all possible values are valid.
536 UserProperty::VIDEO, _("Colour range"), String::compose(_("Limited (%1-%2)"), lim_start, lim_end)
540 case AVCOL_RANGE_JPEG:
541 /// TRANSLATORS: this means that the range of pixel values used in this
542 /// file is full, so that all possible pixel values are valid.
543 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), String::compose (_("Full (0-%1)"), total)));
546 DCPOMATIC_ASSERT (false);
549 switch (_color_range.get_value_or(AVCOL_RANGE_UNSPECIFIED)) {
550 case AVCOL_RANGE_UNSPECIFIED:
551 /// TRANSLATORS: this means that the range of pixel values used in this
552 /// file is unknown (not specified in the file).
553 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
555 case AVCOL_RANGE_MPEG:
556 /// TRANSLATORS: this means that the range of pixel values used in this
557 /// file is limited, so that not all possible values are valid.
558 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Limited")));
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"), _("Full")));
566 DCPOMATIC_ASSERT (false);
570 char const * primaries[] = {
577 _("SMPTE 170M (BT601)"),
581 _("SMPTE ST 428-1 (CIE 1931 XYZ)"),
582 _("SMPTE ST 431-2 (2011)"),
583 _("SMPTE ST 432-1 D65 (2010)"), // 12
596 DCPOMATIC_ASSERT (AVCOL_PRI_NB <= 23);
597 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour primaries"), primaries[_color_primaries.get_value_or(AVCOL_PRI_UNSPECIFIED)]));
599 char const * transfers[] = {
604 _("Gamma 22 (BT470M)"),
605 _("Gamma 28 (BT470BG)"),
606 _("SMPTE 170M (BT601)"),
609 _("Logarithmic (100:1 range)"),
610 _("Logarithmic (316:1 range)"),
612 _("BT1361 extended colour gamut"),
613 _("IEC61966-2-1 (sRGB or sYCC)"),
614 _("BT2020 for a 10-bit system"),
615 _("BT2020 for a 12-bit system"),
616 _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
618 _("ARIB STD-B67 ('Hybrid log-gamma')")
621 DCPOMATIC_ASSERT (AVCOL_TRC_NB <= 19);
622 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour transfer characteristic"), transfers[_color_trc.get_value_or(AVCOL_TRC_UNSPECIFIED)]));
624 char const * spaces[] = {
625 _("RGB / sRGB (IEC61966-2-1)"),
630 _("BT470BG (BT601-6)"),
631 _("SMPTE 170M (BT601-6)"),
634 _("BT2020 non-constant luminance"),
635 _("BT2020 constant luminance"),
636 _("SMPTE 2085, Y'D'zD'x"),
637 _("Chroma-derived non-constant luminance"),
638 _("Chroma-derived constant luminance"),
642 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 15);
643 p.push_back (UserProperty (UserProperty::VIDEO, _("Colourspace"), spaces[_colorspace.get_value_or(AVCOL_SPC_UNSPECIFIED)]));
645 if (_bits_per_pixel) {
646 p.push_back (UserProperty (UserProperty::VIDEO, _("Bits per pixel"), *_bits_per_pixel));
651 audio->add_properties (film, p);
655 /** Our subtitle streams have colour maps, which can be changed, but
656 * they have no way of signalling that change. As a hack, we have this
657 * method which callers can use when they've modified one of our subtitle
661 FFmpegContent::signal_subtitle_stream_changed ()
663 /* XXX: this is too late; really it should be before the change */
664 ChangeSignaller<Content> cc (this, FFmpegContentProperty::SUBTITLE_STREAM);
667 vector<shared_ptr<FFmpegAudioStream> >
668 FFmpegContent::ffmpeg_audio_streams () const
670 vector<shared_ptr<FFmpegAudioStream> > fa;
673 BOOST_FOREACH (AudioStreamPtr i, audio->streams()) {
674 fa.push_back (dynamic_pointer_cast<FFmpegAudioStream> (i));
682 FFmpegContent::take_settings_from (shared_ptr<const Content> c)
684 shared_ptr<const FFmpegContent> fc = dynamic_pointer_cast<const FFmpegContent> (c);
689 Content::take_settings_from (c);
690 _filters = fc->_filters;