X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fdcp.cc;h=9d3cd72c33e0635ca7c483c9a7e5c94c64196824;hb=2f0e6ee9d883abbbc31aca0d1cc80e89eb9b0af2;hp=7cce30feb31c77ab44558690310a5965fc434f27;hpb=110dc70856bd0f6ae5ec1931f51a4817c5e38f42;p=libdcp.git diff --git a/src/dcp.cc b/src/dcp.cc index 7cce30fe..9d3cd72c 100644 --- a/src/dcp.cc +++ b/src/dcp.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2014 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,78 +18,231 @@ */ /** @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 "sound_mxf.h" +#include "picture_mxf.h" +#include "subtitle_content.h" +#include "mono_picture_mxf.h" +#include "stereo_picture_mxf.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 "signer.h" -#include "kdm.h" -#include "raw_convert.h" +#include "compose.hpp" +#include "AS_DCP.h" +#include "decrypted_kdm.h" +#include "decrypted_kdm_key.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include using std::string; using std::list; using std::stringstream; using std::ostream; -using std::copy; -using std::back_inserter; using std::make_pair; +using std::map; +using std::cout; +using std::exception; using boost::shared_ptr; -using namespace libdcp; +using boost::algorithm::starts_with; +using namespace dcp; DCP::DCP (boost::filesystem::path directory) : _directory (directory) { boost::filesystem::create_directories (directory); + _directory = boost::filesystem::canonical (_directory); } -void -DCP::write_xml (bool interop, XMLMetadata const & metadata, shared_ptr signer) 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 (interop, metadata, signer); + 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, interop, metadata, signer); +void +DCP::read (bool keep_going, ReadErrors* errors) +{ + /* Read the ASSETMAP */ - write_volindex (interop); - write_assetmap (pkl_uuid, boost::filesystem::file_size (pkl_path), interop, metadata); + 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 `%1'", asset_map_file.string()))); + } + + 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; + for (list >::const_iterator i = asset_nodes.begin(); i != asset_nodes.end(); ++i) { + 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 */ + 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)); + continue; + } + + if (boost::algorithm::ends_with (path.string(), ".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") { + _assets.push_back (shared_ptr (new CPL (path))); + } else if (root == "DCSubtitle") { + _assets.push_back (shared_ptr (new SubtitleContent (path, false))); + } + } else if (boost::algorithm::ends_with (path.string(), ".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: + _assets.push_back (shared_ptr (new MonoPictureMXF (path))); + break; + case ASDCP::ESS_PCM_24b_48k: + case ASDCP::ESS_PCM_24b_96k: + _assets.push_back (shared_ptr (new SoundMXF (path))); + break; + case ASDCP::ESS_JPEG_2000_S: + _assets.push_back (shared_ptr (new StereoPictureMXF (path))); + break; + case ASDCP::ESS_TIMED_TEXT: + _assets.push_back (shared_ptr (new SubtitleContent (path, true))); + break; + default: + throw DCPReadError ("Unknown MXF essence type"); + } + } + } + + list > cpl = cpls (); + for (list >::const_iterator i = cpl.begin(); i != cpl.end(); ++i) { + (*i)->resolve_refs (list_of_type (assets ())); + } +} + +bool +DCP::equals (DCP const & other, EqualityOptions opt, boost::function note) const +{ + if (_assets.size() != other._assets.size()) { + note (ERROR, String::compose ("Asset counts differ: %1 vs %2", _assets.size(), other._assets.size())); + return false; + } + + list >::const_iterator a = _assets.begin (); + list >::const_iterator b = other._assets.begin (); + + while (a != _assets.end ()) { + if (!(*a)->equals (*b, opt, note)) { + return false; + } + ++a; + ++b; + } + + return true; } -std::string -DCP::write_pkl (string pkl_uuid, bool interop, XMLMetadata const & metadata, shared_ptr signer) const +void +DCP::add (boost::shared_ptr asset) +{ + _assets.push_back (asset); +} + +class AssetComparator +{ +public: + bool operator() (shared_ptr a, shared_ptr b) { + return a->id() < b->id(); + } +}; + +bool +DCP::encrypted () const { - assert (!_cpls.empty ()); + list > cpl = cpls (); + for (list >::const_iterator i = cpl.begin(); i != cpl.end(); ++i) { + if ((*i)->encrypted ()) { + return true; + } + } + + return false; +} + +void +DCP::add (DecryptedKDM const & kdm) +{ + list keys = kdm.keys (); + list > cpl = cpls (); - boost::filesystem::path p; - p /= _directory; + for (list >::iterator i = cpl.begin(); i != cpl.end(); ++i) { + for (list::iterator j = keys.begin(); j != keys.end(); ++j) { + if (j->cpl_id() == (*i)->id()) { + (*i)->add (kdm); + } + } + } +} + +boost::filesystem::path +DCP::write_pkl (Standard standard, string pkl_uuid, XMLMetadata metadata, shared_ptr signer) const +{ + boost::filesystem::path p = _directory; stringstream s; s << pkl_uuid << "_pkl.xml"; p /= s.str(); xmlpp::Document doc; xmlpp::Element* pkl; - if (interop) { + 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"); @@ -100,83 +253,112 @@ DCP::write_pkl (string pkl_uuid, bool interop, XMLMetadata const & metadata, sha } pkl->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid); + /* XXX: this is a bit of a hack */ - pkl->add_child("AnnotationText")->add_child_text(_cpls.front()->name()); + 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"); - list > a = assets (); - for (list >::const_iterator i = a.begin(); i != a.end(); ++i) { - (*i)->write_to_pkl (asset_list, interop); - } - - for (list >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) { - (*i)->write_to_pkl (asset_list, interop); + for (list >::const_iterator i = _assets.begin(); i != _assets.end(); ++i) { + (*i)->write_to_pkl (asset_list, standard); } if (signer) { - signer->sign (pkl, interop); + 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 (bool interop) const +DCP::write_volindex (Standard standard) const { - boost::filesystem::path p; - p /= _directory; - if (interop) { + boost::filesystem::path p = _directory; + switch (standard) { + case INTEROP: p /= "VOLINDEX"; - } else { + break; + case SMPTE: p /= "VOLINDEX.xml"; + break; + default: + assert (false); } xmlpp::Document doc; xmlpp::Element* root; - if (interop) { + + switch (standard) { + case INTEROP: root = doc.create_root_node ("VolumeIndex", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#"); - } else { + break; + case SMPTE: root = doc.create_root_node ("VolumeIndex", "http://www.smpte-ra.org/schemas/429-9/2007/AM"); + break; + default: + assert (false); } + root->add_child("Index")->add_child_text ("1"); doc.write_to_file (p.string (), "UTF-8"); } void -DCP::write_assetmap (string pkl_uuid, int pkl_length, bool interop, XMLMetadata const & metadata) const +DCP::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMetadata metadata) const { - boost::filesystem::path p; - p /= _directory; - if (interop) { + boost::filesystem::path p = _directory; + + switch (standard) { + case INTEROP: p /= "ASSETMAP"; - } else { + break; + case SMPTE: p /= "ASSETMAP.xml"; + break; + default: + assert (false); } xmlpp::Document doc; xmlpp::Element* root; - if (interop) { + + switch (standard) { + case INTEROP: root = doc.create_root_node ("AssetMap", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#"); - } else { + break; + case SMPTE: root = doc.create_root_node ("AssetMap", "http://www.smpte-ra.org/schemas/429-9/2007/AM"); + break; + default: + assert (false); } root->add_child("Id")->add_child_text ("urn:uuid:" + make_uuid()); root->add_child("AnnotationText")->add_child_text ("Created by " + metadata.creator); - if (interop) { + + 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); - } else { + 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: + assert (false); } xmlpp::Node* asset_list = root->add_child ("AssetList"); @@ -191,187 +373,41 @@ DCP::write_assetmap (string pkl_uuid, int pkl_length, bool interop, XMLMetadata chunk->add_child("Offset")->add_child_text ("0"); chunk->add_child("Length")->add_child_text (raw_convert (pkl_length)); - for (list >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) { - (*i)->write_to_assetmap (asset_list); - } - - list > a = assets (); - for (list >::const_iterator i = a.begin(); i != a.end(); ++i) { - (*i)->write_to_assetmap (asset_list); + for (list >::const_iterator i = _assets.begin(); i != _assets.end(); ++i) { + (*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::read (bool require_mxfs) -{ - read_assets (); - read_cpls (require_mxfs); -} - -void -DCP::read_assets () -{ - 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 (FileError ("could not find AssetMap file", p, -1)); - } - } - - } catch (FileError& e) { - boost::throw_exception (FileError ("could not load AssetMap file", e.filename(), e.number ())); - } - - 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")); - } - - 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; - } - - xmlpp::DomParser* p = new xmlpp::DomParser; - try { - p->parse_file (t.string()); - } catch (std::exception& e) { - delete p; - continue; - } - - string const root = p->get_document()->get_root_node()->get_name (); - delete p; - - 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")); - } - } - } - - if (_files.cpls.empty ()) { - boost::throw_exception (DCPReadError ("no CPL files found")); - } - - if (_files.pkl.empty ()) { - boost::throw_exception (DCPReadError ("no PKL file found")); - } - - 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, e.number ())); - } - - _asset_maps.push_back (make_pair (boost::filesystem::absolute (_directory).string(), asset_map)); -} - -void -DCP::read_cpls (bool require_mxfs) -{ - for (list::iterator i = _files.cpls.begin(); i != _files.cpls.end(); ++i) { - _cpls.push_back (shared_ptr (new CPL (_directory, *i, _asset_maps, require_mxfs))); - } -} - -bool -DCP::equals (DCP const & other, EqualityOptions opt, boost::function note) const -{ - if (_cpls.size() != other._cpls.size()) { - note (ERROR, "CPL counts differ"); - return false; - } - - list >::const_iterator a = _cpls.begin (); - list >::const_iterator b = other._cpls.begin (); - - while (a != _cpls.end ()) { - if (!(*a)->equals (*b->get(), opt, note)) { - return false; - } - ++a; - ++b; - } - - return true; -} - -void -DCP::add_cpl (shared_ptr cpl) -{ - _cpls.push_back (cpl); -} - -class AssetComparator -{ -public: - bool operator() (shared_ptr a, shared_ptr b) { - return a->uuid() < b->uuid(); - } -}; - -list > -DCP::assets () const -{ - list > a; - for (list >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) { - list > t = (*i)->assets (); - a.merge (t); - } - - a.sort (AssetComparator ()); - a.unique (); - return a; -} - -bool -DCP::encrypted () const +DCP::write_xml ( + Standard standard, + XMLMetadata metadata, + shared_ptr signer + ) { - for (list >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) { - if ((*i)->encrypted ()) { - return true; - } + list > cpl = cpls (); + for (list >::const_iterator i = cpl.begin(); i != cpl.end(); ++i) { + string const filename = (*i)->id() + "_cpl.xml"; + (*i)->write_xml (_directory / filename, standard, signer); } - return false; -} - -void -DCP::add_kdm (KDM const & kdm) -{ - list keys = kdm.keys (); + string const pkl_uuid = make_uuid (); + boost::filesystem::path const pkl_path = write_pkl (standard, pkl_uuid, metadata, signer); - for (list >::iterator i = _cpls.begin(); i != _cpls.end(); ++i) { - for (list::iterator j = keys.begin(); j != keys.end(); ++j) { - if (j->cpl_id() == (*i)->id()) { - (*i)->add_kdm (kdm); - } - } - } + write_volindex (standard); + write_assetmap (standard, pkl_uuid, boost::filesystem::file_size (pkl_path), metadata); } -void -DCP::add_assets_from (DCP const & ov) +list > +DCP::cpls () const { - copy (ov._asset_maps.begin(), ov._asset_maps.end(), back_inserter (_asset_maps)); + return list_of_type (_assets); }