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::pair;
  44 using std::list;
  45 using boost::shared_ptr;
  46 using boost::optional;
  47
  48 /** @param f Film.
  49  *  @param o Options.
  50  *  @param j Job that we are running within, or 0
  51  *  @param minimal true to do the bare minimum of work; just run through the content.  Useful for acquiring
  52  *  accurate frame counts as quickly as possible.  This generates no video or audio output.
  53  */
  54 Decoder::Decoder (boost::shared_ptr<Film> f, boost::shared_ptr<const Options> o, Job* j)
  55         : _film (f)
  56         , _opt (o)
  57         , _job (j)
  58         , _video_frame (0)
  59         , _audio_frame (0)
  60         , _delay_line (0)
  61         , _delay_in_frames (0)
  62 {
  63
  64 }
  65
  66 Decoder::~Decoder ()
  67 {
  68         delete _delay_line;
  69 }
  70
  71 /** Start off a decode processing run.  This should only be called once on
  72  *  a given Decoder object.
  73  */
  74 void
  75 Decoder::process_begin ()
  76 {
  77         if (_audio_stream) {
  78                 _delay_in_frames = _film->audio_delay() * _audio_stream.get().sample_rate() / 1000;
  79                 _delay_line = new DelayLine (_audio_stream.get().channels(), _delay_in_frames);
  80         }
  81 }
  82
  83 /** Finish off a decode processing run */
  84 void
  85 Decoder::process_end ()
  86 {
  87         if (_delay_in_frames < 0 && _opt->decode_audio && _audio_stream) {
  88                 shared_ptr<AudioBuffers> b (new AudioBuffers (_audio_stream.get().channels(), -_delay_in_frames));
  89                 b->make_silent ();
  90                 emit_audio (b);
  91         }
  92
  93         if (_opt->decode_audio && _audio_stream) {
  94
  95                 /* Ensure that our video and audio emissions are the same length */
  96
  97                 int64_t audio_short_by_frames = video_frames_to_audio_frames (_video_frame, _audio_stream.get().sample_rate(), frames_per_second()) - _audio_frame;
  98
  99                 _film->log()->log (
 100                         String::compose (
 101                                 "Decoder has emitted %1 video frames (which equals %2 audio frames) and %3 audio frames",
 102                                 _video_frame,
 103                                 video_frames_to_audio_frames (_video_frame, _audio_stream.get().sample_rate(), frames_per_second()),
 104                                 _audio_frame
 105                                 )
 106                         );
 107
 108                 if (audio_short_by_frames < 0) {
 109
 110                         _film->log()->log (String::compose ("Emitted %1 too many audio frames", -audio_short_by_frames));
 111
 112                         /* We have emitted more audio than video.  Emit enough black video frames so that we reverse this */
 113                         int const black_video_frames = ceil (-audio_short_by_frames * frames_per_second() / _audio_stream.get().sample_rate());
 114
 115                         _film->log()->log (String::compose ("Emitting %1 frames of black video", black_video_frames));
 116
 117                         shared_ptr<Image> black (new CompactImage (pixel_format(), native_size()));
 118                         black->make_black ();
 119                         for (int i = 0; i < black_video_frames; ++i) {
 120                                 emit_video (black, shared_ptr<Subtitle> ());
 121                         }
 122
 123                         /* Now recompute our check value */
 124                         audio_short_by_frames = video_frames_to_audio_frames (_video_frame, _audio_stream.get().sample_rate(), frames_per_second()) - _audio_frame;
 125                 }
 126
 127                 if (audio_short_by_frames > 0) {
 128                         _film->log()->log (String::compose ("Emitted %1 too few audio frames", audio_short_by_frames));
 129                         shared_ptr<AudioBuffers> b (new AudioBuffers (_audio_stream.get().channels(), audio_short_by_frames));
 130                         b->make_silent ();
 131                         emit_audio (b);
 132                 }
 133         }
 134 }
 135
 136 /** Start decoding */
 137 void
 138 Decoder::go ()
 139 {
 140         process_begin ();
 141
 142         if (_job && !_film->dcp_length()) {
 143                 _job->set_progress_unknown ();
 144         }
 145
 146         while (pass () == false) {
 147                 if (_job && _film->dcp_length()) {
 148                         _job->set_progress (float (_video_frame) / _film->length().get());
 149                 }
 150         }
 151
 152         process_end ();
 153 }
 154
 155 /** Called by subclasses to tell the world that some audio data is ready
 156  *  @param data Audio data, in Film::audio_sample_format.
 157  *  @param size Number of bytes of data.
 158  */
 159 void
 160 Decoder::process_audio (shared_ptr<AudioBuffers> audio)
 161 {
 162         /* Maybe apply gain */
 163         if (_film->audio_gain() != 0) {
 164                 float const linear_gain = pow (10, _film->audio_gain() / 20);
 165                 for (int i = 0; i < audio->channels(); ++i) {
 166                         for (int j = 0; j < audio->frames(); ++j) {
 167                                 audio->data(i)[j] *= linear_gain;
 168                         }
 169                 }
 170         }
 171
 172         _delay_line->feed (audio);
 173         emit_audio (audio);
 174 }
 175
 176 /** Called by subclasses to tell the world that some video data is ready.
 177  *  We do some post-processing / filtering then emit it for listeners.
 178  *  @param frame to decode; caller manages memory.
 179  */
 180 void
 181 Decoder::process_video (AVFrame* frame)
 182 {
 183         shared_ptr<FilterGraph> graph;
 184
 185         list<shared_ptr<FilterGraph> >::iterator i = _filter_graphs.begin();
 186         while (i != _filter_graphs.end() && !(*i)->can_process (Size (frame->width, frame->height), (AVPixelFormat) frame->format)) {
 187                 ++i;
 188         }
 189
 190         if (i == _filter_graphs.end ()) {
 191                 graph.reset (new FilterGraph (_film, this, _opt->apply_crop, Size (frame->width, frame->height), (AVPixelFormat) frame->format));
 192                 _filter_graphs.push_back (graph);
 193                 _film->log()->log (String::compose ("New graph for %1x%2, pixel format %3", frame->width, frame->height, frame->format));
 194         } else {
 195                 graph = *i;
 196         }
 197
 198         list<shared_ptr<Image> > images = graph->process (frame);
 199
 200         for (list<shared_ptr<Image> >::iterator i = images.begin(); i != images.end(); ++i) {
 201                 shared_ptr<Subtitle> sub;
 202                 if (_timed_subtitle && _timed_subtitle->displayed_at (double (video_frame()) / _film->frames_per_second())) {
 203                         sub = _timed_subtitle->subtitle ();
 204                 }
 205
 206                 emit_video (*i, sub);
 207         }
 208 }
 209
 210 void
 211 Decoder::repeat_last_video ()
 212 {
 213         if (!_last_image) {
 214                 _last_image.reset (new CompactImage (pixel_format(), native_size()));
 215                 _last_image->make_black ();
 216         }
 217
 218         emit_video (_last_image, _last_subtitle);
 219 }
 220
 221 void
 222 Decoder::emit_video (shared_ptr<Image> image, shared_ptr<Subtitle> sub)
 223 {
 224         TIMING ("Decoder emits %1", _video_frame);
 225         Video (image, _video_frame, sub);
 226         ++_video_frame;
 227
 228         _last_image = image;
 229         _last_subtitle = sub;
 230 }
 231
 232 void
 233 Decoder::emit_audio (shared_ptr<AudioBuffers> audio)
 234 {
 235         Audio (audio, _audio_frame);
 236         _audio_frame += audio->frames ();
 237 }
 238
 239 void
 240 Decoder::process_subtitle (shared_ptr<TimedSubtitle> s)
 241 {
 242         _timed_subtitle = s;
 243
 244         if (_timed_subtitle && _opt->apply_crop) {
 245                 Position const p = _timed_subtitle->subtitle()->position ();
 246                 _timed_subtitle->subtitle()->set_position (Position (p.x - _film->crop().left, p.y - _film->crop().top));
 247         }
 248 }
 249
 250 void
 251 Decoder::set_audio_stream (optional<AudioStream> s)
 252 {
 253         _audio_stream = s;
 254 }
 255
 256 void
 257 Decoder::set_subtitle_stream (optional<SubtitleStream> s)
 258 {
 259         _subtitle_stream = s;
 260 }