Remove out-of-date comment.
[dcpomatic.git] / src / lib / ffmpeg.cc
1 /*
2     Copyright (C) 2013-2015 Carl Hetherington <cth@carlh.net>
3
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.
8
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.
13
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.
17
18 */
19
20 #include "ffmpeg.h"
21 #include "ffmpeg_content.h"
22 #include "film.h"
23 #include "ffmpeg_audio_stream.h"
24 #include "ffmpeg_subtitle_stream.h"
25 #include "exceptions.h"
26 #include "util.h"
27 #include "raw_convert.h"
28 #include "log.h"
29 extern "C" {
30 #include <libavcodec/avcodec.h>
31 #include <libavformat/avformat.h>
32 #include <libswscale/swscale.h>
33 }
34 #include <boost/algorithm/string.hpp>
35
36 #include "i18n.h"
37
38 using std::string;
39 using std::cout;
40 using std::cerr;
41 using boost::shared_ptr;
42
43 boost::mutex FFmpeg::_mutex;
44 boost::weak_ptr<Log> FFmpeg::_ffmpeg_log;
45
46 FFmpeg::FFmpeg (boost::shared_ptr<const FFmpegContent> c)
47         : _ffmpeg_content (c)
48         , _avio_buffer (0)
49         , _avio_buffer_size (4096)
50         , _avio_context (0)
51         , _format_context (0)
52         , _frame (0)
53         , _video_stream (-1)
54 {
55         setup_general ();
56         setup_decoders ();
57 }
58
59 FFmpeg::~FFmpeg ()
60 {
61         boost::mutex::scoped_lock lm (_mutex);
62
63         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
64                 avcodec_close (_format_context->streams[i]->codec);
65         }
66
67         av_frame_free (&_frame);
68         avformat_close_input (&_format_context);
69 }
70
71 static int
72 avio_read_wrapper (void* data, uint8_t* buffer, int amount)
73 {
74         return reinterpret_cast<FFmpeg*>(data)->avio_read (buffer, amount);
75 }
76
77 static int64_t
78 avio_seek_wrapper (void* data, int64_t offset, int whence)
79 {
80         return reinterpret_cast<FFmpeg*>(data)->avio_seek (offset, whence);
81 }
82
83 void
84 FFmpeg::ffmpeg_log_callback (void* ptr, int level, const char* fmt, va_list vl)
85 {
86         if (level > AV_LOG_WARNING) {
87                 return;
88         }
89
90         char line[1024];
91         static int prefix = 0;
92         av_log_format_line (ptr, level, fmt, vl, line, sizeof (line), &prefix);
93         shared_ptr<Log> log = _ffmpeg_log.lock ();
94         if (log) {
95                 string str (line);
96                 boost::algorithm::trim (str);
97                 log->log (String::compose ("FFmpeg: %1", str), Log::TYPE_GENERAL);
98         } else {
99                 cerr << line;
100         }
101 }
102
103 void
104 FFmpeg::setup_general ()
105 {
106         av_register_all ();
107
108         /* This might not work too well in some cases of multiple FFmpeg decoders,
109            but it's probably good enough.
110         */
111         _ffmpeg_log = _ffmpeg_content->film()->log ();
112         av_log_set_callback (FFmpeg::ffmpeg_log_callback);
113
114         _file_group.set_paths (_ffmpeg_content->paths ());
115         _avio_buffer = static_cast<uint8_t*> (wrapped_av_malloc (_avio_buffer_size));
116         _avio_context = avio_alloc_context (_avio_buffer, _avio_buffer_size, 0, this, avio_read_wrapper, 0, avio_seek_wrapper);
117         _format_context = avformat_alloc_context ();
118         _format_context->pb = _avio_context;
119
120         AVDictionary* options = 0;
121         /* These durations are in microseconds, and represent how far into the content file
122            we will look for streams.
123         */
124         av_dict_set (&options, "analyzeduration", raw_convert<string> (5 * 60 * 1000000).c_str(), 0);
125         av_dict_set (&options, "probesize", raw_convert<string> (5 * 60 * 1000000).c_str(), 0);
126
127         if (avformat_open_input (&_format_context, 0, 0, &options) < 0) {
128                 throw OpenFileError (_ffmpeg_content->path(0).string ());
129         }
130
131         if (avformat_find_stream_info (_format_context, 0) < 0) {
132                 throw DecodeError (_("could not find stream information"));
133         }
134
135         /* Find video stream */
136
137         int video_stream_undefined_frame_rate = -1;
138
139         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
140                 AVStream* s = _format_context->streams[i];
141                 if (s->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
142                         if (s->avg_frame_rate.num > 0 && s->avg_frame_rate.den > 0) {
143                                 /* This is definitely our video stream */
144                                 _video_stream = i;
145                         } else {
146                                 /* This is our video stream if we don't get a better offer */
147                                 video_stream_undefined_frame_rate = i;
148                         }
149                 }
150         }
151
152         /* Files from iTunes sometimes have two video streams, one with the avg_frame_rate.num and .den set
153            to zero.  Only use such a stream if there is no alternative.
154         */
155         if (_video_stream == -1 && video_stream_undefined_frame_rate != -1) {
156                 _video_stream = video_stream_undefined_frame_rate;
157         }
158
159         if (_video_stream < 0) {
160                 throw DecodeError (N_("could not find video stream"));
161         }
162
163         /* Hack: if the AVStreams have duplicate IDs, replace them with our
164            own.  We use the IDs so that we can cope with VOBs, in which streams
165            move about in index but remain with the same ID in different
166            VOBs.  However, some files have duplicate IDs, hence this hack.
167         */
168
169         bool duplicates = false;
170         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
171                 for (uint32_t j = i + 1; j < _format_context->nb_streams; ++j) {
172                         if (_format_context->streams[i]->id == _format_context->streams[j]->id) {
173                                 duplicates = true;
174                         }
175                 }
176         }
177
178         if (duplicates) {
179                 /* Put in our own IDs */
180                 for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
181                         _format_context->streams[i]->id = i;
182                 }
183         }
184
185         _frame = av_frame_alloc ();
186         if (_frame == 0) {
187                 throw DecodeError (N_("could not allocate frame"));
188         }
189 }
190
191 void
192 FFmpeg::setup_decoders ()
193 {
194         boost::mutex::scoped_lock lm (_mutex);
195
196         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
197                 AVCodecContext* context = _format_context->streams[i]->codec;
198
199                 AVCodec* codec = avcodec_find_decoder (context->codec_id);
200                 if (codec) {
201
202                         /* This option disables decoding of DCA frame footers in our patched version
203                            of FFmpeg.  I believe these footers are of no use to us, and they can cause
204                            problems when FFmpeg fails to decode them (mantis #352).
205                         */
206                         AVDictionary* options = 0;
207                         av_dict_set (&options, "disable_footer", "1", 0);
208
209                         if (avcodec_open2 (context, codec, &options) < 0) {
210                                 throw DecodeError (N_("could not open decoder"));
211                         }
212                 }
213
214                 /* We are silently ignoring any failures to find suitable decoders here */
215         }
216 }
217
218 AVCodecContext *
219 FFmpeg::video_codec_context () const
220 {
221         return _format_context->streams[_video_stream]->codec;
222 }
223
224 AVCodecContext *
225 FFmpeg::subtitle_codec_context () const
226 {
227         if (!_ffmpeg_content->subtitle_stream ()) {
228                 return 0;
229         }
230
231         return _ffmpeg_content->subtitle_stream()->stream(_format_context)->codec;
232 }
233
234 int
235 FFmpeg::avio_read (uint8_t* buffer, int const amount)
236 {
237         return _file_group.read (buffer, amount);
238 }
239
240 int64_t
241 FFmpeg::avio_seek (int64_t const pos, int whence)
242 {
243         if (whence == AVSEEK_SIZE) {
244                 return _file_group.length ();
245         }
246
247         return _file_group.seek (pos, whence);
248 }