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