src/lib/decoder.h

   1 /*
   2     Copyright (C) 2012-2015 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 Decoder class.
  22  */
  23
  24 #ifndef DCPOMATIC_DECODER_H
  25 #define DCPOMATIC_DECODER_H
  26
  27 #include "types.h"
  28 #include "dcpomatic_time.h"
  29 #include <boost/utility.hpp>
  30
  31 class Decoded;
  32
  33 /** @class Decoder.
  34  *  @brief Parent class for decoders of content.
  35  */
  36 class Decoder : public boost::noncopyable
  37 {
  38 public:
  39         virtual ~Decoder () {}
  40
  41 protected:
  42         friend class AudioDecoderStream;
  43
  44         /** Seek so that the next pass() will yield the next thing
  45          *  (video/sound frame, subtitle etc.) at or after the requested
  46          *  time.  Pass accurate = true to try harder to ensure that, at worst,
  47          *  the next thing we yield comes before `time'.  This may entail
  48          *  seeking some way before `time' to be on the safe side.
  49          *  Alternatively, if seeking is 100% accurate for this decoder,
  50          *  it may seek to just the right spot.
  51          */
  52         virtual void seek (ContentTime time, bool accurate) = 0;
  53
  54         virtual bool pass () = 0;
  55 };
  56
  57 #endif