2 Copyright (C) 2013-2016 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"
33 #include "exceptions.h"
34 #include "frame_rate_change.h"
35 #include "subtitle_content.h"
36 #include <dcp/raw_convert.h>
37 #include <libcxml/cxml.h>
39 #include <libavformat/avformat.h>
40 #include <libavutil/pixdesc.h>
42 #include <libxml++/libxml++.h>
43 #include <boost/foreach.hpp>
48 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
57 using boost::shared_ptr;
58 using boost::dynamic_pointer_cast;
59 using boost::optional;
60 using dcp::raw_convert;
62 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
63 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
64 int const FFmpegContentProperty::FILTERS = 102;
66 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, boost::filesystem::path p)
72 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
73 : Content (film, node)
75 video = VideoContent::from_xml (this, node, version);
76 audio = AudioContent::from_xml (this, node, version);
77 subtitle = SubtitleContent::from_xml (this, node, version);
79 list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
80 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
81 _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i, version)));
82 if ((*i)->optional_number_child<int> ("Selected")) {
83 _subtitle_stream = _subtitle_streams.back ();
87 c = node->node_children ("AudioStream");
88 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
89 shared_ptr<FFmpegAudioStream> as (new FFmpegAudioStream (*i, version));
90 audio->add_stream (as);
91 if (version < 11 && !(*i)->optional_node_child ("Selected")) {
92 /* This is an old file and this stream is not selected, so un-map it */
93 as->set_mapping (AudioMapping (as->channels (), MAX_DCP_AUDIO_CHANNELS));
97 c = node->node_children ("Filter");
98 for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
99 Filter const * f = Filter::from_id ((*i)->content ());
101 _filters.push_back (f);
103 notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), (*i)->content()));
107 optional<ContentTime::Type> const f = node->optional_number_child<ContentTime::Type> ("FirstVideo");
109 _first_video = ContentTime (f.get ());
112 _color_range = static_cast<AVColorRange> (node->optional_number_child<int>("ColorRange").get_value_or (AVCOL_RANGE_UNSPECIFIED));
113 _color_primaries = static_cast<AVColorPrimaries> (node->optional_number_child<int>("ColorPrimaries").get_value_or (AVCOL_PRI_UNSPECIFIED));
114 _color_trc = static_cast<AVColorTransferCharacteristic> (
115 node->optional_number_child<int>("ColorTransferCharacteristic").get_value_or (AVCOL_TRC_UNSPECIFIED)
117 _colorspace = static_cast<AVColorSpace> (node->optional_number_child<int>("Colorspace").get_value_or (AVCOL_SPC_UNSPECIFIED));
118 _bits_per_pixel = node->optional_number_child<int> ("BitsPerPixel");
122 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, vector<shared_ptr<Content> > c)
125 vector<shared_ptr<Content> >::const_iterator i = c.begin ();
127 bool need_video = false;
128 bool need_audio = false;
129 bool need_subtitle = false;
132 need_video = static_cast<bool> ((*i)->video);
133 need_audio = static_cast<bool> ((*i)->audio);
134 need_subtitle = static_cast<bool> ((*i)->subtitle);
137 while (i != c.end ()) {
138 if (need_video != static_cast<bool> ((*i)->video)) {
139 throw JoinError (_("Content to be joined must all have or not have video"));
141 if (need_audio != static_cast<bool> ((*i)->audio)) {
142 throw JoinError (_("Content to be joined must all have or not have audio"));
144 if (need_subtitle != static_cast<bool> ((*i)->subtitle)) {
145 throw JoinError (_("Content to be joined must all have or not have subtitles"));
151 video.reset (new VideoContent (this, c));
154 audio.reset (new AudioContent (this, c));
157 subtitle.reset (new SubtitleContent (this, c));
160 shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
161 DCPOMATIC_ASSERT (ref);
163 for (size_t i = 0; i < c.size(); ++i) {
164 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
165 if (fc->subtitle && fc->subtitle->use() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
166 throw JoinError (_("Content to be joined must use the same subtitle stream."));
170 /* XXX: should probably check that more of the stuff below is the same in *this and ref */
172 _subtitle_streams = ref->subtitle_streams ();
173 _subtitle_stream = ref->subtitle_stream ();
174 _first_video = ref->_first_video;
175 _filters = ref->_filters;
176 _color_range = ref->_color_range;
177 _color_primaries = ref->_color_primaries;
178 _color_trc = ref->_color_trc;
179 _colorspace = ref->_colorspace;
180 _bits_per_pixel = ref->_bits_per_pixel;
184 FFmpegContent::as_xml (xmlpp::Node* node, bool with_paths) const
186 node->add_child("Type")->add_child_text ("FFmpeg");
187 Content::as_xml (node, with_paths);
190 video->as_xml (node);
194 audio->as_xml (node);
196 BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
197 shared_ptr<FFmpegAudioStream> f = dynamic_pointer_cast<FFmpegAudioStream> (i);
198 DCPOMATIC_ASSERT (f);
199 f->as_xml (node->add_child("AudioStream"));
204 subtitle->as_xml (node);
207 boost::mutex::scoped_lock lm (_mutex);
209 for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
210 xmlpp::Node* t = node->add_child("SubtitleStream");
211 if (_subtitle_stream && *i == _subtitle_stream) {
212 t->add_child("Selected")->add_child_text("1");
217 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
218 node->add_child("Filter")->add_child_text ((*i)->id ());
222 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
225 node->add_child("ColorRange")->add_child_text (raw_convert<string> (static_cast<int> (_color_range)));
226 node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (static_cast<int> (_color_primaries)));
227 node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (static_cast<int> (_color_trc)));
228 node->add_child("Colorspace")->add_child_text (raw_convert<string> (static_cast<int> (_colorspace)));
229 if (_bits_per_pixel) {
230 node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (_bits_per_pixel.get ()));
235 FFmpegContent::examine (shared_ptr<Job> job)
237 job->set_progress_unknown ();
239 Content::examine (job);
241 shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
243 if (examiner->has_video ()) {
244 video.reset (new VideoContent (this));
245 video->take_from_examiner (examiner);
246 set_default_colour_conversion ();
249 boost::filesystem::path first_path = path (0);
252 boost::mutex::scoped_lock lm (_mutex);
254 if (examiner->has_video ()) {
255 _first_video = examiner->first_video ();
256 _color_range = examiner->color_range ();
257 _color_primaries = examiner->color_primaries ();
258 _color_trc = examiner->color_trc ();
259 _colorspace = examiner->colorspace ();
260 _bits_per_pixel = examiner->bits_per_pixel ();
263 if (!examiner->audio_streams().empty ()) {
264 audio.reset (new AudioContent (this));
266 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, examiner->audio_streams ()) {
267 audio->add_stream (i);
270 AudioStreamPtr as = audio->streams().front();
271 AudioMapping m = as->mapping ();
272 film()->make_audio_mapping_default (m, first_path);
276 _subtitle_streams = examiner->subtitle_streams ();
277 if (!_subtitle_streams.empty ()) {
278 subtitle.reset (new SubtitleContent (this));
279 _subtitle_stream = _subtitle_streams.front ();
284 signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
285 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
289 FFmpegContent::summary () const
291 if (video && audio) {
292 return String::compose (_("%1 [movie]"), path_summary ());
294 return String::compose (_("%1 [video]"), path_summary ());
296 return String::compose (_("%1 [audio]"), path_summary ());
299 return path_summary ();
303 FFmpegContent::technical_summary () const
306 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
307 as += i->technical_summary () + " " ;
315 if (_subtitle_stream) {
316 ss = _subtitle_stream->technical_summary ();
319 string filt = Filter::ffmpeg_string (_filters);
321 string s = Content::technical_summary ();
324 s += " - " + video->technical_summary ();
328 s += " - " + audio->technical_summary ();
331 return s + String::compose (
332 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
337 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
340 boost::mutex::scoped_lock lm (_mutex);
341 _subtitle_stream = s;
344 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
348 operator== (FFmpegStream const & a, FFmpegStream const & b)
350 return a._id == b._id;
354 operator!= (FFmpegStream const & a, FFmpegStream const & b)
356 return a._id != b._id;
360 FFmpegContent::full_length () const
362 FrameRateChange const frc (active_video_frame_rate (), film()->video_frame_rate ());
364 return DCPTime::from_frames (llrint (video->length_after_3d_combine() * frc.factor()), film()->video_frame_rate());
367 DCPOMATIC_ASSERT (audio);
370 BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
371 longest = max (longest, DCPTime::from_frames (llrint (i->length() / frc.speed_up), i->frame_rate()));
378 FFmpegContent::set_filters (vector<Filter const *> const & filters)
381 boost::mutex::scoped_lock lm (_mutex);
385 signal_changed (FFmpegContentProperty::FILTERS);
389 FFmpegContent::identifier () const
391 string s = Content::identifier();
394 s += "_" + video->identifier();
398 s += "_" + subtitle->identifier();
401 boost::mutex::scoped_lock lm (_mutex);
403 if (_subtitle_stream) {
404 s += "_" + _subtitle_stream->identifier ();
407 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
408 s += "_" + (*i)->id ();
414 list<ContentTimePeriod>
415 FFmpegContent::image_subtitles_during (ContentTimePeriod period, bool starting) const
417 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
419 return list<ContentTimePeriod> ();
422 return stream->image_subtitles_during (period, starting);
425 list<ContentTimePeriod>
426 FFmpegContent::text_subtitles_during (ContentTimePeriod period, bool starting) const
428 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
430 return list<ContentTimePeriod> ();
433 return stream->text_subtitles_during (period, starting);
437 FFmpegContent::set_default_colour_conversion ()
439 DCPOMATIC_ASSERT (video);
441 dcp::Size const s = video->size ();
443 boost::mutex::scoped_lock lm (_mutex);
445 if (s.width < 1080) {
446 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
448 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
453 FFmpegContent::add_properties (list<UserProperty>& p) const
455 Content::add_properties (p);
458 video->add_properties (p);
460 if (_bits_per_pixel) {
461 int const sub = 219 * pow (2, _bits_per_pixel.get() - 8);
462 int const total = pow (2, _bits_per_pixel.get());
464 switch (_color_range) {
465 case AVCOL_RANGE_UNSPECIFIED:
466 /// TRANSLATORS: this means that the range of pixel values used in this
467 /// file is unknown (not specified in the file).
468 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
470 case AVCOL_RANGE_MPEG:
471 /// TRANSLATORS: this means that the range of pixel values used in this
472 /// file is limited, so that not all possible values are valid.
475 UserProperty::VIDEO, _("Colour range"), String::compose (_("Limited (%1-%2)"), (total - sub) / 2, (total + sub) / 2)
479 case AVCOL_RANGE_JPEG:
480 /// TRANSLATORS: this means that the range of pixel values used in this
481 /// file is full, so that all possible pixel values are valid.
482 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), String::compose (_("Full (0-%1)"), total)));
485 DCPOMATIC_ASSERT (false);
488 switch (_color_range) {
489 case AVCOL_RANGE_UNSPECIFIED:
490 /// TRANSLATORS: this means that the range of pixel values used in this
491 /// file is unknown (not specified in the file).
492 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
494 case AVCOL_RANGE_MPEG:
495 /// TRANSLATORS: this means that the range of pixel values used in this
496 /// file is limited, so that not all possible values are valid.
497 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Limited")));
499 case AVCOL_RANGE_JPEG:
500 /// TRANSLATORS: this means that the range of pixel values used in this
501 /// file is full, so that all possible pixel values are valid.
502 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Full")));
505 DCPOMATIC_ASSERT (false);
509 char const * primaries[] = {
516 _("SMPTE 170M (BT601)"),
520 _("SMPTE ST 428-1 (CIE 1931 XYZ)")
523 DCPOMATIC_ASSERT (AVCOL_PRI_NB <= 11);
524 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour primaries"), primaries[_color_primaries]));
526 char const * transfers[] = {
531 _("Gamma 22 (BT470M)"),
532 _("Gamma 28 (BT470BG)"),
533 _("SMPTE 170M (BT601)"),
536 _("Logarithmic (100:1 range)"),
537 _("Logarithmic (316:1 range)"),
539 _("BT1361 extended colour gamut"),
540 _("IEC61966-2-1 (sRGB or sYCC)"),
541 _("BT2020 for a 10-bit system"),
542 _("BT2020 for a 12-bit system"),
543 _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
545 _("ARIB STD-B67 ('Hybrid log-gamma')")
548 DCPOMATIC_ASSERT (AVCOL_TRC_NB <= 19);
549 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour transfer characteristic"), transfers[_color_trc]));
551 char const * spaces[] = {
552 _("RGB / sRGB (IEC61966-2-1)"),
557 _("BT470BG (BT601-6)"),
558 _("SMPTE 170M (BT601-6)"),
561 _("BT2020 non-constant luminance"),
562 _("BT2020 constant luminance"),
565 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 11);
566 p.push_back (UserProperty (UserProperty::VIDEO, _("Colourspace"), spaces[_colorspace]));
568 if (_bits_per_pixel) {
569 p.push_back (UserProperty (UserProperty::VIDEO, _("Bits per pixel"), _bits_per_pixel.get ()));
574 audio->add_properties (p);
578 /** Our subtitle streams have colour maps, which can be changed, but
579 * they have no way of signalling that change. As a hack, we have this
580 * method which callers can use when they've modified one of our subtitle
584 FFmpegContent::signal_subtitle_stream_changed ()
586 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
589 vector<shared_ptr<FFmpegAudioStream> >
590 FFmpegContent::ffmpeg_audio_streams () const
592 vector<shared_ptr<FFmpegAudioStream> > fa;
595 BOOST_FOREACH (AudioStreamPtr i, audio->streams()) {
596 fa.push_back (dynamic_pointer_cast<FFmpegAudioStream> (i));
604 FFmpegContent::use_template (shared_ptr<const Content> c)
606 Content::use_template (c);
608 shared_ptr<const FFmpegContent> fc = dynamic_pointer_cast<const FFmpegContent> (c);
609 _filters = fc->_filters;