2 Copyright (C) 2012-2016 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.
38 #include "certificate_chain.h"
40 #include "reel_picture_asset.h"
41 #include "reel_sound_asset.h"
42 #include "reel_subtitle_asset.h"
43 #include "reel_atmos_asset.h"
44 #include "local_time.h"
45 #include "dcp_assert.h"
46 #include "compose.hpp"
47 #include <libxml/parser.h>
48 #include <libxml++/libxml++.h>
49 #include <boost/foreach.hpp>
56 using boost::shared_ptr;
57 using boost::optional;
58 using boost::dynamic_pointer_cast;
61 static string const cpl_interop_ns = "http://www.digicine.com/PROTO-ASDCP-CPL-20040511#";
62 static string const cpl_smpte_ns = "http://www.smpte-ra.org/schemas/429-7/2006/CPL";
64 CPL::CPL (string annotation_text, ContentKind content_kind)
65 : _annotation_text (annotation_text)
66 /* default _content_title_text to _annotation_text */
67 , _content_title_text (annotation_text)
68 , _content_kind (content_kind)
69 , _content_version_id ("urn:uuid:" + make_uuid ())
71 /* default _content_version_id to a random ID and _content_version_label to
72 a random ID and the current time.
74 _content_version_id = "urn:uuid:" + make_uuid();
75 _content_version_label_text = _content_version_id + LocalTime().as_string ();
78 /** Construct a CPL object from a XML file */
79 CPL::CPL (boost::filesystem::path file)
81 , _content_kind (FEATURE)
83 cxml::Document f ("CompositionPlaylist");
86 if (f.namespace_uri() == cpl_interop_ns) {
88 } else if (f.namespace_uri() == cpl_smpte_ns) {
91 boost::throw_exception (XMLError ("Unrecognised CPL namespace " + f.namespace_uri()));
94 _id = remove_urn_uuid (f.string_child ("Id"));
95 _annotation_text = f.optional_string_child ("AnnotationText").get_value_or ("");
96 _metadata.issuer = f.optional_string_child ("Issuer").get_value_or ("");
97 _metadata.creator = f.optional_string_child ("Creator").get_value_or ("");
98 _metadata.issue_date = f.string_child ("IssueDate");
99 _content_title_text = f.string_child ("ContentTitleText");
100 _content_kind = content_kind_from_string (f.string_child ("ContentKind"));
101 shared_ptr<cxml::Node> content_version = f.optional_node_child ("ContentVersion");
102 if (content_version) {
103 _content_version_id = content_version->optional_string_child ("Id").get_value_or ("");
104 _content_version_label_text = content_version->string_child ("LabelText");
105 content_version->done ();
107 f.ignore_child ("RatingList");
108 _reels = type_grand_children<Reel> (f, "ReelList", "Reel");
110 f.ignore_child ("Issuer");
111 f.ignore_child ("Signer");
112 f.ignore_child ("Signature");
117 /** Add a reel to this CPL.
118 * @param reel Reel to add.
121 CPL::add (boost::shared_ptr<Reel> reel)
123 _reels.push_back (reel);
126 /** Write an CompositonPlaylist XML file.
127 * @param file Filename to write.
128 * @param standard INTEROP or SMPTE.
129 * @param signer Signer to sign the CPL, or 0 to add no signature.
132 CPL::write_xml (boost::filesystem::path file, Standard standard, shared_ptr<const CertificateChain> signer) const
135 xmlpp::Element* root;
136 if (standard == INTEROP) {
137 root = doc.create_root_node ("CompositionPlaylist", cpl_interop_ns);
139 root = doc.create_root_node ("CompositionPlaylist", cpl_smpte_ns);
143 root->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig");
146 root->add_child("Id")->add_child_text ("urn:uuid:" + _id);
147 root->add_child("AnnotationText")->add_child_text (_annotation_text);
148 root->add_child("IssueDate")->add_child_text (_metadata.issue_date);
149 root->add_child("Issuer")->add_child_text (_metadata.issuer);
150 root->add_child("Creator")->add_child_text (_metadata.creator);
151 root->add_child("ContentTitleText")->add_child_text (_content_title_text);
152 root->add_child("ContentKind")->add_child_text (content_kind_to_string (_content_kind));
154 xmlpp::Node* cv = root->add_child ("ContentVersion");
155 cv->add_child ("Id")->add_child_text (_content_version_id);
156 cv->add_child ("LabelText")->add_child_text (_content_version_label_text);
158 root->add_child("RatingList");
160 xmlpp::Element* reel_list = root->add_child ("ReelList");
162 BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
163 i->write_to_cpl (reel_list, standard);
167 signer->sign (root, standard);
170 /* This must not be the _formatted version otherwise signature digests will be wrong */
171 doc.write_to_file (file.string (), "UTF-8");
176 list<shared_ptr<const ReelAsset> >
177 CPL::reel_assets () const
179 list<shared_ptr<const ReelAsset> > c;
181 BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
182 if (i->main_picture ()) {
183 c.push_back (i->main_picture());
185 if (i->main_sound ()) {
186 c.push_back (i->main_sound());
188 if (i->main_subtitle ()) {
189 c.push_back (i->main_subtitle());
192 c.push_back (i->atmos());
200 CPL::equals (shared_ptr<const Asset> other, EqualityOptions opt, NoteHandler note) const
202 shared_ptr<const CPL> other_cpl = dynamic_pointer_cast<const CPL> (other);
207 if (_annotation_text != other_cpl->_annotation_text && !opt.cpl_annotation_texts_can_differ) {
208 string const s = "CPL: annotation texts differ: " + _annotation_text + " vs " + other_cpl->_annotation_text + "\n";
213 if (_content_kind != other_cpl->_content_kind) {
214 note (DCP_ERROR, "CPL: content kinds differ");
218 if (_reels.size() != other_cpl->_reels.size()) {
219 note (DCP_ERROR, String::compose ("CPL: reel counts differ (%1 vs %2)", _reels.size(), other_cpl->_reels.size()));
223 list<shared_ptr<Reel> >::const_iterator a = _reels.begin ();
224 list<shared_ptr<Reel> >::const_iterator b = other_cpl->_reels.begin ();
226 while (a != _reels.end ()) {
227 if (!(*a)->equals (*b, opt, note)) {
237 /** @return true if we have any encrypted content */
239 CPL::encrypted () const
241 BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
242 if (i->encrypted ()) {
250 /** Add a KDM to this CPL. If the KDM is for any of this CPLs assets it will be used
251 * to decrypt those assets.
255 CPL::add (DecryptedKDM const & kdm)
257 BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
263 CPL::resolve_refs (list<shared_ptr<Asset> > assets)
265 BOOST_FOREACH (shared_ptr<Reel> i, _reels) {
266 i->resolve_refs (assets);
271 CPL::pkl_type (Standard standard) const
275 return "text/xml;asdcpKind=CPL";
284 CPL::duration () const
287 BOOST_FOREACH (shared_ptr<Reel> i, _reels) {