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 <boost/shared_ptr.hpp>
  28 #include <boost/weak_ptr.hpp>
  29 #include <boost/utility.hpp>
  30
  31 class Film;
  32
  33 /** @class Decoder.
  34  *  @brief Parent class for decoders of content.
  35  */
  36 class Decoder : public boost::noncopyable
  37 {
  38 public:
  39         Decoder (boost::shared_ptr<const Film>);
  40         virtual ~Decoder () {}
  41
  42         /** Perform one decode pass of the content, which may or may not
  43          *  cause the object to emit some data.
  44          */
  45         virtual void pass () = 0;
  46         virtual bool done () const = 0;
  47
  48 protected:
  49
  50         virtual void flush () {};
  51
  52         /** The Film that we are decoding in */
  53         boost::weak_ptr<const Film> _film;
  54 };
  55
  56 #endif