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);
 115         }
 116
 117         for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
 118                 (*i)->write_to_pkl (asset_list);
 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 = doc.create_root_node ("VolumeIndex", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
 142         root->add_child("Index")->add_child_text ("1");
 143         doc.write_to_file (p.string (), "UTF-8");
 144 }
 145
 146 void
 147 DCP::write_assetmap (string pkl_uuid, int pkl_length, bool interop, XMLMetadata const & metadata) const
 148 {
 149         boost::filesystem::path p;
 150         p /= _directory;
 151         if (interop) {
 152                 p /= "ASSETMAP";
 153         } else {
 154                 p /= "ASSETMAP.xml";
 155         }
 156
 157         xmlpp::Document doc;
 158         xmlpp::Element* root;
 159         if (interop) {
 160                 root = doc.create_root_node ("AssetMap", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#");
 161         } else {
 162                 root = doc.create_root_node ("AssetMap", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
 163         }
 164
 165         root->add_child("Id")->add_child_text ("urn:uuid:" + make_uuid());
 166         root->add_child("AnnotationText")->add_child_text ("Created by " + metadata.creator);
 167         if (interop) {
 168                 root->add_child("VolumeCount")->add_child_text ("1");
 169                 root->add_child("IssueDate")->add_child_text (metadata.issue_date);
 170                 root->add_child("Issuer")->add_child_text (metadata.issuer);
 171                 root->add_child("Creator")->add_child_text (metadata.creator);
 172         } else {
 173                 root->add_child("Creator")->add_child_text (metadata.creator);
 174                 root->add_child("VolumeCount")->add_child_text ("1");
 175                 root->add_child("IssueDate")->add_child_text (metadata.issue_date);
 176                 root->add_child("Issuer")->add_child_text (metadata.issuer);
 177         }
 178
 179         xmlpp::Node* asset_list = root->add_child ("AssetList");
 180
 181         xmlpp::Node* asset = asset_list->add_child ("Asset");
 182         asset->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid);
 183         asset->add_child("PackingList")->add_child_text ("true");
 184         xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
 185         xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
 186         chunk->add_child("Path")->add_child_text (pkl_uuid + "_pkl.xml");
 187         chunk->add_child("VolumeIndex")->add_child_text ("1");
 188         chunk->add_child("Offset")->add_child_text ("0");
 189         chunk->add_child("Length")->add_child_text (lexical_cast<string> (pkl_length));
 190
 191         for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
 192                 (*i)->write_to_assetmap (asset_list);
 193         }
 194
 195         list<shared_ptr<const Asset> > a = assets ();
 196         for (list<shared_ptr<const Asset> >::const_iterator i = a.begin(); i != a.end(); ++i) {
 197                 (*i)->write_to_assetmap (asset_list);
 198         }
 199
 200         /* This must not be the _formatted version otherwise signature digests will be wrong */
 201         doc.write_to_file (p.string (), "UTF-8");
 202 }
 203
 204 void
 205 DCP::read (bool require_mxfs)
 206 {
 207         read_assets ();
 208         read_cpls (require_mxfs);
 209 }
 210
 211 void
 212 DCP::read_assets ()
 213 {
 214         shared_ptr<parse::AssetMap> asset_map;
 215         try {
 216                 boost::filesystem::path p = _directory;
 217                 p /= "ASSETMAP";
 218                 if (boost::filesystem::exists (p)) {
 219                         asset_map.reset (new libdcp::parse::AssetMap (p.string ()));
 220                 } else {
 221                         p = _directory;
 222                         p /= "ASSETMAP.xml";
 223                         if (boost::filesystem::exists (p)) {
 224                                 asset_map.reset (new libdcp::parse::AssetMap (p.string ()));
 225                         } else {
 226                                 boost::throw_exception (DCPReadError ("could not find AssetMap file"));
 227                         }
 228                 }
 229
 230         } catch (FileError& e) {
 231                 boost::throw_exception (FileError ("could not load AssetMap file", _files.asset_map));
 232         }
 233
 234         for (list<shared_ptr<libdcp::parse::AssetMapAsset> >::const_iterator i = asset_map->assets.begin(); i != asset_map->assets.end(); ++i) {
 235                 if ((*i)->chunks.size() != 1) {
 236                         boost::throw_exception (XMLError ("unsupported asset chunk count"));
 237                 }
 238
 239                 boost::filesystem::path t = _directory;
 240                 t /= (*i)->chunks.front()->path;
 241
 242                 if (boost::algorithm::ends_with (t.string(), ".mxf") || boost::algorithm::ends_with (t.string(), ".ttf")) {
 243                         continue;
 244                 }
 245
 246                 xmlpp::DomParser* p = new xmlpp::DomParser;
 247                 try {
 248                         p->parse_file (t.string());
 249                 } catch (std::exception& e) {
 250                         delete p;
 251                         continue;
 252                 }
 253
 254                 string const root = p->get_document()->get_root_node()->get_name ();
 255                 delete p;
 256
 257                 if (root == "CompositionPlaylist") {
 258                         _files.cpls.push_back (t.string());
 259                 } else if (root == "PackingList") {
 260                         if (_files.pkl.empty ()) {
 261                                 _files.pkl = t.string();
 262                         } else {
 263                                 boost::throw_exception (DCPReadError ("duplicate PKLs found"));
 264                         }
 265                 }
 266         }
 267
 268         if (_files.cpls.empty ()) {
 269                 boost::throw_exception (FileError ("no CPL files found", ""));
 270         }
 271
 272         if (_files.pkl.empty ()) {
 273                 boost::throw_exception (FileError ("no PKL file found", ""));
 274         }
 275
 276         shared_ptr<parse::PKL> pkl;
 277         try {
 278                 pkl.reset (new parse::PKL (_files.pkl));
 279         } catch (FileError& e) {
 280                 boost::throw_exception (FileError ("could not load PKL file", _files.pkl));
 281         }
 282
 283         _asset_maps.push_back (make_pair (boost::filesystem::absolute (_directory).string(), asset_map));
 284 }
 285
 286 void
 287 DCP::read_cpls (bool require_mxfs)
 288 {
 289         for (list<string>::iterator i = _files.cpls.begin(); i != _files.cpls.end(); ++i) {
 290                 _cpls.push_back (shared_ptr<CPL> (new CPL (_directory, *i, _asset_maps, require_mxfs)));
 291         }
 292 }
 293
 294 bool
 295 DCP::equals (DCP const & other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
 296 {
 297         if (_cpls.size() != other._cpls.size()) {
 298                 note (ERROR, "CPL counts differ");
 299                 return false;
 300         }
 301
 302         list<shared_ptr<CPL> >::const_iterator a = _cpls.begin ();
 303         list<shared_ptr<CPL> >::const_iterator b = other._cpls.begin ();
 304
 305         while (a != _cpls.end ()) {
 306                 if (!(*a)->equals (*b->get(), opt, note)) {
 307                         return false;
 308                 }
 309                 ++a;
 310                 ++b;
 311         }
 312
 313         return true;
 314 }
 315
 316 void
 317 DCP::add_cpl (shared_ptr<CPL> cpl)
 318 {
 319         _cpls.push_back (cpl);
 320 }
 321
 322 class AssetComparator
 323 {
 324 public:
 325         bool operator() (shared_ptr<const Asset> a, shared_ptr<const Asset> b) {
 326                 return a->uuid() < b->uuid();
 327         }
 328 };
 329
 330 list<shared_ptr<const Asset> >
 331 DCP::assets () const
 332 {
 333         list<shared_ptr<const Asset> > a;
 334         for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
 335                 list<shared_ptr<const Asset> > t = (*i)->assets ();
 336                 a.merge (t);
 337         }
 338
 339         a.sort (AssetComparator ());
 340         a.unique ();
 341         return a;
 342 }
 343
 344 bool
 345 DCP::encrypted () const
 346 {
 347         for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
 348                 if ((*i)->encrypted ()) {
 349                         return true;
 350                 }
 351         }
 352
 353         return false;
 354 }
 355
 356 void
 357 DCP::add_kdm (KDM const & kdm)
 358 {
 359         list<KDMKey> keys = kdm.keys ();
 360
 361         for (list<shared_ptr<CPL> >::iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
 362                 for (list<KDMKey>::iterator j = keys.begin(); j != keys.end(); ++j) {
 363                         if (j->cpl_id() == (*i)->id()) {
 364                                 (*i)->add_kdm (kdm);
 365                         }
 366                 }
 367         }
 368 }
 369
 370 void
 371 DCP::add_assets_from (DCP const & ov)
 372 {
 373         copy (ov._asset_maps.begin(), ov._asset_maps.end(), back_inserter (_asset_maps));
 374 }