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 "safe_stringstream.h"
36 #include "raw_convert.h"
37 #include "subtitle_content.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>
49 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
58 using boost::shared_ptr;
59 using boost::dynamic_pointer_cast;
60 using boost::optional;
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<boost::shared_ptr<Content> > c)
125 /* XXX: this should look at c to decide which of video/audio/subtitle
128 video.reset (new VideoContent (this, c));
129 audio.reset (new AudioContent (this, c));
130 subtitle.reset (new SubtitleContent (this, c));
132 shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
133 DCPOMATIC_ASSERT (ref);
135 for (size_t i = 0; i < c.size(); ++i) {
136 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
137 if (fc->subtitle->use() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
138 throw JoinError (_("Content to be joined must use the same subtitle stream."));
142 /* XXX: should probably check that more of the stuff below is the same in *this and ref */
144 _subtitle_streams = ref->subtitle_streams ();
145 _subtitle_stream = ref->subtitle_stream ();
146 _first_video = ref->_first_video;
147 _filters = ref->_filters;
148 _color_range = ref->_color_range;
149 _color_primaries = ref->_color_primaries;
150 _color_trc = ref->_color_trc;
151 _colorspace = ref->_colorspace;
152 _bits_per_pixel = ref->_bits_per_pixel;
156 FFmpegContent::as_xml (xmlpp::Node* node) const
158 node->add_child("Type")->add_child_text ("FFmpeg");
159 Content::as_xml (node);
162 video->as_xml (node);
166 audio->as_xml (node);
168 BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
169 shared_ptr<FFmpegAudioStream> f = dynamic_pointer_cast<FFmpegAudioStream> (i);
170 DCPOMATIC_ASSERT (f);
171 f->as_xml (node->add_child("AudioStream"));
176 subtitle->as_xml (node);
179 boost::mutex::scoped_lock lm (_mutex);
181 for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
182 xmlpp::Node* t = node->add_child("SubtitleStream");
183 if (_subtitle_stream && *i == _subtitle_stream) {
184 t->add_child("Selected")->add_child_text("1");
189 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
190 node->add_child("Filter")->add_child_text ((*i)->id ());
194 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
197 node->add_child("ColorRange")->add_child_text (raw_convert<string> (_color_range));
198 node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (_color_primaries));
199 node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (_color_trc));
200 node->add_child("Colorspace")->add_child_text (raw_convert<string> (_colorspace));
201 if (_bits_per_pixel) {
202 node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (_bits_per_pixel.get ()));
207 FFmpegContent::examine (shared_ptr<Job> job)
209 job->set_progress_unknown ();
211 Content::examine (job);
213 shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
215 if (examiner->has_video ()) {
216 video.reset (new VideoContent (this));
217 video->take_from_examiner (examiner);
218 set_default_colour_conversion ();
221 boost::filesystem::path first_path = path (0);
224 boost::mutex::scoped_lock lm (_mutex);
226 if (examiner->has_video ()) {
227 _first_video = examiner->first_video ();
228 _color_range = examiner->color_range ();
229 _color_primaries = examiner->color_primaries ();
230 _color_trc = examiner->color_trc ();
231 _colorspace = examiner->colorspace ();
232 _bits_per_pixel = examiner->bits_per_pixel ();
235 if (!examiner->audio_streams().empty ()) {
236 audio.reset (new AudioContent (this));
238 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, examiner->audio_streams ()) {
239 audio->add_stream (i);
242 AudioStreamPtr as = audio->streams().front();
243 AudioMapping m = as->mapping ();
244 film()->make_audio_mapping_default (m, first_path);
248 _subtitle_streams = examiner->subtitle_streams ();
249 if (!_subtitle_streams.empty ()) {
250 subtitle.reset (new SubtitleContent (this));
251 _subtitle_stream = _subtitle_streams.front ();
256 signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
257 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
261 FFmpegContent::summary () const
263 if (video && audio) {
264 return String::compose (_("%1 [movie]"), path_summary ());
266 return String::compose (_("%1 [video]"), path_summary ());
268 return String::compose (_("%1 [audio]"), path_summary ());
271 return path_summary ();
275 FFmpegContent::technical_summary () const
278 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
279 as += i->technical_summary () + " " ;
287 if (_subtitle_stream) {
288 ss = _subtitle_stream->technical_summary ();
291 string filt = Filter::ffmpeg_string (_filters);
293 string s = Content::technical_summary ();
296 s += " - " + video->technical_summary ();
300 s += " - " + audio->technical_summary ();
303 return s + String::compose (
304 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
309 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
312 boost::mutex::scoped_lock lm (_mutex);
313 _subtitle_stream = s;
316 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
320 operator== (FFmpegStream const & a, FFmpegStream const & b)
322 return a._id == b._id;
326 operator!= (FFmpegStream const & a, FFmpegStream const & b)
328 return a._id != b._id;
332 FFmpegContent::full_length () const
334 FrameRateChange const frc (active_video_frame_rate (), film()->video_frame_rate ());
336 return DCPTime::from_frames (llrint (video->length_after_3d_combine() * frc.factor()), film()->video_frame_rate());
339 DCPOMATIC_ASSERT (audio);
342 BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
343 longest = max (longest, DCPTime::from_frames (llrint (i->length() / frc.speed_up), i->frame_rate()));
350 FFmpegContent::set_filters (vector<Filter const *> const & filters)
353 boost::mutex::scoped_lock lm (_mutex);
357 signal_changed (FFmpegContentProperty::FILTERS);
361 FFmpegContent::identifier () const
365 s << Content::identifier();
368 s << "_" << video->identifier();
372 s << "_" << subtitle->identifier();
375 boost::mutex::scoped_lock lm (_mutex);
377 if (_subtitle_stream) {
378 s << "_" << _subtitle_stream->identifier ();
381 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
382 s << "_" << (*i)->id ();
388 list<ContentTimePeriod>
389 FFmpegContent::image_subtitles_during (ContentTimePeriod period, bool starting) const
391 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
393 return list<ContentTimePeriod> ();
396 return stream->image_subtitles_during (period, starting);
399 list<ContentTimePeriod>
400 FFmpegContent::text_subtitles_during (ContentTimePeriod period, bool starting) const
402 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
404 return list<ContentTimePeriod> ();
407 return stream->text_subtitles_during (period, starting);
411 FFmpegContent::set_default_colour_conversion ()
413 DCPOMATIC_ASSERT (video);
415 dcp::Size const s = video->size ();
417 boost::mutex::scoped_lock lm (_mutex);
419 if (s.width < 1080) {
420 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
422 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
427 FFmpegContent::add_properties (list<UserProperty>& p) const
429 Content::add_properties (p);
432 video->add_properties (p);
434 if (_bits_per_pixel) {
435 int const sub = 219 * pow (2, _bits_per_pixel.get() - 8);
436 int const total = pow (2, _bits_per_pixel.get());
438 switch (_color_range) {
439 case AVCOL_RANGE_UNSPECIFIED:
440 /// TRANSLATORS: this means that the range of pixel values used in this
441 /// file is unknown (not specified in the file).
442 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
444 case AVCOL_RANGE_MPEG:
445 /// TRANSLATORS: this means that the range of pixel values used in this
446 /// file is limited, so that not all possible values are valid.
449 UserProperty::VIDEO, _("Colour range"), String::compose (_("Limited (%1-%2)"), (total - sub) / 2, (total + sub) / 2)
453 case AVCOL_RANGE_JPEG:
454 /// TRANSLATORS: this means that the range of pixel values used in this
455 /// file is full, so that all possible pixel values are valid.
456 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), String::compose (_("Full (0-%1)"), total)));
459 DCPOMATIC_ASSERT (false);
462 switch (_color_range) {
463 case AVCOL_RANGE_UNSPECIFIED:
464 /// TRANSLATORS: this means that the range of pixel values used in this
465 /// file is unknown (not specified in the file).
466 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
468 case AVCOL_RANGE_MPEG:
469 /// TRANSLATORS: this means that the range of pixel values used in this
470 /// file is limited, so that not all possible values are valid.
471 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Limited")));
473 case AVCOL_RANGE_JPEG:
474 /// TRANSLATORS: this means that the range of pixel values used in this
475 /// file is full, so that all possible pixel values are valid.
476 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Full")));
479 DCPOMATIC_ASSERT (false);
483 char const * primaries[] = {
490 _("SMPTE 170M (BT601)"),
494 _("SMPTE ST 428-1 (CIE 1931 XYZ)")
497 DCPOMATIC_ASSERT (AVCOL_PRI_NB <= 11);
498 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour primaries"), primaries[_color_primaries]));
500 char const * transfers[] = {
505 _("Gamma 22 (BT470M)"),
506 _("Gamma 28 (BT470BG)"),
507 _("SMPTE 170M (BT601)"),
510 _("Logarithmic (100:1 range)"),
511 _("Logarithmic (316:1 range)"),
513 _("BT1361 extended colour gamut"),
514 _("IEC61966-2-1 (sRGB or sYCC)"),
515 _("BT2020 for a 10-bit system"),
516 _("BT2020 for a 12-bit system"),
517 _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
521 DCPOMATIC_ASSERT (AVCOL_TRC_NB <= 18);
522 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour transfer characteristic"), transfers[_color_trc]));
524 char const * spaces[] = {
525 _("RGB / sRGB (IEC61966-2-1)"),
530 _("BT470BG (BT601-6)"),
531 _("SMPTE 170M (BT601-6)"),
534 _("BT2020 non-constant luminance"),
535 _("BT2020 constant luminance"),
538 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 11);
539 p.push_back (UserProperty (UserProperty::VIDEO, _("Colourspace"), spaces[_colorspace]));
541 if (_bits_per_pixel) {
542 p.push_back (UserProperty (UserProperty::VIDEO, _("Bits per pixel"), raw_convert<string> (_bits_per_pixel.get ())));
547 audio->add_properties (p);
551 /** Our subtitle streams have colour maps, which can be changed, but
552 * they have no way of signalling that change. As a hack, we have this
553 * method which callers can use when they've modified one of our subtitle
557 FFmpegContent::signal_subtitle_stream_changed ()
559 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
562 vector<shared_ptr<FFmpegAudioStream> >
563 FFmpegContent::ffmpeg_audio_streams () const
565 vector<shared_ptr<FFmpegAudioStream> > fa;
568 BOOST_FOREACH (AudioStreamPtr i, audio->streams()) {
569 fa.push_back (dynamic_pointer_cast<FFmpegAudioStream> (i));