2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
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.
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.
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.
20 /** @file src/decoder.cc
21 * @brief Parent class for decoders of content.
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>
35 #include <libavformat/avio.h>
40 #include "film_state.h"
42 #include "exceptions.h"
48 #include "delay_line.h"
49 #include "ffmpeg_compatibility.h"
52 using namespace boost;
54 /** @param s FilmState of the Film.
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.
62 Decoder::Decoder (boost::shared_ptr<const FilmState> s, boost::shared_ptr<const Options> o, Job* j, Log* l, bool minimal, bool ignore_length)
68 , _ignore_length (ignore_length)
70 , _buffer_src_context (0)
71 , _buffer_sink_context (0)
75 , _have_setup_video_filters (false)
78 , _audio_frames_processed (0)
80 if (_opt->decode_video_frequency != 0 && _fs->length == 0) {
81 throw DecodeError ("cannot do a partial decode if length == 0");
90 /** Start off a decode processing run */
92 Decoder::process_begin ()
94 if (_fs->audio_sample_rate != dcp_audio_sample_rate (_fs->audio_sample_rate)) {
96 _swr_context = swr_alloc_set_opts (
98 audio_channel_layout(),
99 audio_sample_format(),
100 dcp_audio_sample_rate (_fs->audio_sample_rate),
101 audio_channel_layout(),
102 audio_sample_format(),
103 _fs->audio_sample_rate,
107 swr_init (_swr_context);
109 throw DecodeError ("Cannot resample audio as libswresample is not present");
117 _delay_in_bytes = _fs->audio_delay * _fs->audio_sample_rate * _fs->audio_channels * _fs->bytes_per_sample() / 1000;
119 _delay_line = new DelayLine (_delay_in_bytes);
121 _audio_frames_processed = 0;
124 /** Finish off a decode processing run */
126 Decoder::process_end ()
133 uint8_t buffer[256 * _fs->bytes_per_sample() * _fs->audio_channels];
138 int const frames = swr_convert (_swr_context, out, 256, 0, 0);
141 throw DecodeError ("could not run sample-rate converter");
149 int available = _delay_line->feed (buffer, frames * _fs->audio_channels * _fs->bytes_per_sample());
150 Audio (buffer, available);
153 swr_free (&_swr_context);
157 if (_delay_in_bytes < 0) {
158 uint8_t remainder[-_delay_in_bytes];
159 _delay_line->get_remaining (remainder);
160 _audio_frames_processed += _delay_in_bytes / (_fs->audio_channels * _fs->bytes_per_sample());
161 Audio (remainder, _delay_in_bytes);
164 /* If we cut the decode off, the audio may be short; push some silence
165 in to get it to the right length.
168 int64_t const audio_short_by_frames =
169 ((int64_t) decoding_frames() * dcp_audio_sample_rate (_fs->audio_sample_rate) / _fs->frames_per_second)
170 - _audio_frames_processed;
172 if (audio_short_by_frames >= 0) {
173 int bytes = audio_short_by_frames * _fs->audio_channels * _fs->bytes_per_sample();
175 int const silence_size = 64 * 1024;
176 uint8_t silence[silence_size];
177 memset (silence, 0, silence_size);
180 int const t = min (bytes, silence_size);
187 /** Start decoding */
193 if (_job && _ignore_length) {
194 _job->set_progress_unknown ();
197 while (pass () == false) {
198 if (_job && !_ignore_length) {
199 _job->set_progress (float (_video_frame) / decoding_frames ());
206 /** @return Number of frames that we will be decoding */
208 Decoder::decoding_frames () const
210 if (_opt->num_frames > 0) {
211 return _opt->num_frames;
217 /** Run one pass. This may or may not generate any actual video / audio data;
218 * some decoders may require several passes to generate a single frame.
219 * @return true if we have finished processing all data; otherwise false.
224 if (!_have_setup_video_filters) {
225 setup_video_filters ();
226 _have_setup_video_filters = true;
229 if (_opt->num_frames != 0 && _video_frame >= _opt->num_frames) {
236 /** Called by subclasses to tell the world that some audio data is ready
237 * @param data Interleaved audio data, in FilmState::audio_sample_format.
238 * @param size Number of bytes of data.
241 Decoder::process_audio (uint8_t* data, int size)
243 /* Here's samples per channel */
244 int const samples = size / _fs->bytes_per_sample();
247 /* And here's frames (where 1 frame is a collection of samples, 1 for each channel,
248 so for 5.1 a frame would be 6 samples)
250 int const frames = samples / _fs->audio_channels;
253 /* Maybe apply gain */
254 if (_fs->audio_gain != 0) {
255 float const linear_gain = pow (10, _fs->audio_gain / 20);
257 switch (_fs->audio_sample_format) {
258 case AV_SAMPLE_FMT_S16:
259 for (int i = 0; i < samples; ++i) {
260 /* XXX: assumes little-endian; also we should probably be dithering here */
262 /* unsigned sample */
263 int const ou = p[0] | (p[1] << 8);
266 int const os = ou >= 0x8000 ? (- 0x10000 + ou) : ou;
268 /* signed sample with altered gain */
269 int const gs = int (os * linear_gain);
271 /* unsigned sample with altered gain */
272 int const gu = gs > 0 ? gs : (0x10000 + gs);
276 p[1] = (gu & 0xff00) >> 8;
285 /* This is a buffer we might use if we are sample-rate converting;
286 it will need freeing if so.
288 uint8_t* out_buffer = 0;
290 /* Maybe sample-rate convert */
294 uint8_t const * in[2] = {
299 /* Compute the resampled frame count and add 32 for luck */
300 int const out_buffer_size_frames = ceil (frames * float (dcp_audio_sample_rate (_fs->audio_sample_rate)) / _fs->audio_sample_rate) + 32;
301 int const out_buffer_size_bytes = out_buffer_size_frames * _fs->audio_channels * _fs->bytes_per_sample();
302 out_buffer = new uint8_t[out_buffer_size_bytes];
310 int out_frames = swr_convert (_swr_context, out, out_buffer_size_frames, in, frames);
311 if (out_frames < 0) {
312 throw DecodeError ("could not run sample-rate converter");
315 /* And point our variables at the resampled audio */
317 size = out_frames * _fs->audio_channels * _fs->bytes_per_sample();
321 /* Update the number of audio frames we've pushed to the encoder */
322 _audio_frames_processed += size / (_fs->audio_channels * _fs->bytes_per_sample ());
324 /* Push into the delay line and then tell the world what we've got */
325 int available = _delay_line->feed (data, size);
326 Audio (data, available);
328 /* Delete the sample-rate conversion buffer, if it exists */
332 /** Called by subclasses to tell the world that some video data is ready.
333 * We do some post-processing / filtering then emit it for listeners.
334 * @param frame to decode; caller manages memory.
337 Decoder::process_video (AVFrame* frame)
344 /* Use FilmState::length here as our one may be wrong */
347 if (_opt->decode_video_frequency != 0) {
348 gap = _fs->length / _opt->decode_video_frequency;
351 if (_opt->decode_video_frequency != 0 && gap != 0 && (_video_frame % gap) != 0) {
356 #if LIBAVFILTER_VERSION_MAJOR == 2 && LIBAVFILTER_VERSION_MINOR >= 53 && LIBAVFILTER_VERSION_MINOR <= 61
358 if (av_vsrc_buffer_add_frame (_buffer_src_context, frame, 0) < 0) {
359 throw DecodeError ("could not push buffer into filter chain.");
362 #elif LIBAVFILTER_VERSION_MAJOR == 2 && LIBAVFILTER_VERSION_MINOR == 15
365 par.num = sample_aspect_ratio_numerator ();
366 par.den = sample_aspect_ratio_denominator ();
368 if (av_vsrc_buffer_add_frame (_buffer_src_context, frame, 0, par) < 0) {
369 throw DecodeError ("could not push buffer into filter chain.");
374 if (av_buffersrc_write_frame (_buffer_src_context, frame) < 0) {
375 throw DecodeError ("could not push buffer into filter chain.");
380 #if LIBAVFILTER_VERSION_MAJOR == 2 && LIBAVFILTER_VERSION_MINOR >= 15 && LIBAVFILTER_VERSION_MINOR <= 61
381 while (avfilter_poll_frame (_buffer_sink_context->inputs[0])) {
383 while (av_buffersink_read (_buffer_sink_context, 0)) {
386 #if LIBAVFILTER_VERSION_MAJOR == 2 && LIBAVFILTER_VERSION_MINOR >= 15
388 int r = avfilter_request_frame (_buffer_sink_context->inputs[0]);
390 throw DecodeError ("could not request filtered frame");
393 AVFilterBufferRef* filter_buffer = _buffer_sink_context->inputs[0]->cur_buf;
397 AVFilterBufferRef* filter_buffer;
398 if (av_buffersink_get_buffer_ref (_buffer_sink_context, &filter_buffer, 0) < 0) {
405 /* This takes ownership of filter_buffer */
406 shared_ptr<Image> image (new FilterBufferImage ((PixelFormat) frame->format, filter_buffer));
408 if (_opt->black_after > 0 && _video_frame > _opt->black_after) {
409 image->make_black ();
412 Video (image, _video_frame);
419 /** Set up a video filtering chain to include cropping and any filters that are specified
423 Decoder::setup_video_filters ()
426 Size size_after_crop;
428 if (_opt->apply_crop) {
429 size_after_crop = _fs->cropped_size (native_size ());
430 fs << crop_string (Position (_fs->crop.left, _fs->crop.top), size_after_crop);
432 size_after_crop = native_size ();
433 fs << crop_string (Position (0, 0), size_after_crop);
436 string filters = Filter::ffmpeg_strings (_fs->filters).first;
437 if (!filters.empty ()) {
441 filters += fs.str ();
443 avfilter_register_all ();
445 AVFilterGraph* graph = avfilter_graph_alloc();
447 throw DecodeError ("Could not create filter graph.");
450 AVFilter* buffer_src = avfilter_get_by_name("buffer");
451 if (buffer_src == 0) {
452 throw DecodeError ("Could not find buffer src filter");
455 AVFilter* buffer_sink = get_sink ();
458 a << native_size().width << ":"
459 << native_size().height << ":"
460 << pixel_format() << ":"
461 << time_base_numerator() << ":"
462 << time_base_denominator() << ":"
463 << sample_aspect_ratio_numerator() << ":"
464 << sample_aspect_ratio_denominator();
468 if ((r = avfilter_graph_create_filter (&_buffer_src_context, buffer_src, "in", a.str().c_str(), 0, graph)) < 0) {
469 throw DecodeError ("could not create buffer source");
472 AVBufferSinkParams* sink_params = av_buffersink_params_alloc ();
473 PixelFormat* pixel_fmts = new PixelFormat[2];
474 pixel_fmts[0] = pixel_format ();
475 pixel_fmts[1] = PIX_FMT_NONE;
476 sink_params->pixel_fmts = pixel_fmts;
478 if (avfilter_graph_create_filter (&_buffer_sink_context, buffer_sink, "out", 0, sink_params, graph) < 0) {
479 throw DecodeError ("could not create buffer sink.");
482 AVFilterInOut* outputs = avfilter_inout_alloc ();
483 outputs->name = av_strdup("in");
484 outputs->filter_ctx = _buffer_src_context;
485 outputs->pad_idx = 0;
488 AVFilterInOut* inputs = avfilter_inout_alloc ();
489 inputs->name = av_strdup("out");
490 inputs->filter_ctx = _buffer_sink_context;
494 _log->log ("Using filter chain `" + filters + "'");
496 #if LIBAVFILTER_VERSION_MAJOR == 2 && LIBAVFILTER_VERSION_MINOR == 15
497 if (avfilter_graph_parse (graph, filters.c_str(), inputs, outputs, 0) < 0) {
498 throw DecodeError ("could not set up filter graph.");
501 if (avfilter_graph_parse (graph, filters.c_str(), &inputs, &outputs, 0) < 0) {
502 throw DecodeError ("could not set up filter graph.");
506 if (avfilter_graph_config (graph, 0) < 0) {
507 throw DecodeError ("could not configure filter graph.");
510 /* XXX: leaking `inputs' / `outputs' ? */