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 <boost/signals2.hpp>
  32 #include "util.h"
  33 #include "stream.h"
  34 #include "video_source.h"
  35 #include "audio_source.h"
  36
  37 class Job;
  38 class DecodeOptions;
  39 class Image;
  40 class Log;
  41 class DelayLine;
  42 class TimedSubtitle;
  43 class Subtitle;
  44 class Film;
  45 class FilterGraph;
  46
  47 /** @class Decoder.
  48  *  @brief Parent class for decoders of content.
  49  *
  50  *  These classes can be instructed run through their content (by
  51  *  calling ::go), and they emit signals when video or audio data is
  52  *  ready for something else to process.
  53  */
  54 class Decoder
  55 {
  56 public:
  57         Decoder (boost::shared_ptr<Film>, boost::shared_ptr<const DecodeOptions>, Job *);
  58         virtual ~Decoder () {}
  59
  60         virtual bool pass () = 0;
  61         /** Seek.
  62          *  @return true on error.
  63          */
  64         virtual bool seek (SourceFrame);
  65
  66 protected:
  67         /** our Film */
  68         boost::shared_ptr<Film> _film;
  69         /** our options */
  70         boost::shared_ptr<const DecodeOptions> _opt;
  71         /** associated Job, or 0 */
  72         Job* _job;
  73 };
  74
  75 #endif