Make subtitle addition optional.
[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
52 using namespace std;
53 using namespace boost;
54
55 FFmpegDecoder::FFmpegDecoder (boost::shared_ptr<const FilmState> s, boost::shared_ptr<const Options> o, Job* j, Log* l, bool minimal, bool ignore_length)
56         : Decoder (s, o, j, l, minimal, ignore_length)
57         , _format_context (0)
58         , _video_stream (-1)
59         , _audio_stream (-1)
60         , _subtitle_stream (-1)
61         , _frame (0)
62         , _video_codec_context (0)
63         , _video_codec (0)
64         , _audio_codec_context (0)
65         , _audio_codec (0)
66         , _subtitle_codec_context (0)
67         , _subtitle_codec (0)
68         , _have_subtitle (false)
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 (_have_subtitle) {
87                 avsubtitle_free (&_subtitle);
88         }
89
90         if (_subtitle_codec_context) {
91                 avcodec_close (_subtitle_codec_context);
92         }
93         
94         av_free (_frame);
95         avformat_close_input (&_format_context);
96 }       
97
98 void
99 FFmpegDecoder::setup_general ()
100 {
101         int r;
102         
103         av_register_all ();
104
105         if ((r = avformat_open_input (&_format_context, _fs->content_path().c_str(), 0, 0)) != 0) {
106                 throw OpenFileError (_fs->content_path ());
107         }
108
109         if (avformat_find_stream_info (_format_context, 0) < 0) {
110                 throw DecodeError ("could not find stream information");
111         }
112
113         for (uint32_t i = 0; i < _format_context->nb_streams; ++i) {
114                 if (_format_context->streams[i]->codec->codec_type == AVMEDIA_TYPE_VIDEO) {
115                         _video_stream = i;
116                 } else if (_format_context->streams[i]->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
117                         _audio_stream = i;
118                 } else if (_format_context->streams[i]->codec->codec_type == AVMEDIA_TYPE_SUBTITLE) {
119                         _subtitle_stream = i;
120                 }
121         }
122
123         if (_video_stream < 0) {
124                 throw DecodeError ("could not find video stream");
125         }
126
127         _frame = avcodec_alloc_frame ();
128         if (_frame == 0) {
129                 throw DecodeError ("could not allocate frame");
130         }
131 }
132
133 void
134 FFmpegDecoder::setup_video ()
135 {
136         _video_codec_context = _format_context->streams[_video_stream]->codec;
137         _video_codec = avcodec_find_decoder (_video_codec_context->codec_id);
138
139         if (_video_codec == 0) {
140                 throw DecodeError ("could not find video decoder");
141         }
142         
143         if (avcodec_open2 (_video_codec_context, _video_codec, 0) < 0) {
144                 throw DecodeError ("could not open video decoder");
145         }
146 }
147
148 void
149 FFmpegDecoder::setup_audio ()
150 {
151         if (_audio_stream < 0) {
152                 return;
153         }
154         
155         _audio_codec_context = _format_context->streams[_audio_stream]->codec;
156         _audio_codec = avcodec_find_decoder (_audio_codec_context->codec_id);
157
158         if (_audio_codec == 0) {
159                 throw DecodeError ("could not find audio decoder");
160         }
161
162         if (avcodec_open2 (_audio_codec_context, _audio_codec, 0) < 0) {
163                 throw DecodeError ("could not open audio decoder");
164         }
165
166         /* This is a hack; sometimes it seems that _audio_codec_context->channel_layout isn't set up,
167            so bodge it here.  No idea why we should have to do this.
168         */
169
170         if (_audio_codec_context->channel_layout == 0) {
171                 _audio_codec_context->channel_layout = av_get_default_channel_layout (audio_channels ());
172         }
173 }
174
175 void
176 FFmpegDecoder::setup_subtitle ()
177 {
178         if (_subtitle_stream < 0) {
179                 return;
180         }
181
182         _subtitle_codec_context = _format_context->streams[_subtitle_stream]->codec;
183         _subtitle_codec = avcodec_find_decoder (_subtitle_codec_context->codec_id);
184
185         if (_subtitle_codec == 0) {
186                 throw DecodeError ("could not find subtitle decoder");
187         }
188         
189         if (avcodec_open2 (_subtitle_codec_context, _subtitle_codec, 0) < 0) {
190                 throw DecodeError ("could not open subtitle decoder");
191         }
192 }
193
194
195 bool
196 FFmpegDecoder::do_pass ()
197 {
198         int r = av_read_frame (_format_context, &_packet);
199         if (r < 0) {
200                 if (r != AVERROR_EOF) {
201                         throw DecodeError ("error on av_read_frame");
202                 }
203                 
204                 /* Get any remaining frames */
205                 
206                 _packet.data = 0;
207                 _packet.size = 0;
208
209                 int frame_finished;
210
211                 if (_opt->decode_video) {
212                         while (avcodec_decode_video2 (_video_codec_context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
213                                 process_video (_frame);
214                         }
215                 }
216
217                 if (_audio_stream >= 0 && _opt->decode_audio) {
218                         while (avcodec_decode_audio4 (_audio_codec_context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
219                                 int const data_size = av_samples_get_buffer_size (
220                                         0, _audio_codec_context->channels, _frame->nb_samples, audio_sample_format (), 1
221                                         );
222                                 
223                                 assert (_audio_codec_context->channels == _fs->audio_channels);
224                                 process_audio (_frame->data[0], data_size);
225                         }
226                 }
227
228                 return true;
229         }
230
231         if (_packet.stream_index == _video_stream && _opt->decode_video) {
232
233                 int frame_finished;
234                 if (avcodec_decode_video2 (_video_codec_context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
235                         process_video (_frame);
236                 }
237
238         } else if (_audio_stream >= 0 && _packet.stream_index == _audio_stream && _opt->decode_audio) {
239                 
240                 avcodec_get_frame_defaults (_frame);
241                 
242                 int frame_finished;
243                 if (avcodec_decode_audio4 (_audio_codec_context, _frame, &frame_finished, &_packet) >= 0 && frame_finished) {
244                         int const data_size = av_samples_get_buffer_size (
245                                 0, _audio_codec_context->channels, _frame->nb_samples, audio_sample_format (), 1
246                                 );
247
248                         assert (_audio_codec_context->channels == _fs->audio_channels);
249                         process_audio (_frame->data[0], data_size);
250                 }
251
252         } else if (_subtitle_stream >= 0 && _packet.stream_index == _subtitle_stream && _fs->with_subtitles) {
253
254                 if (_have_subtitle) {
255                         avsubtitle_free (&_subtitle);
256                         _have_subtitle = false;
257                 }
258
259                 int got_subtitle;
260                 if (avcodec_decode_subtitle2 (_subtitle_codec_context, &_subtitle, &got_subtitle, &_packet) && got_subtitle) {
261                         _have_subtitle = true;
262                 }
263         }
264         
265         av_free_packet (&_packet);
266         return false;
267 }
268
269 int
270 FFmpegDecoder::length_in_frames () const
271 {
272         return (_format_context->duration / AV_TIME_BASE) * frames_per_second ();
273 }
274
275 float
276 FFmpegDecoder::frames_per_second () const
277 {
278         return av_q2d (_format_context->streams[_video_stream]->avg_frame_rate);
279 }
280
281 int
282 FFmpegDecoder::audio_channels () const
283 {
284         if (_audio_codec_context == 0) {
285                 return 0;
286         }
287
288         return _audio_codec_context->channels;
289 }
290
291 int
292 FFmpegDecoder::audio_sample_rate () const
293 {
294         if (_audio_codec_context == 0) {
295                 return 0;
296         }
297         
298         return _audio_codec_context->sample_rate;
299 }
300
301 AVSampleFormat
302 FFmpegDecoder::audio_sample_format () const
303 {
304         if (_audio_codec_context == 0) {
305                 return (AVSampleFormat) 0;
306         }
307         
308         return _audio_codec_context->sample_fmt;
309 }
310
311 int64_t
312 FFmpegDecoder::audio_channel_layout () const
313 {
314         if (_audio_codec_context == 0) {
315                 return 0;
316         }
317         
318         return _audio_codec_context->channel_layout;
319 }
320
321 Size
322 FFmpegDecoder::native_size () const
323 {
324         return Size (_video_codec_context->width, _video_codec_context->height);
325 }
326
327 PixelFormat
328 FFmpegDecoder::pixel_format () const
329 {
330         return _video_codec_context->pix_fmt;
331 }
332
333 int
334 FFmpegDecoder::time_base_numerator () const
335 {
336         return _video_codec_context->time_base.num;
337 }
338
339 int
340 FFmpegDecoder::time_base_denominator () const
341 {
342         return _video_codec_context->time_base.den;
343 }
344
345 int
346 FFmpegDecoder::sample_aspect_ratio_numerator () const
347 {
348         return _video_codec_context->sample_aspect_ratio.num;
349 }
350
351 int
352 FFmpegDecoder::sample_aspect_ratio_denominator () const
353 {
354         return _video_codec_context->sample_aspect_ratio.den;
355 }
356
357 void
358 FFmpegDecoder::overlay (shared_ptr<Image> image) const
359 {
360         if (!_have_subtitle) {
361                 return;
362         }
363         
364         /* subtitle PTS in seconds */
365         float const packet_time = (_subtitle.pts / AV_TIME_BASE) + float (_subtitle.pts % AV_TIME_BASE) / 1e6;
366         /* hence start time for this sub */
367         float const from = packet_time + (float (_subtitle.start_display_time) / 1e3);
368         float const to = packet_time + (float (_subtitle.end_display_time) / 1e3);
369         
370         float const video_frame_time = float (last_video_frame ()) / rint (_fs->frames_per_second);
371
372         if (from > video_frame_time || video_frame_time < to) {
373                 return;
374         }
375
376         for (unsigned int i = 0; i < _subtitle.num_rects; ++i) {
377                 AVSubtitleRect* rect = _subtitle.rects[i];
378                 if (rect->type != SUBTITLE_BITMAP) {
379                         throw DecodeError ("non-bitmap subtitles not yet supported");
380                 }
381
382                 /* XXX: all this assumes YUV420 in image */
383                 
384                 assert (rect->pict.data[0]);
385
386                 /* Start of the first line in the target image */
387                 uint8_t* frame_y_p = image->data()[0] + rect->y * image->line_size()[0];
388                 uint8_t* frame_u_p = image->data()[1] + (rect->y / 2) * image->line_size()[1];
389                 uint8_t* frame_v_p = image->data()[2] + (rect->y / 2) * image->line_size()[2];
390
391                 int const hlim = min (rect->y + rect->h, image->size().height) - rect->y;
392                 
393                 /* Start of the first line in the subtitle */
394                 uint8_t* sub_p = rect->pict.data[0];
395                 /* sub_p looks up into a RGB palette which is here */
396                 uint32_t const * palette = (uint32_t *) rect->pict.data[1];
397                 
398                 for (int sub_y = 0; sub_y < hlim; ++sub_y) {
399                         /* Pointers to the start of this line */
400                         uint8_t* sub_line_p = sub_p;
401                         uint8_t* frame_line_y_p = frame_y_p + rect->x;
402                         uint8_t* frame_line_u_p = frame_u_p + (rect->x / 2);
403                         uint8_t* frame_line_v_p = frame_v_p + (rect->x / 2);
404                         
405                         /* U and V are subsampled */
406                         uint8_t next_u = 0;
407                         uint8_t next_v = 0;
408                         int subsample_step = 0;
409                         
410                         for (int sub_x = 0; sub_x < rect->w; ++sub_x) {
411                                 
412                                 /* RGB value for this subtitle pixel */
413                                 uint32_t const val = palette[*sub_line_p++];
414                                 
415                                 int const     red =  (val &       0xff);
416                                 int const   green =  (val &     0xff00) >> 8;
417                                 int const    blue =  (val &   0xff0000) >> 16;
418                                 float const alpha = ((val & 0xff000000) >> 24) / 255.0;
419                                 
420                                 /* Alpha-blend Y */
421                                 int const cy = *frame_line_y_p;
422                                 *frame_line_y_p++ = int (cy * (1 - alpha)) + int (RGB_TO_Y_CCIR (red, green, blue) * alpha);
423                                 
424                                 /* Store up U and V */
425                                 next_u |= ((RGB_TO_U_CCIR (red, green, blue, 0) & 0xf0) >> 4) << (4 * subsample_step);
426                                 next_v |= ((RGB_TO_V_CCIR (red, green, blue, 0) & 0xf0) >> 4) << (4 * subsample_step);
427                                 
428                                 if (subsample_step == 1 && (sub_y % 2) == 0) {
429                                         int const cu = *frame_line_u_p;
430                                         int const cv = *frame_line_v_p;
431
432                                         *frame_line_u_p++ =
433                                                 int (((cu & 0x0f) * (1 - alpha) + (next_u & 0x0f) * alpha)) |
434                                                 int (((cu & 0xf0) * (1 - alpha) + (next_u & 0xf0) * alpha));
435
436                                         *frame_line_v_p++ = 
437                                                 int (((cv & 0x0f) * (1 - alpha) + (next_v & 0x0f) * alpha)) |
438                                                 int (((cv & 0xf0) * (1 - alpha) + (next_v & 0xf0) * alpha));
439                                         
440                                         next_u = next_v = 0;
441                                 }
442                                 
443                                 subsample_step = (subsample_step + 1) % 2;
444                         }
445                         
446                         sub_p += rect->pict.linesize[0];
447                         frame_y_p += image->line_size()[0];
448                         if ((sub_y % 2) == 0) {
449                                 frame_u_p += image->line_size()[1];
450                                 frame_v_p += image->line_size()[2];
451                         }
452                 }
453         }
454 }
455     
456 bool
457 FFmpegDecoder::has_subtitles () const
458 {
459         return (_subtitle_stream != -1);
460 }