X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fdcp.cc;h=2929b5d85bf81d45c2cdec4e92c10d6a60446e83;hb=f77a03cc3ec0c5f917e0a2b6cf7599d035b34cff;hp=53d5dd39843f27fd0b91a97b6bedcb0a2f118f74;hpb=6dc0cdbd5be3f8f60bd50523501a0bd85666ebda;p=libdcp.git diff --git a/src/dcp.cc b/src/dcp.cc index 53d5dd39..2929b5d8 100644 --- a/src/dcp.cc +++ b/src/dcp.cc @@ -1,20 +1,34 @@ /* Copyright (C) 2012-2015 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of libdcp. + + libdcp 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, + libdcp 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. - + along with libdcp. If not, see . + + In addition, as a special exception, the copyright holders give + permission to link the code of portions of this program with the + OpenSSL library under certain conditions as described in each + individual source file, and distribute linked combinations + including the two. + + You must obey the GNU General Public License in all respects + for all of the code used other than OpenSSL. If you modify + file(s) with this exception, you may extend this exception to your + version of the file(s), but you are not obligated to do so. If you + do not wish to do so, delete this exception statement from your + version. If you delete this exception statement from all source + files in the program, then also delete it here. */ /** @file src/dcp.cc @@ -24,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" @@ -36,34 +51,41 @@ #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::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 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) : _directory (directory) { @@ -74,36 +96,44 @@ DCP::DCP (boost::filesystem::path directory) _directory = boost::filesystem::canonical (_directory); } -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) +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) { + _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"); 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")); @@ -112,15 +142,43 @@ DCP::read (bool keep_going, ReadErrors* errors) if (starts_with (p, "file://")) { p = p.substr (7); } - paths.insert (make_pair (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 - 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 assets so that we can resolve the references + /* Make a list of non-CPL/PKL assets so that we can resolve the references from the CPLs. */ list > other_assets; @@ -128,60 +186,95 @@ DCP::read (bool keep_going, ReadErrors* errors) 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 (); delete p; if (root == "CompositionPlaylist") { - _cpls.push_back (shared_ptr (new CPL (path))); + shared_ptr cpl (new CPL (path)); + 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) { + 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") { - 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") { + } 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)); } } + resolve_refs (other_assets); + + /* While we've got the ASSETMAP lets look and see if this DCP refers to things that are not in its ASSETMAP */ + if (notes) { + BOOST_FOREACH (shared_ptr i, cpls()) { + BOOST_FOREACH (shared_ptr 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)); + } + } + } + } +} + +void +DCP::resolve_refs (list > assets) +{ BOOST_FOREACH (shared_ptr i, cpls ()) { - i->resolve_refs (list_of_type (other_assets)); + i->resolve_refs (assets); } } @@ -230,6 +323,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) { @@ -244,47 +341,6 @@ 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", "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 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) */ @@ -308,21 +364,21 @@ DCP::write_volindex (Standard standard) const switch (standard) { case INTEROP: - root = doc.create_root_node ("VolumeIndex", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#"); + root = doc.create_root_node ("VolumeIndex", volindex_interop_ns); break; case SMPTE: - root = doc.create_root_node ("VolumeIndex", "http://www.smpte-ra.org/schemas/429-9/2007/AM"); + root = doc.create_root_node ("VolumeIndex", volindex_smpte_ns); break; default: DCP_ASSERT (false); } 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, XMLMetadata metadata) const { boost::filesystem::path p = _directory; @@ -342,17 +398,17 @@ DCP::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMeta switch (standard) { case INTEROP: - root = doc.create_root_node ("AssetMap", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#"); + root = doc.create_root_node ("AssetMap", assetmap_interop_ns); break; case SMPTE: - root = doc.create_root_node ("AssetMap", "http://www.smpte-ra.org/schemas/429-9/2007/AM"); + root = doc.create_root_node ("AssetMap", assetmap_smpte_ns); 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); + root->add_child("AnnotationText")->add_child_text (metadata.annotation_text); switch (standard) { case INTEROP: @@ -378,17 +434,17 @@ DCP::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMeta 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("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 ()) { 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. @@ -400,19 +456,35 @@ void DCP::write_xml ( Standard standard, XMLMetadata metadata, - shared_ptr signer + 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); + NameFormat::Map values; + values['t'] = "cpl"; + i->write_xml (_directory / (name_format.get(values, "_" + i->id() + ".xml")), standard, signer); } - string const pkl_uuid = make_uuid (); - boost::filesystem::path const pkl_path = write_pkl (standard, pkl_uuid, metadata, signer); + 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 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, metadata); } list > @@ -421,15 +493,21 @@ DCP::cpls () const return _cpls; } -/** @return All assets (including CPLs) */ +/** @param ignore_unresolved true to silently ignore unresolved assets, otherwise + * an exception is thrown if they are found. + * @return All assets (including CPLs). + */ list > -DCP::assets () const +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 ()) { - shared_ptr o = j->asset_ref().object (); + BOOST_FOREACH (shared_ptr j, i->reel_mxfs()) { + if (ignore_unresolved && !j->asset_ref().resolved()) { + continue; + } + shared_ptr o = j->asset_ref().asset (); assets.push_back (o); /* More Interop special-casing */ shared_ptr sub = dynamic_pointer_cast (o); @@ -441,3 +519,16 @@ DCP::assets () const 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; + BOOST_FOREACH (boost::filesystem::path i, files) { + if (i.filename() == "ASSETMAP" || i.filename() == "ASSETMAP.xml") { + d.push_back (i.parent_path ()); + } + } + return d; +}