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