2 Copyright (C) 2013-2019 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 #include "ffmpeg_content.h"
24 #include "exceptions.h"
27 #include "dcpomatic_log.h"
28 #include "ffmpeg_subtitle_stream.h"
29 #include "ffmpeg_audio_stream.h"
30 #include "decrypted_ecinema_kdm.h"
32 #include "compose.hpp"
34 #include <dcp/raw_convert.h>
36 #include <libavcodec/avcodec.h>
37 #include <libavformat/avformat.h>
38 #include <libswscale/swscale.h>
40 #include <boost/algorithm/string.hpp>
41 #include <boost/foreach.hpp>
50 using boost::shared_ptr;
51 using boost::optional;
52 using dcp::raw_convert;
53 using namespace dcpomatic;
55 boost::mutex FFmpeg::_mutex;
57 FFmpeg::FFmpeg (boost::shared_ptr<const FFmpegContent> c)
60 , _avio_buffer_size (4096)
71 boost::mutex::scoped_lock lm (_mutex);
73 for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
74 avcodec_close (_format_context->streams[i]->codec);
77 av_frame_free (&_frame);
78 avformat_close_input (&_format_context);
82 avio_read_wrapper (void* data, uint8_t* buffer, int amount)
84 return reinterpret_cast<FFmpeg*>(data)->avio_read (buffer, amount);
88 avio_seek_wrapper (void* data, int64_t offset, int whence)
90 return reinterpret_cast<FFmpeg*>(data)->avio_seek (offset, whence);
94 FFmpeg::ffmpeg_log_callback (void* ptr, int level, const char* fmt, va_list vl)
96 if (level > AV_LOG_WARNING) {
101 static int prefix = 0;
102 av_log_format_line (ptr, level, fmt, vl, line, sizeof (line), &prefix);
104 boost::algorithm::trim (str);
105 dcpomatic_log->log (String::compose ("FFmpeg: %1", str), LogEntry::TYPE_GENERAL);
109 FFmpeg::setup_general ()
111 /* This might not work too well in some cases of multiple FFmpeg decoders,
112 but it's probably good enough.
114 av_log_set_callback (FFmpeg::ffmpeg_log_callback);
116 _file_group.set_paths (_ffmpeg_content->paths ());
117 _avio_buffer = static_cast<uint8_t*> (wrapped_av_malloc (_avio_buffer_size));
118 _avio_context = avio_alloc_context (_avio_buffer, _avio_buffer_size, 0, this, avio_read_wrapper, 0, avio_seek_wrapper);
119 _format_context = avformat_alloc_context ();
120 _format_context->pb = _avio_context;
122 AVDictionary* options = 0;
123 /* These durations are in microseconds, and represent how far into the content file
124 we will look for streams.
126 av_dict_set (&options, "analyzeduration", raw_convert<string> (5 * 60 * 1000000).c_str(), 0);
127 av_dict_set (&options, "probesize", raw_convert<string> (5 * 60 * 1000000).c_str(), 0);
128 #ifdef DCPOMATIC_VARIANT_SWAROOP
129 if (_ffmpeg_content->kdm()) {
130 DecryptedECinemaKDM kdm (_ffmpeg_content->kdm().get(), Config::instance()->decryption_chain()->key().get());
131 av_dict_set (&options, "decryption_key", kdm.key().hex().c_str(), 0);
135 int e = avformat_open_input (&_format_context, 0, 0, &options);
137 throw OpenFileError (_ffmpeg_content->path(0).string(), e, OpenFileError::READ);
140 if (avformat_find_stream_info (_format_context, 0) < 0) {
141 throw DecodeError (_("could not find stream information"));
144 /* Find video stream */
146 optional<int> video_stream_undefined_frame_rate;
148 for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
149 AVStream* s = _format_context->streams[i];
150 if (s->codec->codec_type == AVMEDIA_TYPE_VIDEO && avcodec_find_decoder(s->codec->codec_id)) {
151 if (s->avg_frame_rate.num > 0 && s->avg_frame_rate.den > 0) {
152 /* This is definitely our video stream */
155 /* This is our video stream if we don't get a better offer */
156 video_stream_undefined_frame_rate = i;
161 /* Files from iTunes sometimes have two video streams, one with the avg_frame_rate.num and .den set
162 to zero. Only use such a stream if there is no alternative.
164 if (!_video_stream && video_stream_undefined_frame_rate) {
165 _video_stream = video_stream_undefined_frame_rate.get();
168 /* Ignore video streams with crazy frame rates. These are usually things like album art on MP3s. */
169 if (_video_stream && av_q2d(av_guess_frame_rate(_format_context, _format_context->streams[_video_stream.get()], 0)) > 1000) {
170 _video_stream = optional<int>();
173 /* Hack: if the AVStreams have duplicate IDs, replace them with our
174 own. We use the IDs so that we can cope with VOBs, in which streams
175 move about in index but remain with the same ID in different
176 VOBs. However, some files have duplicate IDs, hence this hack.
179 bool duplicates = false;
180 for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
181 for (uint32_t j = i + 1; j < _format_context->nb_streams; ++j) {
182 if (_format_context->streams[i]->id == _format_context->streams[j]->id) {
189 /* Put in our own IDs */
190 for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
191 _format_context->streams[i]->id = i;
195 _frame = av_frame_alloc ();
197 throw DecodeError (N_("could not allocate frame"));
202 FFmpeg::setup_decoders ()
204 boost::mutex::scoped_lock lm (_mutex);
206 for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
207 AVCodecContext* context = _format_context->streams[i]->codec;
209 AVCodec* codec = avcodec_find_decoder (context->codec_id);
212 AVDictionary* options = 0;
213 /* This option disables decoding of DCA frame footers in our patched version
214 of FFmpeg. I believe these footers are of no use to us, and they can cause
215 problems when FFmpeg fails to decode them (mantis #352).
217 av_dict_set (&options, "disable_footer", "1", 0);
218 /* This allows decoding of some DNxHR 444 and HQX files; see
219 https://trac.ffmpeg.org/ticket/5681
221 av_dict_set_int (&options, "strict", FF_COMPLIANCE_EXPERIMENTAL, 0);
222 /* Enable following of links in files */
223 av_dict_set_int (&options, "enable_drefs", 1, 0);
225 if (avcodec_open2 (context, codec, &options) < 0) {
226 throw DecodeError (N_("could not open decoder"));
229 dcpomatic_log->log (String::compose ("No codec found for stream %1", i), LogEntry::TYPE_WARNING);
235 FFmpeg::video_codec_context () const
237 if (!_video_stream) {
241 return _format_context->streams[_video_stream.get()]->codec;
245 FFmpeg::subtitle_codec_context () const
247 if (!_ffmpeg_content->subtitle_stream ()) {
251 return _ffmpeg_content->subtitle_stream()->stream(_format_context)->codec;
255 FFmpeg::avio_read (uint8_t* buffer, int const amount)
257 return _file_group.read (buffer, amount);
261 FFmpeg::avio_seek (int64_t const pos, int whence)
263 if (whence == AVSEEK_SIZE) {
264 return _file_group.length ();
267 return _file_group.seek (pos, whence);
271 FFmpeg::subtitle_period (AVSubtitle const & sub)
273 ContentTime const packet_time = ContentTime::from_seconds (static_cast<double> (sub.pts) / AV_TIME_BASE);
275 if (sub.end_display_time == static_cast<uint32_t> (-1)) {
276 /* End time is not known */
277 return FFmpegSubtitlePeriod (packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3));
280 return FFmpegSubtitlePeriod (
281 packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3),
282 packet_time + ContentTime::from_seconds (sub.end_display_time / 1e3)
286 /** Compute the pts offset to use given a set of audio streams and some video details.
287 * Sometimes these parameters will have just been determined by an Examiner, sometimes
288 * they will have been retrieved from a piece of Content, hence the need for this method
292 FFmpeg::pts_offset (vector<shared_ptr<FFmpegAudioStream> > audio_streams, optional<ContentTime> first_video, double video_frame_rate) const
294 /* Audio and video frame PTS values may not start with 0. We want
295 to fiddle them so that:
297 1. One of them starts at time 0.
298 2. The first video PTS value ends up on a frame boundary.
300 Then we remove big initial gaps in PTS and we allow our
301 insertion of black frames to work.
304 audio_pts_to_use = audio_pts_from_ffmpeg + pts_offset;
305 video_pts_to_use = video_pts_from_ffmpeg + pts_offset;
308 /* First, make one of them start at 0 */
310 ContentTime po = ContentTime::min ();
313 po = - first_video.get ();
316 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, audio_streams) {
317 if (i->first_audio) {
318 po = max (po, - i->first_audio.get ());
322 /* If the offset is positive we would be pushing things from a -ve PTS to be played.
323 I don't think we ever want to do that, as it seems things at -ve PTS are not meant
324 to be seen (use for alignment bars etc.); see mantis #418.
326 if (po > ContentTime ()) {
330 /* Now adjust so that the video pts starts on a frame */
332 ContentTime const fvc = first_video.get() + po;
333 po += fvc.ceil (video_frame_rate) - fvc;