Move DCP -> Package with a token DCP class.

1 files changed, 426 insertions, 0 deletions

diff --git a/src/package.cc b/src/package.cc
new file mode 100644
index 00000000..a3c72bf7
--- /dev/null
+++ b/src/package.cc
@@ -0,0 +1,426 @@
+/*
+    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+*/
+
+/** @file  src/package.cc
+ *  @brief Package class.
+ */
+
+#include "raw_convert.h"
+#include "package.h"
+#include "sound_asset.h"
+#include "picture_asset.h"
+#include "interop_subtitle_asset.h"
+#include "smpte_subtitle_asset.h"
+#include "mono_picture_asset.h"
+#include "stereo_picture_asset.h"
+#include "reel_subtitle_asset.h"
+#include "util.h"
+#include "metadata.h"
+#include "exceptions.h"
+#include "cpl.h"
+#include "certificate_chain.h"
+#include "compose.hpp"
+#include "AS_DCP.h"
+#include "decrypted_kdm.h"
+#include "decrypted_kdm_key.h"
+#include "dcp_assert.h"
+#include "reel_asset.h"
+#include "font_asset.h"
+#include <xmlsec/xmldsig.h>
+#include <xmlsec/app.h>
+#include <libxml++/libxml++.h>
+#include <boost/filesystem.hpp>
+#include <boost/algorithm/string.hpp>
+#include <boost/foreach.hpp>
+#include <iostream>
+
+using std::string;
+using std::list;
+using std::cout;
+using std::ostream;
+using std::make_pair;
+using std::map;
+using std::cout;
+using std::cerr;
+using std::exception;
+using boost::shared_ptr;
+using boost::dynamic_pointer_cast;
+using boost::algorithm::starts_with;
+using namespace dcp;
+
+Package::Package (boost::filesystem::path directory)
+{
+	if (!boost::filesystem::exists (directory)) {
+		boost::filesystem::create_directories (directory);
+	}
+
+	_directory = boost::filesystem::canonical (directory);
+}
+
+template<class T> void
+survivable_error (bool keep_going, dcp::Package::ReadErrors* errors, T const & e)
+{
+	if (keep_going) {
+		if (errors) {
+			errors->push_back (shared_ptr<T> (new T (e)));
+		}
+	} else {
+		throw e;
+	}
+}
+
+void
+Package::read (bool keep_going, ReadErrors* errors)
+{
+	/* Read the ASSETMAP */
+
+	boost::filesystem::path asset_map_file;
+	if (boost::filesystem::exists (_directory / "ASSETMAP")) {
+		asset_map_file = _directory / "ASSETMAP";
+	} else if (boost::filesystem::exists (_directory / "ASSETMAP.xml")) {
+		asset_map_file = _directory / "ASSETMAP.xml";
+	} else {
+		boost::throw_exception (PackageReadError (String::compose ("could not find AssetMap file in `%1'", _directory.string())));
+	}
+
+	cxml::Document asset_map ("AssetMap");
+	asset_map.read_file (asset_map_file);
+	list<shared_ptr<cxml::Node> > asset_nodes = asset_map.node_child("AssetList")->node_children ("Asset");
+	map<string, boost::filesystem::path> paths;
+	BOOST_FOREACH (shared_ptr<cxml::Node> i, asset_nodes) {
+		if (i->node_child("ChunkList")->node_children("Chunk").size() != 1) {
+			boost::throw_exception (XMLError ("unsupported asset chunk count"));
+		}
+		string p = i->node_child("ChunkList")->node_child("Chunk")->string_child ("Path");
+		if (starts_with (p, "file://")) {
+			p = p.substr (7);
+		}
+		paths.insert (make_pair (i->string_child ("Id"), p));
+	}
+
+	/* Read all the assets from the asset map */
+	/* XXX: I think we should be looking at the PKL here to decide type, not
+	   the extension of the file.
+	*/
+
+	/* Make a list of non-CPL assets so that we can resolve the references
+	   from the CPLs.
+	*/
+	list<shared_ptr<Asset> > other_assets;
+
+	for (map<string, boost::filesystem::path>::const_iterator i = paths.begin(); i != paths.end(); ++i) {
+		boost::filesystem::path path = _directory / i->second;
+
+		if (!boost::filesystem::exists (path)) {
+			survivable_error (keep_going, errors, MissingAssetError (path));
+			continue;
+		}
+
+		if (boost::filesystem::extension (path) == ".xml") {
+			xmlpp::DomParser* p = new xmlpp::DomParser;
+			try {
+				p->parse_file (path.string());
+			} catch (std::exception& e) {
+				delete p;
+				continue;
+			}
+
+			string const root = p->get_document()->get_root_node()->get_name ();
+			delete p;
+
+			if (root == "CompositionPlaylist") {
+				_cpls.push_back (shared_ptr<CPL> (new CPL (path)));
+			} else if (root == "DCSubtitle") {
+				other_assets.push_back (shared_ptr<InteropSubtitleAsset> (new InteropSubtitleAsset (path)));
+			}
+		} else if (boost::filesystem::extension (path) == ".mxf") {
+			ASDCP::EssenceType_t type;
+			if (ASDCP::EssenceType (path.string().c_str(), type) != ASDCP::RESULT_OK) {
+				throw PackageReadError ("Could not find essence type");
+			}
+			switch (type) {
+				case ASDCP::ESS_UNKNOWN:
+				case ASDCP::ESS_MPEG2_VES:
+					throw PackageReadError ("MPEG2 video essences are not supported");
+				case ASDCP::ESS_JPEG_2000:
+					other_assets.push_back (shared_ptr<MonoPictureAsset> (new MonoPictureAsset (path)));
+					break;
+				case ASDCP::ESS_PCM_24b_48k:
+				case ASDCP::ESS_PCM_24b_96k:
+					other_assets.push_back (shared_ptr<SoundAsset> (new SoundAsset (path)));
+					break;
+				case ASDCP::ESS_JPEG_2000_S:
+					other_assets.push_back (shared_ptr<StereoPictureAsset> (new StereoPictureAsset (path)));
+					break;
+				case ASDCP::ESS_TIMED_TEXT:
+					other_assets.push_back (shared_ptr<SMPTESubtitleAsset> (new SMPTESubtitleAsset (path)));
+					break;
+				default:
+					throw PackageReadError ("Unknown MXF essence type");
+			}
+		} else if (boost::filesystem::extension (path) == ".ttf") {
+			other_assets.push_back (shared_ptr<FontAsset> (new FontAsset (i->first, path)));
+		}
+	}
+
+	BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
+		i->resolve_refs (other_assets);
+	}
+}
+
+void
+Package::resolve_refs (list<shared_ptr<Asset> > assets)
+{
+	BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
+		i->resolve_refs (assets);
+	}
+}
+
+bool
+Package::equals (Package const & other, EqualityOptions opt, NoteHandler note) const
+{
+	list<shared_ptr<CPL> > a = cpls ();
+	list<shared_ptr<CPL> > b = other.cpls ();
+
+	if (a.size() != b.size()) {
+		note (DCP_ERROR, String::compose ("CPL counts differ: %1 vs %2", a.size(), b.size()));
+		return false;
+	}
+
+	bool r = true;
+
+	BOOST_FOREACH (shared_ptr<CPL> i, a) {
+		list<shared_ptr<CPL> >::const_iterator j = b.begin ();
+		while (j != b.end() && !(*j)->equals (i, opt, note)) {
+			++j;
+		}
+
+		if (j == b.end ()) {
+			r = false;
+		}
+	}
+
+	return r;
+}
+
+void
+Package::add (boost::shared_ptr<CPL> cpl)
+{
+	_cpls.push_back (cpl);
+}
+
+bool
+Package::encrypted () const
+{
+	BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
+		if (i->encrypted ()) {
+			return true;
+		}
+	}
+
+	return false;
+}
+
+void
+Package::add (DecryptedKDM const & kdm)
+{
+	list<DecryptedKDMKey> keys = kdm.keys ();
+
+	BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
+		BOOST_FOREACH (DecryptedKDMKey const & j, kdm.keys ()) {
+			if (j.cpl_id() == i->id()) {
+				i->add (kdm);
+			}
+		}
+	}
+}
+
+boost::filesystem::path
+Package::write_pkl (Standard standard, string pkl_uuid, XMLMetadata metadata, shared_ptr<const CertificateChain> signer) const
+{
+	boost::filesystem::path p = _directory;
+	p /= String::compose ("pkl_%1.xml", pkl_uuid);
+
+	xmlpp::Document doc;
+	xmlpp::Element* pkl;
+	if (standard == INTEROP) {
+		pkl = doc.create_root_node("PackingList", "http://www.digicine.com/PROTO-ASDCP-PKL-20040311#");
+	} else {
+		pkl = doc.create_root_node("PackingList", "http://www.smpte-ra.org/schemas/429-8/2007/PKL");
+	}
+
+	if (signer) {
+		pkl->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig");
+	}
+
+	pkl->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid);
+
+	/* XXX: this is a bit of a hack */
+	DCP_ASSERT (cpls().size() > 0);
+	pkl->add_child("AnnotationText")->add_child_text (cpls().front()->annotation_text ());
+
+	pkl->add_child("IssueDate")->add_child_text (metadata.issue_date);
+	pkl->add_child("Issuer")->add_child_text (metadata.issuer);
+	pkl->add_child("Creator")->add_child_text (metadata.creator);
+
+	xmlpp::Element* asset_list = pkl->add_child("AssetList");
+	BOOST_FOREACH (shared_ptr<Asset> i, assets ()) {
+		i->write_to_pkl (asset_list, _directory, standard);
+	}
+
+	if (signer) {
+		signer->sign (pkl, standard);
+	}
+
+	doc.write_to_file (p.string (), "UTF-8");
+	return p.string ();
+}
+
+/** Write the VOLINDEX file.
+ *  @param standard DCP standard to use (INTEROP or SMPTE)
+ */
+void
+Package::write_volindex (Standard standard) const
+{
+	boost::filesystem::path p = _directory;
+	switch (standard) {
+	case INTEROP:
+		p /= "VOLINDEX";
+		break;
+	case SMPTE:
+		p /= "VOLINDEX.xml";
+		break;
+	default:
+		DCP_ASSERT (false);
+	}
+
+	xmlpp::Document doc;
+	xmlpp::Element* root;
+
+	switch (standard) {
+	case INTEROP:
+		root = doc.create_root_node ("VolumeIndex", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#");
+		break;
+	case SMPTE:
+		root = doc.create_root_node ("VolumeIndex", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
+		break;
+	default:
+		DCP_ASSERT (false);
+	}
+
+	root->add_child("Index")->add_child_text ("1");
+	doc.write_to_file (p.string (), "UTF-8");
+}
+
+void
+Package::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMetadata metadata) const
+{
+	boost::filesystem::path p = _directory;
+
+	switch (standard) {
+	case INTEROP:
+		p /= "ASSETMAP";
+		break;
+	case SMPTE:
+		p /= "ASSETMAP.xml";
+		break;
+	default:
+		DCP_ASSERT (false);
+	}
+
+	xmlpp::Document doc;
+	xmlpp::Element* root;
+
+	switch (standard) {
+	case INTEROP:
+		root = doc.create_root_node ("AssetMap", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#");
+		break;
+	case SMPTE:
+		root = doc.create_root_node ("AssetMap", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
+		break;
+	default:
+		DCP_ASSERT (false);
+	}
+
+	root->add_child("Id")->add_child_text ("urn:uuid:" + make_uuid());
+	root->add_child("AnnotationText")->add_child_text ("Created by " + metadata.creator);
+
+	switch (standard) {
+	case INTEROP:
+		root->add_child("VolumeCount")->add_child_text ("1");
+		root->add_child("IssueDate")->add_child_text (metadata.issue_date);
+		root->add_child("Issuer")->add_child_text (metadata.issuer);
+		root->add_child("Creator")->add_child_text (metadata.creator);
+		break;
+	case SMPTE:
+		root->add_child("Creator")->add_child_text (metadata.creator);
+		root->add_child("VolumeCount")->add_child_text ("1");
+		root->add_child("IssueDate")->add_child_text (metadata.issue_date);
+		root->add_child("Issuer")->add_child_text (metadata.issuer);
+		break;
+	default:
+		DCP_ASSERT (false);
+	}
+
+	xmlpp::Node* asset_list = root->add_child ("AssetList");
+
+	xmlpp::Node* asset = asset_list->add_child ("Asset");
+	asset->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid);
+	asset->add_child("PackingList")->add_child_text ("true");
+	xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
+	xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
+	chunk->add_child("Path")->add_child_text ("pkl_" + pkl_uuid + ".xml");
+	chunk->add_child("VolumeIndex")->add_child_text ("1");
+	chunk->add_child("Offset")->add_child_text ("0");
+	chunk->add_child("Length")->add_child_text (raw_convert<string> (pkl_length));
+
+	BOOST_FOREACH (shared_ptr<Asset> i, assets ()) {
+		i->write_to_assetmap (asset_list, _directory);
+	}
+
+	/* This must not be the _formatted version otherwise signature digests will be wrong */
+	doc.write_to_file (p.string (), "UTF-8");
+}
+
+list<shared_ptr<CPL> >
+Package::cpls () const
+{
+	return _cpls;
+}
+
+/** @return All assets (including CPLs) */
+list<shared_ptr<Asset> >
+Package::assets () const
+{
+	list<shared_ptr<Asset> > assets;
+	BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
+		assets.push_back (i);
+		BOOST_FOREACH (shared_ptr<const ReelAsset> j, i->reel_assets ()) {
+			shared_ptr<Asset> o = j->asset_ref().asset ();
+			assets.push_back (o);
+			/* More Interop special-casing */
+			shared_ptr<InteropSubtitleAsset> sub = dynamic_pointer_cast<InteropSubtitleAsset> (o);
+			if (sub) {
+				sub->add_font_assets (assets);
+			}
+		}
+	}
+
+	return assets;
+}