src/cpl.cc

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <fstream>
  21 #include <libxml/parser.h>
  22 #include "cpl.h"
  23 #include "parse/cpl.h"
  24 #include "util.h"
  25 #include "picture_asset.h"
  26 #include "sound_asset.h"
  27 #include "subtitle_asset.h"
  28 #include "parse/asset_map.h"
  29 #include "reel.h"
  30 #include "metadata.h"
  31 #include "encryption.h"
  32 #include "exceptions.h"
  33 #include "compose.hpp"
  34
  35 using std::string;
  36 using std::stringstream;
  37 using std::ofstream;
  38 using std::ostream;
  39 using std::list;
  40 using boost::shared_ptr;
  41 using boost::lexical_cast;
  42 using namespace libdcp;
  43
  44 CPL::CPL (string directory, string name, ContentKind content_kind, int length, int frames_per_second)
  45         : _directory (directory)
  46         , _name (name)
  47         , _content_kind (content_kind)
  48         , _length (length)
  49         , _fps (frames_per_second)
  50 {
  51         _uuid = make_uuid ();
  52 }
  53
  54 /** Construct a CPL object from a XML file.
  55  *  @param directory The directory containing this CPL's DCP.
  56  *  @param file The CPL XML filename.
  57  *  @param asset_map The corresponding asset map.
  58  *  @param require_mxfs true to throw an exception if a required MXF file does not exist.
  59  */
  60 CPL::CPL (string directory, string file, shared_ptr<const libdcp::parse::AssetMap> asset_map, bool require_mxfs)
  61         : _directory (directory)
  62         , _content_kind (FEATURE)
  63         , _length (0)
  64         , _fps (0)
  65 {
  66         /* Read the XML */
  67         shared_ptr<parse::CPL> cpl;
  68         try {
  69                 cpl.reset (new parse::CPL (file));
  70         } catch (FileError& e) {
  71                 boost::throw_exception (FileError ("could not load CPL file", file));
  72         }
  73
  74         /* Now cherry-pick the required bits into our own data structure */
  75
  76         _name = cpl->annotation_text;
  77         _content_kind = cpl->content_kind;
  78
  79         for (list<shared_ptr<libdcp::parse::Reel> >::iterator i = cpl->reels.begin(); i != cpl->reels.end(); ++i) {
  80
  81                 shared_ptr<parse::Picture> p;
  82
  83                 if ((*i)->asset_list->main_picture) {
  84                         p = (*i)->asset_list->main_picture;
  85                 } else {
  86                         p = (*i)->asset_list->main_stereoscopic_picture;
  87                 }
  88
  89                 _fps = p->edit_rate.numerator;
  90                 _length += p->duration;
  91
  92                 shared_ptr<PictureAsset> picture;
  93                 shared_ptr<SoundAsset> sound;
  94                 shared_ptr<SubtitleAsset> subtitle;
  95
  96                 /* Some rather twisted logic to decide if we are 3D or not;
  97                    some DCPs give a MainStereoscopicPicture to indicate 3D, others
  98                    just have a FrameRate twice the EditRate and apparently
  99                    expect you to divine the fact that they are hence 3D.
 100                 */
 101
 102                 if (!(*i)->asset_list->main_stereoscopic_picture && p->edit_rate == p->frame_rate) {
 103
 104                         try {
 105                                 picture.reset (new MonoPictureAsset (
 106                                                        _directory,
 107                                                        asset_map->asset_from_id (p->id)->chunks.front()->path
 108                                                        )
 109                                         );
 110
 111                                 picture->set_entry_point (p->entry_point);
 112                                 picture->set_duration (p->duration);
 113                                 picture->set_key_id (p->key_id);
 114                         } catch (MXFFileError) {
 115                                 if (require_mxfs) {
 116                                         throw;
 117                                 }
 118                         }
 119
 120                 } else {
 121                         try {
 122                                 picture.reset (new StereoPictureAsset (
 123                                                        _directory,
 124                                                        asset_map->asset_from_id (p->id)->chunks.front()->path,
 125                                                        _fps,
 126                                                        p->duration
 127                                                        )
 128                                         );
 129
 130                                 picture->set_entry_point (p->entry_point);
 131                                 picture->set_duration (p->duration);
 132                                 picture->set_key_id (p->key_id);
 133
 134                         } catch (MXFFileError) {
 135                                 if (require_mxfs) {
 136                                         throw;
 137                                 }
 138                         }
 139
 140                 }
 141
 142                 if ((*i)->asset_list->main_sound) {
 143
 144                         try {
 145                                 sound.reset (new SoundAsset (
 146                                                      _directory,
 147                                                      asset_map->asset_from_id ((*i)->asset_list->main_sound->id)->chunks.front()->path
 148                                                      )
 149                                         );
 150
 151                                 sound->set_entry_point ((*i)->asset_list->main_sound->entry_point);
 152                                 sound->set_duration ((*i)->asset_list->main_sound->duration);
 153                                 sound->set_key_id ((*i)->asset_list->main_sound->key_id);
 154                         } catch (MXFFileError) {
 155                                 if (require_mxfs) {
 156                                         throw;
 157                                 }
 158                         }
 159                 }
 160
 161                 if ((*i)->asset_list->main_subtitle) {
 162
 163                         subtitle.reset (new SubtitleAsset (
 164                                                 _directory,
 165                                                 asset_map->asset_from_id ((*i)->asset_list->main_subtitle->id)->chunks.front()->path
 166                                                 )
 167                                 );
 168
 169                         subtitle->set_entry_point ((*i)->asset_list->main_subtitle->entry_point);
 170                         subtitle->set_duration ((*i)->asset_list->main_subtitle->duration);
 171                 }
 172
 173                 _reels.push_back (shared_ptr<Reel> (new Reel (picture, sound, subtitle)));
 174         }
 175 }
 176
 177 void
 178 CPL::add_reel (shared_ptr<const Reel> reel)
 179 {
 180         _reels.push_back (reel);
 181 }
 182
 183 void
 184 CPL::write_xml (XMLMetadata const & metadata, shared_ptr<Encryption> crypt) const
 185 {
 186         boost::filesystem::path p;
 187         p /= _directory;
 188         stringstream s;
 189         s << _uuid << "_cpl.xml";
 190         p /= s.str();
 191
 192         xmlpp::Document doc;
 193         xmlpp::Element* root = doc.create_root_node ("CompositionPlaylist", "http://www.smpte-ra.org/schemas/429-7/2006/CPL");
 194
 195         if (crypt) {
 196                 root->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig");
 197         }
 198
 199         root->add_child("Id")->add_child_text ("urn:uuid:" + _uuid);
 200         root->add_child("AnnotationText")->add_child_text (_name);
 201         root->add_child("IssueDate")->add_child_text (metadata.issue_date);
 202         root->add_child("Creator")->add_child_text (metadata.creator);
 203         root->add_child("ContentTitleText")->add_child_text (_name);
 204         root->add_child("ContentKind")->add_child_text (content_kind_to_string (_content_kind));
 205         {
 206                 xmlpp::Node* cv = root->add_child ("ContentVersion");
 207                 cv->add_child ("Id")->add_child_text ("urn:uri:" + _uuid + "_" + metadata.issue_date);
 208                 cv->add_child ("LabelText")->add_child_text (_uuid + "_" + metadata.issue_date);
 209         }
 210         root->add_child("RatingList");
 211
 212         xmlpp::Node* reel_list = root->add_child ("ReelList");
 213
 214         for (list<shared_ptr<const Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
 215                 (*i)->write_to_cpl (reel_list);
 216         }
 217
 218         if (crypt) {
 219                 sign (root, crypt->certificates, crypt->signer_key);
 220         }
 221
 222         doc.write_to_file_formatted (p.string (), "UTF-8");
 223
 224         _digest = make_digest (p.string ());
 225         _length = boost::filesystem::file_size (p.string ());
 226 }
 227
 228 void
 229 CPL::write_to_pkl (xmlpp::Node* node) const
 230 {
 231         xmlpp::Node* asset = node->add_child ("Asset");
 232         asset->add_child("Id")->add_child_text ("urn:uuid:" + _uuid);
 233         asset->add_child("Hash")->add_child_text (_digest);
 234         asset->add_child("Size")->add_child_text (lexical_cast<string> (_length));
 235         asset->add_child("Type")->add_child_text ("text/xml");
 236 }
 237
 238 list<shared_ptr<const Asset> >
 239 CPL::assets () const
 240 {
 241         list<shared_ptr<const Asset> > a;
 242         for (list<shared_ptr<const Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
 243                 if ((*i)->main_picture ()) {
 244                         a.push_back ((*i)->main_picture ());
 245                 }
 246                 if ((*i)->main_sound ()) {
 247                         a.push_back ((*i)->main_sound ());
 248                 }
 249                 if ((*i)->main_subtitle ()) {
 250                         a.push_back ((*i)->main_subtitle ());
 251                 }
 252         }
 253
 254         return a;
 255 }
 256
 257 void
 258 CPL::write_to_assetmap (xmlpp::Node* node) const
 259 {
 260         xmlpp::Node* asset = node->add_child ("Asset");
 261         asset->add_child("Id")->add_child_text ("urn:uuid:" + _uuid);
 262         xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
 263         xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
 264         chunk->add_child("Path")->add_child_text (_uuid + "_cpl.xml");
 265         chunk->add_child("VolumeIndex")->add_child_text ("1");
 266         chunk->add_child("Offset")->add_child_text("0");
 267         chunk->add_child("Length")->add_child_text(lexical_cast<string> (_length));
 268 }
 269
 270
 271
 272 bool
 273 CPL::equals (CPL const & other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
 274 {
 275         if (_name != other._name && !opt.cpl_names_can_differ) {
 276                 stringstream s;
 277                 s << "names differ: " << _name << " vs " << other._name << "\n";
 278                 note (ERROR, s.str ());
 279                 return false;
 280         }
 281
 282         if (_content_kind != other._content_kind) {
 283                 note (ERROR, "content kinds differ");
 284                 return false;
 285         }
 286
 287         if (_fps != other._fps) {
 288                 note (ERROR, String::compose ("frames per second differ (%1 vs %2)", _fps, other._fps));
 289                 return false;
 290         }
 291
 292         if (_length != other._length) {
 293                 stringstream s;
 294                 s << "lengths differ (" << _length << " cf " << other._length << ")";
 295                 note (ERROR, String::compose ("lengths differ (%1 vs %2)", _length, other._length));
 296                 return false;
 297         }
 298
 299         if (_reels.size() != other._reels.size()) {
 300                 note (ERROR, String::compose ("reel counts differ (%1 vs %2)", _reels.size(), other._reels.size()));
 301                 return false;
 302         }
 303
 304         list<shared_ptr<const Reel> >::const_iterator a = _reels.begin ();
 305         list<shared_ptr<const Reel> >::const_iterator b = other._reels.begin ();
 306
 307         while (a != _reels.end ()) {
 308                 if (!(*a)->equals (*b, opt, note)) {
 309                         return false;
 310                 }
 311                 ++a;
 312                 ++b;
 313         }
 314
 315         return true;
 316 }
 317
 318 shared_ptr<xmlpp::Document>
 319 CPL::make_kdm (
 320         CertificateChain const & certificates,
 321         string const & signer_key,
 322         shared_ptr<const Certificate> recipient_cert,
 323         boost::posix_time::ptime from,
 324         boost::posix_time::ptime until,
 325         MXFMetadata const & mxf_metadata,
 326         XMLMetadata const & xml_metadata
 327         ) const
 328 {
 329         assert (recipient_cert);
 330
 331         shared_ptr<xmlpp::Document> doc (new xmlpp::Document);
 332         xmlpp::Element* root = doc->create_root_node ("DCinemaSecurityMessage");
 333         root->set_namespace_declaration ("http://www.smpte-ra.org/schemas/430-3/2006/ETM", "");
 334         root->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "ds");
 335         root->set_namespace_declaration ("http://www.w3.org/2001/04/xmlenc#", "enc");
 336
 337         {
 338                 xmlpp::Element* authenticated_public = root->add_child("AuthenticatedPublic");
 339                 authenticated_public->set_attribute("Id", "ID_AuthenticatedPublic");
 340                 xmlAddID (0, doc->cobj(), (const xmlChar *) "ID_AuthenticatedPublic", authenticated_public->get_attribute("Id")->cobj());
 341
 342                 authenticated_public->add_child("MessageId")->add_child_text ("urn:uuid:" + make_uuid());
 343                 authenticated_public->add_child("MessageType")->add_child_text ("http://www.smpte-ra.org/430-1/2006/KDM#kdm-key-type");
 344                 authenticated_public->add_child("AnnotationText")->add_child_text (mxf_metadata.product_name);
 345                 authenticated_public->add_child("IssueDate")->add_child_text (xml_metadata.issue_date);
 346
 347                 {
 348                         xmlpp::Element* signer = authenticated_public->add_child("Signer");
 349                         signer->add_child("X509IssuerName", "ds")->add_child_text (
 350                                 Certificate::name_for_xml (recipient_cert->issuer())
 351                                 );
 352                         signer->add_child("X509SerialNumber", "ds")->add_child_text (
 353                                 recipient_cert->serial()
 354                                 );
 355                 }
 356
 357                 {
 358                         xmlpp::Element* required_extensions = authenticated_public->add_child("RequiredExtensions");
 359
 360                         {
 361                                 xmlpp::Element* kdm_required_extensions = required_extensions->add_child("KDMRequiredExtensions");
 362                                 kdm_required_extensions->set_namespace_declaration ("http://www.smpte-ra.org/schemas/430-1/2006/KDM");
 363                                 {
 364                                         xmlpp::Element* recipient = kdm_required_extensions->add_child("Recipient");
 365                                         {
 366                                                 xmlpp::Element* serial_element = recipient->add_child("X509IssuerSerial");
 367                                                 serial_element->add_child("X509IssuerName", "ds")->add_child_text (
 368                                                         Certificate::name_for_xml (recipient_cert->issuer())
 369                                                         );
 370                                                 serial_element->add_child("X509SerialNumber", "ds")->add_child_text (
 371                                                         recipient_cert->serial()
 372                                                         );
 373                                         }
 374
 375                                         recipient->add_child("X509SubjectName")->add_child_text (Certificate::name_for_xml (recipient_cert->subject()));
 376                                 }
 377
 378                                 kdm_required_extensions->add_child("CompositionPlaylistId")->add_child_text("urn:uuid:" + _uuid);
 379                                 kdm_required_extensions->add_child("ContentTitleText")->add_child_text(_name);
 380                                 kdm_required_extensions->add_child("ContentAuthenticator")->add_child_text(certificates.leaf()->thumbprint());
 381                                 kdm_required_extensions->add_child("ContentKeysNotValidBefore")->add_child_text("XXX");
 382                                 kdm_required_extensions->add_child("ContentKeysNotValidAfter")->add_child_text("XXX");
 383
 384                                 {
 385                                         xmlpp::Element* authorized_device_info = kdm_required_extensions->add_child("AuthorizedDeviceInfo");
 386                                         authorized_device_info->add_child("DeviceListIdentifier")->add_child_text("urn:uuid:" + make_uuid());
 387                                         authorized_device_info->add_child("DeviceListDescription")->add_child_text(recipient_cert->subject());
 388                                         {
 389                                                 xmlpp::Element* device_list = authorized_device_info->add_child("DeviceList");
 390                                                 device_list->add_child("CertificateThumbprint")->add_child_text(recipient_cert->thumbprint());
 391                                         }
 392                                 }
 393
 394                                 {
 395                                         xmlpp::Element* key_id_list = kdm_required_extensions->add_child("KeyIdList");
 396                                         list<shared_ptr<const Asset> > a = assets();
 397                                         for (list<shared_ptr<const Asset> >::iterator i = a.begin(); i != a.end(); ++i) {
 398                                                 /* XXX: non-MXF assets? */
 399                                                 shared_ptr<const MXFAsset> mxf = boost::dynamic_pointer_cast<const MXFAsset> (*i);
 400                                                 if (mxf) {
 401                                                         mxf->add_typed_key_id (key_id_list);
 402                                                 }
 403                                         }
 404                                 }
 405
 406                                 {
 407                                         xmlpp::Element* forensic_mark_flag_list = kdm_required_extensions->add_child("ForensicMarkFlagList");
 408                                         forensic_mark_flag_list->add_child("ForensicMarkFlag")->add_child_text (
 409                                                 "http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-picture-disable"
 410                                                 );
 411                                         forensic_mark_flag_list->add_child("ForensicMarkFlag")->add_child_text (
 412                                                 "http://www.smpte-ra.org/430-1/2006/KDM#mrkflg-audio-disable"
 413                                                 );
 414                                 }
 415                         }
 416                 }
 417
 418                 authenticated_public->add_child("NonCriticalExtensions");
 419         }
 420
 421         {
 422                 xmlpp::Element* authenticated_private = root->add_child("AuthenticatedPrivate");
 423                 authenticated_private->set_attribute ("Id", "ID_AuthenticatedPrivate");
 424                 xmlAddID (0, doc->cobj(), (const xmlChar *) "ID_AuthenticatedPrivate", authenticated_private->get_attribute("Id")->cobj());
 425                 {
 426                         xmlpp::Element* encrypted_key = authenticated_private->add_child ("EncryptedKey", "enc");
 427                         {
 428                                 xmlpp::Element* encryption_method = encrypted_key->add_child ("EncryptionMethod", "enc");
 429                                 encryption_method->set_attribute ("Algorithm", "http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p");
 430                                 encryption_method->add_child("DigestMethod", "ds")->set_attribute("Algorithm", "http://www.w3.org/2000/09/xmldsig#sha1");
 431                         }
 432
 433                         xmlpp::Element* cipher_data = authenticated_private->add_child ("CipherData", "enc");
 434                         cipher_data->add_child("CipherValue", "enc")->add_child_text("XXX");
 435                 }
 436         }
 437
 438         /* XXX: x2 one for each mxf? */
 439
 440         {
 441                 xmlpp::Element* signature = root->add_child("Signature", "ds");
 442
 443                 {
 444                         xmlpp::Element* signed_info = signature->add_child("SignedInfo", "ds");
 445                         signed_info->add_child("CanonicalizationMethod", "ds")->set_attribute(
 446                                 "Algorithm", "http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments"
 447                                 );
 448                         signed_info->add_child("SignatureMethod", "ds")->set_attribute(
 449                                 "Algorithm", "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"
 450                                 );
 451                         {
 452                                 xmlpp::Element* reference = signed_info->add_child("Reference", "ds");
 453                                 reference->set_attribute("URI", "#ID_AuthenticatedPublic");
 454                                 reference->add_child("DigestMethod", "ds")->set_attribute("Algorithm", "http://www.w3.org/2001/04/xmlenc#sha256");
 455                                 reference->add_child("DigestValue", "ds");
 456                         }
 457
 458                         {
 459                                 xmlpp::Element* reference = signed_info->add_child("Reference", "ds");
 460                                 reference->set_attribute("URI", "#ID_AuthenticatedPrivate");
 461                                 reference->add_child("DigestMethod", "ds")->set_attribute("Algorithm", "http://www.w3.org/2001/04/xmlenc#sha256");
 462                                 reference->add_child("DigestValue", "ds");
 463                         }
 464                 }
 465
 466                 add_signature_value (signature, certificates, signer_key, "ds");
 467         }
 468
 469         return doc;
 470 }
 471
 472 /** @return true if we have any encrypted content */
 473 bool
 474 CPL::encrypted () const
 475 {
 476         for (list<shared_ptr<const Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
 477                 if ((*i)->encrypted ()) {
 478                         return true;
 479                 }
 480         }
 481
 482         return false;
 483 }