2 Copyright (C) 2013-2015 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 "ffmpeg_examiner.h"
22 #include "ffmpeg_subtitle_stream.h"
23 #include "ffmpeg_audio_stream.h"
24 #include "compose.hpp"
30 #include "exceptions.h"
31 #include "frame_rate_change.h"
32 #include "safe_stringstream.h"
33 #include "raw_convert.h"
34 #include <libcxml/cxml.h>
36 #include <libavformat/avformat.h>
37 #include <libavutil/pixdesc.h>
39 #include <libxml++/libxml++.h>
40 #include <boost/foreach.hpp>
45 #define LOG_GENERAL(...) film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
53 using boost::shared_ptr;
54 using boost::dynamic_pointer_cast;
55 using boost::optional;
57 int const FFmpegContentProperty::SUBTITLE_STREAMS = 100;
58 int const FFmpegContentProperty::SUBTITLE_STREAM = 101;
59 int const FFmpegContentProperty::FILTERS = 102;
61 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, boost::filesystem::path p)
63 , VideoContent (film, p)
64 , AudioContent (film, p)
65 , SubtitleContent (film, p)
70 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, cxml::ConstNodePtr node, int version, list<string>& notes)
71 : Content (film, node)
72 , VideoContent (film, node, version)
73 , AudioContent (film, node)
74 , SubtitleContent (film, node, version)
76 list<cxml::NodePtr> c = node->node_children ("SubtitleStream");
77 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
78 _subtitle_streams.push_back (shared_ptr<FFmpegSubtitleStream> (new FFmpegSubtitleStream (*i, version)));
79 if ((*i)->optional_number_child<int> ("Selected")) {
80 _subtitle_stream = _subtitle_streams.back ();
84 c = node->node_children ("AudioStream");
85 for (list<cxml::NodePtr>::const_iterator i = c.begin(); i != c.end(); ++i) {
86 _audio_streams.push_back (shared_ptr<FFmpegAudioStream> (new FFmpegAudioStream (*i, version)));
87 if (version < 11 && !(*i)->optional_node_child ("Selected")) {
88 /* This is an old file and this stream is not selected, so un-map it */
89 _audio_streams.back()->set_mapping (AudioMapping (_audio_streams.back()->channels (), MAX_DCP_AUDIO_CHANNELS));
93 c = node->node_children ("Filter");
94 for (list<cxml::NodePtr>::iterator i = c.begin(); i != c.end(); ++i) {
95 Filter const * f = Filter::from_id ((*i)->content ());
97 _filters.push_back (f);
99 notes.push_back (String::compose (_("DCP-o-matic no longer supports the `%1' filter, so it has been turned off."), (*i)->content()));
103 optional<ContentTime::Type> const f = node->optional_number_child<ContentTime::Type> ("FirstVideo");
105 _first_video = ContentTime (f.get ());
108 _color_range = static_cast<AVColorRange> (node->optional_number_child<int>("ColorRange").get_value_or (AVCOL_RANGE_UNSPECIFIED));
109 _color_primaries = static_cast<AVColorPrimaries> (node->optional_number_child<int>("ColorPrimaries").get_value_or (AVCOL_PRI_UNSPECIFIED));
110 _color_trc = static_cast<AVColorTransferCharacteristic> (
111 node->optional_number_child<int>("ColorTransferCharacteristic").get_value_or (AVCOL_TRC_UNSPECIFIED)
113 _colorspace = static_cast<AVColorSpace> (node->optional_number_child<int>("Colorspace").get_value_or (AVCOL_SPC_UNSPECIFIED));
114 _bits_per_pixel = node->optional_number_child<int> ("BitsPerPixel");
118 FFmpegContent::FFmpegContent (shared_ptr<const Film> film, vector<boost::shared_ptr<Content> > c)
120 , VideoContent (film, c)
121 , AudioContent (film, c)
122 , SubtitleContent (film, c)
124 shared_ptr<FFmpegContent> ref = dynamic_pointer_cast<FFmpegContent> (c[0]);
125 DCPOMATIC_ASSERT (ref);
127 for (size_t i = 0; i < c.size(); ++i) {
128 shared_ptr<FFmpegContent> fc = dynamic_pointer_cast<FFmpegContent> (c[i]);
129 if (fc->use_subtitles() && *(fc->_subtitle_stream.get()) != *(ref->_subtitle_stream.get())) {
130 throw JoinError (_("Content to be joined must use the same subtitle stream."));
134 /* XXX: should probably check that more of the stuff below is the same in *this and ref */
136 _subtitle_streams = ref->subtitle_streams ();
137 _subtitle_stream = ref->subtitle_stream ();
138 _audio_streams = ref->ffmpeg_audio_streams ();
139 _first_video = ref->_first_video;
140 _filters = ref->_filters;
141 _color_range = ref->_color_range;
142 _color_primaries = ref->_color_primaries;
143 _color_trc = ref->_color_trc;
144 _colorspace = ref->_colorspace;
145 _bits_per_pixel = ref->_bits_per_pixel;
149 FFmpegContent::as_xml (xmlpp::Node* node) const
151 node->add_child("Type")->add_child_text ("FFmpeg");
152 Content::as_xml (node);
153 VideoContent::as_xml (node);
154 AudioContent::as_xml (node);
155 SubtitleContent::as_xml (node);
157 boost::mutex::scoped_lock lm (_mutex);
159 for (vector<shared_ptr<FFmpegSubtitleStream> >::const_iterator i = _subtitle_streams.begin(); i != _subtitle_streams.end(); ++i) {
160 xmlpp::Node* t = node->add_child("SubtitleStream");
161 if (_subtitle_stream && *i == _subtitle_stream) {
162 t->add_child("Selected")->add_child_text("1");
167 for (vector<shared_ptr<FFmpegAudioStream> >::const_iterator i = _audio_streams.begin(); i != _audio_streams.end(); ++i) {
168 (*i)->as_xml (node->add_child("AudioStream"));
171 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
172 node->add_child("Filter")->add_child_text ((*i)->id ());
176 node->add_child("FirstVideo")->add_child_text (raw_convert<string> (_first_video.get().get()));
179 node->add_child("ColorRange")->add_child_text (raw_convert<string> (_color_range));
180 node->add_child("ColorPrimaries")->add_child_text (raw_convert<string> (_color_primaries));
181 node->add_child("ColorTransferCharacteristic")->add_child_text (raw_convert<string> (_color_trc));
182 node->add_child("Colorspace")->add_child_text (raw_convert<string> (_colorspace));
183 if (_bits_per_pixel) {
184 node->add_child("BitsPerPixel")->add_child_text (raw_convert<string> (_bits_per_pixel.get ()));
189 FFmpegContent::examine (shared_ptr<Job> job)
191 job->set_progress_unknown ();
193 Content::examine (job);
195 shared_ptr<FFmpegExaminer> examiner (new FFmpegExaminer (shared_from_this (), job));
196 take_from_video_examiner (examiner);
199 boost::mutex::scoped_lock lm (_mutex);
201 _subtitle_streams = examiner->subtitle_streams ();
202 if (!_subtitle_streams.empty ()) {
203 _subtitle_stream = _subtitle_streams.front ();
206 _audio_streams = examiner->audio_streams ();
208 if (!_audio_streams.empty ()) {
209 AudioMapping m = _audio_streams.front()->mapping ();
210 film()->make_audio_mapping_default (m);
211 _audio_streams.front()->set_mapping (m);
214 _first_video = examiner->first_video ();
216 _color_range = examiner->color_range ();
217 _color_primaries = examiner->color_primaries ();
218 _color_trc = examiner->color_trc ();
219 _colorspace = examiner->colorspace ();
220 _bits_per_pixel = examiner->bits_per_pixel ();
223 signal_changed (FFmpegContentProperty::SUBTITLE_STREAMS);
224 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
225 signal_changed (AudioContentProperty::AUDIO_STREAMS);
229 FFmpegContent::summary () const
231 /* Get the string() here so that the name does not have quotes around it */
232 return String::compose (_("%1 [movie]"), path_summary ());
236 FFmpegContent::technical_summary () const
239 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, ffmpeg_audio_streams ()) {
240 as += i->technical_summary () + " " ;
248 if (_subtitle_stream) {
249 ss = _subtitle_stream->technical_summary ();
252 string filt = Filter::ffmpeg_string (_filters);
254 return Content::technical_summary() + " - "
255 + VideoContent::technical_summary() + " - "
256 + AudioContent::technical_summary() + " - "
258 "ffmpeg: audio %1 subtitle %2 filters %3", as, ss, filt
263 FFmpegContent::set_subtitle_stream (shared_ptr<FFmpegSubtitleStream> s)
266 boost::mutex::scoped_lock lm (_mutex);
267 _subtitle_stream = s;
270 signal_changed (FFmpegContentProperty::SUBTITLE_STREAM);
274 operator== (FFmpegStream const & a, FFmpegStream const & b)
276 return a._id == b._id;
280 operator!= (FFmpegStream const & a, FFmpegStream const & b)
282 return a._id != b._id;
286 FFmpegContent::full_length () const
288 FrameRateChange const frc (video_frame_rate (), film()->video_frame_rate ());
289 return DCPTime::from_frames (llrint (video_length_after_3d_combine() * frc.factor()), film()->video_frame_rate());
293 FFmpegContent::set_filters (vector<Filter const *> const & filters)
296 boost::mutex::scoped_lock lm (_mutex);
300 signal_changed (FFmpegContentProperty::FILTERS);
304 FFmpegContent::identifier () const
308 s << VideoContent::identifier() << "_"
309 << SubtitleContent::identifier();
311 boost::mutex::scoped_lock lm (_mutex);
313 if (_subtitle_stream) {
314 s << "_" << _subtitle_stream->identifier ();
317 for (vector<Filter const *>::const_iterator i = _filters.begin(); i != _filters.end(); ++i) {
318 s << "_" << (*i)->id ();
324 list<ContentTimePeriod>
325 FFmpegContent::image_subtitles_during (ContentTimePeriod period, bool starting) const
327 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
329 return list<ContentTimePeriod> ();
332 return stream->image_subtitles_during (period, starting);
335 list<ContentTimePeriod>
336 FFmpegContent::text_subtitles_during (ContentTimePeriod period, bool starting) const
338 shared_ptr<FFmpegSubtitleStream> stream = subtitle_stream ();
340 return list<ContentTimePeriod> ();
343 return stream->text_subtitles_during (period, starting);
347 FFmpegContent::has_image_subtitles () const
349 BOOST_FOREACH (shared_ptr<FFmpegSubtitleStream> i, subtitle_streams()) {
350 if (i->has_image_subtitles()) {
359 FFmpegContent::has_text_subtitles () const
361 BOOST_FOREACH (shared_ptr<FFmpegSubtitleStream> i, subtitle_streams()) {
362 if (i->has_text_subtitles()) {
371 FFmpegContent::set_default_colour_conversion ()
373 dcp::Size const s = video_size ();
375 boost::mutex::scoped_lock lm (_mutex);
377 if (s.width < 1080) {
378 _colour_conversion = PresetColourConversion::from_id ("rec601").conversion;
380 _colour_conversion = PresetColourConversion::from_id ("rec709").conversion;
384 vector<AudioStreamPtr>
385 FFmpegContent::audio_streams () const
387 boost::mutex::scoped_lock lm (_mutex);
389 vector<AudioStreamPtr> s;
390 copy (_audio_streams.begin(), _audio_streams.end(), back_inserter (s));
395 FFmpegContent::add_properties (list<pair<string, string> >& p) const
397 VideoContent::add_properties (p);
399 if (_bits_per_pixel) {
400 int const sub = 219 * pow (2, _bits_per_pixel.get() - 8);
401 int const total = pow (2, _bits_per_pixel.get());
403 switch (_color_range) {
404 case AVCOL_RANGE_UNSPECIFIED:
405 /// TRANSLATORS: this means that the range of pixel values used in this
406 /// file is unknown (not specified in the file).
407 p.push_back (make_pair (_("Colour range"), _("Unspecified")));
409 case AVCOL_RANGE_MPEG:
410 /// TRANSLATORS: this means that the range of pixel values used in this
411 /// file is limited, so that not all possible values are valid.
412 p.push_back (make_pair (_("Colour range"), String::compose (_("Limited (%1-%2)"), (total - sub) / 2, (total + sub) / 2)));
414 case AVCOL_RANGE_JPEG:
415 /// TRANSLATORS: this means that the range of pixel values used in this
416 /// file is full, so that all possible pixel values are valid.
417 p.push_back (make_pair (_("Colour range"), String::compose (_("Full (0-%1)"), total)));
420 DCPOMATIC_ASSERT (false);
423 switch (_color_range) {
424 case AVCOL_RANGE_UNSPECIFIED:
425 /// TRANSLATORS: this means that the range of pixel values used in this
426 /// file is unknown (not specified in the file).
427 p.push_back (make_pair (_("Colour range"), _("Unspecified")));
429 case AVCOL_RANGE_MPEG:
430 /// TRANSLATORS: this means that the range of pixel values used in this
431 /// file is limited, so that not all possible values are valid.
432 p.push_back (make_pair (_("Colour range"), _("Limited")));
434 case AVCOL_RANGE_JPEG:
435 /// TRANSLATORS: this means that the range of pixel values used in this
436 /// file is full, so that all possible pixel values are valid.
437 p.push_back (make_pair (_("Colour range"), _("Full")));
440 DCPOMATIC_ASSERT (false);
444 char const * primaries[] = {
451 _("SMPTE 170M (BT601)"),
457 DCPOMATIC_ASSERT (AVCOL_PRI_NB == 10);
458 p.push_back (make_pair (_("Colour primaries"), primaries[_color_primaries]));
460 char const * transfers[] = {
465 _("Gamma 22 (BT470M)"),
466 _("Gamma 28 (BT470BG)"),
467 _("SMPTE 170M (BT601)"),
470 _("Logarithmic (100:1 range)"),
471 _("Logarithmic (316:1 range)"),
473 _("BT1361 extended colour gamut"),
474 _("IEC61966-2-1 (sRGB or sYCC)"),
475 _("BT2020 for a 10-bit system"),
476 _("BT2020 for a 12-bit system")
479 DCPOMATIC_ASSERT (AVCOL_TRC_NB == 16);
480 p.push_back (make_pair (_("Colour transfer characteristic"), transfers[_color_trc]));
482 char const * spaces[] = {
483 _("RGB / sRGB (IEC61966-2-1)"),
488 _("BT470BG (BT601-6)"),
489 _("SMPTE 170M (BT601-6)"),
492 _("BT2020 non-constant luminance"),
493 _("BT2020 constant luminance"),
496 DCPOMATIC_ASSERT (AVCOL_SPC_NB == 11);
497 p.push_back (make_pair (_("Colourspace"), spaces[_colorspace]));
499 if (_bits_per_pixel) {
500 p.push_back (make_pair (_("Bits per pixel"), raw_convert<string> (_bits_per_pixel.get ())));