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