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 "audio_content.h"
23 #include "ffmpeg_examiner.h"
24 #include "ffmpeg_subtitle_stream.h"
25 #include "ffmpeg_audio_stream.h"
26 #include "compose.hpp"
32 #include "exceptions.h"
33 #include "frame_rate_change.h"
34 #include "safe_stringstream.h"
35 #include "raw_convert.h"
36 #include "subtitle_content.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);
56 using boost::shared_ptr;
57 using boost::dynamic_pointer_cast;
58 using boost::optional;
60 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
61 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
62 int const FFmpegContentProperty::FILTERS = 102;
64 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, boost::filesystem::path p)
67 video.reset (new VideoContent (this, film));
68 audio.reset (new AudioContent (this, film));
69 subtitle.reset (new SubtitleContent (this, film));
71 set_default_colour_conversion ();
74 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
75 : Content (film, node)
77 video.reset (new VideoContent (this, film, node, version));
78 audio.reset (new AudioContent (this, film, node));
79 subtitle.reset (new SubtitleContent (this, film, 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 (shared_ptr<FFmpegSubtitleStream> (new 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 (new 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 (_audio_streams.back()->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 video.reset (new VideoContent (this, film, c));
128 audio.reset (new AudioContent (this, film, c));
129 subtitle.reset (new SubtitleContent (this, film, c));
131 shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
132 DCPOMATIC_ASSERT (ref);
134 for (size_t i = 0; i < c.size(); ++i) {
135 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
136 if (fc->subtitle->use() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
137 throw JoinError (_("Content to be joined must use the same subtitle stream."));
141 /* XXX: should probably check that more of the stuff below is the same in *this and ref */
143 _subtitle_streams = ref->subtitle_streams ();
144 _subtitle_stream = ref->subtitle_stream ();
145 _first_video = ref->_first_video;
146 _filters = ref->_filters;
147 _color_range = ref->_color_range;
148 _color_primaries = ref->_color_primaries;
149 _color_trc = ref->_color_trc;
150 _colorspace = ref->_colorspace;
151 _bits_per_pixel = ref->_bits_per_pixel;
155 FFmpegContent::as_xml (xmlpp::Node* node) const
157 node->add_child("Type")->add_child_text ("FFmpeg");
158 Content::as_xml (node);
159 video->as_xml (node);
160 audio->as_xml (node);
161 subtitle->as_xml (node);
163 boost::mutex::scoped_lock lm (_mutex);
165 for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
166 xmlpp::Node* t = node->add_child("SubtitleStream");
167 if (_subtitle_stream && *i == _subtitle_stream) {
168 t->add_child("Selected")->add_child_text("1");
173 BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
174 shared_ptr<FFmpegAudioStream> f = dynamic_pointer_cast<FFmpegAudioStream> (i);
175 DCPOMATIC_ASSERT (f);
176 f->as_xml (node->add_child("AudioStream"));
179 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
180 node->add_child("Filter")->add_child_text ((*i)->id ());
184 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
187 node->add_child("ColorRange")->add_child_text (raw_convert<string> (_color_range));
188 node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (_color_primaries));
189 node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (_color_trc));
190 node->add_child("Colorspace")->add_child_text (raw_convert<string> (_colorspace));
191 if (_bits_per_pixel) {
192 node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (_bits_per_pixel.get ()));
197 FFmpegContent::examine (shared_ptr<Job> job)
199 job->set_progress_unknown ();
201 Content::examine (job);
203 shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
204 video->take_from_examiner (examiner);
205 set_default_colour_conversion ();
208 boost::mutex::scoped_lock lm (_mutex);
210 _subtitle_streams = examiner->subtitle_streams ();
211 if (!_subtitle_streams.empty ()) {
212 _subtitle_stream = _subtitle_streams.front ();
215 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, examiner->audio_streams ()) {
216 audio->add_stream (i);
219 if (!audio->streams().empty ()) {
220 AudioStreamPtr as = audio->streams().front();
221 AudioMapping m = as->mapping ();
222 film()->make_audio_mapping_default (m);
226 _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 signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
236 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
240 FFmpegContent::summary () const
242 /* Get the string() here so that the name does not have quotes around it */
243 return String::compose (_("%1 [movie]"), path_summary ());
247 FFmpegContent::technical_summary () const
250 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
251 as += i->technical_summary () + " " ;
259 if (_subtitle_stream) {
260 ss = _subtitle_stream->technical_summary ();
263 string filt = Filter::ffmpeg_string (_filters);
265 return Content::technical_summary() + " - "
266 + video->technical_summary() + " - "
267 + audio->technical_summary() + " - "
269 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
274 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
277 boost::mutex::scoped_lock lm (_mutex);
278 _subtitle_stream = s;
281 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
285 operator== (FFmpegStream const & a, FFmpegStream const & b)
287 return a._id == b._id;
291 operator!= (FFmpegStream const & a, FFmpegStream const & b)
293 return a._id != b._id;
297 FFmpegContent::full_length () const
299 FrameRateChange const frc (video->frame_rate (), film()->video_frame_rate ());
300 return DCPTime::from_frames (llrint (video->length_after_3d_combine() * frc.factor()), film()->video_frame_rate());
304 FFmpegContent::set_filters (vector<Filter const *> const & filters)
307 boost::mutex::scoped_lock lm (_mutex);
311 signal_changed (FFmpegContentProperty::FILTERS);
315 FFmpegContent::identifier () const
319 s << Content::identifier() << "_"
320 << video->identifier() << "_"
321 << subtitle->identifier();
323 boost::mutex::scoped_lock lm (_mutex);
325 if (_subtitle_stream) {
326 s << "_" << _subtitle_stream->identifier ();
329 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
330 s << "_" << (*i)->id ();
336 list<ContentTimePeriod>
337 FFmpegContent::image_subtitles_during (ContentTimePeriod period, bool starting) const
339 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
341 return list<ContentTimePeriod> ();
344 return stream->image_subtitles_during (period, starting);
347 list<ContentTimePeriod>
348 FFmpegContent::text_subtitles_during (ContentTimePeriod period, bool starting) const
350 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
352 return list<ContentTimePeriod> ();
355 return stream->text_subtitles_during (period, starting);
359 FFmpegContent::has_image_subtitles () const
361 BOOST_FOREACH (shared_ptr<FFmpegSubtitleStream> i, subtitle_streams()) {
362 if (i->has_image_subtitles()) {
371 FFmpegContent::has_text_subtitles () const
373 BOOST_FOREACH (shared_ptr<FFmpegSubtitleStream> i, subtitle_streams()) {
374 if (i->has_text_subtitles()) {
383 FFmpegContent::set_default_colour_conversion ()
385 dcp::Size const s = video->size ();
387 boost::mutex::scoped_lock lm (_mutex);
389 if (s.width < 1080) {
390 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
392 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
396 vector<AudioStreamPtr>
397 FFmpegContent::audio_streams () const
399 boost::mutex::scoped_lock lm (_mutex);
401 vector<AudioStreamPtr> s;
402 copy (_audio_streams.begin(), _audio_streams.end(), back_inserter (s));
407 FFmpegContent::add_properties (list<UserProperty>& p) const
409 Content::add_properties (p);
410 video->add_properties (p);
411 audio->add_properties (p);
413 if (_bits_per_pixel) {
414 int const sub = 219 * pow (2, _bits_per_pixel.get() - 8);
415 int const total = pow (2, _bits_per_pixel.get());
417 switch (_color_range) {
418 case AVCOL_RANGE_UNSPECIFIED:
419 /// TRANSLATORS: this means that the range of pixel values used in this
420 /// file is unknown (not specified in the file).
421 p.push_back (UserProperty (_("Video"), _("Colour range"), _("Unspecified")));
423 case AVCOL_RANGE_MPEG:
424 /// TRANSLATORS: this means that the range of pixel values used in this
425 /// file is limited, so that not all possible values are valid.
428 _("Video"), _("Colour range"), String::compose (_("Limited (%1-%2)"), (total - sub) / 2, (total + sub) / 2)
432 case AVCOL_RANGE_JPEG:
433 /// TRANSLATORS: this means that the range of pixel values used in this
434 /// file is full, so that all possible pixel values are valid.
435 p.push_back (UserProperty (_("Video"), _("Colour range"), String::compose (_("Full (0-%1)"), total)));
438 DCPOMATIC_ASSERT (false);
441 switch (_color_range) {
442 case AVCOL_RANGE_UNSPECIFIED:
443 /// TRANSLATORS: this means that the range of pixel values used in this
444 /// file is unknown (not specified in the file).
445 p.push_back (UserProperty (_("Video"), _("Colour range"), _("Unspecified")));
447 case AVCOL_RANGE_MPEG:
448 /// TRANSLATORS: this means that the range of pixel values used in this
449 /// file is limited, so that not all possible values are valid.
450 p.push_back (UserProperty (_("Video"), _("Colour range"), _("Limited")));
452 case AVCOL_RANGE_JPEG:
453 /// TRANSLATORS: this means that the range of pixel values used in this
454 /// file is full, so that all possible pixel values are valid.
455 p.push_back (UserProperty (_("Video"), _("Colour range"), _("Full")));
458 DCPOMATIC_ASSERT (false);
462 char const * primaries[] = {
469 _("SMPTE 170M (BT601)"),
473 _("SMPTE ST 428-1 (CIE 1931 XYZ)")
476 DCPOMATIC_ASSERT (AVCOL_PRI_NB == 11);
477 p.push_back (UserProperty (_("Video"), _("Colour primaries"), primaries[_color_primaries]));
479 char const * transfers[] = {
484 _("Gamma 22 (BT470M)"),
485 _("Gamma 28 (BT470BG)"),
486 _("SMPTE 170M (BT601)"),
489 _("Logarithmic (100:1 range)"),
490 _("Logarithmic (316:1 range)"),
492 _("BT1361 extended colour gamut"),
493 _("IEC61966-2-1 (sRGB or sYCC)"),
494 _("BT2020 for a 10-bit system"),
495 _("BT2020 for a 12-bit system"),
496 _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
500 DCPOMATIC_ASSERT (AVCOL_TRC_NB == 18);
501 p.push_back (UserProperty (_("Video"), _("Colour transfer characteristic"), transfers[_color_trc]));
503 char const * spaces[] = {
504 _("RGB / sRGB (IEC61966-2-1)"),
509 _("BT470BG (BT601-6)"),
510 _("SMPTE 170M (BT601-6)"),
513 _("BT2020 non-constant luminance"),
514 _("BT2020 constant luminance"),
517 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 11);
518 p.push_back (UserProperty (_("Video"), _("Colourspace"), spaces[_colorspace]));
520 if (_bits_per_pixel) {
521 p.push_back (UserProperty (_("Video"), _("Bits per pixel"), raw_convert<string> (_bits_per_pixel.get ())));
525 /** Our subtitle streams have colour maps, which can be changed, but
526 * they have no way of signalling that change. As a hack, we have this
527 * method which callers can use when they've modified one of our subtitle
531 FFmpegContent::signal_subtitle_stream_changed ()
533 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
537 FFmpegContent::changed (int property)
539 if (property == VideoContentProperty::FRAME_RATE && subtitle) {
540 subtitle->set_video_frame_rate (video->frame_rate ());