Allow build using Ubuntu 12.04 repos.
[dcpomatic.git] / src / lib / 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/decoder.cc
21  *  @brief Parent class for decoders of content.
22  */
23
24 #include <iostream>
25 #include <stdint.h>
26 extern "C" {
27 #include <libavfilter/avfiltergraph.h>
28 #include <libavfilter/buffersrc.h>
29 #if (LIBAVFILTER_VERSION_MAJOR == 2 && LIBAVFILTER_VERSION_MINOR >= 53 && LIBAVFILTER_VERSION_MINOR <= 77) || LIBAVFILTER_VERSION_MAJOR == 3
30 #include <libavfilter/avcodec.h>
31 #include <libavfilter/buffersink.h>
32 #elif LIBAVFILTER_VERSION_MAJOR == 2 && LIBAVFILTER_VERSION_MINOR == 15
33 #include <libavfilter/vsrc_buffer.h>
34 #endif
35 #include <libavformat/avio.h>
36 }
37 #include "film.h"
38 #include "format.h"
39 #include "job.h"
40 #include "film_state.h"
41 #include "options.h"
42 #include "exceptions.h"
43 #include "image.h"
44 #include "util.h"
45 #include "log.h"
46 #include "decoder.h"
47 #include "filter.h"
48 #include "delay_line.h"
49 #include "ffmpeg_compatibility.h"
50
51 using namespace std;
52 using namespace boost;
53
54 /** @param s FilmState of the Film.
55  *  @param o Options.
56  *  @param j Job that we are running within, or 0
57  *  @param l Log to use.
58  *  @param minimal true to do the bare minimum of work; just run through the content.  Useful for acquiring
59  *  accurate frame counts as quickly as possible.  This generates no video or audio output.
60  *  @param ignore_length Ignore the content's claimed length when computing progress.
61  */
62 Decoder::Decoder (boost::shared_ptr<const FilmState> s, boost::shared_ptr<const Options> o, Job* j, Log* l, bool minimal, bool ignore_length)
63         : _fs (s)
64         , _opt (o)
65         , _job (j)
66         , _log (l)
67         , _minimal (minimal)
68         , _ignore_length (ignore_length)
69         , _video_frame (0)
70         , _buffer_src_context (0)
71         , _buffer_sink_context (0)
72 #if HAVE_SWRESAMPLE       
73         , _swr_context (0)
74 #endif    
75         , _have_setup_video_filters (false)
76         , _delay_line (0)
77         , _delay_in_bytes (0)
78         , _audio_frames_processed (0)
79 {
80         if (_opt->decode_video_frequency != 0 && _fs->length == 0) {
81                 throw DecodeError ("cannot do a partial decode if length == 0");
82         }
83 }
84
85 Decoder::~Decoder ()
86 {
87         delete _delay_line;
88 }
89
90 void
91 Decoder::process_begin ()
92 {
93         if (_fs->audio_sample_rate != dcp_audio_sample_rate (_fs->audio_sample_rate)) {
94 #if HAVE_SWRESAMPLE             
95                 _swr_context = swr_alloc_set_opts (
96                         0,
97                         audio_channel_layout(),
98                         audio_sample_format(),
99                         dcp_audio_sample_rate (_fs->audio_sample_rate),
100                         audio_channel_layout(),
101                         audio_sample_format(),
102                         _fs->audio_sample_rate,
103                         0, 0
104                         );
105                 
106                 swr_init (_swr_context);
107 #else
108                 throw DecodeError ("Cannot resample audio as libswresample is not present");
109 #endif          
110         } else {
111 #if HAVE_SWRESAMPLE             
112                 _swr_context = 0;
113 #endif          
114         }
115
116         _delay_in_bytes = _fs->audio_delay * _fs->audio_sample_rate * _fs->audio_channels * _fs->bytes_per_sample() / 1000;
117         delete _delay_line;
118         _delay_line = new DelayLine (_delay_in_bytes);
119
120         _audio_frames_processed = 0;
121 }
122
123 void
124 Decoder::process_end ()
125 {
126 #if HAVE_SWRESAMPLE     
127         if (_swr_context) {
128
129                 int mop = 0;
130                 while (1) {
131                         uint8_t buffer[256 * _fs->bytes_per_sample() * _fs->audio_channels];
132                         uint8_t* out[1] = {
133                                 buffer
134                         };
135
136                         int const frames = swr_convert (_swr_context, out, 256, 0, 0);
137
138                         if (frames < 0) {
139                                 throw DecodeError ("could not run sample-rate converter");
140                         }
141
142                         if (frames == 0) {
143                                 break;
144                         }
145
146                         mop += frames;
147                         int available = _delay_line->feed (buffer, frames * _fs->audio_channels * _fs->bytes_per_sample());
148                         Audio (buffer, available);
149                 }
150
151                 swr_free (&_swr_context);
152         }
153 #endif  
154         
155         if (_delay_in_bytes < 0) {
156                 uint8_t remainder[-_delay_in_bytes];
157                 _delay_line->get_remaining (remainder);
158                 _audio_frames_processed += _delay_in_bytes / (_fs->audio_channels * _fs->bytes_per_sample());
159                 Audio (remainder, _delay_in_bytes);
160         }
161
162         /* If we cut the decode off, the audio may be short; push some silence
163            in to get it to the right length.
164         */
165
166         int const audio_short_by_frames =
167                 (decoding_frames() * dcp_audio_sample_rate (_fs->audio_sample_rate) / _fs->frames_per_second)
168                 - _audio_frames_processed;
169
170         int bytes = audio_short_by_frames * _fs->audio_channels * _fs->bytes_per_sample();
171
172         int const silence_size = 64 * 1024;
173         uint8_t silence[silence_size];
174         memset (silence, 0, silence_size);
175
176         while (bytes) {
177                 int const t = min (bytes, silence_size);
178                 Audio (silence, t);
179                 bytes -= t;
180         }
181 }
182
183 /** Start decoding */
184 void
185 Decoder::go ()
186 {
187         process_begin ();
188
189         if (_job && _ignore_length) {
190                 _job->set_progress_unknown ();
191         }
192
193         while (pass () == false) {
194                 if (_job && !_ignore_length) {
195                         _job->set_progress (float (_video_frame) / decoding_frames ());
196                 }
197         }
198
199         process_end ();
200 }
201
202 /** @return Number of frames that we will be decoding */
203 int
204 Decoder::decoding_frames () const
205 {
206         if (_opt->num_frames > 0) {
207                 return _opt->num_frames;
208         }
209         
210         return _fs->length;
211 }
212
213 /** Run one pass.  This may or may not generate any actual video / audio data;
214  *  some decoders may require several passes to generate a single frame.
215  *  @return true if we have finished processing all data; otherwise false.
216  */
217 bool
218 Decoder::pass ()
219 {
220         if (!_have_setup_video_filters) {
221                 setup_video_filters ();
222                 _have_setup_video_filters = true;
223         }
224         
225         if (_opt->num_frames != 0 && _video_frame >= _opt->num_frames) {
226                 return true;
227         }
228
229         return do_pass ();
230 }
231
232 /** Called by subclasses to tell the world that some audio data is ready
233  *  @param data Interleaved audio data, in FilmState::audio_sample_format.
234  *  @param size Number of bytes of data.
235  */
236 void
237 Decoder::process_audio (uint8_t* data, int size)
238 {
239         /* Here's samples per channel */
240         int const samples = size / _fs->bytes_per_sample();
241
242 #if HAVE_SWRESAMPLE     
243         /* And here's frames (where 1 frame is a collection of samples, 1 for each channel,
244            so for 5.1 a frame would be 6 samples)
245         */
246         int const frames = samples / _fs->audio_channels;
247 #endif  
248
249         /* Maybe apply gain */
250         if (_fs->audio_gain != 0) {
251                 float const linear_gain = pow (10, _fs->audio_gain / 20);
252                 uint8_t* p = data;
253                 switch (_fs->audio_sample_format) {
254                 case AV_SAMPLE_FMT_S16:
255                         for (int i = 0; i < samples; ++i) {
256                                 /* XXX: assumes little-endian; also we should probably be dithering here */
257
258                                 /* unsigned sample */
259                                 int const ou = p[0] | (p[1] << 8);
260
261                                 /* signed sample */
262                                 int const os = ou >= 0x8000 ? (- 0x10000 + ou) : ou;
263
264                                 /* signed sample with altered gain */
265                                 int const gs = int (os * linear_gain);
266
267                                 /* unsigned sample with altered gain */
268                                 int const gu = gs > 0 ? gs : (0x10000 + gs);
269
270                                 /* write it back */
271                                 p[0] = gu & 0xff;
272                                 p[1] = (gu & 0xff00) >> 8;
273                                 p += 2;
274                         }
275                         break;
276                 default:
277                         assert (false);
278                 }
279         }
280
281         /* This is a buffer we might use if we are sample-rate converting;
282            it will need freeing if so.
283         */
284         uint8_t* out_buffer = 0;
285
286         /* Maybe sample-rate convert */
287 #if HAVE_SWRESAMPLE     
288         if (_swr_context) {
289
290                 uint8_t const * in[2] = {
291                         data,
292                         0
293                 };
294
295                 /* Compute the resampled frame count and add 32 for luck */
296                 int const out_buffer_size_frames = ceil (frames * float (dcp_audio_sample_rate (_fs->audio_sample_rate)) / _fs->audio_sample_rate) + 32;
297                 int const out_buffer_size_bytes = out_buffer_size_frames * _fs->audio_channels * _fs->bytes_per_sample();
298                 out_buffer = new uint8_t[out_buffer_size_bytes];
299
300                 uint8_t* out[2] = {
301                         out_buffer, 
302                         0
303                 };
304
305                 /* Resample audio */
306                 int out_frames = swr_convert (_swr_context, out, out_buffer_size_frames, in, frames);
307                 if (out_frames < 0) {
308                         throw DecodeError ("could not run sample-rate converter");
309                 }
310
311                 /* And point our variables at the resampled audio */
312                 data = out_buffer;
313                 size = out_frames * _fs->audio_channels * _fs->bytes_per_sample();
314         }
315 #endif  
316                 
317         /* Update the number of audio frames we've pushed to the encoder */
318         _audio_frames_processed += size / (_fs->audio_channels * _fs->bytes_per_sample ());
319
320         /* Push into the delay line and then tell the world what we've got */
321         int available = _delay_line->feed (data, size);
322         Audio (data, available);
323
324         /* Delete the sample-rate conversion buffer, if it exists */
325         delete[] out_buffer;
326 }
327
328 /** Called by subclasses to tell the world that some video data is ready.
329  *  We do some post-processing / filtering then emit it for listeners.
330  *  @param frame to decode; caller manages memory.
331  */
332 void
333 Decoder::process_video (AVFrame* frame)
334 {
335         if (_minimal) {
336                 ++_video_frame;
337                 return;
338         }
339
340         /* Use FilmState::length here as our one may be wrong */
341
342         int gap = 0;
343         if (_opt->decode_video_frequency != 0) {
344                 gap = _fs->length / _opt->decode_video_frequency;
345         }
346
347         if (_opt->decode_video_frequency != 0 && gap != 0 && (_video_frame % gap) != 0) {
348                 ++_video_frame;
349                 return;
350         }
351
352 #if LIBAVFILTER_VERSION_MAJOR == 2 && LIBAVFILTER_VERSION_MINOR >= 53 && LIBAVFILTER_VERSION_MINOR <= 61
353
354         if (av_vsrc_buffer_add_frame (_buffer_src_context, frame, 0) < 0) {
355                 throw DecodeError ("could not push buffer into filter chain.");
356         }
357
358 #elif LIBAVFILTER_VERSION_MAJOR == 2 && LIBAVFILTER_VERSION_MINOR == 15
359
360         AVRational par;
361         par.num = sample_aspect_ratio_numerator ();
362         par.den = sample_aspect_ratio_denominator ();
363
364         if (av_vsrc_buffer_add_frame (_buffer_src_context, frame, 0, par) < 0) {
365                 throw DecodeError ("could not push buffer into filter chain.");
366         }
367
368 #else
369
370         if (av_buffersrc_write_frame (_buffer_src_context, frame) < 0) {
371                 throw DecodeError ("could not push buffer into filter chain.");
372         }
373
374 #endif  
375         
376 #if LIBAVFILTER_VERSION_MAJOR == 2 && LIBAVFILTER_VERSION_MINOR >= 15 && LIBAVFILTER_VERSION_MINOR <= 61        
377         while (avfilter_poll_frame (_buffer_sink_context->inputs[0])) {
378 #else
379         while (av_buffersink_read (_buffer_sink_context, 0)) {
380 #endif          
381
382 #if LIBAVFILTER_VERSION_MAJOR == 2 && LIBAVFILTER_VERSION_MINOR >= 15
383                 
384                 int r = avfilter_request_frame (_buffer_sink_context->inputs[0]);
385                 if (r < 0) {
386                         throw DecodeError ("could not request filtered frame");
387                 }
388                 
389                 AVFilterBufferRef* filter_buffer = _buffer_sink_context->inputs[0]->cur_buf;
390                 
391 #else
392
393                 AVFilterBufferRef* filter_buffer;
394                 if (av_buffersink_get_buffer_ref (_buffer_sink_context, &filter_buffer, 0) < 0) {
395                         filter_buffer = 0;
396                 }
397
398 #endif          
399                 
400                 if (filter_buffer) {
401                         /* This takes ownership of filter_buffer */
402                         shared_ptr<Image> image (new FilterBufferImage ((PixelFormat) frame->format, filter_buffer));
403
404                         if (_opt->black_after > 0 && _video_frame > _opt->black_after) {
405                                 image->make_black ();
406                         }
407
408                         Video (image, _video_frame);
409                         ++_video_frame;
410                 }
411         }
412 }
413
414
415 /** Set up a video filtering chain to include cropping and any filters that are specified
416  *  by the Film.
417  */
418 void
419 Decoder::setup_video_filters ()
420 {
421         stringstream fs;
422         Size size_after_crop;
423         
424         if (_opt->apply_crop) {
425                 size_after_crop = _fs->cropped_size (native_size ());
426                 fs << crop_string (Position (_fs->crop.left, _fs->crop.top), size_after_crop);
427         } else {
428                 size_after_crop = native_size ();
429                 fs << crop_string (Position (0, 0), size_after_crop);
430         }
431
432         string filters = Filter::ffmpeg_strings (_fs->filters).first;
433         if (!filters.empty ()) {
434                 filters += ",";
435         }
436
437         filters += fs.str ();
438
439         avfilter_register_all ();
440         
441         AVFilterGraph* graph = avfilter_graph_alloc();
442         if (graph == 0) {
443                 throw DecodeError ("Could not create filter graph.");
444         }
445
446         AVFilter* buffer_src = avfilter_get_by_name("buffer");
447         if (buffer_src == 0) {
448                 throw DecodeError ("Could not find buffer src filter");
449         }
450
451         AVFilter* buffer_sink = get_sink ();
452
453         stringstream a;
454         a << native_size().width << ":"
455           << native_size().height << ":"
456           << pixel_format() << ":"
457           << time_base_numerator() << ":"
458           << time_base_denominator() << ":"
459           << sample_aspect_ratio_numerator() << ":"
460           << sample_aspect_ratio_denominator();
461
462         int r;
463         if ((r = avfilter_graph_create_filter (&_buffer_src_context, buffer_src, "in", a.str().c_str(), 0, graph)) < 0) {
464                 throw DecodeError ("could not create buffer source");
465         }
466
467         enum PixelFormat pixel_formats[] = { pixel_format(), PIX_FMT_NONE };
468         if (avfilter_graph_create_filter (&_buffer_sink_context, buffer_sink, "out", 0, pixel_formats, graph) < 0) {
469                 throw DecodeError ("could not create buffer sink.");
470         }
471
472         AVFilterInOut* outputs = avfilter_inout_alloc ();
473         outputs->name = av_strdup("in");
474         outputs->filter_ctx = _buffer_src_context;
475         outputs->pad_idx = 0;
476         outputs->next = 0;
477
478         AVFilterInOut* inputs = avfilter_inout_alloc ();
479         inputs->name = av_strdup("out");
480         inputs->filter_ctx = _buffer_sink_context;
481         inputs->pad_idx = 0;
482         inputs->next = 0;
483
484         _log->log ("Using filter chain `" + filters + "'");
485
486 #if LIBAVFILTER_VERSION_MAJOR == 2 && LIBAVFILTER_VERSION_MINOR == 15
487         if (avfilter_graph_parse (graph, filters.c_str(), inputs, outputs, 0) < 0) {
488                 throw DecodeError ("could not set up filter graph.");
489         }
490 #else   
491         if (avfilter_graph_parse (graph, filters.c_str(), &inputs, &outputs, 0) < 0) {
492                 throw DecodeError ("could not set up filter graph.");
493         }
494 #endif  
495         
496         if (avfilter_graph_config (graph, 0) < 0) {
497                 throw DecodeError ("could not configure filter graph.");
498         }
499
500         /* XXX: leaking `inputs' / `outputs' ? */
501 }
502