src/lib/decoder.h

   1 /*
   2     Copyright (C) 2012-2013 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 DCPOMATIC_DECODER_H
  25 #define DCPOMATIC_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 "film.h"
  33
  34 class Image;
  35 class Log;
  36 class DelayLine;
  37 class TimedSubtitle;
  38 class Subtitle;
  39 class FilterGraph;
  40
  41 /** @class Decoder.
  42  *  @brief Parent class for decoders of content.
  43  */
  44 class Decoder
  45 {
  46 public:
  47         Decoder (boost::shared_ptr<const Film>);
  48         virtual ~Decoder () {}
  49
  50         /** Perform one decode pass of the content, which may or may not
  51          *  cause the object to emit some data.
  52          */
  53         virtual void pass () = 0;
  54
  55         virtual bool done () const = 0;
  56
  57 protected:
  58
  59         /** The Film that we are decoding in */
  60         boost::weak_ptr<const Film> _film;
  61
  62 private:
  63         /** This will be called when our Film emits Changed */
  64         virtual void film_changed (Film::Property) {}
  65
  66         /** Connection to our Film */
  67         boost::signals2::scoped_connection _film_connection;
  68 };
  69
  70 #endif