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 #include "film.h"
  28 #include "format.h"
  29 #include "job.h"
  30 #include "options.h"
  31 #include "exceptions.h"
  32 #include "image.h"
  33 #include "util.h"
  34 #include "log.h"
  35 #include "decoder.h"
  36 #include "delay_line.h"
  37 #include "subtitle.h"
  38 #include "filter_graph.h"
  39
  40 using std::string;
  41 using std::stringstream;
  42 using std::min;
  43 using std::list;
  44 using boost::shared_ptr;
  45
  46 /** @param f Film.
  47  *  @param o Options.
  48  *  @param j Job that we are running within, or 0
  49  *  @param minimal true to do the bare minimum of work; just run through the content.  Useful for acquiring
  50  *  accurate frame counts as quickly as possible.  This generates no video or audio output.
  51  *  @param ignore_length Ignore the content's claimed length when computing progress.
  52  */
  53 Decoder::Decoder (boost::shared_ptr<Film> f, boost::shared_ptr<const Options> o, Job* j, bool minimal, bool ignore_length)
  54         : _film (f)
  55         , _opt (o)
  56         , _job (j)
  57         , _minimal (minimal)
  58         , _ignore_length (ignore_length)
  59         , _video_frame_index (0)
  60         , _delay_line (0)
  61         , _delay_in_bytes (0)
  62         , _audio_frames_processed (0)
  63 {
  64
  65 }
  66
  67 Decoder::~Decoder ()
  68 {
  69         delete _delay_line;
  70 }
  71
  72 /** Start off a decode processing run */
  73 void
  74 Decoder::process_begin ()
  75 {
  76         _delay_in_bytes = _film->audio_delay() * audio_sample_rate() * audio_channels() * bytes_per_audio_sample() / 1000;
  77         delete _delay_line;
  78         _delay_line = new DelayLine (_delay_in_bytes);
  79
  80         _audio_frames_processed = 0;
  81 }
  82
  83 /** Finish off a decode processing run */
  84 void
  85 Decoder::process_end ()
  86 {
  87         if (_delay_in_bytes < 0) {
  88                 uint8_t remainder[-_delay_in_bytes];
  89                 _delay_line->get_remaining (remainder);
  90                 _audio_frames_processed += _delay_in_bytes / (audio_channels() * bytes_per_audio_sample());
  91                 emit_audio (remainder, -_delay_in_bytes);
  92         }
  93
  94         /* If we cut the decode off, the audio may be short; push some silence
  95            in to get it to the right length.
  96         */
  97
  98         int64_t const video_length_in_audio_frames = ((int64_t) video_frame_index() * audio_sample_rate() / frames_per_second());
  99         int64_t const audio_short_by_frames = video_length_in_audio_frames - _audio_frames_processed;
 100
 101         _film->log()->log (
 102                 String::compose ("Source length is %1 (%2 audio frames); %3 frames of audio processed.",
 103                                  video_frame_index(),
 104                                  video_length_in_audio_frames,
 105                                  _audio_frames_processed)
 106                 );
 107
 108         if (audio_short_by_frames >= 0 && _opt->decode_audio) {
 109
 110                 _film->log()->log (String::compose ("Source length is %1; %2 frames of audio processed.", video_frame_index(), _audio_frames_processed));
 111                 _film->log()->log (String::compose ("Adding %1 frames of silence to the end.", audio_short_by_frames));
 112
 113                 /* XXX: this is slightly questionable; does memset () give silence with all
 114                    sample formats?
 115                 */
 116
 117                 int64_t bytes = audio_short_by_frames * _film->audio_channels() * bytes_per_audio_sample();
 118
 119                 int64_t const silence_size = 16 * 1024 * _film->audio_channels() * bytes_per_audio_sample();
 120                 uint8_t silence[silence_size];
 121                 memset (silence, 0, silence_size);
 122
 123                 while (bytes) {
 124                         int64_t const t = min (bytes, silence_size);
 125                         emit_audio (silence, t);
 126                         bytes -= t;
 127                 }
 128         }
 129 }
 130
 131 /** Start decoding */
 132 void
 133 Decoder::go ()
 134 {
 135         process_begin ();
 136
 137         if (_job && !_film->dcp_length()) {
 138                 _job->set_progress_unknown ();
 139         }
 140
 141         while (pass () == false) {
 142                 if (_job && _film->dcp_length()) {
 143                         _job->set_progress (float ((_video_frame_index - _film->dcp_trim_start())) / _film->dcp_length().get());
 144                 }
 145         }
 146
 147         process_end ();
 148 }
 149
 150 /** Called by subclasses to tell the world that some audio data is ready
 151  *  @param data Audio data, in Film::audio_sample_format.
 152  *  @param size Number of bytes of data.
 153  */
 154 void
 155 Decoder::process_audio (uint8_t* data, int size)
 156 {
 157         /* Push into the delay line */
 158         size = _delay_line->feed (data, size);
 159
 160         emit_audio (data, size);
 161 }
 162
 163 void
 164 Decoder::emit_audio (uint8_t* data, int size)
 165 {
 166         if (size == 0) {
 167                 return;
 168         }
 169
 170         assert (_film->audio_channels());
 171         assert (bytes_per_audio_sample());
 172
 173         /* Deinterleave and convert to float */
 174
 175         assert ((size % (bytes_per_audio_sample() * audio_channels())) == 0);
 176
 177         int const total_samples = size / bytes_per_audio_sample();
 178         int const frames = total_samples / _film->audio_channels();
 179         shared_ptr<AudioBuffers> audio (new AudioBuffers (audio_channels(), frames));
 180
 181         switch (audio_sample_format()) {
 182         case AV_SAMPLE_FMT_S16:
 183         {
 184                 int16_t* p = (int16_t *) data;
 185                 int sample = 0;
 186                 int channel = 0;
 187                 for (int i = 0; i < total_samples; ++i) {
 188                         audio->data(channel)[sample] = float(*p++) / (1 << 15);
 189
 190                         ++channel;
 191                         if (channel == _film->audio_channels()) {
 192                                 channel = 0;
 193                                 ++sample;
 194                         }
 195                 }
 196         }
 197         break;
 198
 199         case AV_SAMPLE_FMT_S32:
 200         {
 201                 int32_t* p = (int32_t *) data;
 202                 int sample = 0;
 203                 int channel = 0;
 204                 for (int i = 0; i < total_samples; ++i) {
 205                         audio->data(channel)[sample] = float(*p++) / (1 << 31);
 206
 207                         ++channel;
 208                         if (channel == _film->audio_channels()) {
 209                                 channel = 0;
 210                                 ++sample;
 211                         }
 212                 }
 213         }
 214
 215         case AV_SAMPLE_FMT_FLTP:
 216         {
 217                 float* p = reinterpret_cast<float*> (data);
 218                 for (int i = 0; i < _film->audio_channels(); ++i) {
 219                         memcpy (audio->data(i), p, frames * sizeof(float));
 220                         p += frames;
 221                 }
 222         }
 223         break;
 224
 225         default:
 226                 assert (false);
 227         }
 228
 229         /* Maybe apply gain */
 230         if (_film->audio_gain() != 0) {
 231                 float const linear_gain = pow (10, _film->audio_gain() / 20);
 232                 for (int i = 0; i < _film->audio_channels(); ++i) {
 233                         for (int j = 0; j < frames; ++j) {
 234                                 audio->data(i)[j] *= linear_gain;
 235                         }
 236                 }
 237         }
 238
 239         /* Update the number of audio frames we've pushed to the encoder */
 240         _audio_frames_processed += audio->frames ();
 241
 242         Audio (audio);
 243 }
 244
 245 /** Called by subclasses to tell the world that some video data is ready.
 246  *  We do some post-processing / filtering then emit it for listeners.
 247  *  @param frame to decode; caller manages memory.
 248  */
 249 void
 250 Decoder::process_video (AVFrame* frame)
 251 {
 252         assert (_ignore_length || _film->length());
 253
 254         if (_minimal) {
 255                 ++_video_frame_index;
 256                 return;
 257         }
 258
 259         /* Use Film::length here as our one may be wrong */
 260
 261         if (_opt->decode_video_skip != 0 && (_video_frame_index % _opt->decode_video_skip) != 0) {
 262                 ++_video_frame_index;
 263                 return;
 264         }
 265
 266         if (_film->dcp_trim_start() > _video_frame_index || (_film->length().get() - _film->dcp_trim_end()) < _video_frame_index) {
 267                 ++_video_frame_index;
 268                 return;
 269         }
 270
 271         shared_ptr<FilterGraph> graph;
 272
 273         list<shared_ptr<FilterGraph> >::iterator i = _filter_graphs.begin();
 274         while (i != _filter_graphs.end() && !(*i)->can_process (Size (frame->width, frame->height), (AVPixelFormat) frame->format)) {
 275                 ++i;
 276         }
 277
 278         if (i == _filter_graphs.end ()) {
 279                 graph.reset (new FilterGraph (_film, this, _opt->apply_crop, Size (frame->width, frame->height), (AVPixelFormat) frame->format));
 280                 _filter_graphs.push_back (graph);
 281                 _film->log()->log (String::compose ("New graph for %1x%2, pixel format %3", frame->width, frame->height, frame->format));
 282         } else {
 283                 graph = *i;
 284         }
 285
 286         list<shared_ptr<Image> > images = graph->process (frame);
 287
 288         for (list<shared_ptr<Image> >::iterator i = images.begin(); i != images.end(); ++i) {
 289                 shared_ptr<Subtitle> sub;
 290                 if (_timed_subtitle && _timed_subtitle->displayed_at (double (video_frame_index()) / _film->frames_per_second())) {
 291                         sub = _timed_subtitle->subtitle ();
 292                 }
 293
 294                 TIMING ("Decoder emits %1", _video_frame_index);
 295                 Video (*i, _video_frame_index, sub);
 296                 ++_video_frame_index;
 297                 _last_image = *i;
 298                 _last_subtitle = sub;
 299         }
 300 }
 301
 302 void
 303 Decoder::repeat_last_video ()
 304 {
 305         if (!_last_image) {
 306                 _last_image.reset (new CompactImage (pixel_format(), native_size()));
 307                 _last_image->make_black ();
 308         }
 309
 310         Video (_last_image, _video_frame_index, _last_subtitle);
 311         ++_video_frame_index;
 312 }
 313
 314 void
 315 Decoder::process_subtitle (shared_ptr<TimedSubtitle> s)
 316 {
 317         _timed_subtitle = s;
 318
 319         if (_timed_subtitle && _opt->apply_crop) {
 320                 Position const p = _timed_subtitle->subtitle()->position ();
 321                 _timed_subtitle->subtitle()->set_position (Position (p.x - _film->crop().left, p.y - _film->crop().top));
 322         }
 323 }
 324
 325
 326 int
 327 Decoder::bytes_per_audio_sample () const
 328 {
 329         return av_get_bytes_per_sample (audio_sample_format ());
 330 }