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)
70 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
71 : Content (film, node)
73 video = VideoContent::from_xml (this, film, node, version);
74 audio = AudioContent::from_xml (this, film, node);
75 subtitle = SubtitleContent::from_xml (this, film, node, version);
77 list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
78 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
79 _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i, version)));
80 if ((*i)->optional_number_child<int> ("Selected")) {
81 _subtitle_stream = _subtitle_streams.back ();
85 c = node->node_children ("AudioStream");
86 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
87 shared_ptr<FFmpegAudioStream> as (new FFmpegAudioStream (*i, version));
88 audio->add_stream (as);
89 if (version < 11 && !(*i)->optional_node_child ("Selected")) {
90 /* This is an old file and this stream is not selected, so un-map it */
91 as->set_mapping (AudioMapping (as->channels (), MAX_DCP_AUDIO_CHANNELS));
95 c = node->node_children ("Filter");
96 for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
97 Filter const * f = Filter::from_id ((*i)->content ());
99 _filters.push_back (f);
101 notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), (*i)->content()));
105 optional<ContentTime::Type> const f = node->optional_number_child<ContentTime::Type> ("FirstVideo");
107 _first_video = ContentTime (f.get ());
110 _color_range = static_cast<AVColorRange> (node->optional_number_child<int>("ColorRange").get_value_or (AVCOL_RANGE_UNSPECIFIED));
111 _color_primaries = static_cast<AVColorPrimaries> (node->optional_number_child<int>("ColorPrimaries").get_value_or (AVCOL_PRI_UNSPECIFIED));
112 _color_trc = static_cast<AVColorTransferCharacteristic> (
113 node->optional_number_child<int>("ColorTransferCharacteristic").get_value_or (AVCOL_TRC_UNSPECIFIED)
115 _colorspace = static_cast<AVColorSpace> (node->optional_number_child<int>("Colorspace").get_value_or (AVCOL_SPC_UNSPECIFIED));
116 _bits_per_pixel = node->optional_number_child<int> ("BitsPerPixel");
120 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, vector<boost::shared_ptr<Content> > c)
123 video.reset (new VideoContent (this, film, c));
124 audio.reset (new AudioContent (this, film, c));
125 subtitle.reset (new SubtitleContent (this, film, c));
127 shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
128 DCPOMATIC_ASSERT (ref);
130 for (size_t i = 0; i < c.size(); ++i) {
131 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
132 if (fc->subtitle->use() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
133 throw JoinError (_("Content to be joined must use the same subtitle stream."));
137 /* XXX: should probably check that more of the stuff below is the same in *this and ref */
139 _subtitle_streams = ref->subtitle_streams ();
140 _subtitle_stream = ref->subtitle_stream ();
141 _first_video = ref->_first_video;
142 _filters = ref->_filters;
143 _color_range = ref->_color_range;
144 _color_primaries = ref->_color_primaries;
145 _color_trc = ref->_color_trc;
146 _colorspace = ref->_colorspace;
147 _bits_per_pixel = ref->_bits_per_pixel;
151 FFmpegContent::as_xml (xmlpp::Node* node) const
153 node->add_child("Type")->add_child_text ("FFmpeg");
154 Content::as_xml (node);
157 video->as_xml (node);
161 audio->as_xml (node);
165 subtitle->as_xml (node);
168 boost::mutex::scoped_lock lm (_mutex);
170 for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
171 xmlpp::Node* t = node->add_child("SubtitleStream");
172 if (_subtitle_stream && *i == _subtitle_stream) {
173 t->add_child("Selected")->add_child_text("1");
178 BOOST_FOREACH (AudioStreamPtr i, audio->streams ()) {
179 shared_ptr<FFmpegAudioStream> f = dynamic_pointer_cast<FFmpegAudioStream> (i);
180 DCPOMATIC_ASSERT (f);
181 f->as_xml (node->add_child("AudioStream"));
184 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
185 node->add_child("Filter")->add_child_text ((*i)->id ());
189 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
192 node->add_child("ColorRange")->add_child_text (raw_convert<string> (_color_range));
193 node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (_color_primaries));
194 node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (_color_trc));
195 node->add_child("Colorspace")->add_child_text (raw_convert<string> (_colorspace));
196 if (_bits_per_pixel) {
197 node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (_bits_per_pixel.get ()));
202 FFmpegContent::examine (shared_ptr<Job> job)
204 job->set_progress_unknown ();
206 Content::examine (job);
208 shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
210 if (examiner->has_video ()) {
211 video.reset (new VideoContent (this, film ()));
212 video->take_from_examiner (examiner);
213 set_default_colour_conversion ();
217 boost::mutex::scoped_lock lm (_mutex);
219 if (examiner->has_video ()) {
220 _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 if (!examiner->audio_streams().empty ()) {
229 audio.reset (new AudioContent (this, film ()));
231 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, examiner->audio_streams ()) {
232 audio->add_stream (i);
235 AudioStreamPtr as = audio->streams().front();
236 AudioMapping m = as->mapping ();
237 film()->make_audio_mapping_default (m);
241 _subtitle_streams = examiner->subtitle_streams ();
242 if (!_subtitle_streams.empty ()) {
243 subtitle.reset (new SubtitleContent (this, film ()));
244 _subtitle_stream = _subtitle_streams.front ();
249 signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
250 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
254 FFmpegContent::summary () const
256 /* Get the string() here so that the name does not have quotes around it */
257 return String::compose (_("%1 [movie]"), path_summary ());
261 FFmpegContent::technical_summary () const
264 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
265 as += i->technical_summary () + " " ;
273 if (_subtitle_stream) {
274 ss = _subtitle_stream->technical_summary ();
277 string filt = Filter::ffmpeg_string (_filters);
279 return Content::technical_summary() + " - "
280 + video->technical_summary() + " - "
281 + audio->technical_summary() + " - "
283 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
288 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
291 boost::mutex::scoped_lock lm (_mutex);
292 _subtitle_stream = s;
295 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
299 operator== (FFmpegStream const & a, FFmpegStream const & b)
301 return a._id == b._id;
305 operator!= (FFmpegStream const & a, FFmpegStream const & b)
307 return a._id != b._id;
311 FFmpegContent::full_length () const
313 FrameRateChange const frc (active_video_frame_rate (), film()->video_frame_rate ());
314 return DCPTime::from_frames (llrint (video->length_after_3d_combine() * frc.factor()), film()->video_frame_rate());
318 FFmpegContent::set_filters (vector<Filter const *> const & filters)
321 boost::mutex::scoped_lock lm (_mutex);
325 signal_changed (FFmpegContentProperty::FILTERS);
329 FFmpegContent::identifier () const
333 s << Content::identifier() << "_"
334 << video->identifier() << "_"
335 << subtitle->identifier();
337 boost::mutex::scoped_lock lm (_mutex);
339 if (_subtitle_stream) {
340 s << "_" << _subtitle_stream->identifier ();
343 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
344 s << "_" << (*i)->id ();
350 list<ContentTimePeriod>
351 FFmpegContent::image_subtitles_during (ContentTimePeriod period, bool starting) const
353 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
355 return list<ContentTimePeriod> ();
358 return stream->image_subtitles_during (period, starting);
361 list<ContentTimePeriod>
362 FFmpegContent::text_subtitles_during (ContentTimePeriod period, bool starting) const
364 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
366 return list<ContentTimePeriod> ();
369 return stream->text_subtitles_during (period, starting);
373 FFmpegContent::set_default_colour_conversion ()
375 dcp::Size const s = video->size ();
377 boost::mutex::scoped_lock lm (_mutex);
379 if (s.width < 1080) {
380 video->set_colour_conversion (PresetColourConversion::from_id ("rec601").conversion);
382 video->set_colour_conversion (PresetColourConversion::from_id ("rec709").conversion);
387 FFmpegContent::add_properties (list<UserProperty>& p) const
389 Content::add_properties (p);
390 video->add_properties (p);
391 audio->add_properties (p);
393 if (_bits_per_pixel) {
394 int const sub = 219 * pow (2, _bits_per_pixel.get() - 8);
395 int const total = pow (2, _bits_per_pixel.get());
397 switch (_color_range) {
398 case AVCOL_RANGE_UNSPECIFIED:
399 /// TRANSLATORS: this means that the range of pixel values used in this
400 /// file is unknown (not specified in the file).
401 p.push_back (UserProperty (_("Video"), _("Colour range"), _("Unspecified")));
403 case AVCOL_RANGE_MPEG:
404 /// TRANSLATORS: this means that the range of pixel values used in this
405 /// file is limited, so that not all possible values are valid.
408 _("Video"), _("Colour range"), String::compose (_("Limited (%1-%2)"), (total - sub) / 2, (total + sub) / 2)
412 case AVCOL_RANGE_JPEG:
413 /// TRANSLATORS: this means that the range of pixel values used in this
414 /// file is full, so that all possible pixel values are valid.
415 p.push_back (UserProperty (_("Video"), _("Colour range"), String::compose (_("Full (0-%1)"), total)));
418 DCPOMATIC_ASSERT (false);
421 switch (_color_range) {
422 case AVCOL_RANGE_UNSPECIFIED:
423 /// TRANSLATORS: this means that the range of pixel values used in this
424 /// file is unknown (not specified in the file).
425 p.push_back (UserProperty (_("Video"), _("Colour range"), _("Unspecified")));
427 case AVCOL_RANGE_MPEG:
428 /// TRANSLATORS: this means that the range of pixel values used in this
429 /// file is limited, so that not all possible values are valid.
430 p.push_back (UserProperty (_("Video"), _("Colour range"), _("Limited")));
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"), _("Full")));
438 DCPOMATIC_ASSERT (false);
442 char const * primaries[] = {
449 _("SMPTE 170M (BT601)"),
453 _("SMPTE ST 428-1 (CIE 1931 XYZ)")
456 DCPOMATIC_ASSERT (AVCOL_PRI_NB == 11);
457 p.push_back (UserProperty (_("Video"), _("Colour primaries"), primaries[_color_primaries]));
459 char const * transfers[] = {
464 _("Gamma 22 (BT470M)"),
465 _("Gamma 28 (BT470BG)"),
466 _("SMPTE 170M (BT601)"),
469 _("Logarithmic (100:1 range)"),
470 _("Logarithmic (316:1 range)"),
472 _("BT1361 extended colour gamut"),
473 _("IEC61966-2-1 (sRGB or sYCC)"),
474 _("BT2020 for a 10-bit system"),
475 _("BT2020 for a 12-bit system"),
476 _("SMPTE ST 2084 for 10, 12, 14 and 16 bit systems"),
480 DCPOMATIC_ASSERT (AVCOL_TRC_NB == 18);
481 p.push_back (UserProperty (_("Video"), _("Colour transfer characteristic"), transfers[_color_trc]));
483 char const * spaces[] = {
484 _("RGB / sRGB (IEC61966-2-1)"),
489 _("BT470BG (BT601-6)"),
490 _("SMPTE 170M (BT601-6)"),
493 _("BT2020 non-constant luminance"),
494 _("BT2020 constant luminance"),
497 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 11);
498 p.push_back (UserProperty (_("Video"), _("Colourspace"), spaces[_colorspace]));
500 if (_bits_per_pixel) {
501 p.push_back (UserProperty (_("Video"), _("Bits per pixel"), raw_convert<string> (_bits_per_pixel.get ())));
505 /** Our subtitle streams have colour maps, which can be changed, but
506 * they have no way of signalling that change. As a hack, we have this
507 * method which callers can use when they've modified one of our subtitle
511 FFmpegContent::signal_subtitle_stream_changed ()
513 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
516 vector<shared_ptr<FFmpegAudioStream> >
517 FFmpegContent::ffmpeg_audio_streams () const
519 vector<shared_ptr<FFmpegAudioStream> > fa;
520 BOOST_FOREACH (AudioStreamPtr i, audio->streams()) {
521 fa.push_back (dynamic_pointer_cast<FFmpegAudioStream> (i));