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 #ifndef DVDOMATIC_FFMPEG_0_8_3
30 #include <libavfilter/avcodec.h>
31 #include <libavfilter/buffersink.h>
33 #include <libavformat/avio.h>
38 #include "film_state.h"
40 #include "exceptions.h"
46 #include "delay_line.h"
47 #include "ffmpeg_compatibility.h"
50 using namespace boost;
52 /** @param s FilmState of the Film.
54 * @param j Job that we are running within, or 0
55 * @param l Log to use.
56 * @param minimal true to do the bare minimum of work; just run through the content. Useful for acquiring
57 * accurate frame counts as quickly as possible. This generates no video or audio output.
58 * @param ignore_length Ignore the content's claimed length when computing progress.
60 Decoder::Decoder (boost::shared_ptr<const FilmState> s, boost::shared_ptr<const Options> o, Job* j, Log* l, bool minimal, bool ignore_length)
66 , _ignore_length (ignore_length)
68 , _buffer_src_context (0)
69 , _buffer_sink_context (0)
71 , _have_setup_video_filters (false)
74 , _audio_frames_processed (0)
76 if (_opt->decode_video_frequency != 0 && _fs->length == 0) {
77 throw DecodeError ("cannot do a partial decode if length == 0");
87 Decoder::process_begin ()
89 if (_fs->audio_sample_rate != dcp_audio_sample_rate (_fs->audio_sample_rate)) {
90 _swr_context = swr_alloc_set_opts (
92 audio_channel_layout(),
93 audio_sample_format(),
94 dcp_audio_sample_rate (_fs->audio_sample_rate),
95 audio_channel_layout(),
96 audio_sample_format(),
97 _fs->audio_sample_rate,
101 swr_init (_swr_context);
106 _delay_in_bytes = _fs->audio_delay * _fs->audio_sample_rate * _fs->audio_channels * _fs->bytes_per_sample() / 1000;
108 _delay_line = new DelayLine (_delay_in_bytes);
110 _audio_frames_processed = 0;
114 Decoder::process_end ()
120 uint8_t buffer[256 * _fs->bytes_per_sample() * _fs->audio_channels];
125 int const frames = swr_convert (_swr_context, out, 256, 0, 0);
128 throw DecodeError ("could not run sample-rate converter");
136 int available = _delay_line->feed (buffer, frames * _fs->audio_channels * _fs->bytes_per_sample());
137 Audio (buffer, available);
140 cout << "mopped up " << mop << "\n";
142 swr_free (&_swr_context);
145 if (_delay_in_bytes < 0) {
146 uint8_t remainder[-_delay_in_bytes];
147 _delay_line->get_remaining (remainder);
148 _audio_frames_processed += _delay_in_bytes / (_fs->audio_channels * _fs->bytes_per_sample());
149 Audio (remainder, _delay_in_bytes);
152 /* If we cut the decode off, the audio may be short; push some silence
153 in to get it to the right length.
156 int const audio_short_by_frames =
157 (decoding_frames() * dcp_audio_sample_rate (_fs->audio_sample_rate) / _fs->frames_per_second)
158 - _audio_frames_processed;
160 int bytes = audio_short_by_frames * _fs->audio_channels * _fs->bytes_per_sample();
162 int const silence_size = 64 * 1024;
163 uint8_t silence[silence_size];
164 memset (silence, 0, silence_size);
167 int const t = min (bytes, silence_size);
173 /** Start decoding */
179 if (_job && _ignore_length) {
180 _job->set_progress_unknown ();
183 while (pass () == false) {
184 if (_job && !_ignore_length) {
185 _job->set_progress (float (_video_frame) / decoding_frames ());
192 /** @return Number of frames that we will be decoding */
194 Decoder::decoding_frames () const
196 if (_opt->num_frames > 0) {
197 return _opt->num_frames;
203 /** Run one pass. This may or may not generate any actual video / audio data;
204 * some decoders may require several passes to generate a single frame.
205 * @return true if we have finished processing all data; otherwise false.
210 if (!_have_setup_video_filters) {
211 setup_video_filters ();
212 _have_setup_video_filters = true;
215 if (_opt->num_frames != 0 && _video_frame >= _opt->num_frames) {
222 /** Called by subclasses to tell the world that some audio data is ready
223 * @param data Interleaved audio data, in FilmState::audio_sample_format.
224 * @param size Number of bytes of data.
227 Decoder::process_audio (uint8_t* data, int size)
229 /* Here's samples per channel */
230 int const samples = size / _fs->bytes_per_sample();
232 /* And here's frames (where 1 frame is a collection of samples, 1 for each channel,
233 so for 5.1 a frame would be 6 samples)
235 int const frames = samples / _fs->audio_channels;
237 /* Maybe apply gain */
238 if (_fs->audio_gain != 0) {
239 float const linear_gain = pow (10, _fs->audio_gain / 20);
241 switch (_fs->audio_sample_format) {
242 case AV_SAMPLE_FMT_S16:
243 for (int i = 0; i < samples; ++i) {
244 /* XXX: assumes little-endian; also we should probably be dithering here */
246 /* unsigned sample */
247 int const ou = p[0] | (p[1] << 8);
250 int const os = ou >= 0x8000 ? (- 0x10000 + ou) : ou;
252 /* signed sample with altered gain */
253 int const gs = int (os * linear_gain);
255 /* unsigned sample with altered gain */
256 int const gu = gs > 0 ? gs : (0x10000 + gs);
260 p[1] = (gu & 0xff00) >> 8;
269 /* This is a buffer we might use if we are sample-rate converting;
270 it will need freeing if so.
272 uint8_t* out_buffer = 0;
274 /* Maybe sample-rate convert */
277 uint8_t const * in[2] = {
282 /* Compute the resampled frame count and add 32 for luck */
283 int const out_buffer_size_frames = ceil (frames * float (dcp_audio_sample_rate (_fs->audio_sample_rate)) / _fs->audio_sample_rate) + 32;
284 int const out_buffer_size_bytes = out_buffer_size_frames * _fs->audio_channels * _fs->bytes_per_sample();
285 out_buffer = new uint8_t[out_buffer_size_bytes];
293 int out_frames = swr_convert (_swr_context, out, out_buffer_size_frames, in, frames);
294 if (out_frames < 0) {
295 throw DecodeError ("could not run sample-rate converter");
298 /* And point our variables at the resampled audio */
300 size = out_frames * _fs->audio_channels * _fs->bytes_per_sample();
303 /* Update the number of audio frames we've pushed to the encoder */
304 _audio_frames_processed += size / (_fs->audio_channels * _fs->bytes_per_sample ());
306 /* Push into the delay line and then tell the world what we've got */
307 int available = _delay_line->feed (data, size);
308 Audio (data, available);
310 /* Delete the sample-rate conversion buffer, if it exists */
314 /** Called by subclasses to tell the world that some video data is ready.
315 * We do some post-processing / filtering then emit it for listeners.
316 * @param frame to decode; caller manages memory.
319 Decoder::process_video (AVFrame* frame)
326 /* Use FilmState::length here as our one may be wrong */
329 if (_opt->decode_video_frequency != 0) {
330 gap = _fs->length / _opt->decode_video_frequency;
333 if (_opt->decode_video_frequency != 0 && gap != 0 && (_video_frame % gap) != 0) {
338 #ifdef DVDOMATIC_FFMPEG_0_8_3
341 par.num = sample_aspect_ratio_numerator ();
342 par.den = sample_aspect_ratio_denominator ();
344 if (av_vsrc_buffer_add_frame (_buffer_src_context, frame, 0, par) < 0) {
345 throw DecodeError ("could not push buffer into filter chain.");
350 if (av_buffersrc_write_frame (_buffer_src_context, frame) < 0) {
351 throw DecodeError ("could not push buffer into filter chain.");
356 #ifdef DVDOMATIC_FFMPEG_0_8_3
357 while (avfilter_poll_frame (_buffer_sink_context->inputs[0])) {
359 while (av_buffersink_read (_buffer_sink_context, 0)) {
362 #ifdef DVDOMATIC_FFMPEG_0_8_3
364 int r = avfilter_request_frame (_buffer_sink_context->inputs[0]);
366 throw DecodeError ("could not request filtered frame");
369 AVFilterBufferRef* filter_buffer = _buffer_sink_context->inputs[0]->cur_buf;
373 AVFilterBufferRef* filter_buffer;
374 if (av_buffersink_get_buffer_ref (_buffer_sink_context, &filter_buffer, 0) < 0) {
381 /* This takes ownership of filter_buffer */
382 shared_ptr<Image> image (new FilterBufferImage ((PixelFormat) frame->format, filter_buffer));
384 if (_opt->black_after > 0 && _video_frame > _opt->black_after) {
385 image->make_black ();
388 Video (image, _video_frame);
395 /** Set up a video filtering chain to include cropping and any filters that are specified
399 Decoder::setup_video_filters ()
402 Size size_after_crop;
404 if (_opt->apply_crop) {
405 size_after_crop = _fs->cropped_size (native_size ());
406 fs << crop_string (Position (_fs->left_crop, _fs->top_crop), size_after_crop);
408 size_after_crop = native_size ();
409 fs << crop_string (Position (0, 0), size_after_crop);
412 string filters = Filter::ffmpeg_strings (_fs->filters).first;
413 if (!filters.empty ()) {
417 filters += fs.str ();
419 avfilter_register_all ();
421 AVFilterGraph* graph = avfilter_graph_alloc();
423 throw DecodeError ("Could not create filter graph.");
426 AVFilter* buffer_src = avfilter_get_by_name("buffer");
427 if (buffer_src == 0) {
428 throw DecodeError ("Could not find buffer src filter");
431 AVFilter* buffer_sink = get_sink ();
434 a << native_size().width << ":"
435 << native_size().height << ":"
436 << pixel_format() << ":"
437 << time_base_numerator() << ":"
438 << time_base_denominator() << ":"
439 << sample_aspect_ratio_numerator() << ":"
440 << sample_aspect_ratio_denominator();
443 if ((r = avfilter_graph_create_filter (&_buffer_src_context, buffer_src, "in", a.str().c_str(), 0, graph)) < 0) {
444 throw DecodeError ("could not create buffer source");
447 enum PixelFormat pixel_formats[] = { pixel_format(), PIX_FMT_NONE };
448 if (avfilter_graph_create_filter (&_buffer_sink_context, buffer_sink, "out", 0, pixel_formats, graph) < 0) {
449 throw DecodeError ("could not create buffer sink.");
452 AVFilterInOut* outputs = avfilter_inout_alloc ();
453 outputs->name = av_strdup("in");
454 outputs->filter_ctx = _buffer_src_context;
455 outputs->pad_idx = 0;
458 AVFilterInOut* inputs = avfilter_inout_alloc ();
459 inputs->name = av_strdup("out");
460 inputs->filter_ctx = _buffer_sink_context;
464 _log->log ("Using filter chain `" + filters + "'");
465 #ifdef DVDOMATIC_FFMPEG_0_8_3
466 if (avfilter_graph_parse (graph, filters.c_str(), inputs, outputs, 0) < 0) {
468 if (avfilter_graph_parse (graph, filters.c_str(), &inputs, &outputs, 0) < 0) {
471 throw DecodeError ("could not set up filter graph.");
474 if (avfilter_graph_config (graph, 0) < 0) {
475 throw DecodeError ("could not configure filter graph.");
478 /* XXX: leaking `inputs' / `outputs' ? */