src/reel.h

   1 /*
   2     Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp 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     libdcp 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 libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34
  35 /** @file  src/reel.cc
  36  *  @brief Reel class
  37  */
  38
  39
  40 #ifndef LIBDCP_REEL_H
  41 #define LIBDCP_REEL_H
  42
  43
  44 #include "key.h"
  45 #include "types.h"
  46 #include "ref.h"
  47 #include <memory>
  48 #include <boost/function.hpp>
  49
  50
  51 namespace cxml {
  52         class Node;
  53 }
  54
  55
  56 namespace xmlpp {
  57         class Element;
  58 }
  59
  60
  61 namespace dcp {
  62
  63
  64 class DecryptedKDM;
  65 class ReelAsset;
  66 class ReelPictureAsset;
  67 class ReelSoundAsset;
  68 class ReelSubtitleAsset;
  69 class ReelMarkersAsset;
  70 class ReelClosedCaptionAsset;
  71 class ReelAtmosAsset;
  72 class Content;
  73
  74
  75 /** @brief A reel within a DCP; the part which actually refers to picture, sound, subtitle, marker and Atmos data */
  76 class Reel : public Object
  77 {
  78 public:
  79         Reel () {}
  80
  81         Reel (
  82                 std::shared_ptr<ReelPictureAsset> picture,
  83                 std::shared_ptr<ReelSoundAsset> sound = std::shared_ptr<ReelSoundAsset> (),
  84                 std::shared_ptr<ReelSubtitleAsset> subtitle = std::shared_ptr<ReelSubtitleAsset> (),
  85                 std::shared_ptr<ReelMarkersAsset> markers = std::shared_ptr<ReelMarkersAsset> (),
  86                 std::shared_ptr<ReelAtmosAsset> atmos = std::shared_ptr<ReelAtmosAsset> ()
  87                 )
  88                 : _main_picture (picture)
  89                 , _main_sound (sound)
  90                 , _main_subtitle (subtitle)
  91                 , _main_markers (markers)
  92                 , _atmos (atmos)
  93         {}
  94
  95         explicit Reel (std::shared_ptr<const cxml::Node>);
  96
  97         std::shared_ptr<ReelPictureAsset> main_picture () const {
  98                 return _main_picture;
  99         }
 100
 101         std::shared_ptr<ReelSoundAsset> main_sound () const {
 102                 return _main_sound;
 103         }
 104
 105         std::shared_ptr<ReelSubtitleAsset> main_subtitle () const {
 106                 return _main_subtitle;
 107         }
 108
 109         std::shared_ptr<ReelMarkersAsset> main_markers () const {
 110                 return _main_markers;
 111         }
 112
 113         std::vector<std::shared_ptr<ReelClosedCaptionAsset>> closed_captions () const {
 114                 return _closed_captions;
 115         }
 116
 117         std::shared_ptr<ReelAtmosAsset> atmos () const {
 118                 return _atmos;
 119         }
 120
 121         int64_t duration () const;
 122
 123         void add (std::shared_ptr<ReelAsset> asset);
 124
 125         std::vector<std::shared_ptr<ReelAsset>> assets () const;
 126
 127         xmlpp::Element* write_to_cpl (xmlpp::Element* node, Standard standard) const;
 128
 129         bool any_encrypted () const;
 130         bool all_encrypted () const;
 131
 132         bool equals (std::shared_ptr<const Reel> other, EqualityOptions opt, NoteHandler notes) const;
 133
 134         void add (DecryptedKDM const &);
 135
 136         void resolve_refs (std::vector<std::shared_ptr<Asset>>);
 137
 138 private:
 139         std::shared_ptr<ReelPictureAsset> _main_picture;
 140         std::shared_ptr<ReelSoundAsset> _main_sound;
 141         std::shared_ptr<ReelSubtitleAsset> _main_subtitle;
 142         std::shared_ptr<ReelMarkersAsset> _main_markers;
 143         std::vector<std::shared_ptr<ReelClosedCaptionAsset>> _closed_captions;
 144         std::shared_ptr<ReelAtmosAsset> _atmos;
 145 };
 146
 147 }
 148
 149 #endif