X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fcpl.cc;h=0bf1582490155786f9727acc45e3c199a62acf79;hb=9eba1ff84fd89e2ff04181799f2185c8575de16d;hp=1ca64f888e1b730d51b2fa10af7e8c1706554fff;hpb=c2bac22380bea453665a24c6f39200a977771daf;p=libdcp.git diff --git a/src/cpl.cc b/src/cpl.cc index 1ca64f88..0bf15824 100644 --- a/src/cpl.cc +++ b/src/cpl.cc @@ -1,301 +1,259 @@ /* - Copyright (C) 2012 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 "picture_asset.h" -#include "sound_asset.h" -#include "subtitle_asset.h" -#include "parse/asset_map.h" #include "reel.h" #include "metadata.h" -#include "encryption.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 +#include +#include using std::string; -using std::stringstream; -using std::ofstream; -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 namespace libdcp; +using boost::optional; +using boost::dynamic_pointer_cast; +using namespace dcp; -CPL::CPL (string 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) { - _uuid = 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. + */ + string const uuid = make_uuid(); + _content_version_id = "urn:uuid:" + uuid; + _content_version_label_text = uuid + 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_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) +/** 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)); + cxml::Document f ("CompositionPlaylist"); + f.read_file (file); + + 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())); } - - /* Now cherry-pick the required bits into our own data structure */ - - _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 - ) - ); - - picture->set_entry_point (p->entry_point); - picture->set_duration (p->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->duration - ) - ); - - picture->set_entry_point (p->entry_point); - picture->set_duration (p->duration); - - } catch (MXFFileError) { - if (require_mxfs) { - throw; - } - } - - } - - 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 - ) - ); - - sound->set_entry_point ((*i)->asset_list->main_sound->entry_point); - sound->set_duration ((*i)->asset_list->main_sound->duration); - } catch (MXFFileError) { - if (require_mxfs) { - throw; - } - } - } + _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"); - 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 - ) - ); + 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 (shared_ptr crypt, XMLMetadata const & metadata) const +CPL::write_xml (boost::filesystem::path file, Standard standard, shared_ptr signer) const { - boost::filesystem::path p; - p /= _directory; - stringstream s; - s << _uuid << "_cpl.xml"; - p /= s.str(); - xmlpp::Document doc; - xmlpp::Element* root = doc.create_root_node ("CompositionPlaylist", "http://www.smpte-ra.org/schemas/429-7/2006/CPL"); + xmlpp::Element* root; + if (standard == INTEROP) { + root = doc.create_root_node ("CompositionPlaylist", cpl_interop_ns); + } else { + root = doc.create_root_node ("CompositionPlaylist", cpl_smpte_ns); + } - if (crypt) { + if (signer) { root->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig"); } - - root->add_child("Id")->add_child_text ("urn:uuid:" + _uuid); - root->add_child("AnnotationText")->add_child_text (_name); - root->add_child("IssueDate")->add_child_text (metadata.issue_date); - root->add_child("Creator")->add_child_text (metadata.creator); - root->add_child("ContentTitleText")->add_child_text (_name); + + root->add_child("Id")->add_child_text ("urn:uuid:" + _id); + 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:" + _uuid + "_" + metadata.issue_date); - cv->add_child ("LabelText")->add_child_text (_uuid + "_" + 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::Node* reel_list = root->add_child ("ReelList"); - - for (list >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) { - (*i)->write_to_cpl (reel_list); + xmlpp::Element* reel_list = root->add_child ("ReelList"); + + BOOST_FOREACH (shared_ptr i, _reels) { + i->write_to_cpl (reel_list, standard); } - if (crypt) { - sign (root, crypt->certificates, crypt->signer_key); + indent (root, 0); + + if (signer) { + signer->sign (root, standard); } - doc.write_to_file_formatted (p.string (), "UTF-8"); + doc.write_to_file_formatted (file.string(), "UTF-8"); - _digest = make_digest (p.string ()); - _length = boost::filesystem::file_size (p.string ()); + set_file (file); } -void -CPL::write_to_pkl (xmlpp::Node* node) const +list > +CPL::reel_mxfs () { - xmlpp::Node* asset = node->add_child ("Asset"); - asset->add_child("Id")->add_child_text ("urn:uuid:" + _uuid); - asset->add_child("Hash")->add_child_text (_digest); - asset->add_child("Size")->add_child_text (lexical_cast (_length)); - asset->add_child("Type")->add_child_text ("text/xml"); -} + list > c; -list > -CPL::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 ()); + 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()); } - if ((*i)->main_sound ()) { - a.push_back ((*i)->main_sound ()); + BOOST_FOREACH (shared_ptr j, i->closed_captions()) { + c.push_back (j); } - if ((*i)->main_subtitle ()) { - a.push_back ((*i)->main_subtitle ()); + if (i->atmos ()) { + c.push_back (i->atmos()); } } - return a; + return c; } -void -CPL::write_to_assetmap (xmlpp::Node* node) const +list > +CPL::reel_mxfs () const { - xmlpp::Node* asset = node->add_child ("Asset"); - asset->add_child("Id")->add_child_text ("urn:uuid:" + _uuid); - xmlpp::Node* chunk_list = asset->add_child ("ChunkList"); - xmlpp::Node* chunk = chunk_list->add_child ("Chunk"); - chunk->add_child("Path")->add_child_text (_uuid + "_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(lexical_cast (_length)); + 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; } - - - + 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, "frames per second differ"); + if (_content_kind != other_cpl->_content_kind) { + note (DCP_ERROR, "CPL: content kinds differ"); return false; } - if (_length != other._length) { - note (ERROR, "lengths differ"); + 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; } - if (_reels.size() != other._reels.size()) { - note (ERROR, "reel counts differ"); - return false; - } - - list >::const_iterator a = _reels.begin (); - list >::const_iterator b = other._reels.begin (); - + list >::const_iterator a = _reels.begin (); + list >::const_iterator b = other_cpl->_reels.begin (); + while (a != _reels.end ()) { if (!(*a)->equals (*b, opt, note)) { return false; @@ -307,154 +265,64 @@ CPL::equals (CPL const & other, EqualityOptions opt, boost::function -CPL::make_kdm ( - CertificateChain const & certificates, - string const & signer_key, - shared_ptr recipient_cert, - boost::posix_time::ptime from, - boost::posix_time::ptime until - ) const +/** @return true if we have any encrypted content */ +bool +CPL::encrypted () const { - assert (recipient_cert); - - shared_ptr doc (new xmlpp::Document); - xmlpp::Element* root = doc->create_root_node ("DCinemaSecurityMessage"); - root->set_namespace_declaration ("http://www.smpte-ra.org/schemas/430-3/2006/ETM", ""); - root->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "ds"); - root->set_namespace_declaration ("http://www.w3.org/2001/04/xmlenc#", "enc"); - - { - xmlpp::Element* authenticated_public = root->add_child("AuthenticatedPublic"); - authenticated_public->set_attribute("Id", "ID_AuthenticatedPublic"); - xmlAddID (0, doc->cobj(), (const xmlChar *) "ID_AuthenticatedPublic", authenticated_public->get_attribute("Id")->cobj()); - - authenticated_public->add_child("MessageId")->add_child_text("urn:uuid:" + make_uuid()); - authenticated_public->add_child("MessageType")->add_child_text("http://www.smpte-ra.org/430-1/2006/KDM#kdm-key-type"); - authenticated_public->add_child("AnnotationText")->add_child_text(Metadata::instance()->product_name); - authenticated_public->add_child("IssueDate")->add_child_text(Metadata::instance()->issue_date); - - { - xmlpp::Element* signer = authenticated_public->add_child("Signer"); - signer->add_child("X509IssuerName", "ds")->add_child_text ( - Certificate::name_for_xml (recipient_cert->issuer()) - ); - signer->add_child("X509SerialNumber", "ds")->add_child_text ( - recipient_cert->serial() - ); + BOOST_FOREACH (shared_ptr i, _reels) { + if (i->encrypted ()) { + return true; } + } - { - xmlpp::Element* required_extensions = authenticated_public->add_child("RequiredExtensions"); - - { - xmlpp::Element* kdm_required_extensions = required_extensions->add_child("KDMRequiredExtensions"); - kdm_required_extensions->set_namespace_declaration ("http://www.smpte-ra.org/schemas/430-1/2006/KDM"); - { - xmlpp::Element* recipient = kdm_required_extensions->add_child("Recipient"); - { - xmlpp::Element* serial_element = recipient->add_child("X509IssuerSerial"); - serial_element->add_child("X509IssuerName", "ds")->add_child_text ( - Certificate::name_for_xml (recipient_cert->issuer()) - ); - serial_element->add_child("X509SerialNumber", "ds")->add_child_text ( - recipient_cert->serial() - ); - } - - recipient->add_child("X509SubjectName")->add_child_text (Certificate::name_for_xml (recipient_cert->subject())); - } - - kdm_required_extensions->add_child("CompositionPlaylistId")->add_child_text("urn:uuid:" + _uuid); - kdm_required_extensions->add_child("ContentTitleText")->add_child_text(_name); - kdm_required_extensions->add_child("ContentAuthenticator")->add_child_text(certificates.leaf()->thumbprint()); - kdm_required_extensions->add_child("ContentKeysNotValidBefore")->add_child_text("XXX"); - kdm_required_extensions->add_child("ContentKeysNotValidAfter")->add_child_text("XXX"); - - { - xmlpp::Element* authorized_device_info = kdm_required_extensions->add_child("AuthorizedDeviceInfo"); - authorized_device_info->add_child("DeviceListIdentifier")->add_child_text("urn:uuid:" + make_uuid()); - authorized_device_info->add_child("DeviceListDescription")->add_child_text(recipient_cert->subject()); - { - xmlpp::Element* device_list = authorized_device_info->add_child("DeviceList"); - device_list->add_child("CertificateThumbprint")->add_child_text(recipient_cert->thumbprint()); - } - } - - { - xmlpp::Element* key_id_list = kdm_required_extensions->add_child("KeyIdList"); - list > a = assets(); - for (list >::iterator i = a.begin(); i != a.end(); ++i) { - /* XXX: non-MXF assets? */ - shared_ptr mxf = boost::dynamic_pointer_cast (*i); - if (mxf) { - mxf->add_typed_key_id (key_id_list); - } - } - } - - { - xmlpp::Element* forensic_mark_flag_list = kdm_required_extensions->add_child("ForensicMarkFlagList"); - forensic_mark_flag_list->add_child("ForensicMarkFlag")->add_child_text ( - "http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-picture-disable" - ); - forensic_mark_flag_list->add_child("ForensicMarkFlag")->add_child_text ( - "http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-audio-disable" - ); - } - } - } - - authenticated_public->add_child("NonCriticalExtensions"); + 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 (DecryptedKDM const & kdm) +{ + BOOST_FOREACH (shared_ptr i, _reels) { + i->add (kdm); } +} - { - xmlpp::Element* authenticated_private = root->add_child("AuthenticatedPrivate"); - authenticated_private->set_attribute ("Id", "ID_AuthenticatedPrivate"); - xmlAddID (0, doc->cobj(), (const xmlChar *) "ID_AuthenticatedPrivate", authenticated_private->get_attribute("Id")->cobj()); - { - xmlpp::Element* encrypted_key = authenticated_private->add_child ("EncryptedKey", "enc"); - { - xmlpp::Element* encryption_method = encrypted_key->add_child ("EncryptionMethod", "enc"); - encryption_method->set_attribute ("Algorithm", "http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p"); - encryption_method->add_child("DigestMethod", "ds")->set_attribute("Algorithm", "http://www.w3.org/2000/09/xmldsig#sha1"); - } - - xmlpp::Element* cipher_data = authenticated_private->add_child ("CipherData", "enc"); - cipher_data->add_child("CipherValue", "enc")->add_child_text("XXX"); - } +void +CPL::resolve_refs (list > assets) +{ + BOOST_FOREACH (shared_ptr i, _reels) { + i->resolve_refs (assets); } - - /* XXX: x2 one for each mxf? */ +} - { - xmlpp::Element* signature = root->add_child("Signature", "ds"); - - { - xmlpp::Element* signed_info = signature->add_child("SignedInfo", "ds"); - signed_info->add_child("CanonicalizationMethod", "ds")->set_attribute( - "Algorithm", "http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments" - ); - signed_info->add_child("SignatureMethod", "ds")->set_attribute( - "Algorithm", "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256" - ); - { - xmlpp::Element* reference = signed_info->add_child("Reference", "ds"); - reference->set_attribute("URI", "#ID_AuthenticatedPublic"); - reference->add_child("DigestMethod", "ds")->set_attribute("Algorithm", "http://www.w3.org/2001/04/xmlenc#sha256"); - reference->add_child("DigestValue", "ds"); - } - - { - xmlpp::Element* reference = signed_info->add_child("Reference", "ds"); - reference->set_attribute("URI", "#ID_AuthenticatedPrivate"); - reference->add_child("DigestMethod", "ds")->set_attribute("Algorithm", "http://www.w3.org/2001/04/xmlenc#sha256"); - reference->add_child("DigestValue", "ds"); - } - } - - add_signature_value (signature, certificates, signer_key, "ds"); +string +CPL::pkl_type (Standard standard) const +{ + return static_pkl_type (standard); +} + +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); } +} - return doc; +int64_t +CPL::duration () const +{ + int64_t d = 0; + BOOST_FOREACH (shared_ptr i, _reels) { + d += i->duration (); + } + return d; }