2 Copyright (C) 2013-2021 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 "compose.hpp"
24 #include "dcpomatic_log.h"
26 #include "exceptions.h"
28 #include "ffmpeg_audio_stream.h"
29 #include "ffmpeg_content.h"
30 #include "ffmpeg_subtitle_stream.h"
33 #include "memory_util.h"
35 #include <dcp/raw_convert.h>
37 #include <libavcodec/avcodec.h>
38 #include <libavformat/avformat.h>
39 #include <libswscale/swscale.h>
41 #include <boost/algorithm/string.hpp>
51 using std::shared_ptr;
52 using boost::optional;
53 using dcp::raw_convert;
54 using namespace dcpomatic;
57 boost::mutex FFmpeg::_mutex;
60 FFmpeg::FFmpeg (std::shared_ptr<const FFmpegContent> c)
70 boost::mutex::scoped_lock lm (_mutex);
72 for (auto& i: _codec_context) {
73 avcodec_free_context (&i);
76 av_frame_free (&_video_frame);
77 for (auto& audio_frame: _audio_frame) {
78 av_frame_free (&audio_frame.second);
81 avformat_close_input (&_format_context);
86 avio_read_wrapper (void* data, uint8_t* buffer, int amount)
88 return reinterpret_cast<FFmpeg*>(data)->avio_read (buffer, amount);
93 avio_seek_wrapper (void* data, int64_t offset, int whence)
95 return reinterpret_cast<FFmpeg*>(data)->avio_seek (offset, whence);
100 FFmpeg::ffmpeg_log_callback (void* ptr, int level, const char* fmt, va_list vl)
102 if (level > AV_LOG_WARNING) {
107 static int prefix = 0;
108 av_log_format_line (ptr, level, fmt, vl, line, sizeof (line), &prefix);
110 boost::algorithm::trim (str);
111 dcpomatic_log->log (String::compose ("FFmpeg: %1", str), LogEntry::TYPE_GENERAL);
116 FFmpeg::setup_general ()
118 /* This might not work too well in some cases of multiple FFmpeg decoders,
119 but it's probably good enough.
121 av_log_set_callback (FFmpeg::ffmpeg_log_callback);
123 _file_group.set_paths (_ffmpeg_content->paths ());
124 _avio_buffer = static_cast<uint8_t*> (wrapped_av_malloc(_avio_buffer_size));
125 _avio_context = avio_alloc_context (_avio_buffer, _avio_buffer_size, 0, this, avio_read_wrapper, 0, avio_seek_wrapper);
126 if (!_avio_context) {
127 throw std::bad_alloc ();
129 _format_context = avformat_alloc_context ();
130 if (!_format_context) {
131 throw std::bad_alloc ();
133 _format_context->pb = _avio_context;
135 AVDictionary* options = nullptr;
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 auto s = _format_context->streams[i];
151 if (s->codecpar->codec_type == AVMEDIA_TYPE_VIDEO && avcodec_find_decoder(s->codecpar->codec_id)) {
152 auto const frame_rate = av_q2d(s->avg_frame_rate);
153 if (frame_rate < 1 || frame_rate > 1000) {
154 /* Ignore video streams with crazy frame rates. These are usually things like album art on MP3s. */
157 if (s->avg_frame_rate.num > 0 && s->avg_frame_rate.den > 0) {
158 /* This is definitely our video stream */
161 /* This is our video stream if we don't get a better offer */
162 video_stream_undefined_frame_rate = i;
167 /* Files from iTunes sometimes have two video streams, one with the avg_frame_rate.num and .den set
168 to zero. Only use such a stream if there is no alternative.
170 if (!_video_stream && video_stream_undefined_frame_rate) {
171 _video_stream = video_stream_undefined_frame_rate.get();
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 _video_frame = av_frame_alloc ();
197 if (_video_frame == nullptr) {
198 throw std::bad_alloc ();
204 FFmpeg::setup_decoders ()
206 boost::mutex::scoped_lock lm (_mutex);
208 _codec_context.resize (_format_context->nb_streams);
209 for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
210 auto codec = avcodec_find_decoder (_format_context->streams[i]->codecpar->codec_id);
212 auto context = avcodec_alloc_context3 (codec);
214 throw std::bad_alloc ();
216 _codec_context[i] = context;
218 int r = avcodec_parameters_to_context (context, _format_context->streams[i]->codecpar);
220 throw DecodeError ("avcodec_parameters_to_context", "FFmpeg::setup_decoders", r);
223 context->thread_count = 8;
224 context->thread_type = FF_THREAD_FRAME | FF_THREAD_SLICE;
226 AVDictionary* options = nullptr;
227 /* This option disables decoding of DCA frame footers in our patched version
228 of FFmpeg. I believe these footers are of no use to us, and they can cause
229 problems when FFmpeg fails to decode them (mantis #352).
231 av_dict_set (&options, "disable_footer", "1", 0);
232 /* This allows decoding of some DNxHR 444 and HQX files; see
233 https://trac.ffmpeg.org/ticket/5681
235 av_dict_set_int (&options, "strict", FF_COMPLIANCE_EXPERIMENTAL, 0);
236 /* Enable following of links in files */
237 av_dict_set_int (&options, "enable_drefs", 1, 0);
239 r = avcodec_open2 (context, codec, &options);
241 throw DecodeError (N_("avcodec_open2"), N_("FFmpeg::setup_decoders"), r);
244 dcpomatic_log->log (String::compose ("No codec found for stream %1", i), LogEntry::TYPE_WARNING);
251 FFmpeg::video_codec_context () const
253 if (!_video_stream) {
257 return _codec_context[_video_stream.get()];
262 FFmpeg::subtitle_codec_context () const
264 auto str = _ffmpeg_content->subtitle_stream();
269 return _codec_context[str->index(_format_context)];
274 FFmpeg::avio_read (uint8_t* buffer, int const amount)
276 auto result = _file_group.read(buffer, amount);
277 if (result.eof && result.bytes_read == 0) {
280 return result.bytes_read;
285 FFmpeg::avio_seek (int64_t const pos, int whence)
287 if (whence == AVSEEK_SIZE) {
288 return _file_group.length ();
291 return _file_group.seek (pos, whence);
296 FFmpeg::subtitle_period (AVPacket const* packet, AVStream const* stream, AVSubtitle const & sub)
298 auto const packet_time = ContentTime::from_seconds (packet->pts * av_q2d(stream->time_base));
299 auto const start = packet_time + ContentTime::from_seconds(sub.start_display_time / 1e3);
301 if (sub.end_display_time == 0 || sub.end_display_time == static_cast<uint32_t>(-1)) {
302 /* End time is not in the AVSubtitle; perhaps we can use the AVPacket's duration */
303 if (packet->duration) {
304 return FFmpegSubtitlePeriod(start, start + ContentTime::from_seconds(packet->duration * av_q2d(stream->time_base)));
306 return FFmpegSubtitlePeriod(start);
310 return FFmpegSubtitlePeriod (start, packet_time + ContentTime::from_seconds(sub.end_display_time / 1e3));
314 /** Compute the pts offset to use given a set of audio streams and some video details.
315 * Sometimes these parameters will have just been determined by an Examiner, sometimes
316 * they will have been retrieved from a piece of Content, hence the need for this method
320 FFmpeg::pts_offset (vector<shared_ptr<FFmpegAudioStream>> audio_streams, optional<ContentTime> first_video, double video_frame_rate) const
322 /* Audio and video frame PTS values may not start with 0. We want
323 to fiddle them so that:
325 1. One of them starts at time 0.
326 2. The first video PTS value ends up on a frame boundary.
328 Then we remove big initial gaps in PTS and we allow our
329 insertion of black frames to work.
332 audio_pts_to_use = audio_pts_from_ffmpeg + pts_offset;
333 video_pts_to_use = video_pts_from_ffmpeg + pts_offset;
336 /* First, make one of them start at 0 */
338 auto po = ContentTime::min ();
341 po = - first_video.get ();
344 for (auto i: audio_streams) {
345 if (i->first_audio) {
346 po = max (po, - i->first_audio.get ());
350 /* If the offset is positive we would be pushing things from a -ve PTS to be played.
351 I don't think we ever want to do that, as it seems things at -ve PTS are not meant
352 to be seen (use for alignment bars etc.); see mantis #418.
354 if (po > ContentTime ()) {
358 /* Now adjust so that the video pts starts on a frame */
360 auto const fvc = first_video.get() + po;
361 po += fvc.ceil (video_frame_rate) - fvc;
369 FFmpeg::audio_frame (shared_ptr<const FFmpegAudioStream> stream)
371 auto iter = _audio_frame.find(stream);
372 if (iter != _audio_frame.end()) {
376 auto frame = av_frame_alloc ();
377 if (frame == nullptr) {
378 throw std::bad_alloc();
381 _audio_frame[stream] = frame;