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 <libcxml/cxml.h>
37 #include <libavformat/avformat.h>
38 #include <libavutil/pixdesc.h>
40 #include <libxml++/libxml++.h>
41 #include <boost/foreach.hpp>
46 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
54 using boost::shared_ptr;
55 using boost::dynamic_pointer_cast;
56 using boost::optional;
58 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
59 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
60 int const FFmpegContentProperty::FILTERS = 102;
62 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, boost::filesystem::path p)
64 , AudioContent (film, p)
65 , SubtitleContent (film, p)
67 video.reset (new VideoContent (this, film));
69 set_default_colour_conversion ();
72 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
73 : Content (film, node)
74 , AudioContent (film, node)
75 , SubtitleContent (film, node, version)
77 video.reset (new VideoContent (this, film, 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 _audio_streams.push_back (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream (*i, version)));
90 if (version < 11 && !(*i)->optional_node_child ("Selected")) {
91 /* This is an old file and this stream is not selected, so un-map it */
92 _audio_streams.back()->set_mapping (AudioMapping (_audio_streams.back()->channels (), MAX_DCP_AUDIO_CHANNELS));
96 c = node->node_children ("Filter");
97 for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
98 Filter const * f = Filter::from_id ((*i)->content ());
100 _filters.push_back (f);
102 notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), (*i)->content()));
106 optional<ContentTime::Type> const f = node->optional_number_child<ContentTime::Type> ("FirstVideo");
108 _first_video = ContentTime (f.get ());
111 _color_range = static_cast<AVColorRange> (node->optional_number_child<int>("ColorRange").get_value_or (AVCOL_RANGE_UNSPECIFIED));
112 _color_primaries = static_cast<AVColorPrimaries> (node->optional_number_child<int>("ColorPrimaries").get_value_or (AVCOL_PRI_UNSPECIFIED));
113 _color_trc = static_cast<AVColorTransferCharacteristic> (
114 node->optional_number_child<int>("ColorTransferCharacteristic").get_value_or (AVCOL_TRC_UNSPECIFIED)
116 _colorspace = static_cast<AVColorSpace> (node->optional_number_child<int>("Colorspace").get_value_or (AVCOL_SPC_UNSPECIFIED));
117 _bits_per_pixel = node->optional_number_child<int> ("BitsPerPixel");
121 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, vector<boost::shared_ptr<Content> > c)
123 , AudioContent (film, c)
124 , SubtitleContent (film, c)
126 video.reset (new VideoContent (this, film, c));
128 shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
129 DCPOMATIC_ASSERT (ref);
131 for (size_t i = 0; i < c.size(); ++i) {
132 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
133 if (fc->use_subtitles() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
134 throw JoinError (_("Content to be joined must use the same subtitle stream."));
138 /* XXX: should probably check that more of the stuff below is the same in *this and ref */
140 _subtitle_streams = ref->subtitle_streams ();
141 _subtitle_stream = ref->subtitle_stream ();
142 _audio_streams = ref->ffmpeg_audio_streams ();
143 _first_video = ref->_first_video;
144 _filters = ref->_filters;
145 _color_range = ref->_color_range;
146 _color_primaries = ref->_color_primaries;
147 _color_trc = ref->_color_trc;
148 _colorspace = ref->_colorspace;
149 _bits_per_pixel = ref->_bits_per_pixel;
153 FFmpegContent::as_xml (xmlpp::Node* node) const
155 node->add_child("Type")->add_child_text ("FFmpeg");
156 Content::as_xml (node);
157 video->as_xml (node);
158 AudioContent::as_xml (node);
159 SubtitleContent::as_xml (node);
161 boost::mutex::scoped_lock lm (_mutex);
163 for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
164 xmlpp::Node* t = node->add_child("SubtitleStream");
165 if (_subtitle_stream && *i == _subtitle_stream) {
166 t->add_child("Selected")->add_child_text("1");
171 for (vector<shared_ptr<FFmpegAudioStream> >::const_iterator i = _audio_streams.begin(); i != _audio_streams.end(); ++i) {
172 (*i)->as_xml (node->add_child("AudioStream"));
175 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
176 node->add_child("Filter")->add_child_text ((*i)->id ());
180 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
183 node->add_child("ColorRange")->add_child_text (raw_convert<string> (_color_range));
184 node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (_color_primaries));
185 node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (_color_trc));
186 node->add_child("Colorspace")->add_child_text (raw_convert<string> (_colorspace));
187 if (_bits_per_pixel) {
188 node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (_bits_per_pixel.get ()));
193 FFmpegContent::examine (shared_ptr<Job> job)
195 job->set_progress_unknown ();
197 Content::examine (job);
199 shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
200 video->take_from_video_examiner (examiner);
201 set_default_colour_conversion ();
204 boost::mutex::scoped_lock lm (_mutex);
206 _subtitle_streams = examiner->subtitle_streams ();
207 if (!_subtitle_streams.empty ()) {
208 _subtitle_stream = _subtitle_streams.front ();
211 _audio_streams = examiner->audio_streams ();
213 if (!_audio_streams.empty ()) {
214 AudioMapping m = _audio_streams.front()->mapping ();
215 film()->make_audio_mapping_default (m);
216 _audio_streams.front()->set_mapping (m);
219 _first_video = examiner->first_video ();
221 _color_range = examiner->color_range ();
222 _color_primaries = examiner->color_primaries ();
223 _color_trc = examiner->color_trc ();
224 _colorspace = examiner->colorspace ();
225 _bits_per_pixel = examiner->bits_per_pixel ();
228 signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
229 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
230 signal_changed (AudioContentProperty::AUDIO_STREAMS);
234 FFmpegContent::summary () const
236 /* Get the string() here so that the name does not have quotes around it */
237 return String::compose (_("%1 [movie]"), path_summary ());
241 FFmpegContent::technical_summary () const
244 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
245 as += i->technical_summary () + " " ;
253 if (_subtitle_stream) {
254 ss = _subtitle_stream->technical_summary ();
257 string filt = Filter::ffmpeg_string (_filters);
259 return Content::technical_summary() + " - "
260 + video->technical_summary() + " - "
261 + AudioContent::technical_summary() + " - "
263 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
268 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
271 boost::mutex::scoped_lock lm (_mutex);
272 _subtitle_stream = s;
275 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
279 operator== (FFmpegStream const & a, FFmpegStream const & b)
281 return a._id == b._id;
285 operator!= (FFmpegStream const & a, FFmpegStream const & b)
287 return a._id != b._id;
291 FFmpegContent::full_length () const
293 FrameRateChange const frc (video->video_frame_rate (), film()->video_frame_rate ());
294 return DCPTime::from_frames (llrint (video->video_length_after_3d_combine() * frc.factor()), film()->video_frame_rate());
298 FFmpegContent::set_filters (vector<Filter const *> const & filters)
301 boost::mutex::scoped_lock lm (_mutex);
305 signal_changed (FFmpegContentProperty::FILTERS);
309 FFmpegContent::identifier () const
313 s << Content::identifier() << "_"
314 << video->identifier() << "_"
315 << SubtitleContent::identifier();
317 boost::mutex::scoped_lock lm (_mutex);
319 if (_subtitle_stream) {
320 s << "_" << _subtitle_stream->identifier ();
323 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
324 s << "_" << (*i)->id ();
330 list<ContentTimePeriod>
331 FFmpegContent::image_subtitles_during (ContentTimePeriod period, bool starting) const
333 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
335 return list<ContentTimePeriod> ();
338 return stream->image_subtitles_during (period, starting);
341 list<ContentTimePeriod>
342 FFmpegContent::text_subtitles_during (ContentTimePeriod period, bool starting) const
344 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
346 return list<ContentTimePeriod> ();
349 return stream->text_subtitles_during (period, starting);
353 FFmpegContent::has_image_subtitles () const
355 BOOST_FOREACH (shared_ptr<FFmpegSubtitleStream> i, subtitle_streams()) {
356 if (i->has_image_subtitles()) {
365 FFmpegContent::has_text_subtitles () const
367 BOOST_FOREACH (shared_ptr<FFmpegSubtitleStream> i, subtitle_streams()) {
368 if (i->has_text_subtitles()) {
377 FFmpegContent::set_default_colour_conversion ()
379 dcp::Size const s = video->video_size ();
381 boost::mutex::scoped_lock lm (_mutex);
383 if (s.width < 1080) {
384 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
386 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
390 vector<AudioStreamPtr>
391 FFmpegContent::audio_streams () const
393 boost::mutex::scoped_lock lm (_mutex);
395 vector<AudioStreamPtr> s;
396 copy (_audio_streams.begin(), _audio_streams.end(), back_inserter (s));
401 FFmpegContent::add_properties (list<UserProperty>& p) const
403 Content::add_properties (p);
404 video->add_properties (p);
405 AudioContent::add_properties (p);
407 if (_bits_per_pixel) {
408 int const sub = 219 * pow (2, _bits_per_pixel.get() - 8);
409 int const total = pow (2, _bits_per_pixel.get());
411 switch (_color_range) {
412 case AVCOL_RANGE_UNSPECIFIED:
413 /// TRANSLATORS: this means that the range of pixel values used in this
414 /// file is unknown (not specified in the file).
415 p.push_back (UserProperty (_("Video"), _("Colour range"), _("Unspecified")));
417 case AVCOL_RANGE_MPEG:
418 /// TRANSLATORS: this means that the range of pixel values used in this
419 /// file is limited, so that not all possible values are valid.
422 _("Video"), _("Colour range"), String::compose (_("Limited (%1-%2)"), (total - sub) / 2, (total + sub) / 2)
426 case AVCOL_RANGE_JPEG:
427 /// TRANSLATORS: this means that the range of pixel values used in this
428 /// file is full, so that all possible pixel values are valid.
429 p.push_back (UserProperty (_("Video"), _("Colour range"), String::compose (_("Full (0-%1)"), total)));
432 DCPOMATIC_ASSERT (false);
435 switch (_color_range) {
436 case AVCOL_RANGE_UNSPECIFIED:
437 /// TRANSLATORS: this means that the range of pixel values used in this
438 /// file is unknown (not specified in the file).
439 p.push_back (UserProperty (_("Video"), _("Colour range"), _("Unspecified")));
441 case AVCOL_RANGE_MPEG:
442 /// TRANSLATORS: this means that the range of pixel values used in this
443 /// file is limited, so that not all possible values are valid.
444 p.push_back (UserProperty (_("Video"), _("Colour range"), _("Limited")));
446 case AVCOL_RANGE_JPEG:
447 /// TRANSLATORS: this means that the range of pixel values used in this
448 /// file is full, so that all possible pixel values are valid.
449 p.push_back (UserProperty (_("Video"), _("Colour range"), _("Full")));
452 DCPOMATIC_ASSERT (false);
456 char const * primaries[] = {
463 _("SMPTE 170M (BT601)"),
467 _("SMPTE ST 428-1 (CIE 1931 XYZ)")
470 DCPOMATIC_ASSERT (AVCOL_PRI_NB == 11);
471 p.push_back (UserProperty (_("Video"), _("Colour primaries"), primaries[_color_primaries]));
473 char const * transfers[] = {
478 _("Gamma 22 (BT470M)"),
479 _("Gamma 28 (BT470BG)"),
480 _("SMPTE 170M (BT601)"),
483 _("Logarithmic (100:1 range)"),
484 _("Logarithmic (316:1 range)"),
486 _("BT1361 extended colour gamut"),
487 _("IEC61966-2-1 (sRGB or sYCC)"),
488 _("BT2020 for a 10-bit system"),
489 _("BT2020 for a 12-bit system"),
490 _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
494 DCPOMATIC_ASSERT (AVCOL_TRC_NB == 18);
495 p.push_back (UserProperty (_("Video"), _("Colour transfer characteristic"), transfers[_color_trc]));
497 char const * spaces[] = {
498 _("RGB / sRGB (IEC61966-2-1)"),
503 _("BT470BG (BT601-6)"),
504 _("SMPTE 170M (BT601-6)"),
507 _("BT2020 non-constant luminance"),
508 _("BT2020 constant luminance"),
511 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 11);
512 p.push_back (UserProperty (_("Video"), _("Colourspace"), spaces[_colorspace]));
514 if (_bits_per_pixel) {
515 p.push_back (UserProperty (_("Video"), _("Bits per pixel"), raw_convert<string> (_bits_per_pixel.get ())));
519 /** Our subtitle streams have colour maps, which can be changed, but
520 * they have no way of signalling that change. As a hack, we have this
521 * method which callers can use when they've modified one of our subtitle
525 FFmpegContent::signal_subtitle_stream_changed ()
527 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
531 FFmpegContent::subtitle_video_frame_rate () const
533 return video->video_frame_rate ();