2 Copyright (C) 2014-2019 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.
42 #include "certificate.h"
46 #include <boost/shared_ptr.hpp>
47 #include <boost/function.hpp>
48 #include <boost/optional.hpp>
49 #include <boost/filesystem.hpp>
58 class CertificateChain;
62 * @brief A Composition Playlist.
64 class CPL : public Asset
67 CPL (std::string annotation_text, ContentKind content_kind);
68 explicit CPL (boost::filesystem::path file);
71 boost::shared_ptr<const Asset> other,
72 EqualityOptions options,
76 void add (boost::shared_ptr<Reel> reel);
77 void add (DecryptedKDM const &);
79 /** @return contents of the <AnnotationText> node */
80 std::string annotation_text () const {
81 return _metadata.annotation_text;
84 void set_annotation_text (std::string at) {
85 _metadata.annotation_text = at;
88 /** @return contents of the <ContentTitleText> node */
89 std::string content_title_text () const {
90 return _content_title_text;
93 void set_content_title_text (std::string ct) {
94 _content_title_text = ct;
97 /** @return contents of the <Id> node within <ContentVersion> */
98 void set_content_version_id (std::string id) {
99 _content_version_id = id;
102 /** @return contents of the <LabelText> node within <ContentVersion> */
103 void set_content_version_label_text (std::string text) {
104 _content_version_label_text = text;
107 /** @return the type of the content, used by media servers
108 * to categorise things (e.g. feature, trailer, etc.)
110 ContentKind content_kind () const {
111 return _content_kind;
114 /** @return the reels in this CPL */
115 std::list<boost::shared_ptr<Reel> > reels () const {
119 /** @return the ReelMXFs in this CPL in all reels.
121 std::list<boost::shared_ptr<const ReelMXF> > reel_mxfs () const;
122 std::list<boost::shared_ptr<ReelMXF> > reel_mxfs ();
124 bool encrypted () const;
126 void set_metadata (XMLMetadata m) {
131 boost::filesystem::path file,
133 boost::shared_ptr<const CertificateChain>
136 void resolve_refs (std::list<boost::shared_ptr<Asset> >);
138 int64_t duration () const;
140 boost::optional<Standard> standard () const {
144 std::list<Rating> ratings () const {
148 void set_ratings (std::list<Rating> r) {
152 std::string content_version_label_text () const {
153 return _content_version_label_text;
156 static std::string static_pkl_type (Standard standard);
159 /** @return type string for PKLs for this asset */
160 std::string pkl_type (Standard standard) const;
163 /** <Issuer>, <Creator>, <IssueDate> and <AnnotationText>.
164 * These are grouped because they occur together in a few places.
166 XMLMetadata _metadata;
167 std::string _content_title_text; ///< <ContentTitleText>
168 ContentKind _content_kind; ///< <ContentKind>
169 std::string _content_version_id; ///< <Id> in <ContentVersion>
170 std::string _content_version_label_text; ///< <LabelText> in <ContentVersion>
171 std::list<boost::shared_ptr<Reel> > _reels;
172 std::list<Rating> _ratings;
174 /** Standard of CPL that was read in */
175 boost::optional<Standard> _standard;