X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fdcp.cc;h=d8c8c130e0e926ab70d99c562b21dd2ee1fc9217;hb=76e3325a16cdf6d7220a61e2b5cfdb9c804cc32c;hp=d38037e1a2bd7f17c95b2f61e774217e540ba606;hpb=d927e9b913606f4fc982885c7582ecaf0e3c5a1a;p=libdcp.git diff --git a/src/dcp.cc b/src/dcp.cc index d38037e1..d8c8c130 100644 --- a/src/dcp.cc +++ b/src/dcp.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2015 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington This file is part of libdcp. @@ -38,6 +38,7 @@ #include "raw_convert.h" #include "dcp.h" #include "sound_asset.h" +#include "atmos_asset.h" #include "picture_asset.h" #include "interop_subtitle_asset.h" #include "smpte_subtitle_asset.h" @@ -50,39 +51,39 @@ #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 "pkl.h" +#include "asset_factory.h" +#include "verify.h" +#include #include #include #include #include #include -#include -#include using std::string; using std::list; +using std::vector; using std::cout; -using std::ostream; using std::make_pair; using std::map; -using std::cout; using std::cerr; +using std::make_shared; using std::exception; -using boost::shared_ptr; -using boost::dynamic_pointer_cast; +using std::shared_ptr; +using std::dynamic_pointer_cast; +using boost::optional; using boost::algorithm::starts_with; using namespace dcp; static string const assetmap_interop_ns = "http://www.digicine.com/PROTO-ASDCP-AM-20040311#"; static string const assetmap_smpte_ns = "http://www.smpte-ra.org/schemas/429-9/2007/AM"; -static string const pkl_interop_ns = "http://www.digicine.com/PROTO-ASDCP-PKL-20040311#"; -static string const pkl_smpte_ns = "http://www.smpte-ra.org/schemas/429-8/2007/PKL"; -static string const volindex_interop_ns = "http://www.digicine.com/PROTO-ASDCP-AM-20040311#"; +static string const volindex_interop_ns = "http://www.digicine.com/PROTO-ASDCP-VL-20040311#"; static string const volindex_smpte_ns = "http://www.smpte-ra.org/schemas/429-9/2007/AM"; DCP::DCP (boost::filesystem::path directory) @@ -95,152 +96,189 @@ DCP::DCP (boost::filesystem::path directory) _directory = boost::filesystem::canonical (_directory); } -/** Call this instead of throwing an exception if the error can be tolerated */ -template void -survivable_error (bool keep_going, dcp::DCP::ReadErrors* errors, T const & e) -{ - if (keep_going) { - if (errors) { - errors->push_back (shared_ptr (new T (e))); - } - } else { - throw e; - } -} - +/** Read a DCP. This method does not do any deep checking of the DCP's validity, but + * if it comes across any bad things it will do one of two things. + * + * Errors that are so serious that they prevent the method from working will result + * in an exception being thrown. For example, a missing ASSETMAP means that the DCP + * can't be read without a lot of guesswork, so this will throw. + * + * Errors that are not fatal will be added to notes, if it's non-0. For example, + * if the DCP contains a mixture of Interop and SMPTE elements this will result + * in a note being added to the vector. + */ void -DCP::read (bool keep_going, ReadErrors* errors, bool ignore_incorrect_picture_mxf_type) +DCP::read (vector* notes, bool ignore_incorrect_picture_mxf_type) { - /* Read the ASSETMAP */ + /* Read the ASSETMAP and PKL */ - boost::filesystem::path asset_map_file; if (boost::filesystem::exists (_directory / "ASSETMAP")) { - asset_map_file = _directory / "ASSETMAP"; + _asset_map = _directory / "ASSETMAP"; } else if (boost::filesystem::exists (_directory / "ASSETMAP.xml")) { - asset_map_file = _directory / "ASSETMAP.xml"; + _asset_map = _directory / "ASSETMAP.xml"; } else { - boost::throw_exception (DCPReadError (String::compose ("could not find AssetMap file in `%1'", _directory.string()))); + boost::throw_exception (ReadError(String::compose("Could not find ASSETMAP nor ASSETMAP.xml in '%1'", _directory.string()))); } cxml::Document asset_map ("AssetMap"); - asset_map.read_file (asset_map_file); + asset_map.read_file (_asset_map.get()); if (asset_map.namespace_uri() == assetmap_interop_ns) { - _standard = INTEROP; + _standard = Standard::INTEROP; } else if (asset_map.namespace_uri() == assetmap_smpte_ns) { - _standard = SMPTE; + _standard = Standard::SMPTE; } else { boost::throw_exception (XMLError ("Unrecognised Assetmap namespace " + asset_map.namespace_uri())); } - list > asset_nodes = asset_map.node_child("AssetList")->node_children ("Asset"); + auto asset_nodes = asset_map.node_child("AssetList")->node_children ("Asset"); map paths; - BOOST_FOREACH (shared_ptr i, asset_nodes) { + vector pkl_paths; + for (auto 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"); + auto p = i->node_child("ChunkList")->node_child("Chunk")->string_child ("Path"); if (starts_with (p, "file://")) { p = p.substr (7); } - paths.insert (make_pair (remove_urn_uuid (i->string_child ("Id")), p)); + switch (*_standard) { + case Standard::INTEROP: + if (i->optional_node_child("PackingList")) { + pkl_paths.push_back (p); + } else { + paths.insert (make_pair (remove_urn_uuid (i->string_child ("Id")), p)); + } + break; + case Standard::SMPTE: + { + auto pkl_bool = i->optional_string_child("PackingList"); + if (pkl_bool && *pkl_bool == "true") { + pkl_paths.push_back (p); + } else { + paths.insert (make_pair (remove_urn_uuid (i->string_child ("Id")), p)); + } + break; + } + } } - /* 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. - */ + if (pkl_paths.empty()) { + boost::throw_exception (XMLError ("No packing lists found in asset map")); + } + + for (auto i: pkl_paths) { + _pkls.push_back (make_shared(_directory / i)); + } - /* Make a list of non-CPL assets so that we can resolve the references + /* Now we have: + paths - map of files in the DCP that are not PKLs; key is ID, value is path. + _pkls - PKL objects for each PKL. + + Read all the assets from the asset map. + */ + + /* Make a list of non-CPL/PKL assets so that we can resolve the references from the CPLs. */ - list > other_assets; + vector> other_assets; + + for (auto i: paths) { + auto path = _directory / i.second; + + if (i.second.empty()) { + /* I can't see how this is valid, but it's + been seen in the wild with a DCP that + claims to come from ClipsterDCI 5.10.0.5. + */ + if (notes) { + notes->push_back ({VerificationNote::VERIFY_WARNING, VerificationNote::EMPTY_ASSET_PATH}); + } + continue; + } - for (map::const_iterator i = paths.begin(); i != paths.end(); ++i) { - boost::filesystem::path path = _directory / i->second; + if (!boost::filesystem::exists(path)) { + if (notes) { + notes->push_back ({VerificationNote::VERIFY_ERROR, VerificationNote::MISSING_ASSET, path}); + } + continue; + } - if (!boost::filesystem::exists (path)) { - survivable_error (keep_going, errors, MissingAssetError (path)); + /* Find the for this asset from the PKL that contains the asset */ + optional pkl_type; + for (auto j: _pkls) { + pkl_type = j->type(i.first); + if (pkl_type) { + break; + } + } + + if (!pkl_type) { + /* This asset is in the ASSETMAP but not mentioned in any PKL so we don't + * need to worry about it. + */ continue; } - if (boost::filesystem::extension (path) == ".xml") { - xmlpp::DomParser* p = new xmlpp::DomParser; + if (*pkl_type == CPL::static_pkl_type(*_standard) || *pkl_type == InteropSubtitleAsset::static_pkl_type(*_standard)) { + auto p = new xmlpp::DomParser; try { p->parse_file (path.string()); } catch (std::exception& e) { delete p; - continue; + throw ReadError(String::compose("XML error in %1", path.string()), e.what()); } - string const root = p->get_document()->get_root_node()->get_name (); + auto const root = p->get_document()->get_root_node()->get_name (); delete p; if (root == "CompositionPlaylist") { - shared_ptr cpl (new CPL (path)); - if (_standard && cpl->standard() && cpl->standard().get() != _standard.get()) { - survivable_error (keep_going, errors, MismatchedStandardError ()); + auto cpl = make_shared(path); + if (_standard && cpl->standard() && cpl->standard().get() != _standard.get() && notes) { + notes->push_back ({VerificationNote::VERIFY_ERROR, VerificationNote::MISMATCHED_STANDARD}); } _cpls.push_back (cpl); } else if (root == "DCSubtitle") { - if (_standard && _standard.get() == SMPTE) { - survivable_error (keep_going, errors, MismatchedStandardError ()); + if (_standard && _standard.get() == Standard::SMPTE && notes) { + notes->push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::MISMATCHED_STANDARD)); } - other_assets.push_back (shared_ptr (new InteropSubtitleAsset (path))); + other_assets.push_back (make_shared(path)); } - } else if (boost::filesystem::extension (path) == ".mxf") { + } else if ( + *pkl_type == PictureAsset::static_pkl_type(*_standard) || + *pkl_type == SoundAsset::static_pkl_type(*_standard) || + *pkl_type == AtmosAsset::static_pkl_type(*_standard) || + *pkl_type == SMPTESubtitleAsset::static_pkl_type(*_standard) + ) { + + other_assets.push_back (asset_factory(path, ignore_incorrect_picture_mxf_type)); + } else if (*pkl_type == FontAsset::static_pkl_type(*_standard)) { + other_assets.push_back (make_shared(i.first, path)); + } else if (*pkl_type == "image/png") { + /* It's an Interop PNG subtitle; let it go */ + } else { + throw ReadError (String::compose("Unknown asset type %1 in PKL", *pkl_type)); + } + } - /* XXX: asdcplib does not appear to support discovery of read MXFs standard - (Interop / SMPTE) - */ + resolve_refs (other_assets); - 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: - try { - other_assets.push_back (shared_ptr (new MonoPictureAsset (path))); - } catch (dcp::MXFFileError& e) { - if (ignore_incorrect_picture_mxf_type && e.number() == ASDCP::RESULT_SFORMAT) { - /* Tried to load it as mono but the error says it's stereo; try that instead */ - other_assets.push_back (shared_ptr (new StereoPictureAsset (path))); - } else { - throw; - } - } - 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"); + /* While we've got the ASSETMAP lets look and see if this DCP refers to things that are not in its ASSETMAP */ + if (notes) { + for (auto i: cpls()) { + for (auto j: i->reel_mxfs()) { + if (!j->asset_ref().resolved() && paths.find(j->asset_ref().id()) == paths.end()) { + notes->push_back (VerificationNote(VerificationNote::VERIFY_WARNING, VerificationNote::EXTERNAL_ASSET, j->asset_ref().id())); + } } - } 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 (other_assets); - } } void -DCP::resolve_refs (list > assets) +DCP::resolve_refs (vector> assets) { - BOOST_FOREACH (shared_ptr i, cpls ()) { + for (auto i: cpls()) { i->resolve_refs (assets); } } @@ -248,18 +286,18 @@ DCP::resolve_refs (list > assets) bool DCP::equals (DCP const & other, EqualityOptions opt, NoteHandler note) const { - list > a = cpls (); - list > b = other.cpls (); + auto a = cpls (); + auto b = other.cpls (); if (a.size() != b.size()) { - note (DCP_ERROR, String::compose ("CPL counts differ: %1 vs %2", a.size(), b.size())); + note (NoteType::ERROR, String::compose ("CPL counts differ: %1 vs %2", a.size(), b.size())); return false; } bool r = true; - BOOST_FOREACH (shared_ptr i, a) { - list >::const_iterator j = b.begin (); + for (auto i: a) { + auto j = b.begin(); while (j != b.end() && !(*j)->equals (i, opt, note)) { ++j; } @@ -273,16 +311,17 @@ DCP::equals (DCP const & other, EqualityOptions opt, NoteHandler note) const } void -DCP::add (boost::shared_ptr cpl) +DCP::add (std::shared_ptr cpl) { _cpls.push_back (cpl); } + bool -DCP::encrypted () const +DCP::any_encrypted () const { - BOOST_FOREACH (shared_ptr i, cpls ()) { - if (i->encrypted ()) { + for (auto i: cpls()) { + if (i->any_encrypted()) { return true; } } @@ -290,13 +329,31 @@ DCP::encrypted () const return false; } + +bool +DCP::all_encrypted () const +{ + for (auto i: cpls()) { + if (!i->all_encrypted()) { + return false; + } + } + + return true; +} + + +/** Add a KDM to decrypt this DCP. This method must be called after DCP::read() + * or the KDM you specify will be ignored. + * @param kdm KDM to use. + */ void DCP::add (DecryptedKDM const & kdm) { - list keys = kdm.keys (); + auto keys = kdm.keys (); - BOOST_FOREACH (shared_ptr i, cpls ()) { - BOOST_FOREACH (DecryptedKDMKey const & j, kdm.keys ()) { + for (auto i: cpls()) { + for (auto const& j: kdm.keys()) { if (j.cpl_id() == i->id()) { i->add (kdm); } @@ -304,59 +361,18 @@ DCP::add (DecryptedKDM const & kdm) } } -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); - - xmlpp::Document doc; - xmlpp::Element* pkl; - if (standard == INTEROP) { - pkl = doc.create_root_node("PackingList", pkl_interop_ns); - } else { - pkl = doc.create_root_node("PackingList", pkl_smpte_ns); - } - - 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 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 DCP::write_volindex (Standard standard) const { - boost::filesystem::path p = _directory; + auto p = _directory; switch (standard) { - case INTEROP: + case Standard::INTEROP: p /= "VOLINDEX"; break; - case SMPTE: + case Standard::SMPTE: p /= "VOLINDEX.xml"; break; default: @@ -367,10 +383,10 @@ DCP::write_volindex (Standard standard) const xmlpp::Element* root; switch (standard) { - case INTEROP: + case Standard::INTEROP: root = doc.create_root_node ("VolumeIndex", volindex_interop_ns); break; - case SMPTE: + case Standard::SMPTE: root = doc.create_root_node ("VolumeIndex", volindex_smpte_ns); break; default: @@ -378,19 +394,22 @@ DCP::write_volindex (Standard standard) const } root->add_child("Index")->add_child_text ("1"); - doc.write_to_file (p.string (), "UTF-8"); + doc.write_to_file_formatted (p.string (), "UTF-8"); } void -DCP::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMetadata metadata) const +DCP::write_assetmap ( + Standard standard, string pkl_uuid, boost::filesystem::path pkl_path, + string issuer, string creator, string issue_date, string annotation_text + ) const { - boost::filesystem::path p = _directory; + auto p = _directory; switch (standard) { - case INTEROP: + case Standard::INTEROP: p /= "ASSETMAP"; break; - case SMPTE: + case Standard::SMPTE: p /= "ASSETMAP.xml"; break; default: @@ -401,10 +420,10 @@ DCP::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMeta xmlpp::Element* root; switch (standard) { - case INTEROP: + case Standard::INTEROP: root = doc.create_root_node ("AssetMap", assetmap_interop_ns); break; - case SMPTE: + case Standard::SMPTE: root = doc.create_root_node ("AssetMap", assetmap_smpte_ns); break; default: @@ -412,43 +431,43 @@ DCP::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMeta } root->add_child("Id")->add_child_text ("urn:uuid:" + make_uuid()); - root->add_child("AnnotationText")->add_child_text ("Created by " + metadata.creator); + root->add_child("AnnotationText")->add_child_text (annotation_text); switch (standard) { - case INTEROP: + case Standard::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); + root->add_child("IssueDate")->add_child_text (issue_date); + root->add_child("Issuer")->add_child_text (issuer); + root->add_child("Creator")->add_child_text (creator); break; - case SMPTE: - root->add_child("Creator")->add_child_text (metadata.creator); + case Standard::SMPTE: + root->add_child("Creator")->add_child_text (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); + root->add_child("IssueDate")->add_child_text (issue_date); + root->add_child("Issuer")->add_child_text (issuer); break; default: DCP_ASSERT (false); } - xmlpp::Node* asset_list = root->add_child ("AssetList"); + auto asset_list = root->add_child ("AssetList"); - xmlpp::Node* asset = asset_list->add_child ("Asset"); + auto 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"); + auto chunk_list = asset->add_child ("ChunkList"); + auto chunk = chunk_list->add_child ("Chunk"); + chunk->add_child("Path")->add_child_text (pkl_path.filename().string()); 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)); + chunk->add_child("Length")->add_child_text (raw_convert (boost::filesystem::file_size (pkl_path))); - BOOST_FOREACH (shared_ptr i, assets ()) { + for (auto 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"); + doc.write_to_file_formatted (p.string (), "UTF-8"); + _asset_map = p; } /** Write all the XML files for this DCP. @@ -459,45 +478,94 @@ DCP::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMeta void DCP::write_xml ( Standard standard, - XMLMetadata metadata, - shared_ptr signer + string issuer, + string creator, + string issue_date, + string annotation_text, + shared_ptr signer, + NameFormat name_format ) { - BOOST_FOREACH (shared_ptr i, cpls ()) { - string const filename = "cpl_" + i->id() + ".xml"; - i->write_xml (_directory / filename, standard, signer); + for (auto i: cpls()) { + NameFormat::Map values; + values['t'] = "cpl"; + i->write_xml (_directory / (name_format.get(values, "_" + i->id() + ".xml")), standard, signer); + } + + shared_ptr pkl; + + if (_pkls.empty()) { + pkl = make_shared(standard, annotation_text, issue_date, issuer, creator); + _pkls.push_back (pkl); + for (auto i: assets()) { + i->add_to_pkl (pkl, _directory); + } + } else { + pkl = _pkls.front (); } - string const pkl_uuid = make_uuid (); - boost::filesystem::path const pkl_path = write_pkl (standard, pkl_uuid, metadata, signer); + NameFormat::Map values; + values['t'] = "pkl"; + auto pkl_path = _directory / name_format.get(values, "_" + pkl->id() + ".xml"); + pkl->write (pkl_path, signer); write_volindex (standard); - write_assetmap (standard, pkl_uuid, boost::filesystem::file_size (pkl_path), metadata); + write_assetmap (standard, pkl->id(), pkl_path, issuer, creator, issue_date, annotation_text); } -list > +vector> DCP::cpls () const { return _cpls; } -/** @return All assets (including CPLs) */ -list > -DCP::assets () const +/** @param ignore_unresolved true to silently ignore unresolved assets, otherwise + * an exception is thrown if they are found. + * @return All assets (including CPLs). + */ +vector> +DCP::assets (bool ignore_unresolved) const { - list > assets; - BOOST_FOREACH (shared_ptr i, cpls ()) { + vector> assets; + for (auto i: cpls()) { assets.push_back (i); - BOOST_FOREACH (shared_ptr j, i->reel_assets ()) { - shared_ptr o = j->asset_ref().asset (); - assets.push_back (o); - /* More Interop special-casing */ - shared_ptr sub = dynamic_pointer_cast (o); - if (sub) { - sub->add_font_assets (assets); + for (auto j: i->reel_mxfs()) { + if (ignore_unresolved && !j->asset_ref().resolved()) { + continue; + } + + auto const id = j->asset_ref().id(); + auto already_got = false; + for (auto k: assets) { + if (k->id() == id) { + already_got = true; + } + } + + if (!already_got) { + auto o = j->asset_ref().asset(); + assets.push_back (o); + /* More Interop special-casing */ + auto sub = dynamic_pointer_cast(o); + if (sub) { + sub->add_font_assets (assets); + } } } } return assets; } + +/** Given a list of files that make up 1 or more DCPs, return the DCP directories */ +vector +DCP::directories_from_files (vector files) +{ + vector d; + for (auto i: files) { + if (i.filename() == "ASSETMAP" || i.filename() == "ASSETMAP.xml") { + d.push_back (i.parent_path ()); + } + } + return d; +}