src/lib/dcp_decoder.h

   1 /*
   2     Copyright (C) 2014-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/dcp_decoder.h
  22  *  @brief A decoder of existing DCPs.
  23  */
  24
  25 #include "atmos_metadata.h"
  26 #include "decoder.h"
  27 #include "dcp.h"
  28 #include <dcp/mono_picture_asset_reader.h>
  29 #include <dcp/stereo_picture_asset_reader.h>
  30 #include <dcp/sound_asset_reader.h>
  31 #include <dcp/subtitle_asset.h>
  32
  33 namespace dcp {
  34         class Reel;
  35 }
  36
  37 class DCPContent;
  38 class Log;
  39 struct dcp_subtitle_within_dcp_test;
  40
  41 class DCPDecoder : public DCP, public Decoder
  42 {
  43 public:
  44         DCPDecoder (
  45                 boost::shared_ptr<const Film> film,
  46                 boost::shared_ptr<const DCPContent>,
  47                 bool fast,
  48                 bool tolerant,
  49                 boost::shared_ptr<DCPDecoder> old
  50                 );
  51
  52         std::list<boost::shared_ptr<dcp::Reel> > reels () const {
  53                 return _reels;
  54         }
  55
  56         void set_decode_referenced (bool r);
  57         void set_forced_reduction (boost::optional<int> reduction);
  58
  59         bool pass ();
  60         void seek (dcpomatic::ContentTime t, bool accurate);
  61
  62         std::string lazy_digest () const {
  63                 return _lazy_digest;
  64         }
  65
  66         dcpomatic::ContentTime position () const;
  67
  68 private:
  69         friend struct dcp_subtitle_within_dcp_test;
  70
  71         void next_reel ();
  72         void get_readers ();
  73         void pass_texts (dcpomatic::ContentTime next, dcp::Size size);
  74         void pass_texts (
  75                 dcpomatic::ContentTime next,
  76                 boost::shared_ptr<dcp::SubtitleAsset> asset,
  77                 bool reference,
  78                 int64_t entry_point,
  79                 boost::shared_ptr<TextDecoder> decoder,
  80                 dcp::Size size
  81                 );
  82         std::string calculate_lazy_digest (boost::shared_ptr<const DCPContent>) const;
  83
  84         /** Time of next thing to return from pass relative to the start of _reel */
  85         dcpomatic::ContentTime _next;
  86         std::list<boost::shared_ptr<dcp::Reel> > _reels;
  87
  88         std::list<boost::shared_ptr<dcp::Reel> >::iterator _reel;
  89         /** Offset of _reel from the start of the content in frames */
  90         int64_t _offset;
  91         /** Reader for current mono picture asset, if applicable */
  92         boost::shared_ptr<dcp::MonoPictureAssetReader> _mono_reader;
  93         /** Reader for current stereo picture asset, if applicable */
  94         boost::shared_ptr<dcp::StereoPictureAssetReader> _stereo_reader;
  95         /** Reader for current sound asset, if applicable */
  96         boost::shared_ptr<dcp::SoundAssetReader> _sound_reader;
  97         boost::shared_ptr<dcp::AtmosAssetReader> _atmos_reader;
  98         boost::optional<AtmosMetadata> _atmos_metadata;
  99
 100         bool _decode_referenced;
 101         boost::optional<int> _forced_reduction;
 102
 103         std::string _lazy_digest;
 104 };