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 #include "types.h"
  31 #include "dcpomatic_time.h"
  32
  33 class Decoded;
  34
  35 /** @class Decoder.
  36  *  @brief Parent class for decoders of content.
  37  */
  38 class Decoder : public boost::noncopyable
  39 {
  40 public:
  41         Decoder ();
  42         virtual ~Decoder () {}
  43
  44         /** Seek so that the next peek() 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 get close to
  47          *  the request.
  48          */
  49         virtual void seek (ContentTime time, bool accurate);
  50
  51         boost::shared_ptr<Decoded> peek ();
  52
  53         /* Consume the last peek()ed thing so that it won't be returned
  54          * from the next peek().
  55          */
  56         void consume ();
  57
  58 protected:
  59
  60         /** Perform one decode pass of the content, which may or may not
  61          *  result in a complete quantum (Decoded object) of decoded stuff
  62          *  being added to _pending.
  63          *  @return true if the decoder is done (i.e. no more data will be
  64          *  produced by any future calls to pass() without a seek() first).
  65          */
  66         virtual bool pass () = 0;
  67         virtual void flush () {};
  68
  69         std::list<boost::shared_ptr<Decoded> > _pending;
  70         bool _done;
  71 };
  72
  73 #endif