X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fdcp.cc;h=2fcdd193c13bb6dc5ee90e5f99bf64a38e4ff683;hb=7c2dccaa6cfbda041fd1a10a391aab5b184b6267;hp=c0fe70f64ad4d0a99d2503c9f03d7b12a40edca2;hpb=a6a4c4712695b190766f7aba964e1776cc501e3a;p=libdcp.git diff --git a/src/dcp.cc b/src/dcp.cc index c0fe70f6..2fcdd193 100644 --- a/src/dcp.cc +++ b/src/dcp.cc @@ -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" @@ -55,6 +56,9 @@ #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 @@ -73,13 +77,12 @@ using std::cerr; using std::exception; using boost::shared_ptr; using boost::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-VL-20040311#"; static string const volindex_smpte_ns = "http://www.smpte-ra.org/schemas/429-9/2007/AM"; @@ -93,36 +96,33 @@ 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 list. + */ void -DCP::read (bool keep_going, ReadErrors* errors, bool ignore_incorrect_picture_mxf_type) +DCP::read (list* 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; } else if (asset_map.namespace_uri() == assetmap_smpte_ns) { @@ -133,6 +133,7 @@ DCP::read (bool keep_going, ReadErrors* errors, bool ignore_incorrect_picture_mx list > asset_nodes = asset_map.node_child("AssetList")->node_children ("Asset"); map paths; + list pkl_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")); @@ -141,15 +142,43 @@ DCP::read (bool keep_going, ReadErrors* errors, bool ignore_incorrect_picture_mx if (starts_with (p, "file://")) { p = p.substr (7); } - paths.insert (make_pair (remove_urn_uuid (i->string_child ("Id")), p)); + switch (*_standard) { + case 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 SMPTE: + { + optional 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")); + } + + BOOST_FOREACH (boost::filesystem::path i, pkl_paths) { + _pkls.push_back (shared_ptr(new PKL(_directory / i))); + } + + /* Now we have: + paths - files in the DCP that are not PKLs. + _pkls - PKL objects for each PKL. - /* Make a list of non-CPL assets so that we can resolve the references + 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; @@ -157,18 +186,42 @@ DCP::read (bool keep_going, ReadErrors* errors, bool ignore_incorrect_picture_mx for (map::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)); + 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(VerificationNote::VERIFY_WARNING, VerificationNote::EMPTY_ASSET_PATH)); + } + continue; + } + + if (!boost::filesystem::exists(path)) { + if (notes) { + notes->push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::MISSING_ASSET, path)); + } continue; } - if (boost::filesystem::extension (path) == ".xml") { + /* Find the for this asset from the PKL that contains the asset */ + optional pkl_type; + BOOST_FOREACH (shared_ptr j, _pkls) { + pkl_type = j->type(i->first); + if (pkl_type) { + break; + } + } + + DCP_ASSERT (pkl_type); + + if (*pkl_type == CPL::static_pkl_type(*_standard) || *pkl_type == InteropSubtitleAsset::static_pkl_type(*_standard)) { xmlpp::DomParser* 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 (); @@ -176,57 +229,30 @@ DCP::read (bool keep_going, ReadErrors* errors, bool ignore_incorrect_picture_mx if (root == "CompositionPlaylist") { shared_ptr cpl (new CPL (path)); - if (_standard && cpl->standard() && cpl->standard().get() != _standard.get()) { - survivable_error (keep_going, errors, MismatchedStandardError ()); + if (_standard && cpl->standard() && cpl->standard().get() != _standard.get() && notes) { + notes->push_back (VerificationNote(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 ()); + notes->push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::MISMATCHED_STANDARD)); } other_assets.push_back (shared_ptr (new InteropSubtitleAsset (path))); } - } else if (boost::filesystem::extension (path) == ".mxf") { - - /* XXX: asdcplib does not appear to support discovery of read MXFs standard - (Interop / SMPTE) - */ - - 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 (String::compose ("Unknown MXF essence type %1 in %2", int(type), path.string())); - } - } else if (boost::filesystem::extension (path) == ".ttf") { + } 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 (shared_ptr (new FontAsset (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)); } } @@ -288,6 +314,10 @@ DCP::encrypted () const return false; } +/** 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) { @@ -302,44 +332,6 @@ DCP::add (DecryptedKDM const & kdm) } } -/** @return full pathname of PKL file that was written */ -boost::filesystem::path -DCP::write_pkl (string file, Standard standard, string pkl_uuid, XMLMetadata metadata, shared_ptr signer) const -{ - boost::filesystem::path p = _directory; - p /= file; - - 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); - pkl->add_child("AnnotationText")->add_child_text (metadata.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) */ @@ -373,7 +365,7 @@ 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 @@ -442,8 +434,8 @@ DCP::write_assetmap (Standard standard, string pkl_uuid, boost::filesystem::path 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. @@ -465,13 +457,25 @@ DCP::write_xml ( i->write_xml (_directory / (name_format.get(values, "_" + i->id() + ".xml")), standard, signer); } - string const pkl_uuid = make_uuid (); + shared_ptr pkl; + + if (_pkls.empty()) { + pkl.reset (new PKL (standard, metadata.annotation_text, metadata.issue_date, metadata.issuer, metadata.creator)); + _pkls.push_back (pkl); + BOOST_FOREACH (shared_ptr i, assets ()) { + i->add_to_pkl (pkl, _directory); + } + } else { + pkl = _pkls.front (); + } + NameFormat::Map values; values['t'] = "pkl"; - boost::filesystem::path const pkl_path = write_pkl (name_format.get(values, "_" + pkl_uuid + ".xml"), standard, pkl_uuid, metadata, signer); + boost::filesystem::path pkl_path = _directory / name_format.get(values, "_" + pkl->id() + ".xml"); + pkl->write (pkl_path, signer); write_volindex (standard); - write_assetmap (standard, pkl_uuid, pkl_path, metadata); + write_assetmap (standard, pkl->id(), pkl_path, metadata); } list > @@ -490,7 +494,7 @@ DCP::assets (bool ignore_unresolved) const list > assets; BOOST_FOREACH (shared_ptr i, cpls ()) { assets.push_back (i); - BOOST_FOREACH (shared_ptr j, i->reel_assets ()) { + BOOST_FOREACH (shared_ptr j, i->reel_mxfs()) { if (ignore_unresolved && !j->asset_ref().resolved()) { continue; }