src/lib/decoder.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file  src/decoder.h
  22  *  @brief Decoder class.
  23  */
  24
  25 #ifndef DCPOMATIC_DECODER_H
  26 #define DCPOMATIC_DECODER_H
  27
  28 #include "types.h"
  29 #include "dcpomatic_time.h"
  30 #include <boost/utility.hpp>
  31
  32 class Decoded;
  33 class VideoDecoder;
  34 class AudioDecoder;
  35 class SubtitleDecoder;
  36
  37 /** @class Decoder.
  38  *  @brief Parent class for decoders of content.
  39  */
  40 class Decoder : public boost::noncopyable
  41 {
  42 public:
  43         virtual ~Decoder () {}
  44
  45         boost::shared_ptr<VideoDecoder> video;
  46         boost::shared_ptr<AudioDecoder> audio;
  47         boost::shared_ptr<SubtitleDecoder> subtitle;
  48
  49         enum PassReason {
  50                 PASS_REASON_VIDEO,
  51                 PASS_REASON_AUDIO,
  52                 PASS_REASON_SUBTITLE
  53         };
  54
  55         /** Seek so that the next pass() will yield the next thing
  56          *  (video/sound frame, subtitle etc.) at or after the requested
  57          *  time.  Pass accurate = true to try harder to ensure that, at worst,
  58          *  the next thing we yield comes before `time'.  This may entail
  59          *  seeking some way before `time' to be on the safe side.
  60          *  Alternatively, if seeking is 100% accurate for this decoder,
  61          *  it may seek to just the right spot.
  62          */
  63         virtual void seek (ContentTime time, bool accurate) = 0;
  64
  65         /** @return true if this decoder has already returned all its data and will give no more */
  66         virtual bool pass (PassReason, bool accurate) = 0;
  67
  68         /** Ensure that any future get() calls return data that reflect
  69          *  changes in our content's settings.
  70          */
  71         virtual void reset () {}
  72 };
  73
  74 #endif