X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Fcpl.cc;h=fcfa9efac37e5006b799ca6672d672d228df2197;hb=2f0e6ee9d883abbbc31aca0d1cc80e89eb9b0af2;hp=e22ddc71e1f1f8528c0fbe82540da8ef4ad0a08d;hpb=c9cf540a0fee44b724d1f879489dd7e7f51c60c7;p=libdcp.git diff --git a/src/cpl.cc b/src/cpl.cc index e22ddc71..fcfa9efa 100644 --- a/src/cpl.cc +++ b/src/cpl.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 @@ -17,284 +17,168 @@ */ -#include -#include +#include "raw_convert.h" #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 "mono_picture_mxf.h" +#include "stereo_picture_mxf.h" +#include "sound_mxf.h" +#include "subtitle_content.h" #include "reel.h" #include "metadata.h" -#include "encryption.h" +#include "signer.h" #include "exceptions.h" +#include "xml.h" #include "compose.hpp" +#include "reel_picture_asset.h" +#include "reel_sound_asset.h" +#include "reel_subtitle_asset.h" +#include "local_time.h" +#include using std::string; using std::stringstream; -using std::ofstream; using std::ostream; using std::list; +using std::pair; +using std::make_pair; using boost::shared_ptr; -using boost::lexical_cast; -using namespace libdcp; +using boost::optional; +using namespace dcp; -CPL::CPL (string directory, string name, ContentKind content_kind, int length, int frames_per_second) - : _directory (directory) - , _name (name) +CPL::CPL (string annotation_text, ContentKind content_kind) + : _annotation_text (annotation_text) + /* 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 (); + /* default _content_version_id to and _content_version_label to + a random ID and the current time. + */ + _content_version_id = "urn:uuid:" + make_uuid() + LocalTime().as_string (); + _content_version_label_text = _content_version_id; } -/** 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 (string 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)); - } - - /* Now cherry-pick the required bits into our own data structure */ - - _name = cpl->annotation_text; - _content_kind = cpl->content_kind; - - /* 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; + cxml::Document f ("CompositionPlaylist"); + f.read_file (file); - 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_from_id (asset_maps, p->id)->chunks.front()->path - ) - ); - - 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 { - picture.reset (new StereoPictureAsset ( - _directory, - asset_from_id (asset_maps, p->id)->chunks.front()->path, - _fps, - p->duration - ) - ); - - 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 { - sound.reset (new SoundAsset ( - _directory, - asset_from_id (asset_maps, (*i)->asset_list->main_sound->id)->chunks.front()->path - ) - ); - - shared_ptr s = (*i)->asset_list->main_sound; - - 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; - } - } - } + _id = f.string_child ("Id"); + if (_id.length() > 9) { + _id = _id.substr (9); + } + _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_from_id (asset_maps, (*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 (bool interop, XMLMetadata const & metadata, shared_ptr crypt) 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) { + if (standard == INTEROP) { root = doc.create_root_node ("CompositionPlaylist", "http://www.digicine.com/PROTO-ASDCP-CPL-20040511#"); } else { root = doc.create_root_node ("CompositionPlaylist", "http://www.smpte-ra.org/schemas/429-7/2006/CPL"); } - 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:" + _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 (_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::Node* reel_list = root->add_child ("ReelList"); + 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, interop); + (*i)->write_to_cpl (reel_list, standard); } - if (crypt) { - sign (root, crypt->certificates, crypt->signer_key, interop); + if (signer) { + signer->sign (root, standard); } - doc.write_to_file_formatted (p.string (), "UTF-8"); + /* This must not be the _formatted version otherwise signature digests will be wrong */ + doc.write_to_file (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::content () const { - 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 (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 ()); + c.push_back ((*i)->main_picture()->mxf ()); } if ((*i)->main_sound ()) { - a.push_back ((*i)->main_sound ()); + c.push_back ((*i)->main_sound()->mxf ()); } if ((*i)->main_subtitle ()) { - a.push_back ((*i)->main_subtitle ()); + c.push_back ((*i)->main_subtitle()->subtitle_content ()); } } - 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(lexical_cast (_length)); -} - - bool CPL::equals (CPL const & other, EqualityOptions opt, boost::function note) const { - if (_name != other._name && !opt.cpl_names_can_differ) { + if (_annotation_text != other._annotation_text && !opt.cpl_annotation_texts_can_differ) { stringstream s; - s << "names differ: " << _name << " vs " << other._name << "\n"; + s << "annotation texts differ: " << _annotation_text << " vs " << other._annotation_text << "\n"; note (ERROR, s.str ()); return false; } @@ -304,16 +188,6 @@ 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, - bool interop, - MXFMetadata const & mxf_metadata, - XMLMetadata const & xml_metadata - ) 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 (mxf_metadata.product_name); - authenticated_public->add_child("IssueDate")->add_child_text (xml_metadata.issue_date); - - { - xmlpp::Element* signer = authenticated_public->add_child("Signer"); - signer->add_child("X509IssuerName", "ds")->add_child_text (recipient_cert->issuer()); - signer->add_child("X509SerialNumber", "ds")->add_child_text (recipient_cert->serial()); - } - - { - 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 (recipient_cert->issuer()); - serial_element->add_child("X509SerialNumber", "ds")->add_child_text (recipient_cert->serial()); - } - - recipient->add_child("X509SubjectName")->add_child_text (recipient_cert->subject()); - } - - kdm_required_extensions->add_child("CompositionPlaylistId")->add_child_text("urn:uuid:" + _id); - 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"); - } - - { - 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"); - } - } - - /* 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" - ); - - if (interop) { - signed_info->add_child("SignatureMethod", "ds")->set_attribute( - "Algorithm", "http://www.w3.org/2000/09/xmldsig#rsa-sha1" - ); - } else { - 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"); - } - - return doc; -} - /** @return true if we have any encrypted content */ bool CPL::encrypted () const @@ -501,23 +220,48 @@ 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); + (*i)->add (kdm); } } -shared_ptr -CPL::asset_from_id (list > asset_maps, string id) const +/** Set a private key for every MXF referenced by this CPL. This will allow the data + * to be decrypted or encrypted. + * @param key Key to use. + */ +void +CPL::set_mxf_keys (Key key) { - for (list >::const_iterator i = asset_maps.begin(); i != asset_maps.end(); ++i) { - shared_ptr a = (*i)->asset_from_id (id); - if (a) { - return a; - } + for (list >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) { + (*i)->set_mxf_keys (key); } +} + +void +CPL::resolve_refs (list > objects) +{ + for (list >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) { + (*i)->resolve_refs (objects); + } +} - return shared_ptr (); +string +CPL::pkl_type (Standard standard) const +{ + switch (standard) { + case INTEROP: + return "text/xml;asdcpKind=CPL"; + case SMPTE: + return "text/xml"; + default: + assert (false); + } } +