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>
45 #include <boost/make_shared.hpp>
50 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
59 using boost::shared_ptr;
60 using boost::make_shared;
61 using boost::dynamic_pointer_cast;
62 using boost::optional;
64 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
65 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
66 int const FFmpegContentProperty::FILTERS = 102;
68 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, boost::filesystem::path p)
74 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
75 : Content (film, node)
77 video = VideoContent::from_xml (this, node, version);
78 audio = AudioContent::from_xml (this, node, version);
79 subtitle = SubtitleContent::from_xml (this, node, version);
81 list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
82 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
83 _subtitle_streams.push_back (make_shared<FFmpegSubtitleStream> (*i, version));
84 if ((*i)->optional_number_child<int> ("Selected")) {
85 _subtitle_stream = _subtitle_streams.back ();
89 c = node->node_children ("AudioStream");
90 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
91 shared_ptr<FFmpegAudioStream> as = make_shared<FFmpegAudioStream> (*i, version);
92 audio->add_stream (as);
93 if (version < 11 && !(*i)->optional_node_child ("Selected")) {
94 /* This is an old file and this stream is not selected, so un-map it */
95 as->set_mapping (AudioMapping (as->channels (), MAX_DCP_AUDIO_CHANNELS));
99 c = node->node_children ("Filter");
100 for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
101 Filter const * f = Filter::from_id ((*i)->content ());
103 _filters.push_back (f);
105 notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), (*i)->content()));
109 optional<ContentTime::Type> const f = node->optional_number_child<ContentTime::Type> ("FirstVideo");
111 _first_video = ContentTime (f.get ());
114 _color_range = static_cast<AVColorRange> (node->optional_number_child<int>("ColorRange").get_value_or (AVCOL_RANGE_UNSPECIFIED));
115 _color_primaries = static_cast<AVColorPrimaries> (node->optional_number_child<int>("ColorPrimaries").get_value_or (AVCOL_PRI_UNSPECIFIED));
116 _color_trc = static_cast<AVColorTransferCharacteristic> (
117 node->optional_number_child<int>("ColorTransferCharacteristic").get_value_or (AVCOL_TRC_UNSPECIFIED)
119 _colorspace = static_cast<AVColorSpace> (node->optional_number_child<int>("Colorspace").get_value_or (AVCOL_SPC_UNSPECIFIED));
120 _bits_per_pixel = node->optional_number_child<int> ("BitsPerPixel");
124 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, vector<boost::shared_ptr<Content> > c)
127 /* XXX: this should look at c to decide which of video/audio/subtitle
130 video.reset (new VideoContent (this, c));
131 audio.reset (new AudioContent (this, c));
132 subtitle.reset (new SubtitleContent (this, c));
134 shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
135 DCPOMATIC_ASSERT (ref);
137 for (size_t i = 0; i < c.size(); ++i) {
138 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
139 if (fc->subtitle->use() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
140 throw JoinError (_("Content to be joined must use the same subtitle stream."));
144 /* XXX: should probably check that more of the stuff below is the same in *this and ref */
146 _subtitle_streams = ref->subtitle_streams ();
147 _subtitle_stream = ref->subtitle_stream ();
148 _first_video = ref->_first_video;
149 _filters = ref->_filters;
150 _color_range = ref->_color_range;
151 _color_primaries = ref->_color_primaries;
152 _color_trc = ref->_color_trc;
153 _colorspace = ref->_colorspace;
154 _bits_per_pixel = ref->_bits_per_pixel;
158 FFmpegContent::as_xml (xmlpp::Node* node) const
160 node->add_child("Type")->add_child_text ("FFmpeg");
161 Content::as_xml (node);
164 video->as_xml (node);
168 audio->as_xml (node);
170 BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
171 shared_ptr<FFmpegAudioStream> f = dynamic_pointer_cast<FFmpegAudioStream> (i);
172 DCPOMATIC_ASSERT (f);
173 f->as_xml (node->add_child("AudioStream"));
178 subtitle->as_xml (node);
181 boost::mutex::scoped_lock lm (_mutex);
183 for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
184 xmlpp::Node* t = node->add_child("SubtitleStream");
185 if (_subtitle_stream && *i == _subtitle_stream) {
186 t->add_child("Selected")->add_child_text("1");
191 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
192 node->add_child("Filter")->add_child_text ((*i)->id ());
196 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
199 node->add_child("ColorRange")->add_child_text (raw_convert<string> (_color_range));
200 node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (_color_primaries));
201 node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (_color_trc));
202 node->add_child("Colorspace")->add_child_text (raw_convert<string> (_colorspace));
203 if (_bits_per_pixel) {
204 node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (_bits_per_pixel.get ()));
209 FFmpegContent::examine (shared_ptr<Job> job)
211 job->set_progress_unknown ();
213 Content::examine (job);
215 shared_ptr<FFmpegExaminer> examiner = make_shared<FFmpegExaminer> (shared_from_this (), job);
217 if (examiner->has_video ()) {
218 video.reset (new VideoContent (this));
219 video->take_from_examiner (examiner);
220 set_default_colour_conversion ();
223 boost::filesystem::path first_path = path (0);
226 boost::mutex::scoped_lock lm (_mutex);
228 if (examiner->has_video ()) {
229 _first_video = examiner->first_video ();
230 _color_range = examiner->color_range ();
231 _color_primaries = examiner->color_primaries ();
232 _color_trc = examiner->color_trc ();
233 _colorspace = examiner->colorspace ();
234 _bits_per_pixel = examiner->bits_per_pixel ();
237 if (!examiner->audio_streams().empty ()) {
238 audio.reset (new AudioContent (this));
240 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, examiner->audio_streams ()) {
241 audio->add_stream (i);
244 AudioStreamPtr as = audio->streams().front();
245 AudioMapping m = as->mapping ();
246 film()->make_audio_mapping_default (m, first_path);
250 _subtitle_streams = examiner->subtitle_streams ();
251 if (!_subtitle_streams.empty ()) {
252 subtitle.reset (new SubtitleContent (this));
253 _subtitle_stream = _subtitle_streams.front ();
258 signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
259 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
263 FFmpegContent::summary () const
265 if (video && audio) {
266 return String::compose (_("%1 [movie]"), path_summary ());
268 return String::compose (_("%1 [video]"), path_summary ());
270 return String::compose (_("%1 [audio]"), path_summary ());
273 return path_summary ();
277 FFmpegContent::technical_summary () const
280 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
281 as += i->technical_summary () + " " ;
289 if (_subtitle_stream) {
290 ss = _subtitle_stream->technical_summary ();
293 string filt = Filter::ffmpeg_string (_filters);
295 string s = Content::technical_summary ();
298 s += " - " + video->technical_summary ();
302 s += " - " + audio->technical_summary ();
305 return s + String::compose (
306 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
311 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
314 boost::mutex::scoped_lock lm (_mutex);
315 _subtitle_stream = s;
318 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
322 operator== (FFmpegStream const & a, FFmpegStream const & b)
324 return a._id == b._id;
328 operator!= (FFmpegStream const & a, FFmpegStream const & b)
330 return a._id != b._id;
334 FFmpegContent::full_length () const
336 FrameRateChange const frc (active_video_frame_rate (), film()->video_frame_rate ());
338 return DCPTime::from_frames (llrint (video->length_after_3d_combine() * frc.factor()), film()->video_frame_rate());
341 DCPOMATIC_ASSERT (audio);
344 BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
345 longest = max (longest, DCPTime::from_frames (llrint (i->length() / frc.speed_up), i->frame_rate()));
352 FFmpegContent::set_filters (vector<Filter const *> const & filters)
355 boost::mutex::scoped_lock lm (_mutex);
359 signal_changed (FFmpegContentProperty::FILTERS);
363 FFmpegContent::identifier () const
367 s << Content::identifier();
370 s << "_" << video->identifier();
374 s << "_" << subtitle->identifier();
377 boost::mutex::scoped_lock lm (_mutex);
379 if (_subtitle_stream) {
380 s << "_" << _subtitle_stream->identifier ();
383 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
384 s << "_" << (*i)->id ();
390 list<ContentTimePeriod>
391 FFmpegContent::image_subtitles_during (ContentTimePeriod period, bool starting) const
393 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
395 return list<ContentTimePeriod> ();
398 return stream->image_subtitles_during (period, starting);
401 list<ContentTimePeriod>
402 FFmpegContent::text_subtitles_during (ContentTimePeriod period, bool starting) const
404 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
406 return list<ContentTimePeriod> ();
409 return stream->text_subtitles_during (period, starting);
413 FFmpegContent::set_default_colour_conversion ()
415 DCPOMATIC_ASSERT (video);
417 dcp::Size const s = video->size ();
419 boost::mutex::scoped_lock lm (_mutex);
421 if (s.width < 1080) {
422 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
424 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
429 FFmpegContent::add_properties (list<UserProperty>& p) const
431 Content::add_properties (p);
434 video->add_properties (p);
436 if (_bits_per_pixel) {
437 int const sub = 219 * pow (2, _bits_per_pixel.get() - 8);
438 int const total = pow (2, _bits_per_pixel.get());
440 switch (_color_range) {
441 case AVCOL_RANGE_UNSPECIFIED:
442 /// TRANSLATORS: this means that the range of pixel values used in this
443 /// file is unknown (not specified in the file).
444 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Unspecified")));
446 case AVCOL_RANGE_MPEG:
447 /// TRANSLATORS: this means that the range of pixel values used in this
448 /// file is limited, so that not all possible values are valid.
451 UserProperty::VIDEO, _("Colour range"), String::compose (_("Limited (%1-%2)"), (total - sub) / 2, (total + sub) / 2)
455 case AVCOL_RANGE_JPEG:
456 /// TRANSLATORS: this means that the range of pixel values used in this
457 /// file is full, so that all possible pixel values are valid.
458 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), String::compose (_("Full (0-%1)"), total)));
461 DCPOMATIC_ASSERT (false);
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.
473 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Limited")));
475 case AVCOL_RANGE_JPEG:
476 /// TRANSLATORS: this means that the range of pixel values used in this
477 /// file is full, so that all possible pixel values are valid.
478 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour range"), _("Full")));
481 DCPOMATIC_ASSERT (false);
485 char const * primaries[] = {
492 _("SMPTE 170M (BT601)"),
496 _("SMPTE ST 428-1 (CIE 1931 XYZ)")
499 DCPOMATIC_ASSERT (AVCOL_PRI_NB <= 11);
500 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour primaries"), primaries[_color_primaries]));
502 char const * transfers[] = {
507 _("Gamma 22 (BT470M)"),
508 _("Gamma 28 (BT470BG)"),
509 _("SMPTE 170M (BT601)"),
512 _("Logarithmic (100:1 range)"),
513 _("Logarithmic (316:1 range)"),
515 _("BT1361 extended colour gamut"),
516 _("IEC61966-2-1 (sRGB or sYCC)"),
517 _("BT2020 for a 10-bit system"),
518 _("BT2020 for a 12-bit system"),
519 _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
523 DCPOMATIC_ASSERT (AVCOL_TRC_NB <= 18);
524 p.push_back (UserProperty (UserProperty::VIDEO, _("Colour transfer characteristic"), transfers[_color_trc]));
526 char const * spaces[] = {
527 _("RGB / sRGB (IEC61966-2-1)"),
532 _("BT470BG (BT601-6)"),
533 _("SMPTE 170M (BT601-6)"),
536 _("BT2020 non-constant luminance"),
537 _("BT2020 constant luminance"),
540 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 11);
541 p.push_back (UserProperty (UserProperty::VIDEO, _("Colourspace"), spaces[_colorspace]));
543 if (_bits_per_pixel) {
544 p.push_back (UserProperty (UserProperty::VIDEO, _("Bits per pixel"), raw_convert<string> (_bits_per_pixel.get ())));
549 audio->add_properties (p);
553 /** Our subtitle streams have colour maps, which can be changed, but
554 * they have no way of signalling that change. As a hack, we have this
555 * method which callers can use when they've modified one of our subtitle
559 FFmpegContent::signal_subtitle_stream_changed ()
561 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
564 vector<shared_ptr<FFmpegAudioStream> >
565 FFmpegContent::ffmpeg_audio_streams () const
567 vector<shared_ptr<FFmpegAudioStream> > fa;
570 BOOST_FOREACH (AudioStreamPtr i, audio->streams()) {
571 fa.push_back (dynamic_pointer_cast<FFmpegAudioStream> (i));