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 "weak_film.h"
  34 #include <boost/utility.hpp>
  35
  36
  37 class AtmosDecoder;
  38 class AudioDecoder;
  39 class Decoded;
  40 class DecoderPart;
  41 class TextDecoder;
  42 class VideoDecoder;
  43
  44
  45 /** @class Decoder.
  46  *  @brief Parent class for decoders of content.
  47  */
  48 class Decoder : public WeakConstFilm
  49 {
  50 public:
  51         Decoder (std::weak_ptr<const Film> film);
  52         virtual ~Decoder () {}
  53
  54         Decoder (Decoder const&) = delete;
  55         Decoder& operator= (Decoder const&) = delete;
  56
  57         std::shared_ptr<VideoDecoder> video;
  58         std::shared_ptr<AudioDecoder> audio;
  59         std::list<std::shared_ptr<TextDecoder>> text;
  60         std::shared_ptr<AtmosDecoder> atmos;
  61
  62         std::shared_ptr<TextDecoder> only_text () const;
  63
  64         class PassResult
  65         {
  66         public:
  67                 enum class Type
  68                 {
  69                         OK,        ///< there was no error and more data may be emitted on the next pass()
  70                         FINISHED,  ///< this decoder will emit no more data unless a seek() happens
  71                         ERROR,     ///< some survivable error occurred; output may not be correct
  72                 };
  73
  74                 static PassResult ok() {
  75                         return { Type::OK };
  76                 }
  77
  78                 static PassResult finished() {
  79                         return { Type::FINISHED };
  80                 }
  81
  82                 static PassResult error(std::string message) {
  83                         return { Type::ERROR, message };
  84                 };
  85
  86                 bool is_ok() const {
  87                         return _type == Type::OK;
  88                 }
  89
  90                 bool is_finished() const {
  91                         return _type == Type::FINISHED;
  92                 }
  93
  94                 bool is_error() const {
  95                         return _type == Type::ERROR;
  96                 }
  97
  98                 std::string error_message() const {
  99                         DCPOMATIC_ASSERT(is_error());
 100                         return _error_message;
 101                 }
 102
 103         private:
 104                 PassResult(Type type)
 105                         : _type(type)
 106                 {}
 107
 108                 PassResult(Type type, std::string error_message)
 109                         : _type(type)
 110                         , _error_message(error_message)
 111                 {}
 112
 113                 Type _type;
 114                 std::string _error_message;
 115         };
 116
 117         /** Do some decoding and perhaps emit video, audio or subtitle data */
 118         virtual PassResult pass() = 0;
 119         virtual void seek (dcpomatic::ContentTime time, bool accurate);
 120
 121         virtual dcpomatic::ContentTime position () const;
 122 };
 123
 124
 125 #endif