src/dcp.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 /** @file  src/dcp.cc
  21  *  @brief A class to create a DCP.
  22  */
  23
  24 #include <sstream>
  25 #include <iomanip>
  26 #include <cassert>
  27 #include <iostream>
  28 #include <boost/filesystem.hpp>
  29 #include <boost/lexical_cast.hpp>
  30 #include <boost/algorithm/string.hpp>
  31 #include <boost/lexical_cast.hpp>
  32 #include <libxml++/libxml++.h>
  33 #include <xmlsec/xmldsig.h>
  34 #include <xmlsec/app.h>
  35 #include "dcp.h"
  36 #include "asset.h"
  37 #include "sound_asset.h"
  38 #include "picture_asset.h"
  39 #include "subtitle_asset.h"
  40 #include "util.h"
  41 #include "metadata.h"
  42 #include "exceptions.h"
  43 #include "parse/pkl.h"
  44 #include "parse/asset_map.h"
  45 #include "reel.h"
  46 #include "cpl.h"
  47 #include "signer.h"
  48 #include "kdm.h"
  49
  50 using std::string;
  51 using std::list;
  52 using std::stringstream;
  53 using std::ostream;
  54 using std::copy;
  55 using std::back_inserter;
  56 using std::make_pair;
  57 using boost::shared_ptr;
  58 using boost::lexical_cast;
  59 using namespace libdcp;
  60
  61 DCP::DCP (boost::filesystem::path directory)
  62         : _directory (directory)
  63 {
  64         boost::filesystem::create_directories (directory);
  65 }
  66
  67 void
  68 DCP::write_xml (bool interop, XMLMetadata const & metadata, shared_ptr<const Signer> signer) const
  69 {
  70         for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
  71                 (*i)->write_xml (interop, metadata, signer);
  72         }
  73
  74         string pkl_uuid = make_uuid ();
  75         string pkl_path = write_pkl (pkl_uuid, interop, metadata, signer);
  76
  77         write_volindex (interop);
  78         write_assetmap (pkl_uuid, boost::filesystem::file_size (pkl_path), interop, metadata);
  79 }
  80
  81 std::string
  82 DCP::write_pkl (string pkl_uuid, bool interop, XMLMetadata const & metadata, shared_ptr<const Signer> signer) const
  83 {
  84         assert (!_cpls.empty ());
  85
  86         boost::filesystem::path p;
  87         p /= _directory;
  88         stringstream s;
  89         s << pkl_uuid << "_pkl.xml";
  90         p /= s.str();
  91
  92         xmlpp::Document doc;
  93         xmlpp::Element* pkl;
  94         if (interop) {
  95                 pkl = doc.create_root_node("PackingList", "http://www.digicine.com/PROTO-ASDCP-PKL-20040311#");
  96         } else {
  97                 pkl = doc.create_root_node("PackingList", "http://www.smpte-ra.org/schemas/429-8/2007/PKL");
  98         }
  99
 100         if (signer) {
 101                 pkl->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig");
 102         }
 103
 104         pkl->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid);
 105         /* XXX: this is a bit of a hack */
 106         pkl->add_child("AnnotationText")->add_child_text(_cpls.front()->name());
 107         pkl->add_child("IssueDate")->add_child_text (metadata.issue_date);
 108         pkl->add_child("Issuer")->add_child_text (metadata.issuer);
 109         pkl->add_child("Creator")->add_child_text (metadata.creator);
 110
 111         xmlpp::Element* asset_list = pkl->add_child("AssetList");
 112         list<shared_ptr<const Asset> > a = assets ();
 113         for (list<shared_ptr<const Asset> >::const_iterator i = a.begin(); i != a.end(); ++i) {
 114                 (*i)->write_to_pkl (asset_list, interop);
 115         }
 116
 117         for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
 118                 (*i)->write_to_pkl (asset_list, interop);
 119         }
 120
 121         if (signer) {
 122                 signer->sign (pkl, interop);
 123         }
 124
 125         doc.write_to_file (p.string (), "UTF-8");
 126         return p.string ();
 127 }
 128
 129 void
 130 DCP::write_volindex (bool interop) const
 131 {
 132         boost::filesystem::path p;
 133         p /= _directory;
 134         if (interop) {
 135                 p /= "VOLINDEX";
 136         } else {
 137                 p /= "VOLINDEX.xml";
 138         }
 139
 140         xmlpp::Document doc;
 141         xmlpp::Element* root;
 142         if (interop) {
 143                 root = doc.create_root_node ("VolumeIndex", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#");
 144         } else {
 145                 root = doc.create_root_node ("VolumeIndex", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
 146         }
 147         root->add_child("Index")->add_child_text ("1");
 148         doc.write_to_file (p.string (), "UTF-8");
 149 }
 150
 151 void
 152 DCP::write_assetmap (string pkl_uuid, int pkl_length, bool interop, XMLMetadata const & metadata) const
 153 {
 154         boost::filesystem::path p;
 155         p /= _directory;
 156         if (interop) {
 157                 p /= "ASSETMAP";
 158         } else {
 159                 p /= "ASSETMAP.xml";
 160         }
 161
 162         xmlpp::Document doc;
 163         xmlpp::Element* root;
 164         if (interop) {
 165                 root = doc.create_root_node ("AssetMap", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#");
 166         } else {
 167                 root = doc.create_root_node ("AssetMap", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
 168         }
 169
 170         root->add_child("Id")->add_child_text ("urn:uuid:" + make_uuid());
 171         root->add_child("AnnotationText")->add_child_text ("Created by " + metadata.creator);
 172         if (interop) {
 173                 root->add_child("VolumeCount")->add_child_text ("1");
 174                 root->add_child("IssueDate")->add_child_text (metadata.issue_date);
 175                 root->add_child("Issuer")->add_child_text (metadata.issuer);
 176                 root->add_child("Creator")->add_child_text (metadata.creator);
 177         } else {
 178                 root->add_child("Creator")->add_child_text (metadata.creator);
 179                 root->add_child("VolumeCount")->add_child_text ("1");
 180                 root->add_child("IssueDate")->add_child_text (metadata.issue_date);
 181                 root->add_child("Issuer")->add_child_text (metadata.issuer);
 182         }
 183
 184         xmlpp::Node* asset_list = root->add_child ("AssetList");
 185
 186         xmlpp::Node* asset = asset_list->add_child ("Asset");
 187         asset->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid);
 188         asset->add_child("PackingList")->add_child_text ("true");
 189         xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
 190         xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
 191         chunk->add_child("Path")->add_child_text (pkl_uuid + "_pkl.xml");
 192         chunk->add_child("VolumeIndex")->add_child_text ("1");
 193         chunk->add_child("Offset")->add_child_text ("0");
 194         chunk->add_child("Length")->add_child_text (lexical_cast<string> (pkl_length));
 195
 196         for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
 197                 (*i)->write_to_assetmap (asset_list);
 198         }
 199
 200         list<shared_ptr<const Asset> > a = assets ();
 201         for (list<shared_ptr<const Asset> >::const_iterator i = a.begin(); i != a.end(); ++i) {
 202                 (*i)->write_to_assetmap (asset_list);
 203         }
 204
 205         /* This must not be the _formatted version otherwise signature digests will be wrong */
 206         doc.write_to_file (p.string (), "UTF-8");
 207 }
 208
 209 void
 210 DCP::read (bool require_mxfs)
 211 {
 212         read_assets ();
 213         read_cpls (require_mxfs);
 214 }
 215
 216 void
 217 DCP::read_assets ()
 218 {
 219         shared_ptr<parse::AssetMap> asset_map;
 220         try {
 221                 boost::filesystem::path p = _directory;
 222                 p /= "ASSETMAP";
 223                 if (boost::filesystem::exists (p)) {
 224                         asset_map.reset (new libdcp::parse::AssetMap (p.string ()));
 225                 } else {
 226                         p = _directory;
 227                         p /= "ASSETMAP.xml";
 228                         if (boost::filesystem::exists (p)) {
 229                                 asset_map.reset (new libdcp::parse::AssetMap (p.string ()));
 230                         } else {
 231                                 boost::throw_exception (FileError ("could not find AssetMap file", p, -1));
 232                         }
 233                 }
 234
 235         } catch (FileError& e) {
 236                 boost::throw_exception (FileError ("could not load AssetMap file", e.filename(), e.number ()));
 237         }
 238
 239         for (list<shared_ptr<libdcp::parse::AssetMapAsset> >::const_iterator i = asset_map->assets.begin(); i != asset_map->assets.end(); ++i) {
 240                 if ((*i)->chunks.size() != 1) {
 241                         boost::throw_exception (XMLError ("unsupported asset chunk count"));
 242                 }
 243
 244                 boost::filesystem::path t = _directory;
 245                 t /= (*i)->chunks.front()->path;
 246
 247                 if (boost::algorithm::ends_with (t.string(), ".mxf") || boost::algorithm::ends_with (t.string(), ".ttf")) {
 248                         continue;
 249                 }
 250
 251                 xmlpp::DomParser* p = new xmlpp::DomParser;
 252                 try {
 253                         p->parse_file (t.string());
 254                 } catch (std::exception& e) {
 255                         delete p;
 256                         continue;
 257                 }
 258
 259                 string const root = p->get_document()->get_root_node()->get_name ();
 260                 delete p;
 261
 262                 if (root == "CompositionPlaylist") {
 263                         _files.cpls.push_back (t.string());
 264                 } else if (root == "PackingList") {
 265                         if (_files.pkl.empty ()) {
 266                                 _files.pkl = t.string();
 267                         } else {
 268                                 boost::throw_exception (DCPReadError ("duplicate PKLs found"));
 269                         }
 270                 }
 271         }
 272
 273         if (_files.cpls.empty ()) {
 274                 boost::throw_exception (DCPReadError ("no CPL files found"));
 275         }
 276
 277         if (_files.pkl.empty ()) {
 278                 boost::throw_exception (DCPReadError ("no PKL file found"));
 279         }
 280
 281         shared_ptr<parse::PKL> pkl;
 282         try {
 283                 pkl.reset (new parse::PKL (_files.pkl));
 284         } catch (FileError& e) {
 285                 boost::throw_exception (FileError ("could not load PKL file", _files.pkl, e.number ()));
 286         }
 287
 288         _asset_maps.push_back (make_pair (boost::filesystem::absolute (_directory).string(), asset_map));
 289 }
 290
 291 void
 292 DCP::read_cpls (bool require_mxfs)
 293 {
 294         for (list<string>::iterator i = _files.cpls.begin(); i != _files.cpls.end(); ++i) {
 295                 _cpls.push_back (shared_ptr<CPL> (new CPL (_directory, *i, _asset_maps, require_mxfs)));
 296         }
 297 }
 298
 299 bool
 300 DCP::equals (DCP const & other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
 301 {
 302         if (_cpls.size() != other._cpls.size()) {
 303                 note (ERROR, "CPL counts differ");
 304                 return false;
 305         }
 306
 307         list<shared_ptr<CPL> >::const_iterator a = _cpls.begin ();
 308         list<shared_ptr<CPL> >::const_iterator b = other._cpls.begin ();
 309
 310         while (a != _cpls.end ()) {
 311                 if (!(*a)->equals (*b->get(), opt, note)) {
 312                         return false;
 313                 }
 314                 ++a;
 315                 ++b;
 316         }
 317
 318         return true;
 319 }
 320
 321 void
 322 DCP::add_cpl (shared_ptr<CPL> cpl)
 323 {
 324         _cpls.push_back (cpl);
 325 }
 326
 327 class AssetComparator
 328 {
 329 public:
 330         bool operator() (shared_ptr<const Asset> a, shared_ptr<const Asset> b) {
 331                 return a->uuid() < b->uuid();
 332         }
 333 };
 334
 335 list<shared_ptr<const Asset> >
 336 DCP::assets () const
 337 {
 338         list<shared_ptr<const Asset> > a;
 339         for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
 340                 list<shared_ptr<const Asset> > t = (*i)->assets ();
 341                 a.merge (t);
 342         }
 343
 344         a.sort (AssetComparator ());
 345         a.unique ();
 346         return a;
 347 }
 348
 349 bool
 350 DCP::encrypted () const
 351 {
 352         for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
 353                 if ((*i)->encrypted ()) {
 354                         return true;
 355                 }
 356         }
 357
 358         return false;
 359 }
 360
 361 void
 362 DCP::add_kdm (KDM const & kdm)
 363 {
 364         list<KDMKey> keys = kdm.keys ();
 365
 366         for (list<shared_ptr<CPL> >::iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
 367                 for (list<KDMKey>::iterator j = keys.begin(); j != keys.end(); ++j) {
 368                         if (j->cpl_id() == (*i)->id()) {
 369                                 (*i)->add_kdm (kdm);
 370                         }
 371                 }
 372         }
 373 }
 374
 375 void
 376 DCP::add_assets_from (DCP const & ov)
 377 {
 378         copy (ov._asset_maps.begin(), ov._asset_maps.end(), back_inserter (_asset_maps));
 379 }