src/lib/decoder.h

   1 /*
   2     Copyright (C) 2012-2021 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
  22 /** @file  src/decoder.h
  23  *  @brief Decoder class.
  24  */
  25
  26
  27 #ifndef DCPOMATIC_DECODER_H
  28 #define DCPOMATIC_DECODER_H
  29
  30
  31 #include "dcpomatic_time.h"
  32 #include "film.h"
  33 #include "font_data.h"
  34 #include "types.h"
  35 #include "weak_film.h"
  36 #include <boost/utility.hpp>
  37
  38
  39 class AtmosDecoder;
  40 class AudioDecoder;
  41 class Decoded;
  42 class DecoderPart;
  43 class TextDecoder;
  44 class VideoDecoder;
  45
  46
  47 /** @class Decoder.
  48  *  @brief Parent class for decoders of content.
  49  */
  50 class Decoder : public WeakConstFilm
  51 {
  52 public:
  53         Decoder (std::weak_ptr<const Film> film);
  54         virtual ~Decoder () {}
  55
  56         Decoder (Decoder const&) = delete;
  57         Decoder& operator= (Decoder const&) = delete;
  58
  59         std::shared_ptr<VideoDecoder> video;
  60         std::shared_ptr<AudioDecoder> audio;
  61         std::list<std::shared_ptr<TextDecoder>> text;
  62         std::shared_ptr<AtmosDecoder> atmos;
  63
  64         std::shared_ptr<TextDecoder> only_text () const;
  65
  66         /** Do some decoding and perhaps emit video, audio or subtitle data.
  67          *  @return true if this decoder will emit no more data unless a seek() happens.
  68          */
  69         virtual bool pass () = 0;
  70         virtual void seek (dcpomatic::ContentTime time, bool accurate);
  71
  72         virtual dcpomatic::ContentTime position () const;
  73
  74         virtual std::vector<dcpomatic::FontData> fonts () const {
  75                 return {};
  76         }
  77 };
  78
  79
  80 #endif