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