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 if (!_avio_context) {
120 throw std::bad_alloc ();
122 _format_context = avformat_alloc_context ();
123 if (!_format_context) {
124 throw std::bad_alloc ();
126 _format_context->pb = _avio_context;
128 AVDictionary* options = 0;
129 #ifdef DCPOMATIC_VARIANT_SWAROOP
130 if (_ffmpeg_content->kdm()) {
131 DecryptedECinemaKDM kdm (_ffmpeg_content->kdm().get(), Config::instance()->decryption_chain()->key().get());
132 av_dict_set (&options, "decryption_key", kdm.key().hex().c_str(), 0);
136 int e = avformat_open_input (&_format_context, 0, 0, &options);
138 throw OpenFileError (_ffmpeg_content->path(0).string(), e, OpenFileError::READ);
141 if (avformat_find_stream_info (_format_context, 0) < 0) {
142 throw DecodeError (_("could not find stream information"));
145 /* Find video stream */
147 optional<int> video_stream_undefined_frame_rate;
149 for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
150 AVStream* s = _format_context->streams[i];
151 if (s->codec->codec_type == AVMEDIA_TYPE_VIDEO && avcodec_find_decoder(s->codec->codec_id)) {
152 if (s->avg_frame_rate.num > 0 && s->avg_frame_rate.den > 0) {
153 /* This is definitely our video stream */
156 /* This is our video stream if we don't get a better offer */
157 video_stream_undefined_frame_rate = i;
162 /* Files from iTunes sometimes have two video streams, one with the avg_frame_rate.num and .den set
163 to zero. Only use such a stream if there is no alternative.
165 if (!_video_stream && video_stream_undefined_frame_rate) {
166 _video_stream = video_stream_undefined_frame_rate.get();
169 /* Ignore video streams with crazy frame rates. These are usually things like album art on MP3s. */
170 if (_video_stream && av_q2d(av_guess_frame_rate(_format_context, _format_context->streams[_video_stream.get()], 0)) > 1000) {
171 _video_stream = optional<int>();
174 /* Hack: if the AVStreams have duplicate IDs, replace them with our
175 own. We use the IDs so that we can cope with VOBs, in which streams
176 move about in index but remain with the same ID in different
177 VOBs. However, some files have duplicate IDs, hence this hack.
180 bool duplicates = false;
181 for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
182 for (uint32_t j = i + 1; j < _format_context->nb_streams; ++j) {
183 if (_format_context->streams[i]->id == _format_context->streams[j]->id) {
190 /* Put in our own IDs */
191 for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
192 _format_context->streams[i]->id = i;
196 _frame = av_frame_alloc ();
198 throw DecodeError (N_("could not allocate frame"));
203 FFmpeg::setup_decoders ()
205 boost::mutex::scoped_lock lm (_mutex);
207 for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
208 AVCodecContext* context = _format_context->streams[i]->codec;
210 AVCodec* codec = avcodec_find_decoder (context->codec_id);
213 AVDictionary* options = 0;
214 /* This option disables decoding of DCA frame footers in our patched version
215 of FFmpeg. I believe these footers are of no use to us, and they can cause
216 problems when FFmpeg fails to decode them (mantis #352).
218 av_dict_set (&options, "disable_footer", "1", 0);
219 /* This allows decoding of some DNxHR 444 and HQX files; see
220 https://trac.ffmpeg.org/ticket/5681
222 av_dict_set_int (&options, "strict", FF_COMPLIANCE_EXPERIMENTAL, 0);
223 /* Enable following of links in files */
224 av_dict_set_int (&options, "enable_drefs", 1, 0);
226 if (avcodec_open2 (context, codec, &options) < 0) {
227 throw DecodeError (N_("could not open decoder"));
230 dcpomatic_log->log (String::compose ("No codec found for stream %1", i), LogEntry::TYPE_WARNING);
236 FFmpeg::video_codec_context () const
238 if (!_video_stream) {
242 return _format_context->streams[_video_stream.get()]->codec;
246 FFmpeg::subtitle_codec_context () const
248 if (!_ffmpeg_content->subtitle_stream ()) {
252 return _ffmpeg_content->subtitle_stream()->stream(_format_context)->codec;
256 FFmpeg::avio_read (uint8_t* buffer, int const amount)
258 return _file_group.read (buffer, amount);
262 FFmpeg::avio_seek (int64_t const pos, int whence)
264 if (whence == AVSEEK_SIZE) {
265 return _file_group.length ();
268 return _file_group.seek (pos, whence);
272 FFmpeg::subtitle_period (AVSubtitle const & sub)
274 ContentTime const packet_time = ContentTime::from_seconds (static_cast<double> (sub.pts) / AV_TIME_BASE);
276 if (sub.end_display_time == static_cast<uint32_t> (-1)) {
277 /* End time is not known */
278 return FFmpegSubtitlePeriod (packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3));
281 return FFmpegSubtitlePeriod (
282 packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3),
283 packet_time + ContentTime::from_seconds (sub.end_display_time / 1e3)
287 /** Compute the pts offset to use given a set of audio streams and some video details.
288 * Sometimes these parameters will have just been determined by an Examiner, sometimes
289 * they will have been retrieved from a piece of Content, hence the need for this method
293 FFmpeg::pts_offset (vector<shared_ptr<FFmpegAudioStream> > audio_streams, optional<ContentTime> first_video, double video_frame_rate) const
295 /* Audio and video frame PTS values may not start with 0. We want
296 to fiddle them so that:
298 1. One of them starts at time 0.
299 2. The first video PTS value ends up on a frame boundary.
301 Then we remove big initial gaps in PTS and we allow our
302 insertion of black frames to work.
305 audio_pts_to_use = audio_pts_from_ffmpeg + pts_offset;
306 video_pts_to_use = video_pts_from_ffmpeg + pts_offset;
309 /* First, make one of them start at 0 */
311 ContentTime po = ContentTime::min ();
314 po = - first_video.get ();
317 BOOST_FOREACH (shared_ptr<FFmpegAudioStream> i, audio_streams) {
318 if (i->first_audio) {
319 po = max (po, - i->first_audio.get ());
323 /* If the offset is positive we would be pushing things from a -ve PTS to be played.
324 I don't think we ever want to do that, as it seems things at -ve PTS are not meant
325 to be seen (use for alignment bars etc.); see mantis #418.
327 if (po > ContentTime ()) {
331 /* Now adjust so that the video pts starts on a frame */
333 ContentTime const fvc = first_video.get() + po;
334 po += fvc.ceil (video_frame_rate) - fvc;