src/lib/decoder.h

   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.h
  21  *  @brief Parent class for decoders of content.
  22  */
  23
  24 #ifndef DVDOMATIC_DECODER_H
  25 #define DVDOMATIC_DECODER_H
  26
  27 #include <vector>
  28 #include <string>
  29 #include <stdint.h>
  30 #include <boost/shared_ptr.hpp>
  31 #include <sigc++/sigc++.h>
  32 #include "util.h"
  33
  34 class Job;
  35 class FilmState;
  36 class Options;
  37 class Image;
  38 class Log;
  39 class DelayLine;
  40 class TimedSubtitle;
  41 class Subtitle;
  42
  43 /** @class Decoder.
  44  *  @brief Parent class for decoders of content.
  45  *
  46  *  These classes can be instructed run through their content
  47  *  (by calling ::go), and they emit signals when video or audio data is ready for something else
  48  *  to process.
  49  */
  50 class Decoder
  51 {
  52 public:
  53         Decoder (boost::shared_ptr<const FilmState>, boost::shared_ptr<const Options>, Job *, Log *, bool, bool);
  54         virtual ~Decoder ();
  55
  56         /* Methods to query our input video */
  57
  58         /** @return length in video frames */
  59         virtual int length_in_frames () const = 0;
  60         /** @return video frames per second, or 0 if unknown */
  61         virtual float frames_per_second () const = 0;
  62         /** @return native size in pixels */
  63         virtual Size native_size () const = 0;
  64         /** @return number of audio channels */
  65         virtual int audio_channels () const = 0;
  66         /** @return audio sampling rate in Hz */
  67         virtual int audio_sample_rate () const = 0;
  68         /** @return format of audio samples */
  69         virtual AVSampleFormat audio_sample_format () const = 0;
  70         virtual int64_t audio_channel_layout () const = 0;
  71         virtual bool has_subtitles () const = 0;
  72
  73         void process_begin ();
  74         bool pass ();
  75         void process_end ();
  76         void go ();
  77
  78         /** @return the index of the last video frame to be processed */
  79         int last_video_frame () const {
  80                 return _video_frame;
  81         }
  82
  83         /** Emitted when a video frame is ready.
  84          *  First parameter is the frame.
  85          *  Second parameter is its index within the content.
  86          *  Third parameter is either 0 or a subtitle that should be on this frame.
  87          */
  88         sigc::signal<void, boost::shared_ptr<Image>, int, boost::shared_ptr<Subtitle> > Video;
  89
  90         /** Emitted when some audio data is ready.
  91          *  First parameter is the interleaved sample data, format is given in the FilmState.
  92          *  Second parameter is the size of the data.
  93          */
  94         sigc::signal<void, uint8_t *, int> Audio;
  95
  96 protected:
  97         /** perform a single pass at our content */
  98         virtual bool do_pass () = 0;
  99         virtual PixelFormat pixel_format () const = 0;
 100         virtual int time_base_numerator () const = 0;
 101         virtual int time_base_denominator () const = 0;
 102         virtual int sample_aspect_ratio_numerator () const = 0;
 103         virtual int sample_aspect_ratio_denominator () const = 0;
 104
 105         void process_video (AVFrame *);
 106         void process_audio (uint8_t *, int);
 107         void process_subtitle (boost::shared_ptr<TimedSubtitle>);
 108
 109         /** our FilmState */
 110         boost::shared_ptr<const FilmState> _fs;
 111         /** our options */
 112         boost::shared_ptr<const Options> _opt;
 113         /** associated Job, or 0 */
 114         Job* _job;
 115         /** log that we can write to */
 116         Log* _log;
 117
 118         /** true to do the bare minimum of work; just run through the content.  Useful for acquiring
 119          *  accurate frame counts as quickly as possible.  This generates no video or audio output.
 120          */
 121         bool _minimal;
 122
 123         /** ignore_length Ignore the content's claimed length when computing progress */
 124         bool _ignore_length;
 125
 126 private:
 127         void setup_video_filters ();
 128
 129         /** last video frame to be processed */
 130         int _video_frame;
 131
 132         AVFilterContext* _buffer_src_context;
 133         AVFilterContext* _buffer_sink_context;
 134
 135         bool _have_setup_video_filters;
 136         DelayLine* _delay_line;
 137         int _delay_in_bytes;
 138
 139         /* Number of audio frames that we have pushed to the encoder
 140            (at the DCP sample rate).
 141         */
 142         int64_t _audio_frames_processed;
 143
 144         boost::shared_ptr<TimedSubtitle> _timed_subtitle;
 145 };
 146
 147 #endif