2 Copyright (C) 2014-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.
45 #include "certificate.h"
47 #include "language_tag.h"
49 #include <boost/filesystem.hpp>
50 #include <boost/function.hpp>
51 #include <boost/optional.hpp>
56 struct verify_invalid_language3;
65 class CertificateChain;
70 * @brief A Composition Playlist.
72 class CPL : public Asset
75 CPL (std::string annotation_text, ContentKind content_kind);
76 explicit CPL (boost::filesystem::path file);
79 std::shared_ptr<const Asset> other,
80 EqualityOptions options,
84 void add (std::shared_ptr<Reel> reel);
85 void add (DecryptedKDM const &);
87 /** @return the reels in this CPL */
88 std::vector<std::shared_ptr<Reel>> reels () const {
92 /** @return the ReelMXFs in this CPL in all reels */
93 std::vector<std::shared_ptr<const ReelMXF>> reel_mxfs () const;
94 std::vector<std::shared_ptr<ReelMXF>> reel_mxfs ();
96 bool any_encrypted () const;
97 bool all_encrypted () const;
100 boost::filesystem::path file,
102 std::shared_ptr<const CertificateChain>
105 void resolve_refs (std::vector<std::shared_ptr<Asset>>);
107 int64_t duration () const;
109 void set_issuer (std::string issuer) {
113 void set_creator (std::string creator) {
117 void set_issue_date (std::string issue_date) {
118 _issue_date = issue_date;
121 /** @return contents of the <AnnotationText> node, if present */
122 boost::optional<std::string> annotation_text () const {
123 return _annotation_text;
126 void set_annotation_text (std::string at) {
127 _annotation_text = at;
130 /** @return contents of the <ContentTitleText> node */
131 std::string content_title_text () const {
132 return _content_title_text;
135 void set_content_title_text (std::string ct) {
136 _content_title_text = ct;
139 void set_content_kind (dcp::ContentKind k) {
143 /** @return the type of the content, used by media servers
144 * to categorise things (e.g. feature, trailer, etc.)
146 ContentKind content_kind () const {
147 return _content_kind;
150 boost::optional<ContentVersion> content_version () const;
152 std::vector<ContentVersion> content_versions () const {
153 return _content_versions;
156 void set_content_version (ContentVersion v) {
157 _content_versions.clear ();
158 _content_versions.push_back (v);
161 void set_content_versions (std::vector<ContentVersion> v);
163 std::vector<Rating> ratings () const {
167 void set_ratings (std::vector<Rating> r) {
171 boost::optional<std::string> full_content_title_text () const {
172 return _full_content_title_text;
175 void set_full_content_title_text (std::string t) {
176 _full_content_title_text = t;
179 boost::optional<std::string> full_content_title_text_language () const {
180 return _full_content_title_text_language;
183 void set_full_content_title_text_language (dcp::LanguageTag l) {
184 _full_content_title_text_language = l.to_string();
187 boost::optional<std::string> release_territory () const {
188 return _release_territory;
191 void set_release_territory (dcp::LanguageTag::RegionSubtag t) {
192 _release_territory = t.subtag();
195 boost::optional<std::string> release_territory_scope () const {
196 return _release_territory_scope;
199 boost::optional<int> version_number () const {
200 return _version_number;
203 void set_version_number (int v);
205 void unset_version_number ();
207 boost::optional<Status> status () const {
211 void set_status (Status s) {
215 boost::optional<std::string> chain () const {
219 void set_chain (std::string c) {
223 boost::optional<std::string> distributor () const {
227 void set_distributor (std::string d) {
231 boost::optional<std::string> facility () const {
235 void set_facility (std::string f) {
239 boost::optional<Luminance> luminance () const {
243 void set_luminance (Luminance l) {
247 boost::optional<std::string> main_sound_configuration () const {
248 return _main_sound_configuration;
251 void set_main_sound_configuration (std::string c) {
252 _main_sound_configuration = c;
255 boost::optional<int> main_sound_sample_rate () const {
256 return _main_sound_sample_rate;
259 void set_main_sound_sample_rate (int r) {
260 _main_sound_sample_rate = r;
263 boost::optional<dcp::Size> main_picture_stored_area () const {
264 return _main_picture_stored_area;
267 void set_main_picture_stored_area (dcp::Size s) {
268 _main_picture_stored_area = s;
271 boost::optional<dcp::Size> main_picture_active_area () const {
272 return _main_picture_active_area;
275 void set_main_picture_active_area (dcp::Size s) {
276 _main_picture_active_area = s;
279 std::vector<std::string> additional_subtitle_languages () const {
280 return _additional_subtitle_languages;
283 void set_additional_subtitle_languages (std::vector<dcp::LanguageTag> const& lang);
285 boost::optional<Standard> standard () const {
289 static std::string static_pkl_type (Standard standard);
292 /** @return type string for PKLs for this asset */
293 std::string pkl_type (Standard standard) const;
296 friend struct ::verify_invalid_language3;
298 void maybe_write_composition_metadata_asset (xmlpp::Element* node) const;
299 void read_composition_metadata_asset (cxml::ConstNodePtr node);
302 std::string _creator;
303 std::string _issue_date;
304 boost::optional<std::string> _annotation_text;
305 std::string _content_title_text; ///< <ContentTitleText>
306 ContentKind _content_kind; ///< <ContentKind>
307 std::vector<ContentVersion> _content_versions;
308 std::vector<Rating> _ratings;
309 /** Human-readable name of the composition, without any metadata (i.e. no -FTR-EN-XX- etc.) */
310 boost::optional<std::string> _full_content_title_text;
311 boost::optional<std::string> _full_content_title_text_language;
312 /** This is stored and returned as a string so that we can tolerate non-RFC-5646 strings,
313 * but must be set as a dcp::LanguageTag to try to ensure that we create compliant output.
315 boost::optional<std::string> _release_territory;
316 boost::optional<std::string> _release_territory_scope;
317 boost::optional<int> _version_number;
318 boost::optional<Status> _status;
319 boost::optional<std::string> _chain;
320 boost::optional<std::string> _distributor;
321 boost::optional<std::string> _facility;
322 boost::optional<Luminance> _luminance;
323 boost::optional<std::string> _main_sound_configuration;
324 boost::optional<int> _main_sound_sample_rate;
325 boost::optional<dcp::Size> _main_picture_stored_area;
326 boost::optional<dcp::Size> _main_picture_active_area;
327 /* See note for _release_territory above */
328 std::vector<std::string> _additional_subtitle_languages;
330 std::vector<std::shared_ptr<Reel>> _reels;
332 /** Standard of CPL that was read in */
333 boost::optional<Standard> _standard;