src/lib/decoder.h

   1 /*
   2     Copyright (C) 2012-2020 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 "film.h"
  30 #include "dcpomatic_time.h"
  31 #include "weak_film.h"
  32 #include <boost/utility.hpp>
  33
  34 class Decoded;
  35 class VideoDecoder;
  36 class AudioDecoder;
  37 class TextDecoder;
  38 class AtmosDecoder;
  39 class DecoderPart;
  40
  41 /** @class Decoder.
  42  *  @brief Parent class for decoders of content.
  43  */
  44 class Decoder : public boost::noncopyable, public WeakConstFilm
  45 {
  46 public:
  47         Decoder (boost::weak_ptr<const Film> film);
  48         virtual ~Decoder () {}
  49
  50         boost::shared_ptr<VideoDecoder> video;
  51         boost::shared_ptr<AudioDecoder> audio;
  52         std::list<boost::shared_ptr<TextDecoder> > text;
  53         boost::shared_ptr<AtmosDecoder> atmos;
  54
  55         boost::shared_ptr<TextDecoder> only_text () const;
  56
  57         /** Do some decoding and perhaps emit video, audio or subtitle data.
  58          *  @return true if this decoder will emit no more data unless a seek() happens.
  59          */
  60         virtual bool pass () = 0;
  61         virtual void seek (dcpomatic::ContentTime time, bool accurate);
  62
  63         virtual dcpomatic::ContentTime position () const;
  64 };
  65
  66 #endif