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"
45 #include <boost/shared_ptr.hpp>
46 #include <boost/function.hpp>
47 #include <boost/optional.hpp>
48 #include <boost/filesystem.hpp>
56 class CertificateChain;
60 * @brief A Composition Playlist.
62 class CPL : public Asset
65 CPL (std::string annotation_text, ContentKind content_kind);
66 explicit CPL (boost::filesystem::path file);
69 boost::shared_ptr<const Asset> other,
70 EqualityOptions options,
74 void add (boost::shared_ptr<Reel> reel);
75 void add (DecryptedKDM const &);
77 /** @return contents of the <AnnotationText> node */
78 std::string annotation_text () const {
79 return _annotation_text;
82 void set_issuer (std::string issuer) {
86 void set_creator (std::string creator) {
90 void set_issue_date (std::string issue_date) {
91 _issue_date = issue_date;
94 void set_annotation_text (std::string at) {
95 _annotation_text = at;
98 /** @return contents of the <ContentTitleText> node */
99 std::string content_title_text () const {
100 return _content_title_text;
103 void set_content_title_text (std::string ct) {
104 _content_title_text = ct;
107 /** Set the contents of the ContentVersion tag */
108 void set_content_version (ContentVersion v) {
109 _content_version = v;
112 /** @return the type of the content, used by media servers
113 * to categorise things (e.g. feature, trailer, etc.)
115 ContentKind content_kind () const {
116 return _content_kind;
119 /** @return the reels in this CPL */
120 std::list<boost::shared_ptr<Reel> > reels () const {
124 /** @return the ReelMXFs in this CPL in all reels.
126 std::list<boost::shared_ptr<const ReelMXF> > reel_mxfs () const;
127 std::list<boost::shared_ptr<ReelMXF> > reel_mxfs ();
129 bool encrypted () const;
132 boost::filesystem::path file,
134 boost::shared_ptr<const CertificateChain>
137 void resolve_refs (std::list<boost::shared_ptr<Asset> >);
139 int64_t duration () const;
141 boost::optional<Standard> standard () const {
145 std::list<Rating> ratings () const {
149 void set_ratings (std::list<Rating> r) {
153 ContentVersion content_version () const {
154 return _content_version;
157 static std::string static_pkl_type (Standard standard);
160 /** @return type string for PKLs for this asset */
161 std::string pkl_type (Standard standard) const;
165 std::string _creator;
166 std::string _issue_date;
167 std::string _annotation_text;
168 std::string _content_title_text; ///< <ContentTitleText>
169 ContentKind _content_kind; ///< <ContentKind>
170 ContentVersion _content_version; ///< <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;