Clean up subtitle classes a bit.
[dcpomatic.git] / src / lib / ffmpeg_decoder.cc
1 /*
2     Copyright (C) 2012 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 /** @file  src/ffmpeg_decoder.cc
21  *  @brief A decoder using FFmpeg to decode content.
22  */
23
24 #include <stdexcept>
25 #include <vector>
26 #include <sstream>
27 #include <iomanip>
28 #include <iostream>
29 #include <stdint.h>
30 #include <boost/lexical_cast.hpp>
31 extern "C" {
32 #include <tiffio.h>
33 #include <libavcodec/avcodec.h>
34 #include <libavformat/avformat.h>
35 #include <libswscale/swscale.h>
36 #include <libpostproc/postprocess.h>
37 }
38 #include <sndfile.h>
39 #include "film.h"
40 #include "format.h"
41 #include "transcoder.h"
42 #include "job.h"
43 #include "filter.h"
44 #include "film_state.h"
45 #include "options.h"
46 #include "exceptions.h"
47 #include "image.h"
48 #include "util.h"
49 #include "log.h"
50 #include "ffmpeg_decoder.h"
51 #include "subtitle.h"
52
53 using namespace std;
54 using namespace boost;
55
56 FFmpegDecoder::FFmpegDecoder (boost::shared_ptr<const FilmState> s, boost::shared_ptr<const Options> o, Job* j, Log* l, bool minimal, bool ignore_length)
57         : Decoder (s, o, j, l, minimal, ignore_length)
58         , _format_context (0)
59         , _video_stream (-1)
60         , _audio_stream (-1)
61         , _subtitle_stream (-1)
62         , _frame (0)
63         , _video_codec_context (0)
64         , _video_codec (0)
65         , _audio_codec_context (0)
66         , _audio_codec (0)
67         , _subtitle_codec_context (0)
68         , _subtitle_codec (0)
69 {
70         setup_general ();
71         setup_video ();
72         setup_audio ();
73         setup_subtitle ();
74 }
75
76 FFmpegDecoder::~FFmpegDecoder ()
77 {
78         if (_audio_codec_context) {
79                 avcodec_close (_audio_codec_context);
80         }
81         
82         if (_video_codec_context) {
83                 avcodec_close (_video_codec_context);
84         }
85
86         if (_subtitle_codec_context) {
87                 avcodec_close (_subtitle_codec_context);
88         }
89         
90         av_free (_frame);
91         avformat_close_input (&_format_context);
92 }       
93
94 void
95 FFmpegDecoder::setup_general ()
96 {
97         int r;
98         
99         av_register_all ();
100
101         if ((r = avformat_open_input (&_format_context, _fs->content_path().c_str(), 0, 0)) != 0) {
102                 throw OpenFileError (_fs->content_path ());
103         }
104
105         if (avformat_find_stream_info (_format_context, 0) < 0) {
106                 throw DecodeError ("could not find stream information");
107         }
108
109         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
110                 if (_format_context->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
111                         _video_stream = i;
112                 } else if (_format_context->streams[i]->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
113                         _audio_stream = i;
114                 } else if (_format_context->streams[i]->codec->codec_type == AVMEDIA_TYPE_SUBTITLE) {
115                         _subtitle_stream = i;
116                 }
117         }
118
119         if (_video_stream < 0) {
120                 throw DecodeError ("could not find video stream");
121         }
122
123         _frame = avcodec_alloc_frame ();
124         if (_frame == 0) {
125                 throw DecodeError ("could not allocate frame");
126         }
127 }
128
129 void
130 FFmpegDecoder::setup_video ()
131 {
132         _video_codec_context = _format_context->streams[_video_stream]->codec;
133         _video_codec = avcodec_find_decoder (_video_codec_context->codec_id);
134
135         if (_video_codec == 0) {
136                 throw DecodeError ("could not find video decoder");
137         }
138         
139         if (avcodec_open2 (_video_codec_context, _video_codec, 0) < 0) {
140                 throw DecodeError ("could not open video decoder");
141         }
142 }
143
144 void
145 FFmpegDecoder::setup_audio ()
146 {
147         if (_audio_stream < 0) {
148                 return;
149         }
150         
151         _audio_codec_context = _format_context->streams[_audio_stream]->codec;
152         _audio_codec = avcodec_find_decoder (_audio_codec_context->codec_id);
153
154         if (_audio_codec == 0) {
155                 throw DecodeError ("could not find audio decoder");
156         }
157
158         if (avcodec_open2 (_audio_codec_context, _audio_codec, 0) < 0) {
159                 throw DecodeError ("could not open audio decoder");
160         }
161
162         /* This is a hack; sometimes it seems that _audio_codec_context->channel_layout isn't set up,
163            so bodge it here.  No idea why we should have to do this.
164         */
165
166         if (_audio_codec_context->channel_layout == 0) {
167                 _audio_codec_context->channel_layout = av_get_default_channel_layout (audio_channels ());
168         }
169 }
170
171 void
172 FFmpegDecoder::setup_subtitle ()
173 {
174         if (_subtitle_stream < 0) {
175                 return;
176         }
177
178         _subtitle_codec_context = _format_context->streams[_subtitle_stream]->codec;
179         _subtitle_codec = avcodec_find_decoder (_subtitle_codec_context->codec_id);
180
181         if (_subtitle_codec == 0) {
182                 throw DecodeError ("could not find subtitle decoder");
183         }
184         
185         if (avcodec_open2 (_subtitle_codec_context, _subtitle_codec, 0) < 0) {
186                 throw DecodeError ("could not open subtitle decoder");
187         }
188 }
189
190
191 bool
192 FFmpegDecoder::do_pass ()
193 {
194         int r = av_read_frame (_format_context, &_packet);
195         if (r < 0) {
196                 if (r != AVERROR_EOF) {
197                         throw DecodeError ("error on av_read_frame");
198                 }
199                 
200                 /* Get any remaining frames */
201                 
202                 _packet.data = 0;
203                 _packet.size = 0;
204
205                 int frame_finished;
206
207                 while (avcodec_decode_video2 (_video_codec_context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
208                         process_video (_frame);
209                 }
210
211                 if (_audio_stream >= 0 && _opt->decode_audio) {
212                         while (avcodec_decode_audio4 (_audio_codec_context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
213                                 int const data_size = av_samples_get_buffer_size (
214                                         0, _audio_codec_context->channels, _frame->nb_samples, audio_sample_format (), 1
215                                         );
216                                 
217                                 assert (_audio_codec_context->channels == _fs->audio_channels);
218                                 process_audio (_frame->data[0], data_size);
219                         }
220                 }
221
222                 return true;
223         }
224
225         if (_packet.stream_index == _video_stream) {
226
227                 int frame_finished;
228                 if (avcodec_decode_video2 (_video_codec_context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
229                         process_video (_frame);
230                 }
231
232         } else if (_audio_stream >= 0 && _packet.stream_index == _audio_stream && _opt->decode_audio) {
233                 
234                 avcodec_get_frame_defaults (_frame);
235                 
236                 int frame_finished;
237                 if (avcodec_decode_audio4 (_audio_codec_context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
238                         int const data_size = av_samples_get_buffer_size (
239                                 0, _audio_codec_context->channels, _frame->nb_samples, audio_sample_format (), 1
240                                 );
241
242                         assert (_audio_codec_context->channels == _fs->audio_channels);
243                         process_audio (_frame->data[0], data_size);
244                 }
245
246         } else if (_subtitle_stream >= 0 && _packet.stream_index == _subtitle_stream && _opt->decode_subtitles) {
247
248                 int got_subtitle;
249                 AVSubtitle sub;
250                 if (avcodec_decode_subtitle2 (_subtitle_codec_context, &sub, &got_subtitle, &_packet) && got_subtitle) {
251                         process_subtitle (shared_ptr<TimedSubtitle> (new TimedSubtitle (sub)));
252                         avsubtitle_free (&sub);
253                 }
254         }
255         
256         av_free_packet (&_packet);
257         return false;
258 }
259
260 int
261 FFmpegDecoder::length_in_frames () const
262 {
263         return (_format_context->duration / AV_TIME_BASE) * frames_per_second ();
264 }
265
266 float
267 FFmpegDecoder::frames_per_second () const
268 {
269         AVStream* s = _format_context->streams[_video_stream];
270
271         if (s->avg_frame_rate.num && s->avg_frame_rate.den) {
272                 return av_q2d (s->avg_frame_rate);
273         }
274
275         return av_q2d (s->r_frame_rate);
276 }
277
278 int
279 FFmpegDecoder::audio_channels () const
280 {
281         if (_audio_codec_context == 0) {
282                 return 0;
283         }
284
285         return _audio_codec_context->channels;
286 }
287
288 int
289 FFmpegDecoder::audio_sample_rate () const
290 {
291         if (_audio_codec_context == 0) {
292                 return 0;
293         }
294         
295         return _audio_codec_context->sample_rate;
296 }
297
298 AVSampleFormat
299 FFmpegDecoder::audio_sample_format () const
300 {
301         if (_audio_codec_context == 0) {
302                 return (AVSampleFormat) 0;
303         }
304         
305         return _audio_codec_context->sample_fmt;
306 }
307
308 int64_t
309 FFmpegDecoder::audio_channel_layout () const
310 {
311         if (_audio_codec_context == 0) {
312                 return 0;
313         }
314         
315         return _audio_codec_context->channel_layout;
316 }
317
318 Size
319 FFmpegDecoder::native_size () const
320 {
321         return Size (_video_codec_context->width, _video_codec_context->height);
322 }
323
324 PixelFormat
325 FFmpegDecoder::pixel_format () const
326 {
327         return _video_codec_context->pix_fmt;
328 }
329
330 int
331 FFmpegDecoder::time_base_numerator () const
332 {
333         return _video_codec_context->time_base.num;
334 }
335
336 int
337 FFmpegDecoder::time_base_denominator () const
338 {
339         return _video_codec_context->time_base.den;
340 }
341
342 int
343 FFmpegDecoder::sample_aspect_ratio_numerator () const
344 {
345         return _video_codec_context->sample_aspect_ratio.num;
346 }
347
348 int
349 FFmpegDecoder::sample_aspect_ratio_denominator () const
350 {
351         return _video_codec_context->sample_aspect_ratio.den;
352 }
353
354 bool
355 FFmpegDecoder::has_subtitles () const
356 {
357         return (_subtitle_stream != -1);
358 }