/* 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 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, 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. */ /** @file src/dcp.cc * @brief DCP class. */ #include "raw_convert.h" #include "dcp.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.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 using std::string; using std::list; using std::cout; using std::ostream; using std::make_pair; using std::map; using std::cout; using std::exception; using boost::shared_ptr; using boost::algorithm::starts_with; using namespace dcp; DCP::DCP (boost::filesystem::path directory) : _directory (directory) { if (!boost::filesystem::exists (directory)) { boost::filesystem::create_directories (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; } } void DCP::read (bool keep_going, ReadErrors* errors) { /* Read the ASSETMAP */ 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 in `%1'", _directory.string()))); } cxml::NodePtr asset_map = cxml::read_file (asset_map_file); cxml::NodeList asset_nodes = asset_map->child("AssetList")->children ("Asset"); map paths; for (cxml::NodeList::const_iterator i = asset_nodes.begin(); i != asset_nodes.end(); ++i) { if ((*i)->child("ChunkList")->children("Chunk").size() != 1) { boost::throw_exception (XMLError ("unsupported asset chunk count")); } string p = (*i)->child("ChunkList")->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 { 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; } bool r = true; 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; } } return r; } void DCP::add (boost::shared_ptr asset) { _assets.push_back (asset); } bool DCP::encrypted () const { 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 (); 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; p /= String::compose ("%1_pkl.xml", pkl_uuid); cxml::NodePtr pkl (new cxml::Node); pkl->set_name ("PackingList"); if (standard == INTEROP) { pkl->set_attribute ("xmlns", "http://www.digicine.com/PROTO-ASDCP-PKL-20040311#"); } else { pkl->set_attribute ("xmlns", "http://www.smpte-ra.org/schemas/429-8/2007/PKL"); } if (signer) { pkl->set_attribute ("xmlns:dsig", "http://www.w3.org/2000/09/xmldsig#"); } pkl->add_child("Id")->set_content ("urn:uuid:" + pkl_uuid); /* XXX: this is a bit of a hack */ assert (cpls().size() > 0); pkl->add_child("AnnotationText")->set_content (cpls().front()->annotation_text ()); pkl->add_child("IssueDate")->set_content (metadata.issue_date); pkl->add_child("Issuer")->set_content (metadata.issuer); pkl->add_child("Creator")->set_content (metadata.creator); cxml::NodePtr asset_list = pkl->add_child("AssetList"); for (list >::const_iterator i = _assets.begin(); i != _assets.end(); ++i) { (*i)->write_to_pkl (asset_list, standard); } if (signer) { signer->sign (pkl, standard); } cxml::write_to_file (pkl, p.string ()); 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; switch (standard) { case INTEROP: p /= "VOLINDEX"; break; case SMPTE: p /= "VOLINDEX.xml"; break; default: assert (false); } cxml::NodePtr root (new cxml::Node); root->set_name ("VolumeIndex"); switch (standard) { case INTEROP: root->set_attribute ("xmlns", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#"); break; case SMPTE: root->set_attribute ("xmlns", "http://www.smpte-ra.org/schemas/429-9/2007/AM"); break; default: assert (false); } root->add_child("Index")->set_content ("1"); cxml::write_to_file (root, p.string ()); } void DCP::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMetadata metadata) const { boost::filesystem::path p = _directory; switch (standard) { case INTEROP: p /= "ASSETMAP"; break; case SMPTE: p /= "ASSETMAP.xml"; break; default: assert (false); } cxml::NodePtr root (new cxml::Node); root->set_name ("AssetMap"); switch (standard) { case INTEROP: root->set_attribute ("xmlns", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#"); break; case SMPTE: root->set_attribute ("xmlns", "http://www.smpte-ra.org/schemas/429-9/2007/AM"); break; default: assert (false); } root->add_child("Id")->set_content ("urn:uuid:" + make_uuid()); root->add_child("AnnotationText")->set_content ("Created by " + metadata.creator); switch (standard) { case INTEROP: root->add_child("VolumeCount")->set_content ("1"); root->add_child("IssueDate")->set_content (metadata.issue_date); root->add_child("Issuer")->set_content (metadata.issuer); root->add_child("Creator")->set_content (metadata.creator); break; case SMPTE: root->add_child("Creator")->set_content (metadata.creator); root->add_child("VolumeCount")->set_content ("1"); root->add_child("IssueDate")->set_content (metadata.issue_date); root->add_child("Issuer")->set_content (metadata.issuer); break; default: assert (false); } cxml::NodePtr asset_list = root->add_child ("AssetList"); cxml::NodePtr asset = asset_list->add_child ("Asset"); asset->add_child("Id")->set_content ("urn:uuid:" + pkl_uuid); asset->add_child("PackingList")->set_content ("true"); cxml::NodePtr chunk_list = asset->add_child ("ChunkList"); cxml::NodePtr chunk = chunk_list->add_child ("Chunk"); chunk->add_child("Path")->set_content (pkl_uuid + "_pkl.xml"); chunk->add_child("VolumeIndex")->set_content ("1"); chunk->add_child("Offset")->set_content ("0"); chunk->add_child("Length")->set_content (raw_convert (pkl_length)); 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 */ cxml::write_to_file (root, p.string ()); } /** 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); write_volindex (standard); write_assetmap (standard, pkl_uuid, boost::filesystem::file_size (pkl_path), metadata); } list > DCP::cpls () const { return list_of_type (_assets); }