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 "decrypted_kdm.h"
  45 #include "key.h"
  46 #include "ref.h"
  47 #include <boost/function.hpp>
  48 #include <memory>
  49
  50
  51 namespace cxml {
  52         class Node;
  53 }
  54
  55
  56 namespace xmlpp {
  57         class Element;
  58 }
  59
  60
  61 struct dcp_add_kdm_test;
  62
  63
  64 namespace dcp {
  65
  66
  67 class DecryptedKDM;
  68 class ReelAsset;
  69 class ReelPictureAsset;
  70 class ReelSoundAsset;
  71 class ReelSubtitleAsset;
  72 class ReelMarkersAsset;
  73 class ReelClosedCaptionAsset;
  74 class ReelAtmosAsset;
  75 class Content;
  76
  77
  78 /** @brief A reel within a DCP; the part which actually refers to picture, sound, subtitle, marker and Atmos data */
  79 class Reel : public Object
  80 {
  81 public:
  82         Reel () {}
  83
  84         Reel (
  85                 std::shared_ptr<ReelPictureAsset> picture,
  86                 std::shared_ptr<ReelSoundAsset> sound = std::shared_ptr<ReelSoundAsset> (),
  87                 std::shared_ptr<ReelSubtitleAsset> subtitle = std::shared_ptr<ReelSubtitleAsset> (),
  88                 std::shared_ptr<ReelMarkersAsset> markers = std::shared_ptr<ReelMarkersAsset> (),
  89                 std::shared_ptr<ReelAtmosAsset> atmos = std::shared_ptr<ReelAtmosAsset> ()
  90                 )
  91                 : _main_picture (picture)
  92                 , _main_sound (sound)
  93                 , _main_subtitle (subtitle)
  94                 , _main_markers (markers)
  95                 , _atmos (atmos)
  96         {}
  97
  98         explicit Reel (std::shared_ptr<const cxml::Node>, dcp::Standard standard);
  99
 100         std::shared_ptr<ReelPictureAsset> main_picture () const {
 101                 return _main_picture;
 102         }
 103
 104         std::shared_ptr<ReelSoundAsset> main_sound () const {
 105                 return _main_sound;
 106         }
 107
 108         std::shared_ptr<ReelSubtitleAsset> main_subtitle () const {
 109                 return _main_subtitle;
 110         }
 111
 112         std::shared_ptr<ReelMarkersAsset> main_markers () const {
 113                 return _main_markers;
 114         }
 115
 116         std::vector<std::shared_ptr<ReelClosedCaptionAsset>> closed_captions () const {
 117                 return _closed_captions;
 118         }
 119
 120         std::shared_ptr<ReelAtmosAsset> atmos () const {
 121                 return _atmos;
 122         }
 123
 124         int64_t duration () const;
 125
 126         void add (std::shared_ptr<ReelAsset> asset);
 127
 128         std::vector<std::shared_ptr<ReelAsset>> assets () const;
 129
 130         xmlpp::Element* write_to_cpl (xmlpp::Element* node, Standard standard) const;
 131
 132         bool any_encrypted () const;
 133         bool all_encrypted () const;
 134
 135         bool equals(std::shared_ptr<const Reel> other, EqualityOptions const& opt, NoteHandler notes) const;
 136
 137         void add (DecryptedKDM const &);
 138
 139         void resolve_refs (std::vector<std::shared_ptr<Asset>>);
 140
 141 private:
 142         friend struct ::dcp_add_kdm_test;
 143
 144         void give_kdm_to_assets (dcp::DecryptedKDM const& kdm);
 145
 146         std::shared_ptr<ReelPictureAsset> _main_picture;
 147         std::shared_ptr<ReelSoundAsset> _main_sound;
 148         std::shared_ptr<ReelSubtitleAsset> _main_subtitle;
 149         std::shared_ptr<ReelMarkersAsset> _main_markers;
 150         std::vector<std::shared_ptr<ReelClosedCaptionAsset>> _closed_captions;
 151         std::shared_ptr<ReelAtmosAsset> _atmos;
 152
 153         std::vector<dcp::DecryptedKDM> _kdms;
 154 };
 155
 156 }
 157
 158 #endif