X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fdcp.cc;h=ca1c23d9a9df0fdaf7e85a75769c380781f4cf05;hb=595d4fbfee788edfad7f9f8dfe7e76ee634c1a94;hp=edb247a51970abf9977d2e77ddbf701d558de8be;hpb=659559826847246325b2d20fbc654851979268b5;p=libdcp.git diff --git a/src/dcp.cc b/src/dcp.cc index edb247a5..ca1c23d9 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,540 +18,397 @@ */ /** @file src/dcp.cc - * @brief A class to create a DCP. + * @brief DCP class. */ -#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 "cpl_file.h" -#include "pkl_file.h" -#include "asset_map.h" #include "reel.h" +#include "cpl.h" +#include "signer.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::cout; using std::stringstream; -using std::ofstream; using std::ostream; +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 (string directory) +DCP::DCP (boost::filesystem::path directory) : _directory (directory) { - boost::filesystem::create_directories (directory); -} - -void -DCP::write_xml () const -{ - for (list >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) { - (*i)->write_xml (); + if (!boost::filesystem::exists (directory)) { + boost::filesystem::create_directories (directory); } - - string pkl_uuid = make_uuid (); - string pkl_path = write_pkl (pkl_uuid); - write_volindex (); - write_assetmap (pkl_uuid, boost::filesystem::file_size (pkl_path)); + _directory = boost::filesystem::canonical (_directory); } -std::string -DCP::write_pkl (string pkl_uuid) const +template void +survivable_error (bool keep_going, dcp::DCP::ReadErrors* errors, T const & e) { - assert (!_cpls.empty ()); - - boost::filesystem::path p; - p /= _directory; - stringstream s; - s << pkl_uuid << "_pkl.xml"; - p /= s.str(); - ofstream pkl (p.string().c_str()); - - pkl << "\n" - << "\n" - << " urn:uuid:" << pkl_uuid << "\n" - /* XXX: this is a bit of a hack */ - << " " << _cpls.front()->name() << "\n" - << " " << Metadata::instance()->issue_date << "\n" - << " " << Metadata::instance()->issuer << "\n" - << " " << Metadata::instance()->creator << "\n" - << " \n"; - - list > a = assets (); - for (list >::const_iterator i = a.begin(); i != a.end(); ++i) { - (*i)->write_to_pkl (pkl); - } - - for (list >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) { - (*i)->write_to_pkl (pkl); + if (keep_going) { + if (errors) { + errors->push_back (shared_ptr (new T (e))); + } + } else { + throw e; } - - pkl << " \n" - << "\n"; - - return p.string (); -} - -void -DCP::write_volindex () const -{ - boost::filesystem::path p; - p /= _directory; - p /= "VOLINDEX.xml"; - ofstream vi (p.string().c_str()); - - vi << "\n" - << "\n" - << " 1\n" - << "\n"; } void -DCP::write_assetmap (string pkl_uuid, int pkl_length) const +DCP::read (bool keep_going, ReadErrors* errors) { - boost::filesystem::path p; - p /= _directory; - p /= "ASSETMAP.xml"; - ofstream am (p.string().c_str()); - - am << "\n" - << "\n" - << " urn:uuid:" << make_uuid() << "\n" - << " " << Metadata::instance()->creator << "\n" - << " 1\n" - << " " << Metadata::instance()->issue_date << "\n" - << " " << Metadata::instance()->issuer << "\n" - << " \n"; - - am << " \n" - << " urn:uuid:" << pkl_uuid << "\n" - << " true\n" - << " \n" - << " \n" - << " " << pkl_uuid << "_pkl.xml\n" - << " 1\n" - << " 0\n" - << " " << pkl_length << "\n" - << " \n" - << " \n" - << " \n"; + /* Read the ASSETMAP */ - for (list >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) { - (*i)->write_to_assetmap (am); - } - - list > a = assets (); - for (list >::const_iterator i = a.begin(); i != a.end(); ++i) { - (*i)->write_to_assetmap (am); + 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()))); } - am << " \n" - << "\n"; -} - - -void -DCP::read (bool require_mxfs) -{ - Files files; - - shared_ptr asset_map; - try { - boost::filesystem::path p = _directory; - p /= "ASSETMAP"; - if (boost::filesystem::exists (p)) { - asset_map.reset (new AssetMap (p.string ())); - } else { - p = _directory; - p /= "ASSETMAP.xml"; - if (boost::filesystem::exists (p)) { - asset_map.reset (new AssetMap (p.string ())); - } else { - throw DCPReadError ("could not find AssetMap file"); - } + 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")); } - - } catch (FileError& e) { - throw FileError ("could not load AssetMap file", files.asset_map); + 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)); } - for (list >::const_iterator i = asset_map->assets.begin(); i != asset_map->assets.end(); ++i) { - if ((*i)->chunks.size() != 1) { - throw XMLError ("unsupported asset chunk count"); - } + /* 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; - boost::filesystem::path t = _directory; - t /= (*i)->chunks.front()->path; - - if (ends_with (t.string(), ".mxf") || ends_with (t.string(), ".ttf")) { + if (!boost::filesystem::exists (path)) { + survivable_error (keep_going, errors, MissingAssetError (path)); continue; } - - xmlpp::DomParser* p = new xmlpp::DomParser; - try { - p->parse_file (t.string()); - } catch (std::exception& e) { + + 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; - 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 { - throw DCPReadError ("duplicate PKLs found"); + + 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"); + } } } - - if (files.cpls.empty ()) { - throw FileError ("no CPL files found", ""); - } - - if (files.pkl.empty ()) { - throw FileError ("no PKL file found", ""); - } - shared_ptr pkl; - try { - pkl.reset (new PKLFile (files.pkl)); - } catch (FileError& e) { - throw FileError ("could not load PKL file", files.pkl); - } - - /* Cross-check */ - /* XXX */ - - 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))); + 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, list& notes) const +DCP::equals (DCP const & other, EqualityOptions opt, boost::function note) const { - if (_cpls.size() != other._cpls.size()) { - notes.push_back ("CPL counts differ"); + list > a = cpls (); + list > b = other.cpls (); + + if (a.size() != b.size()) { + note (DCP_ERROR, String::compose ("CPL counts differ: %1 vs %2", a.size(), b.size())); return false; } - list >::const_iterator a = _cpls.begin (); - list >::const_iterator b = other._cpls.begin (); + bool r = true; - while (a != _cpls.end ()) { - if (!(*a)->equals (*b->get(), opt, notes)) { - return false; + for (list >::const_iterator i = a.begin(); i != a.end(); ++i) { + list >::const_iterator j = b.begin (); + while (j != b.end() && !(*j)->equals (*i, opt, note)) { + ++j; + } + + if (j == b.end ()) { + r = false; } - ++a; - ++b; } - return true; + return r; } - void -DCP::add_cpl (shared_ptr cpl) +DCP::add (boost::shared_ptr asset) { - _cpls.push_back (cpl); + _assets.push_back (asset); } -class AssetComparator -{ -public: - bool operator() (shared_ptr a, shared_ptr b) { - return a->uuid() < b->uuid(); - } -}; - -list > -DCP::assets () const +bool +DCP::encrypted () const { - list > a; - for (list >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) { - list > t = (*i)->assets (); - a.merge (t); + list > cpl = cpls (); + for (list >::const_iterator i = cpl.begin(); i != cpl.end(); ++i) { + if ((*i)->encrypted ()) { + return true; + } } - a.sort (); - a.unique (); - return a; -} - -CPL::CPL (string directory, string name, ContentKind content_kind, int length, int frames_per_second) - : _directory (directory) - , _name (name) - , _content_kind (content_kind) - , _length (length) - , _fps (frames_per_second) -{ - _uuid = make_uuid (); + return false; } -/** Construct a CPL object from a XML file. - * @param directory The directory containing this CPL's DCP. - * @param file The CPL XML filename. - * @param asset_map The corresponding asset map. - * @param require_mxfs true to throw an exception if a required MXF file does not exist. - */ -CPL::CPL (string directory, string file, shared_ptr asset_map, bool require_mxfs) - : _directory (directory) - , _content_kind (FEATURE) - , _length (0) - , _fps (0) +void +DCP::add (DecryptedKDM const & kdm) { - /* Read the XML */ - shared_ptr cpl; - try { - cpl.reset (new CPLFile (file)); - } catch (FileError& e) { - throw FileError ("could not load CPL file", file); - } - - /* Now cherry-pick the required bits into our own data structure */ + list keys = kdm.keys (); + list > cpl = cpls (); - _name = cpl->annotation_text; - _content_kind = cpl->content_kind; - - for (list >::iterator i = cpl->reels.begin(); i != cpl->reels.end(); ++i) { - - shared_ptr p; - - if ((*i)->asset_list->main_picture) { - p = (*i)->asset_list->main_picture; - } else { - p = (*i)->asset_list->main_stereoscopic_picture; - } - - _fps = p->edit_rate.numerator; - _length += p->duration; - - shared_ptr picture; - shared_ptr sound; - shared_ptr subtitle; - - /* Some rather twisted logic to decide if we are 3D or not; - some DCPs give a MainStereoscopicPicture to indicate 3D, others - just have a FrameRate twice the EditRate and apparently - expect you to divine the fact that they are hence 3D. - */ - - if (!(*i)->asset_list->main_stereoscopic_picture && p->edit_rate == p->frame_rate) { - - try { - picture.reset (new MonoPictureAsset ( - _directory, - asset_map->asset_from_id (p->id)->chunks.front()->path, - _fps, - (*i)->asset_list->main_picture->entry_point, - (*i)->asset_list->main_picture->duration - ) - ); - } catch (MXFFileError) { - if (require_mxfs) { - throw; - } - } - - } else { - - try { - picture.reset (new StereoPictureAsset ( - _directory, - asset_map->asset_from_id (p->id)->chunks.front()->path, - _fps, - p->entry_point, - p->duration - ) - ); - } catch (MXFFileError) { - if (require_mxfs) { - throw; - } - } - + 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); + } } - - if ((*i)->asset_list->main_sound) { - - try { - sound.reset (new SoundAsset ( - _directory, - asset_map->asset_from_id ((*i)->asset_list->main_sound->id)->chunks.front()->path, - _fps, - (*i)->asset_list->main_sound->entry_point, - (*i)->asset_list->main_sound->duration - ) - ); - } catch (MXFFileError) { - if (require_mxfs) { - throw; - } - } - } - - if ((*i)->asset_list->main_subtitle) { - - subtitle.reset (new SubtitleAsset ( - _directory, - asset_map->asset_from_id ((*i)->asset_list->main_subtitle->id)->chunks.front()->path - ) - ); - } - - _reels.push_back (shared_ptr (new Reel (picture, sound, subtitle))); } } -void -CPL::add_reel (shared_ptr reel) -{ - _reels.push_back (reel); -} - -void -CPL::write_xml () const +boost::filesystem::path +DCP::write_pkl (Standard standard, string pkl_uuid, XMLMetadata metadata, shared_ptr signer) const { - boost::filesystem::path p; - p /= _directory; + boost::filesystem::path p = _directory; stringstream s; - s << _uuid << "_cpl.xml"; + s << pkl_uuid << "_pkl.xml"; p /= s.str(); - ofstream os (p.string().c_str()); - - os << "\n" - << "\n" - << " urn:uuid:" << _uuid << "\n" - << " " << _name << "\n" - << " " << Metadata::instance()->issue_date << "\n" - << " " << Metadata::instance()->creator << "\n" - << " " << _name << "\n" - << " " << content_kind_to_string (_content_kind) << "\n" - << " \n" - << " urn:uri:" << _uuid << "_" << Metadata::instance()->issue_date << "\n" - << " " << _uuid << "_" << Metadata::instance()->issue_date << "\n" - << " \n" - << " \n" - << " \n"; + + 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"); + } - for (list >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) { - (*i)->write_to_cpl (os); + if (signer) { + pkl->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig"); } - os << " \n" - << "\n"; + pkl->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid); - os.close (); + /* XXX: this is a bit of a hack */ + 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); - _digest = make_digest (p.string ()); - _length = boost::filesystem::file_size (p.string ()); -} + xmlpp::Element* asset_list = pkl->add_child("AssetList"); + for (list >::const_iterator i = _assets.begin(); i != _assets.end(); ++i) { + (*i)->write_to_pkl (asset_list, standard); + } -void -CPL::write_to_pkl (ostream& s) const -{ - s << " \n" - << " urn:uuid:" << _uuid << "\n" - << " " << _digest << "\n" - << " " << _length << "\n" - << " text/xml\n" - << " \n"; + if (signer) { + signer->sign (pkl, standard); + } + + doc.write_to_file (p.string (), "UTF-8"); + return p.string (); } -list > -CPL::assets () const +/** Write the VOLINDEX file. + * @param standard DCP standard to use (INTEROP or SMPTE) + */ +void +DCP::write_volindex (Standard standard) const { - list > a; - for (list >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) { - if ((*i)->main_picture ()) { - a.push_back ((*i)->main_picture ()); - } - if ((*i)->main_sound ()) { - a.push_back ((*i)->main_sound ()); - } - if ((*i)->main_subtitle ()) { - a.push_back ((*i)->main_subtitle ()); - } + boost::filesystem::path p = _directory; + switch (standard) { + case INTEROP: + p /= "VOLINDEX"; + break; + case SMPTE: + p /= "VOLINDEX.xml"; + break; + default: + assert (false); } - return a; + 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: + assert (false); + } + + root->add_child("Index")->add_child_text ("1"); + doc.write_to_file (p.string (), "UTF-8"); } void -CPL::write_to_assetmap (ostream& s) const +DCP::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMetadata metadata) const { - s << " \n" - << " urn:uuid:" << _uuid << "\n" - << " \n" - << " \n" - << " " << _uuid << "_cpl.xml\n" - << " 1\n" - << " 0\n" - << " " << _length << "\n" - << " \n" - << " \n" - << " \n"; -} + boost::filesystem::path p = _directory; - - -bool -CPL::equals (CPL const & other, EqualityOptions opt, list& notes) const -{ - if (_name != other._name) { - notes.push_back ("names differ"); - return false; + switch (standard) { + case INTEROP: + p /= "ASSETMAP"; + break; + case SMPTE: + p /= "ASSETMAP.xml"; + break; + default: + assert (false); } - if (_content_kind != other._content_kind) { - notes.push_back ("content kinds differ"); - return false; + 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: + assert (false); } - if (_fps != other._fps) { - notes.push_back ("frames per second differ"); - return false; + 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: + assert (false); } - - if (_length != other._length) { - notes.push_back ("lengths differ"); - return false; + + 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_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 (raw_convert (pkl_length)); + + for (list >::const_iterator i = _assets.begin(); i != _assets.end(); ++i) { + (*i)->write_to_assetmap (asset_list, _directory); } - if (_reels.size() != other._reels.size()) { - notes.push_back ("reel counts differ"); - return false; + /* 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::write_xml ( + Standard standard, + XMLMetadata metadata, + shared_ptr signer + ) +{ + 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); } + + string const pkl_uuid = make_uuid (); + boost::filesystem::path const pkl_path = write_pkl (standard, pkl_uuid, metadata, signer); - list >::const_iterator a = _reels.begin (); - list >::const_iterator b = other._reels.begin (); - - while (a != _reels.end ()) { - if (!(*a)->equals (*b, opt, notes)) { - return false; - } - ++a; - ++b; - } + write_volindex (standard); + write_assetmap (standard, pkl_uuid, boost::filesystem::file_size (pkl_path), metadata); +} - return true; +list > +DCP::cpls () const +{ + return list_of_type (_assets); }