2 Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
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.
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.
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/>.
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
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.
44 #include "decrypted_kdm.h"
48 #include <boost/function.hpp>
62 struct dcp_add_kdm_test;
70 class ReelPictureAsset;
72 class ReelSubtitleAsset;
73 class ReelMarkersAsset;
74 class ReelClosedCaptionAsset;
79 /** @brief A reel within a DCP; the part which actually refers to picture, sound, subtitle, marker and Atmos data */
80 class Reel : public Object
86 std::shared_ptr<ReelPictureAsset> picture,
87 std::shared_ptr<ReelSoundAsset> sound = std::shared_ptr<ReelSoundAsset> (),
88 std::shared_ptr<ReelSubtitleAsset> subtitle = std::shared_ptr<ReelSubtitleAsset> (),
89 std::shared_ptr<ReelMarkersAsset> markers = std::shared_ptr<ReelMarkersAsset> (),
90 std::shared_ptr<ReelAtmosAsset> atmos = std::shared_ptr<ReelAtmosAsset> ()
92 : _main_picture (picture)
94 , _main_subtitle (subtitle)
95 , _main_markers (markers)
99 explicit Reel (std::shared_ptr<const cxml::Node>, dcp::Standard standard);
101 std::shared_ptr<ReelPictureAsset> main_picture () const {
102 return _main_picture;
105 std::shared_ptr<ReelSoundAsset> main_sound () const {
109 std::shared_ptr<ReelSubtitleAsset> main_subtitle () const {
110 return _main_subtitle;
113 std::shared_ptr<ReelMarkersAsset> main_markers () const {
114 return _main_markers;
117 std::vector<std::shared_ptr<ReelClosedCaptionAsset>> closed_captions () const {
118 return _closed_captions;
121 std::shared_ptr<ReelAtmosAsset> atmos () const {
125 int64_t duration () const;
127 void add (std::shared_ptr<ReelAsset> asset);
129 std::vector<std::shared_ptr<ReelAsset>> assets () const;
131 xmlpp::Element* write_to_cpl (xmlpp::Element* node, Standard standard) const;
133 bool any_encrypted () const;
134 bool all_encrypted () const;
136 bool equals (std::shared_ptr<const Reel> other, EqualityOptions opt, NoteHandler notes) const;
138 void add (DecryptedKDM const &);
140 void resolve_refs (std::vector<std::shared_ptr<Asset>>);
143 friend struct ::dcp_add_kdm_test;
145 void give_kdm_to_assets (dcp::DecryptedKDM const& kdm);
147 std::shared_ptr<ReelPictureAsset> _main_picture;
148 std::shared_ptr<ReelSoundAsset> _main_sound;
149 std::shared_ptr<ReelSubtitleAsset> _main_subtitle;
150 std::shared_ptr<ReelMarkersAsset> _main_markers;
151 std::vector<std::shared_ptr<ReelClosedCaptionAsset>> _closed_captions;
152 std::shared_ptr<ReelAtmosAsset> _atmos;
154 std::vector<dcp::DecryptedKDM> _kdms;