2 Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include "raw_convert.h"
26 #include "sound_mxf.h"
27 #include "picture_mxf.h"
28 #include "interop_subtitle_content.h"
29 #include "smpte_subtitle_content.h"
30 #include "mono_picture_mxf.h"
31 #include "stereo_picture_mxf.h"
34 #include "exceptions.h"
37 #include "compose.hpp"
39 #include "decrypted_kdm.h"
40 #include "decrypted_kdm_key.h"
41 #include "dcp_assert.h"
42 #include <xmlsec/xmldsig.h>
43 #include <xmlsec/app.h>
44 #include <libxml++/libxml++.h>
45 #include <boost/filesystem.hpp>
46 #include <boost/algorithm/string.hpp>
47 #include <boost/foreach.hpp>
58 using boost::shared_ptr;
59 using boost::algorithm::starts_with;
62 DCP::DCP (boost::filesystem::path directory)
63 : _directory (directory)
65 if (!boost::filesystem::exists (directory)) {
66 boost::filesystem::create_directories (directory);
69 _directory = boost::filesystem::canonical (_directory);
72 template<class T> void
73 survivable_error (bool keep_going, dcp::DCP::ReadErrors* errors, T const & e)
77 errors->push_back (shared_ptr<T> (new T (e)));
85 DCP::read (bool keep_going, ReadErrors* errors)
87 /* Read the ASSETMAP */
89 boost::filesystem::path asset_map_file;
90 if (boost::filesystem::exists (_directory / "ASSETMAP")) {
91 asset_map_file = _directory / "ASSETMAP";
92 } else if (boost::filesystem::exists (_directory / "ASSETMAP.xml")) {
93 asset_map_file = _directory / "ASSETMAP.xml";
95 boost::throw_exception (DCPReadError (String::compose ("could not find AssetMap file in `%1'", _directory.string())));
98 cxml::Document asset_map ("AssetMap");
99 asset_map.read_file (asset_map_file);
100 list<shared_ptr<cxml::Node> > asset_nodes = asset_map.node_child("AssetList")->node_children ("Asset");
101 map<string, boost::filesystem::path> paths;
102 BOOST_FOREACH (shared_ptr<cxml::Node> i, asset_nodes) {
103 if (i->node_child("ChunkList")->node_children("Chunk").size() != 1) {
104 boost::throw_exception (XMLError ("unsupported asset chunk count"));
106 string p = i->node_child("ChunkList")->node_child("Chunk")->string_child ("Path");
107 if (starts_with (p, "file://")) {
110 paths.insert (make_pair (i->string_child ("Id"), p));
113 /* Read all the assets from the asset map */
114 /* XXX: I think we should be looking at the PKL here to decide type, not
115 the extension of the file.
117 for (map<string, boost::filesystem::path>::const_iterator i = paths.begin(); i != paths.end(); ++i) {
118 boost::filesystem::path path = _directory / i->second;
120 if (!boost::filesystem::exists (path)) {
121 survivable_error (keep_going, errors, MissingAssetError (path));
125 if (boost::algorithm::ends_with (path.string(), ".xml")) {
126 xmlpp::DomParser* p = new xmlpp::DomParser;
128 p->parse_file (path.string());
129 } catch (std::exception& e) {
134 string const root = p->get_document()->get_root_node()->get_name ();
137 if (root == "CompositionPlaylist") {
138 _assets.push_back (shared_ptr<CPL> (new CPL (path)));
139 } else if (root == "DCSubtitle") {
140 _assets.push_back (shared_ptr<InteropSubtitleContent> (new InteropSubtitleContent (path)));
142 } else if (boost::algorithm::ends_with (path.string(), ".mxf")) {
143 ASDCP::EssenceType_t type;
144 if (ASDCP::EssenceType (path.string().c_str(), type) != ASDCP::RESULT_OK) {
145 throw DCPReadError ("Could not find essence type");
148 case ASDCP::ESS_UNKNOWN:
149 case ASDCP::ESS_MPEG2_VES:
150 throw DCPReadError ("MPEG2 video essences are not supported");
151 case ASDCP::ESS_JPEG_2000:
152 _assets.push_back (shared_ptr<MonoPictureMXF> (new MonoPictureMXF (path)));
154 case ASDCP::ESS_PCM_24b_48k:
155 case ASDCP::ESS_PCM_24b_96k:
156 _assets.push_back (shared_ptr<SoundMXF> (new SoundMXF (path)));
158 case ASDCP::ESS_JPEG_2000_S:
159 _assets.push_back (shared_ptr<StereoPictureMXF> (new StereoPictureMXF (path)));
161 case ASDCP::ESS_TIMED_TEXT:
162 _assets.push_back (shared_ptr<SMPTESubtitleContent> (new SMPTESubtitleContent (path)));
165 throw DCPReadError ("Unknown MXF essence type");
170 BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
171 i->resolve_refs (list_of_type<Asset, Object> (assets ()));
176 DCP::equals (DCP const & other, EqualityOptions opt, NoteHandler note) const
178 list<shared_ptr<CPL> > a = cpls ();
179 list<shared_ptr<CPL> > b = other.cpls ();
181 if (a.size() != b.size()) {
182 note (DCP_ERROR, String::compose ("CPL counts differ: %1 vs %2", a.size(), b.size()));
188 BOOST_FOREACH (shared_ptr<CPL> i, a) {
189 list<shared_ptr<CPL> >::const_iterator j = b.begin ();
190 while (j != b.end() && !(*j)->equals (i, opt, note)) {
203 DCP::add (boost::shared_ptr<Asset> asset)
205 _assets.push_back (asset);
209 DCP::encrypted () const
211 BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
212 if (i->encrypted ()) {
221 DCP::add (DecryptedKDM const & kdm)
223 list<DecryptedKDMKey> keys = kdm.keys ();
225 BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
226 BOOST_FOREACH (DecryptedKDMKey const & j, kdm.keys ()) {
227 if (j.cpl_id() == i->id()) {
234 boost::filesystem::path
235 DCP::write_pkl (Standard standard, string pkl_uuid, XMLMetadata metadata, shared_ptr<const Signer> signer) const
237 boost::filesystem::path p = _directory;
238 p /= String::compose ("pkl_%1.xml", pkl_uuid);
242 if (standard == INTEROP) {
243 pkl = doc.create_root_node("PackingList", "http://www.digicine.com/PROTO-ASDCP-PKL-20040311#");
245 pkl = doc.create_root_node("PackingList", "http://www.smpte-ra.org/schemas/429-8/2007/PKL");
249 pkl->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig");
252 pkl->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid);
254 /* XXX: this is a bit of a hack */
255 DCP_ASSERT (cpls().size() > 0);
256 pkl->add_child("AnnotationText")->add_child_text (cpls().front()->annotation_text ());
258 pkl->add_child("IssueDate")->add_child_text (metadata.issue_date);
259 pkl->add_child("Issuer")->add_child_text (metadata.issuer);
260 pkl->add_child("Creator")->add_child_text (metadata.creator);
262 xmlpp::Element* asset_list = pkl->add_child("AssetList");
263 BOOST_FOREACH (shared_ptr<Asset> i, _assets) {
264 i->write_to_pkl (asset_list, standard);
268 signer->sign (pkl, standard);
271 doc.write_to_file (p.string (), "UTF-8");
275 /** Write the VOLINDEX file.
276 * @param standard DCP standard to use (INTEROP or SMPTE)
279 DCP::write_volindex (Standard standard) const
281 boost::filesystem::path p = _directory;
294 xmlpp::Element* root;
298 root = doc.create_root_node ("VolumeIndex", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#");
301 root = doc.create_root_node ("VolumeIndex", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
307 root->add_child("Index")->add_child_text ("1");
308 doc.write_to_file (p.string (), "UTF-8");
312 DCP::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMetadata metadata) const
314 boost::filesystem::path p = _directory;
328 xmlpp::Element* root;
332 root = doc.create_root_node ("AssetMap", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#");
335 root = doc.create_root_node ("AssetMap", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
341 root->add_child("Id")->add_child_text ("urn:uuid:" + make_uuid());
342 root->add_child("AnnotationText")->add_child_text ("Created by " + metadata.creator);
346 root->add_child("VolumeCount")->add_child_text ("1");
347 root->add_child("IssueDate")->add_child_text (metadata.issue_date);
348 root->add_child("Issuer")->add_child_text (metadata.issuer);
349 root->add_child("Creator")->add_child_text (metadata.creator);
352 root->add_child("Creator")->add_child_text (metadata.creator);
353 root->add_child("VolumeCount")->add_child_text ("1");
354 root->add_child("IssueDate")->add_child_text (metadata.issue_date);
355 root->add_child("Issuer")->add_child_text (metadata.issuer);
361 xmlpp::Node* asset_list = root->add_child ("AssetList");
363 xmlpp::Node* asset = asset_list->add_child ("Asset");
364 asset->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid);
365 asset->add_child("PackingList")->add_child_text ("true");
366 xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
367 xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
368 chunk->add_child("Path")->add_child_text ("pkl_" + pkl_uuid + ".xml");
369 chunk->add_child("VolumeIndex")->add_child_text ("1");
370 chunk->add_child("Offset")->add_child_text ("0");
371 chunk->add_child("Length")->add_child_text (raw_convert<string> (pkl_length));
373 BOOST_FOREACH (shared_ptr<Asset> i, _assets) {
374 i->write_to_assetmap (asset_list, _directory);
377 /* This must not be the _formatted version otherwise signature digests will be wrong */
378 doc.write_to_file (p.string (), "UTF-8");
381 /** Write all the XML files for this DCP.
382 * @param standand INTEROP or SMPTE.
383 * @param metadata Metadata to use for PKL and asset map files.
384 * @param signer Signer to use, or 0.
389 XMLMetadata metadata,
390 shared_ptr<const Signer> signer
393 BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
394 string const filename = "cpl_" + i->id() + ".xml";
395 i->write_xml (_directory / filename, standard, signer);
398 string const pkl_uuid = make_uuid ();
399 boost::filesystem::path const pkl_path = write_pkl (standard, pkl_uuid, metadata, signer);
401 write_volindex (standard);
402 write_assetmap (standard, pkl_uuid, boost::filesystem::file_size (pkl_path), metadata);
405 list<shared_ptr<CPL> >
408 return list_of_type<Asset, CPL> (_assets);