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