X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fcpl.cc;h=cc7237ea59498a3c2f0926778f7d9641616bb5ee;hb=6fe4ee0c270eb88b046294895ee164ba4853c577;hp=5079b4f632b3e95b4484d19564853ff299b43d4d;hpb=4de8f0118e1baf31cf4c859881dfbf39014b566f;p=libdcp.git diff --git a/src/cpl.cc b/src/cpl.cc index 5079b4f6..cc7237ea 100644 --- a/src/cpl.cc +++ b/src/cpl.cc @@ -1,329 +1,254 @@ /* - Copyright (C) 2012-2014 Carl Hetherington + Copyright (C) 2012-2016 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. */ -#include #include "cpl.h" -#include "parse/cpl.h" #include "util.h" -#include "mono_picture_asset.h" -#include "stereo_picture_asset.h" -#include "sound_asset.h" -#include "subtitle_asset.h" -#include "parse/asset_map.h" #include "reel.h" #include "metadata.h" -#include "signer.h" -#include "exceptions.h" +#include "certificate_chain.h" +#include "xml.h" +#include "reel_picture_asset.h" +#include "reel_sound_asset.h" +#include "reel_subtitle_asset.h" +#include "reel_closed_caption_asset.h" +#include "reel_atmos_asset.h" +#include "local_time.h" +#include "dcp_assert.h" #include "compose.hpp" -#include "raw_convert.h" +#include +#include +#include using std::string; -using std::stringstream; -using std::ostream; using std::list; using std::pair; using std::make_pair; +using std::cout; using boost::shared_ptr; -using boost::lexical_cast; using boost::optional; -using namespace libdcp; +using boost::dynamic_pointer_cast; +using namespace dcp; -CPL::CPL (boost::filesystem::path directory, string name, ContentKind content_kind, int length, int frames_per_second) - : _directory (directory) - , _name (name) +static string const cpl_interop_ns = "http://www.digicine.com/PROTO-ASDCP-CPL-20040511#"; +static string const cpl_smpte_ns = "http://www.smpte-ra.org/schemas/429-7/2006/CPL"; + +CPL::CPL (string annotation_text, ContentKind content_kind) + /* default _content_title_text to annotation_text */ + : _content_title_text (annotation_text) , _content_kind (content_kind) - , _length (length) - , _fps (frames_per_second) + , _content_version_id ("urn:uuid:" + make_uuid ()) { - _id = make_uuid (); + _metadata.annotation_text = annotation_text; + /* default _content_version_id to a random ID and _content_version_label to + a random ID and the current time. + */ + _content_version_id = "urn:uuid:" + make_uuid(); + _content_version_label_text = _content_version_id + LocalTime().as_string (); } -/** 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_maps AssetMaps to look for assets in. - * @param require_mxfs true to throw an exception if a required MXF file does not exist. - */ -CPL::CPL (boost::filesystem::path directory, string file, list asset_maps, bool require_mxfs) - : _directory (directory) +/** Construct a CPL object from a XML file */ +CPL::CPL (boost::filesystem::path file) + : Asset (file) , _content_kind (FEATURE) - , _length (0) - , _fps (0) { - /* Read the XML */ - shared_ptr cpl; - try { - cpl.reset (new parse::CPL (file)); - } catch (FileError& e) { - boost::throw_exception (FileError ("could not load CPL file", file, e.number ())); - } - - /* Now cherry-pick the required bits into our own data structure */ - - _name = cpl->annotation_text; - _content_kind = cpl->content_kind; + cxml::Document f ("CompositionPlaylist"); + f.read_file (file); - /* Trim urn:uuid: off the front */ - _id = cpl->id.substr (9); - - 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 { - pair > asset = asset_from_id (asset_maps, p->id); - - picture.reset (new MonoPictureAsset (asset.first, asset.second->chunks.front()->path)); - - picture->read (); - picture->set_edit_rate (_fps); - picture->set_entry_point (p->entry_point); - picture->set_duration (p->duration); - if (p->key_id.length() > 9) { - /* Trim urn:uuid: */ - picture->set_key_id (p->key_id.substr (9)); - } - } catch (MXFFileError) { - if (require_mxfs) { - throw; - } - } - - } else { - try { - pair > asset = asset_from_id (asset_maps, p->id); - - picture.reset (new StereoPictureAsset (asset.first, asset.second->chunks.front()->path)); - - picture->read (); - picture->set_edit_rate (_fps); - picture->set_entry_point (p->entry_point); - picture->set_duration (p->duration); - if (p->key_id.length() > 9) { - /* Trim urn:uuid: */ - picture->set_key_id (p->key_id.substr (9)); - } - - } catch (MXFFileError) { - if (require_mxfs) { - throw; - } - } - - } - - if ((*i)->asset_list->main_sound) { - - try { - pair > asset = asset_from_id (asset_maps, (*i)->asset_list->main_sound->id); - - sound.reset (new SoundAsset (asset.first, asset.second->chunks.front()->path)); - shared_ptr s = (*i)->asset_list->main_sound; - - sound->read (); - sound->set_entry_point (s->entry_point); - sound->set_duration (s->duration); - if (s->key_id.length() > 9) { - /* Trim urn:uuid: */ - sound->set_key_id (s->key_id.substr (9)); - } - } catch (MXFFileError) { - if (require_mxfs) { - throw; - } - } - } + if (f.namespace_uri() == cpl_interop_ns) { + _standard = INTEROP; + } else if (f.namespace_uri() == cpl_smpte_ns) { + _standard = SMPTE; + } else { + boost::throw_exception (XMLError ("Unrecognised CPL namespace " + f.namespace_uri())); + } - if ((*i)->asset_list->main_subtitle) { - - pair > asset = asset_from_id (asset_maps, (*i)->asset_list->main_subtitle->id); + _id = remove_urn_uuid (f.string_child ("Id")); + _metadata.annotation_text = f.optional_string_child ("AnnotationText").get_value_or (""); + _metadata.issuer = f.optional_string_child ("Issuer").get_value_or (""); + _metadata.creator = f.optional_string_child ("Creator").get_value_or (""); + _metadata.issue_date = f.string_child ("IssueDate"); + _content_title_text = f.string_child ("ContentTitleText"); + _content_kind = content_kind_from_string (f.string_child ("ContentKind")); + shared_ptr content_version = f.optional_node_child ("ContentVersion"); + if (content_version) { + _content_version_id = content_version->optional_string_child ("Id").get_value_or (""); + _content_version_label_text = content_version->string_child ("LabelText"); + content_version->done (); + } + f.ignore_child ("RatingList"); + _reels = type_grand_children (f, "ReelList", "Reel"); - subtitle.reset (new SubtitleAsset (asset.first, asset.second->chunks.front()->path)); + f.ignore_child ("Issuer"); + f.ignore_child ("Signer"); + f.ignore_child ("Signature"); - subtitle->set_entry_point ((*i)->asset_list->main_subtitle->entry_point); - subtitle->set_duration ((*i)->asset_list->main_subtitle->duration); - } - - _reels.push_back (shared_ptr (new Reel (picture, sound, subtitle))); - } + f.done (); } +/** Add a reel to this CPL. + * @param reel Reel to add. + */ void -CPL::add_reel (shared_ptr reel) +CPL::add (boost::shared_ptr reel) { _reels.push_back (reel); } +/** Write an CompositonPlaylist XML file. + * @param file Filename to write. + * @param standard INTEROP or SMPTE. + * @param signer Signer to sign the CPL, or 0 to add no signature. + */ void -CPL::write_xml (bool interop, XMLMetadata const & metadata, shared_ptr signer) const +CPL::write_xml (boost::filesystem::path file, Standard standard, shared_ptr signer) const { - boost::filesystem::path p; - p /= _directory; - stringstream s; - s << _id << "_cpl.xml"; - p /= s.str(); - xmlpp::Document doc; xmlpp::Element* root; - if (interop) { - root = doc.create_root_node ("CompositionPlaylist", "http://www.digicine.com/PROTO-ASDCP-CPL-20040511#"); + if (standard == INTEROP) { + root = doc.create_root_node ("CompositionPlaylist", cpl_interop_ns); } else { - root = doc.create_root_node ("CompositionPlaylist", "http://www.smpte-ra.org/schemas/429-7/2006/CPL"); + root = doc.create_root_node ("CompositionPlaylist", cpl_smpte_ns); } - if (signer) { - root->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig"); - } - root->add_child("Id")->add_child_text ("urn:uuid:" + _id); - root->add_child("AnnotationText")->add_child_text (_name); - 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); - root->add_child("ContentTitleText")->add_child_text (_name); + root->add_child("AnnotationText")->add_child_text (_metadata.annotation_text); + 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); + root->add_child("ContentTitleText")->add_child_text (_content_title_text); root->add_child("ContentKind")->add_child_text (content_kind_to_string (_content_kind)); { xmlpp::Node* cv = root->add_child ("ContentVersion"); - cv->add_child ("Id")->add_child_text ("urn:uri:" + _id + "_" + metadata.issue_date); - cv->add_child ("LabelText")->add_child_text (_id + "_" + metadata.issue_date); + cv->add_child ("Id")->add_child_text (_content_version_id); + cv->add_child ("LabelText")->add_child_text (_content_version_label_text); } root->add_child("RatingList"); xmlpp::Element* reel_list = root->add_child ("ReelList"); - - for (list >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) { - (*i)->write_to_cpl (reel_list); + + BOOST_FOREACH (shared_ptr i, _reels) { + i->write_to_cpl (reel_list, standard); } if (signer) { - signer->sign (root, interop); + signer->sign (root, standard); } /* 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 (file.string (), "UTF-8"); - _digest = make_digest (p.string (), 0); - _length = boost::filesystem::file_size (p.string ()); + set_file (file); } -void -CPL::write_to_pkl (xmlpp::Node* node, bool interop) const +list > +CPL::reel_assets () { - xmlpp::Node* asset = node->add_child ("Asset"); - asset->add_child("Id")->add_child_text ("urn:uuid:" + _id); - asset->add_child("Hash")->add_child_text (_digest); - asset->add_child("Size")->add_child_text (raw_convert (_length)); - if (interop) { - asset->add_child("Type")->add_child_text ("text/xml;asdcpKind=CPL"); - } else { - asset->add_child("Type")->add_child_text ("text/xml"); + list > c; + + BOOST_FOREACH (shared_ptr i, _reels) { + if (i->main_picture ()) { + c.push_back (i->main_picture()); + } + if (i->main_sound ()) { + c.push_back (i->main_sound()); + } + if (i->main_subtitle ()) { + c.push_back (i->main_subtitle()); + } + BOOST_FOREACH (shared_ptr j, i->closed_captions()) { + c.push_back (j); + } + if (i->atmos ()) { + c.push_back (i->atmos()); + } } + + return c; } -list > -CPL::assets () const +list > +CPL::reel_assets () const { - list > a; - for (list >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) { - if ((*i)->main_picture ()) { - a.push_back ((*i)->main_picture ()); + list > c; + + BOOST_FOREACH (shared_ptr i, _reels) { + if (i->main_picture ()) { + c.push_back (i->main_picture()); } - if ((*i)->main_sound ()) { - a.push_back ((*i)->main_sound ()); + if (i->main_sound ()) { + c.push_back (i->main_sound()); } - if ((*i)->main_subtitle ()) { - a.push_back ((*i)->main_subtitle ()); + if (i->main_subtitle ()) { + c.push_back (i->main_subtitle()); + } + BOOST_FOREACH (shared_ptr j, i->closed_captions()) { + c.push_back (j); + } + if (i->atmos ()) { + c.push_back (i->atmos()); } } - return a; + return c; } -void -CPL::write_to_assetmap (xmlpp::Node* node) const -{ - xmlpp::Node* asset = node->add_child ("Asset"); - asset->add_child("Id")->add_child_text ("urn:uuid:" + _id); - xmlpp::Node* chunk_list = asset->add_child ("ChunkList"); - xmlpp::Node* chunk = chunk_list->add_child ("Chunk"); - chunk->add_child("Path")->add_child_text (_id + "_cpl.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 (_length)); -} - - - bool -CPL::equals (CPL const & other, EqualityOptions opt, boost::function note) const +CPL::equals (shared_ptr other, EqualityOptions opt, NoteHandler note) const { - if (_name != other._name && !opt.cpl_names_can_differ) { - stringstream s; - s << "names differ: " << _name << " vs " << other._name << "\n"; - note (ERROR, s.str ()); + shared_ptr other_cpl = dynamic_pointer_cast (other); + if (!other_cpl) { return false; } - if (_content_kind != other._content_kind) { - note (ERROR, "content kinds differ"); + if (_metadata.annotation_text != other_cpl->_metadata.annotation_text && !opt.cpl_annotation_texts_can_differ) { + string const s = "CPL: annotation texts differ: " + _metadata.annotation_text + " vs " + other_cpl->_metadata.annotation_text + "\n"; + note (DCP_ERROR, s); return false; } - if (_fps != other._fps) { - note (ERROR, String::compose ("frames per second differ (%1 vs %2)", _fps, other._fps)); + if (_content_kind != other_cpl->_content_kind) { + note (DCP_ERROR, "CPL: content kinds differ"); return false; } - if (_length != other._length) { - stringstream s; - note (ERROR, String::compose ("lengths differ (%1 vs %2)", _length, other._length)); - } - - if (_reels.size() != other._reels.size()) { - note (ERROR, String::compose ("reel counts differ (%1 vs %2)", _reels.size(), other._reels.size())); + if (_reels.size() != other_cpl->_reels.size()) { + note (DCP_ERROR, String::compose ("CPL: reel counts differ (%1 vs %2)", _reels.size(), other_cpl->_reels.size())); return false; } - + list >::const_iterator a = _reels.begin (); - list >::const_iterator b = other._reels.begin (); - + list >::const_iterator b = other_cpl->_reels.begin (); + while (a != _reels.end ()) { if (!(*a)->equals (*b, opt, note)) { return false; @@ -339,8 +264,8 @@ CPL::equals (CPL const & other, EqualityOptions opt, boost::function >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) { - if ((*i)->encrypted ()) { + BOOST_FOREACH (shared_ptr i, _reels) { + if (i->encrypted ()) { return true; } } @@ -348,31 +273,51 @@ CPL::encrypted () const return false; } +/** Add a KDM to this CPL. If the KDM is for any of this CPLs assets it will be used + * to decrypt those assets. + * @param kdm KDM. + */ void -CPL::add_kdm (KDM const & kdm) +CPL::add (DecryptedKDM const & kdm) { - for (list >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) { - (*i)->add_kdm (kdm); + BOOST_FOREACH (shared_ptr i, _reels) { + i->add (kdm); } } -pair > -CPL::asset_from_id (list asset_maps, string id) const +void +CPL::resolve_refs (list > assets) { - for (list::const_iterator i = asset_maps.begin(); i != asset_maps.end(); ++i) { - shared_ptr a = i->second->asset_from_id (id); - if (a) { - return make_pair (i->first, a); - } + BOOST_FOREACH (shared_ptr i, _reels) { + i->resolve_refs (assets); } +} - return make_pair ("", shared_ptr ()); +string +CPL::pkl_type (Standard standard) const +{ + return static_pkl_type (standard); } -void -CPL::set_mxf_keys (Key key) +string +CPL::static_pkl_type (Standard standard) +{ + switch (standard) { + case INTEROP: + return "text/xml;asdcpKind=CPL"; + case SMPTE: + return "text/xml"; + default: + DCP_ASSERT (false); + } +} + +int64_t +CPL::duration () const { - for (list >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) { - (*i)->set_mxf_keys (key); + int64_t d = 0; + BOOST_FOREACH (shared_ptr i, _reels) { + d += i->duration (); } + return d; }