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