X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fdcp.cc;h=53d5dd39843f27fd0b91a97b6bedcb0a2f118f74;hb=c4db5b5396c6401c63d80777a812e8adc642ce02;hp=c7634b5d3385d1a9cafd5b847dffd41dd4540d66;hpb=8526058d24faec5f83ffd66758fef8d8c8159f73;p=libdcp.git diff --git a/src/dcp.cc b/src/dcp.cc index c7634b5d..53d5dd39 100644 --- a/src/dcp.cc +++ b/src/dcp.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2015 Carl Hetherington 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 @@ -18,279 +18,426 @@ */ /** @file src/dcp.cc - * @brief A class to create a DCP. + * @brief DCP class. */ -#include -#include -#include -#include -#include -#include -#include -#include -#include +#include "raw_convert.h" #include "dcp.h" -#include "asset.h" #include "sound_asset.h" #include "picture_asset.h" -#include "subtitle_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 "parse/pkl.h" -#include "parse/asset_map.h" -#include "reel.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 +#include +#include +#include +#include +#include +#include using std::string; using std::list; -using std::stringstream; -using std::ofstream; +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::lexical_cast; -using namespace libdcp; +using boost::dynamic_pointer_cast; +using boost::algorithm::starts_with; +using namespace dcp; -DCP::DCP (string directory) +DCP::DCP (boost::filesystem::path directory) : _directory (directory) { - boost::filesystem::create_directories (directory); + if (!boost::filesystem::exists (directory)) { + boost::filesystem::create_directories (directory); + } + + _directory = boost::filesystem::canonical (_directory); } -void -DCP::write_xml (XMLMetadata const & metadata) const +template void +survivable_error (bool keep_going, dcp::DCP::ReadErrors* errors, T const & e) { - for (list >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) { - (*i)->write_xml (metadata); + if (keep_going) { + if (errors) { + errors->push_back (shared_ptr (new T (e))); + } + } else { + throw e; } - - string pkl_uuid = make_uuid (); - string pkl_path = write_pkl (pkl_uuid, metadata); - - write_volindex (); - write_assetmap (pkl_uuid, boost::filesystem::file_size (pkl_path), metadata); } -std::string -DCP::write_pkl (string pkl_uuid, XMLMetadata const & metadata) const +void +DCP::read (bool keep_going, ReadErrors* errors) { - assert (!_cpls.empty ()); - - boost::filesystem::path p; - p /= _directory; - stringstream s; - s << pkl_uuid << "_pkl.xml"; - p /= s.str(); + /* 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 (DCPReadError (String::compose ("could not find AssetMap file in `%1'", _directory.string()))); + } - xmlpp::Document doc; - xmlpp::Element* root = doc.create_root_node ("PackingList", "http://www.smpte-ra.org/schemas/429-8/2007/PKL"); + cxml::Document asset_map ("AssetMap"); + asset_map.read_file (asset_map_file); + list > asset_nodes = asset_map.node_child("AssetList")->node_children ("Asset"); + map paths; + BOOST_FOREACH (shared_ptr 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)); + } - root->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid); - /* XXX: this is a bit of a hack */ - root->add_child("AnnotationText")->add_child_text (_cpls.front()->name()); - 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); + /* 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. + */ - xmlpp::Node* asset_list = root->add_child ("AssetList"); + /* Make a list of non-CPL assets so that we can resolve the references + from the CPLs. + */ + list > other_assets; - list > a = assets (); - for (list >::const_iterator i = a.begin(); i != a.end(); ++i) { - (*i)->write_to_pkl (asset_list); - } + for (map::const_iterator i = paths.begin(); i != paths.end(); ++i) { + boost::filesystem::path path = _directory / i->second; - for (list >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) { - (*i)->write_to_pkl (asset_list); - } + if (!boost::filesystem::exists (path)) { + survivable_error (keep_going, errors, MissingAssetError (path)); + continue; + } - doc.write_to_file_formatted (p.string (), "UTF-8"); - return p.string (); -} + 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; + } -void -DCP::write_volindex () const -{ - boost::filesystem::path p; - p /= _directory; - p /= "VOLINDEX.xml"; + string const root = p->get_document()->get_root_node()->get_name (); + delete p; - xmlpp::Document doc; - xmlpp::Element* root = doc.create_root_node ("VolumeIndex", "http://www.smpte-ra.org/schemas/429-9/2007/AM"); - root->add_child("Index")->add_child_text ("1"); - doc.write_to_file_formatted (p.string (), "UTF-8"); + if (root == "CompositionPlaylist") { + _cpls.push_back (shared_ptr (new CPL (path))); + } else if (root == "DCSubtitle") { + other_assets.push_back (shared_ptr (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 DCPReadError ("Could not find essence type"); + } + switch (type) { + case ASDCP::ESS_UNKNOWN: + case ASDCP::ESS_MPEG2_VES: + throw DCPReadError ("MPEG2 video essences are not supported"); + case ASDCP::ESS_JPEG_2000: + other_assets.push_back (shared_ptr (new MonoPictureAsset (path))); + break; + case ASDCP::ESS_PCM_24b_48k: + case ASDCP::ESS_PCM_24b_96k: + other_assets.push_back (shared_ptr (new SoundAsset (path))); + break; + case ASDCP::ESS_JPEG_2000_S: + other_assets.push_back (shared_ptr (new StereoPictureAsset (path))); + break; + case ASDCP::ESS_TIMED_TEXT: + other_assets.push_back (shared_ptr (new SMPTESubtitleAsset (path))); + break; + default: + throw DCPReadError ("Unknown MXF essence type"); + } + } else if (boost::filesystem::extension (path) == ".ttf") { + other_assets.push_back (shared_ptr (new FontAsset (i->first, path))); + } + } + + BOOST_FOREACH (shared_ptr i, cpls ()) { + i->resolve_refs (list_of_type (other_assets)); + } } -void -DCP::write_assetmap (string pkl_uuid, int pkl_length, XMLMetadata const & metadata) const +bool +DCP::equals (DCP const & other, EqualityOptions opt, NoteHandler note) const { - boost::filesystem::path p; - p /= _directory; - p /= "ASSETMAP.xml"; + list > a = cpls (); + list > b = other.cpls (); - xmlpp::Document doc; - xmlpp::Element* root = doc.create_root_node ("AssetMap", "http://www.smpte-ra.org/schemas/429-9/2007/AM"); + if (a.size() != b.size()) { + note (DCP_ERROR, String::compose ("CPL counts differ: %1 vs %2", a.size(), b.size())); + return false; + } - root->add_child("Id")->add_child_text ("urn:uuid:" + make_uuid()); - 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); - xmlpp::Node* asset_list = root->add_child ("AssetList"); + bool r = true; - 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_uuid + "_pkl.xml"); - chunk->add_child("VolumeIndex")->add_child_text ("1"); - chunk->add_child("Offset")->add_child_text ("0"); - chunk->add_child("Length")->add_child_text (lexical_cast (pkl_length)); - - for (list >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) { - (*i)->write_to_assetmap (asset_list); - } + BOOST_FOREACH (shared_ptr i, a) { + list >::const_iterator j = b.begin (); + while (j != b.end() && !(*j)->equals (i, opt, note)) { + ++j; + } - list > a = assets (); - for (list >::const_iterator i = a.begin(); i != a.end(); ++i) { - (*i)->write_to_assetmap (asset_list); + if (j == b.end ()) { + r = false; + } } - doc.write_to_file_formatted (p.string (), "UTF-8"); + return r; } - void -DCP::read (bool require_mxfs) +DCP::add (boost::shared_ptr cpl) { - Files files; + _cpls.push_back (cpl); +} - shared_ptr asset_map; - try { - boost::filesystem::path p = _directory; - p /= "ASSETMAP"; - if (boost::filesystem::exists (p)) { - asset_map.reset (new libdcp::parse::AssetMap (p.string ())); - } else { - p = _directory; - p /= "ASSETMAP.xml"; - if (boost::filesystem::exists (p)) { - asset_map.reset (new libdcp::parse::AssetMap (p.string ())); - } else { - boost::throw_exception (DCPReadError ("could not find AssetMap file")); - } +bool +DCP::encrypted () const +{ + BOOST_FOREACH (shared_ptr i, cpls ()) { + if (i->encrypted ()) { + return true; } - - } catch (FileError& e) { - boost::throw_exception (FileError ("could not load AssetMap file", files.asset_map)); } - for (list >::const_iterator i = asset_map->assets.begin(); i != asset_map->assets.end(); ++i) { - if ((*i)->chunks.size() != 1) { - boost::throw_exception (XMLError ("unsupported asset chunk count")); - } + return false; +} - boost::filesystem::path t = _directory; - t /= (*i)->chunks.front()->path; - - if (boost::algorithm::ends_with (t.string(), ".mxf") || boost::algorithm::ends_with (t.string(), ".ttf")) { - continue; - } +void +DCP::add (DecryptedKDM const & kdm) +{ + list keys = kdm.keys (); - xmlpp::DomParser* p = new xmlpp::DomParser; - try { - p->parse_file (t.string()); - } catch (std::exception& e) { - delete p; - continue; + BOOST_FOREACH (shared_ptr i, cpls ()) { + BOOST_FOREACH (DecryptedKDMKey const & j, kdm.keys ()) { + if (j.cpl_id() == i->id()) { + i->add (kdm); + } } + } +} - string const root = p->get_document()->get_root_node()->get_name (); - delete p; +boost::filesystem::path +DCP::write_pkl (Standard standard, string pkl_uuid, XMLMetadata metadata, shared_ptr signer) const +{ + boost::filesystem::path p = _directory; + p /= String::compose ("pkl_%1.xml", pkl_uuid); - if (root == "CompositionPlaylist") { - files.cpls.push_back (t.string()); - } else if (root == "PackingList") { - if (files.pkl.empty ()) { - files.pkl = t.string(); - } else { - boost::throw_exception (DCPReadError ("duplicate PKLs found")); - } - } + 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 (files.cpls.empty ()) { - boost::throw_exception (FileError ("no CPL files found", "")); + + if (signer) { + pkl->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig"); } - if (files.pkl.empty ()) { - boost::throw_exception (FileError ("no PKL file found", "")); + 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 i, assets ()) { + i->write_to_pkl (asset_list, _directory, standard); } - shared_ptr pkl; - try { - pkl.reset (new parse::PKL (files.pkl)); - } catch (FileError& e) { - boost::throw_exception (FileError ("could not load PKL file", files.pkl)); + if (signer) { + signer->sign (pkl, standard); } - /* Cross-check */ - /* XXX */ + 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 +DCP::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); + } - for (list::iterator i = files.cpls.begin(); i != files.cpls.end(); ++i) { - _cpls.push_back (shared_ptr (new CPL (_directory, *i, asset_map, require_mxfs))); + 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"); } -bool -DCP::equals (DCP const & other, EqualityOptions opt, boost::function note) const +void +DCP::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMetadata metadata) const { - if (_cpls.size() != other._cpls.size()) { - note (ERROR, "CPL counts differ"); - return false; + boost::filesystem::path p = _directory; + + switch (standard) { + case INTEROP: + p /= "ASSETMAP"; + break; + case SMPTE: + p /= "ASSETMAP.xml"; + break; + default: + DCP_ASSERT (false); } - list >::const_iterator a = _cpls.begin (); - list >::const_iterator b = other._cpls.begin (); + 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); + } - while (a != _cpls.end ()) { - if (!(*a)->equals (*b->get(), opt, note)) { - return false; - } - ++a; - ++b; + 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); } - return true; -} + 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 (pkl_length)); + + BOOST_FOREACH (shared_ptr 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"); +} +/** Write all the XML files for this DCP. + * @param standand INTEROP or SMPTE. + * @param metadata Metadata to use for PKL and asset map files. + * @param signer Signer to use, or 0. + */ void -DCP::add_cpl (shared_ptr cpl) +DCP::write_xml ( + Standard standard, + XMLMetadata metadata, + shared_ptr signer + ) { - _cpls.push_back (cpl); + BOOST_FOREACH (shared_ptr i, cpls ()) { + string const filename = "cpl_" + i->id() + ".xml"; + i->write_xml (_directory / filename, standard, signer); + } + + string const pkl_uuid = make_uuid (); + boost::filesystem::path const pkl_path = write_pkl (standard, pkl_uuid, metadata, signer); + + write_volindex (standard); + write_assetmap (standard, pkl_uuid, boost::filesystem::file_size (pkl_path), metadata); } -class AssetComparator +list > +DCP::cpls () const { -public: - bool operator() (shared_ptr a, shared_ptr b) { - return a->uuid() < b->uuid(); - } -}; + return _cpls; +} -list > +/** @return All assets (including CPLs) */ +list > DCP::assets () const { - list > a; - for (list >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) { - list > t = (*i)->assets (); - a.merge (t); + list > assets; + BOOST_FOREACH (shared_ptr i, cpls ()) { + assets.push_back (i); + BOOST_FOREACH (shared_ptr j, i->reel_assets ()) { + shared_ptr o = j->asset_ref().object (); + assets.push_back (o); + /* More Interop special-casing */ + shared_ptr sub = dynamic_pointer_cast (o); + if (sub) { + sub->add_font_assets (assets); + } + } } - a.sort (); - a.unique (); - return a; + return assets; } -