2 Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #include "ffmpeg_content.h"
21 #include "video_content.h"
22 #include "ffmpeg_examiner.h"
23 #include "ffmpeg_subtitle_stream.h"
24 #include "ffmpeg_audio_stream.h"
25 #include "compose.hpp"
31 #include "exceptions.h"
32 #include "frame_rate_change.h"
33 #include "safe_stringstream.h"
34 #include "raw_convert.h"
35 #include "subtitle_content.h"
36 #include <libcxml/cxml.h>
38 #include <libavformat/avformat.h>
39 #include <libavutil/pixdesc.h>
41 #include <libxml++/libxml++.h>
42 #include <boost/foreach.hpp>
47 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
55 using boost::shared_ptr;
56 using boost::dynamic_pointer_cast;
57 using boost::optional;
59 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
60 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
61 int const FFmpegContentProperty::FILTERS = 102;
63 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, boost::filesystem::path p)
65 , AudioContent (film, p)
67 video.reset (new VideoContent (this, film));
68 subtitle.reset (new SubtitleContent (this, film));
70 set_default_colour_conversion ();
73 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
74 : Content (film, node)
75 , AudioContent (film, node)
77 video.reset (new VideoContent (this, film, node, version));
78 subtitle.reset (new SubtitleContent (this, film, node, version));
80 list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
81 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
82 _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i, version)));
83 if ((*i)->optional_number_child<int> ("Selected")) {
84 _subtitle_stream = _subtitle_streams.back ();
88 c = node->node_children ("AudioStream");
89 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
90 _audio_streams.push_back (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream (*i, version)));
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 _audio_streams.back()->set_mapping (AudioMapping (_audio_streams.back()->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)
124 , AudioContent (film, c)
126 video.reset (new VideoContent (this, film, c));
127 subtitle.reset (new SubtitleContent (this, film, c));
129 shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
130 DCPOMATIC_ASSERT (ref);
132 for (size_t i = 0; i < c.size(); ++i) {
133 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
134 if (fc->subtitle->use_subtitles() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
135 throw JoinError (_("Content to be joined must use the same subtitle stream."));
139 /* XXX: should probably check that more of the stuff below is the same in *this and ref */
141 _subtitle_streams = ref->subtitle_streams ();
142 _subtitle_stream = ref->subtitle_stream ();
143 _audio_streams = ref->ffmpeg_audio_streams ();
144 _first_video = ref->_first_video;
145 _filters = ref->_filters;
146 _color_range = ref->_color_range;
147 _color_primaries = ref->_color_primaries;
148 _color_trc = ref->_color_trc;
149 _colorspace = ref->_colorspace;
150 _bits_per_pixel = ref->_bits_per_pixel;
154 FFmpegContent::as_xml (xmlpp::Node* node) const
156 node->add_child("Type")->add_child_text ("FFmpeg");
157 Content::as_xml (node);
158 video->as_xml (node);
159 AudioContent::as_xml (node);
160 subtitle->as_xml (node);
162 boost::mutex::scoped_lock lm (_mutex);
164 for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
165 xmlpp::Node* t = node->add_child("SubtitleStream");
166 if (_subtitle_stream && *i == _subtitle_stream) {
167 t->add_child("Selected")->add_child_text("1");
172 for (vector<shared_ptr<FFmpegAudioStream> >::const_iterator i = _audio_streams.begin(); i != _audio_streams.end(); ++i) {
173 (*i)->as_xml (node->add_child("AudioStream"));
176 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
177 node->add_child("Filter")->add_child_text ((*i)->id ());
181 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
184 node->add_child("ColorRange")->add_child_text (raw_convert<string> (_color_range));
185 node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (_color_primaries));
186 node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (_color_trc));
187 node->add_child("Colorspace")->add_child_text (raw_convert<string> (_colorspace));
188 if (_bits_per_pixel) {
189 node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (_bits_per_pixel.get ()));
194 FFmpegContent::examine (shared_ptr<Job> job)
196 job->set_progress_unknown ();
198 Content::examine (job);
200 shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
201 video->take_from_video_examiner (examiner);
202 set_default_colour_conversion ();
205 boost::mutex::scoped_lock lm (_mutex);
207 _subtitle_streams = examiner->subtitle_streams ();
208 if (!_subtitle_streams.empty ()) {
209 _subtitle_stream = _subtitle_streams.front ();
212 _audio_streams = examiner->audio_streams ();
214 if (!_audio_streams.empty ()) {
215 AudioMapping m = _audio_streams.front()->mapping ();
216 film()->make_audio_mapping_default (m);
217 _audio_streams.front()->set_mapping (m);
220 _first_video = examiner->first_video ();
222 _color_range = examiner->color_range ();
223 _color_primaries = examiner->color_primaries ();
224 _color_trc = examiner->color_trc ();
225 _colorspace = examiner->colorspace ();
226 _bits_per_pixel = examiner->bits_per_pixel ();
229 signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
230 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
231 signal_changed (AudioContentProperty::AUDIO_STREAMS);
235 FFmpegContent::summary () const
237 /* Get the string() here so that the name does not have quotes around it */
238 return String::compose (_("%1 [movie]"), path_summary ());
242 FFmpegContent::technical_summary () const
245 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
246 as += i->technical_summary () + " " ;
254 if (_subtitle_stream) {
255 ss = _subtitle_stream->technical_summary ();
258 string filt = Filter::ffmpeg_string (_filters);
260 return Content::technical_summary() + " - "
261 + video->technical_summary() + " - "
262 + AudioContent::technical_summary() + " - "
264 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
269 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
272 boost::mutex::scoped_lock lm (_mutex);
273 _subtitle_stream = s;
276 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
280 operator== (FFmpegStream const & a, FFmpegStream const & b)
282 return a._id == b._id;
286 operator!= (FFmpegStream const & a, FFmpegStream const & b)
288 return a._id != b._id;
292 FFmpegContent::full_length () const
294 FrameRateChange const frc (video->video_frame_rate (), film()->video_frame_rate ());
295 return DCPTime::from_frames (llrint (video->video_length_after_3d_combine() * frc.factor()), film()->video_frame_rate());
299 FFmpegContent::set_filters (vector<Filter const *> const & filters)
302 boost::mutex::scoped_lock lm (_mutex);
306 signal_changed (FFmpegContentProperty::FILTERS);
310 FFmpegContent::identifier () const
314 s << Content::identifier() << "_"
315 << video->identifier() << "_"
316 << subtitle->identifier();
318 boost::mutex::scoped_lock lm (_mutex);
320 if (_subtitle_stream) {
321 s << "_" << _subtitle_stream->identifier ();
324 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
325 s << "_" << (*i)->id ();
331 list<ContentTimePeriod>
332 FFmpegContent::image_subtitles_during (ContentTimePeriod period, bool starting) const
334 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
336 return list<ContentTimePeriod> ();
339 return stream->image_subtitles_during (period, starting);
342 list<ContentTimePeriod>
343 FFmpegContent::text_subtitles_during (ContentTimePeriod period, bool starting) const
345 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
347 return list<ContentTimePeriod> ();
350 return stream->text_subtitles_during (period, starting);
354 FFmpegContent::has_image_subtitles () const
356 BOOST_FOREACH (shared_ptr<FFmpegSubtitleStream> i, subtitle_streams()) {
357 if (i->has_image_subtitles()) {
366 FFmpegContent::has_text_subtitles () const
368 BOOST_FOREACH (shared_ptr<FFmpegSubtitleStream> i, subtitle_streams()) {
369 if (i->has_text_subtitles()) {
378 FFmpegContent::set_default_colour_conversion ()
380 dcp::Size const s = video->video_size ();
382 boost::mutex::scoped_lock lm (_mutex);
384 if (s.width < 1080) {
385 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
387 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
391 vector<AudioStreamPtr>
392 FFmpegContent::audio_streams () const
394 boost::mutex::scoped_lock lm (_mutex);
396 vector<AudioStreamPtr> s;
397 copy (_audio_streams.begin(), _audio_streams.end(), back_inserter (s));
402 FFmpegContent::add_properties (list<UserProperty>& p) const
404 Content::add_properties (p);
405 video->add_properties (p);
406 AudioContent::add_properties (p);
408 if (_bits_per_pixel) {
409 int const sub = 219 * pow (2, _bits_per_pixel.get() - 8);
410 int const total = pow (2, _bits_per_pixel.get());
412 switch (_color_range) {
413 case AVCOL_RANGE_UNSPECIFIED:
414 /// TRANSLATORS: this means that the range of pixel values used in this
415 /// file is unknown (not specified in the file).
416 p.push_back (UserProperty (_("Video"), _("Colour range"), _("Unspecified")));
418 case AVCOL_RANGE_MPEG:
419 /// TRANSLATORS: this means that the range of pixel values used in this
420 /// file is limited, so that not all possible values are valid.
423 _("Video"), _("Colour range"), String::compose (_("Limited (%1-%2)"), (total - sub) / 2, (total + sub) / 2)
427 case AVCOL_RANGE_JPEG:
428 /// TRANSLATORS: this means that the range of pixel values used in this
429 /// file is full, so that all possible pixel values are valid.
430 p.push_back (UserProperty (_("Video"), _("Colour range"), String::compose (_("Full (0-%1)"), total)));
433 DCPOMATIC_ASSERT (false);
436 switch (_color_range) {
437 case AVCOL_RANGE_UNSPECIFIED:
438 /// TRANSLATORS: this means that the range of pixel values used in this
439 /// file is unknown (not specified in the file).
440 p.push_back (UserProperty (_("Video"), _("Colour range"), _("Unspecified")));
442 case AVCOL_RANGE_MPEG:
443 /// TRANSLATORS: this means that the range of pixel values used in this
444 /// file is limited, so that not all possible values are valid.
445 p.push_back (UserProperty (_("Video"), _("Colour range"), _("Limited")));
447 case AVCOL_RANGE_JPEG:
448 /// TRANSLATORS: this means that the range of pixel values used in this
449 /// file is full, so that all possible pixel values are valid.
450 p.push_back (UserProperty (_("Video"), _("Colour range"), _("Full")));
453 DCPOMATIC_ASSERT (false);
457 char const * primaries[] = {
464 _("SMPTE 170M (BT601)"),
468 _("SMPTE ST 428-1 (CIE 1931 XYZ)")
471 DCPOMATIC_ASSERT (AVCOL_PRI_NB == 11);
472 p.push_back (UserProperty (_("Video"), _("Colour primaries"), primaries[_color_primaries]));
474 char const * transfers[] = {
479 _("Gamma 22 (BT470M)"),
480 _("Gamma 28 (BT470BG)"),
481 _("SMPTE 170M (BT601)"),
484 _("Logarithmic (100:1 range)"),
485 _("Logarithmic (316:1 range)"),
487 _("BT1361 extended colour gamut"),
488 _("IEC61966-2-1 (sRGB or sYCC)"),
489 _("BT2020 for a 10-bit system"),
490 _("BT2020 for a 12-bit system"),
491 _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
495 DCPOMATIC_ASSERT (AVCOL_TRC_NB == 18);
496 p.push_back (UserProperty (_("Video"), _("Colour transfer characteristic"), transfers[_color_trc]));
498 char const * spaces[] = {
499 _("RGB / sRGB (IEC61966-2-1)"),
504 _("BT470BG (BT601-6)"),
505 _("SMPTE 170M (BT601-6)"),
508 _("BT2020 non-constant luminance"),
509 _("BT2020 constant luminance"),
512 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 11);
513 p.push_back (UserProperty (_("Video"), _("Colourspace"), spaces[_colorspace]));
515 if (_bits_per_pixel) {
516 p.push_back (UserProperty (_("Video"), _("Bits per pixel"), raw_convert<string> (_bits_per_pixel.get ())));
520 /** Our subtitle streams have colour maps, which can be changed, but
521 * they have no way of signalling that change. As a hack, we have this
522 * method which callers can use when they've modified one of our subtitle
526 FFmpegContent::signal_subtitle_stream_changed ()
528 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
532 FFmpegContent::subtitle_video_frame_rate () const
534 return video->video_frame_rate ();