src/dcp.cc

   1 /*
   2     Copyright (C) 2012-2015 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 DCP class.
  22  */
  23
  24 #include "raw_convert.h"
  25 #include "dcp.h"
  26 #include "sound_asset.h"
  27 #include "picture_asset.h"
  28 #include "interop_subtitle_asset.h"
  29 #include "smpte_subtitle_asset.h"
  30 #include "mono_picture_asset.h"
  31 #include "stereo_picture_asset.h"
  32 #include "reel_subtitle_asset.h"
  33 #include "util.h"
  34 #include "metadata.h"
  35 #include "exceptions.h"
  36 #include "cpl.h"
  37 #include "certificate_chain.h"
  38 #include "compose.hpp"
  39 #include "AS_DCP.h"
  40 #include "decrypted_kdm.h"
  41 #include "decrypted_kdm_key.h"
  42 #include "dcp_assert.h"
  43 #include "reel_asset.h"
  44 #include "font_asset.h"
  45 #include <xmlsec/xmldsig.h>
  46 #include <xmlsec/app.h>
  47 #include <libxml++/libxml++.h>
  48 #include <boost/filesystem.hpp>
  49 #include <boost/algorithm/string.hpp>
  50 #include <boost/foreach.hpp>
  51 #include <iostream>
  52
  53 using std::string;
  54 using std::list;
  55 using std::cout;
  56 using std::ostream;
  57 using std::make_pair;
  58 using std::map;
  59 using std::cout;
  60 using std::cerr;
  61 using std::exception;
  62 using boost::shared_ptr;
  63 using boost::dynamic_pointer_cast;
  64 using boost::algorithm::starts_with;
  65 using namespace dcp;
  66
  67 DCP::DCP (boost::filesystem::path directory)
  68         : _directory (directory)
  69 {
  70         if (!boost::filesystem::exists (directory)) {
  71                 boost::filesystem::create_directories (directory);
  72         }
  73
  74         _directory = boost::filesystem::canonical (_directory);
  75 }
  76
  77 template<class T> void
  78 survivable_error (bool keep_going, dcp::DCP::ReadErrors* errors, T const & e)
  79 {
  80         if (keep_going) {
  81                 if (errors) {
  82                         errors->push_back (shared_ptr<T> (new T (e)));
  83                 }
  84         } else {
  85                 throw e;
  86         }
  87 }
  88
  89 void
  90 DCP::read (bool keep_going, ReadErrors* errors)
  91 {
  92         /* Read the ASSETMAP */
  93
  94         boost::filesystem::path asset_map_file;
  95         if (boost::filesystem::exists (_directory / "ASSETMAP")) {
  96                 asset_map_file = _directory / "ASSETMAP";
  97         } else if (boost::filesystem::exists (_directory / "ASSETMAP.xml")) {
  98                 asset_map_file = _directory / "ASSETMAP.xml";
  99         } else {
 100                 boost::throw_exception (DCPReadError (String::compose ("could not find AssetMap file in `%1'", _directory.string())));
 101         }
 102
 103         cxml::Document asset_map ("AssetMap");
 104         asset_map.read_file (asset_map_file);
 105         list<shared_ptr<cxml::Node> > asset_nodes = asset_map.node_child("AssetList")->node_children ("Asset");
 106         map<string, boost::filesystem::path> paths;
 107         BOOST_FOREACH (shared_ptr<cxml::Node> i, asset_nodes) {
 108                 if (i->node_child("ChunkList")->node_children("Chunk").size() != 1) {
 109                         boost::throw_exception (XMLError ("unsupported asset chunk count"));
 110                 }
 111                 string p = i->node_child("ChunkList")->node_child("Chunk")->string_child ("Path");
 112                 if (starts_with (p, "file://")) {
 113                         p = p.substr (7);
 114                 }
 115                 paths.insert (make_pair (remove_urn_uuid (i->string_child ("Id")), p));
 116         }
 117
 118         /* Read all the assets from the asset map */
 119         /* XXX: I think we should be looking at the PKL here to decide type, not
 120            the extension of the file.
 121         */
 122
 123         /* Make a list of non-CPL assets so that we can resolve the references
 124            from the CPLs.
 125         */
 126         list<shared_ptr<Asset> > other_assets;
 127
 128         for (map<string, boost::filesystem::path>::const_iterator i = paths.begin(); i != paths.end(); ++i) {
 129                 boost::filesystem::path path = _directory / i->second;
 130
 131                 if (!boost::filesystem::exists (path)) {
 132                         survivable_error (keep_going, errors, MissingAssetError (path));
 133                         continue;
 134                 }
 135
 136                 if (boost::filesystem::extension (path) == ".xml") {
 137                         xmlpp::DomParser* p = new xmlpp::DomParser;
 138                         try {
 139                                 p->parse_file (path.string());
 140                         } catch (std::exception& e) {
 141                                 delete p;
 142                                 continue;
 143                         }
 144
 145                         string const root = p->get_document()->get_root_node()->get_name ();
 146                         delete p;
 147
 148                         if (root == "CompositionPlaylist") {
 149                                 _cpls.push_back (shared_ptr<CPL> (new CPL (path)));
 150                         } else if (root == "DCSubtitle") {
 151                                 other_assets.push_back (shared_ptr<InteropSubtitleAsset> (new InteropSubtitleAsset (path)));
 152                         }
 153                 } else if (boost::filesystem::extension (path) == ".mxf") {
 154                         ASDCP::EssenceType_t type;
 155                         if (ASDCP::EssenceType (path.string().c_str(), type) != ASDCP::RESULT_OK) {
 156                                 throw DCPReadError ("Could not find essence type");
 157                         }
 158                         switch (type) {
 159                                 case ASDCP::ESS_UNKNOWN:
 160                                 case ASDCP::ESS_MPEG2_VES:
 161                                         throw DCPReadError ("MPEG2 video essences are not supported");
 162                                 case ASDCP::ESS_JPEG_2000:
 163                                         other_assets.push_back (shared_ptr<MonoPictureAsset> (new MonoPictureAsset (path)));
 164                                         break;
 165                                 case ASDCP::ESS_PCM_24b_48k:
 166                                 case ASDCP::ESS_PCM_24b_96k:
 167                                         other_assets.push_back (shared_ptr<SoundAsset> (new SoundAsset (path)));
 168                                         break;
 169                                 case ASDCP::ESS_JPEG_2000_S:
 170                                         other_assets.push_back (shared_ptr<StereoPictureAsset> (new StereoPictureAsset (path)));
 171                                         break;
 172                                 case ASDCP::ESS_TIMED_TEXT:
 173                                         other_assets.push_back (shared_ptr<SMPTESubtitleAsset> (new SMPTESubtitleAsset (path)));
 174                                         break;
 175                                 default:
 176                                         throw DCPReadError ("Unknown MXF essence type");
 177                         }
 178                 } else if (boost::filesystem::extension (path) == ".ttf") {
 179                         other_assets.push_back (shared_ptr<FontAsset> (new FontAsset (i->first, path)));
 180                 }
 181         }
 182
 183         BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
 184                 i->resolve_refs (other_assets);
 185         }
 186 }
 187
 188 void
 189 DCP::resolve_refs (list<shared_ptr<Asset> > assets)
 190 {
 191         BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
 192                 i->resolve_refs (assets);
 193         }
 194 }
 195
 196 bool
 197 DCP::equals (DCP const & other, EqualityOptions opt, NoteHandler note) const
 198 {
 199         list<shared_ptr<CPL> > a = cpls ();
 200         list<shared_ptr<CPL> > b = other.cpls ();
 201
 202         if (a.size() != b.size()) {
 203                 note (DCP_ERROR, String::compose ("CPL counts differ: %1 vs %2", a.size(), b.size()));
 204                 return false;
 205         }
 206
 207         bool r = true;
 208
 209         BOOST_FOREACH (shared_ptr<CPL> i, a) {
 210                 list<shared_ptr<CPL> >::const_iterator j = b.begin ();
 211                 while (j != b.end() && !(*j)->equals (i, opt, note)) {
 212                         ++j;
 213                 }
 214
 215                 if (j == b.end ()) {
 216                         r = false;
 217                 }
 218         }
 219
 220         return r;
 221 }
 222
 223 void
 224 DCP::add (boost::shared_ptr<CPL> cpl)
 225 {
 226         _cpls.push_back (cpl);
 227 }
 228
 229 bool
 230 DCP::encrypted () const
 231 {
 232         BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
 233                 if (i->encrypted ()) {
 234                         return true;
 235                 }
 236         }
 237
 238         return false;
 239 }
 240
 241 void
 242 DCP::add (DecryptedKDM const & kdm)
 243 {
 244         list<DecryptedKDMKey> keys = kdm.keys ();
 245
 246         BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
 247                 BOOST_FOREACH (DecryptedKDMKey const & j, kdm.keys ()) {
 248                         if (j.cpl_id() == i->id()) {
 249                                 i->add (kdm);
 250                         }
 251                 }
 252         }
 253 }
 254
 255 boost::filesystem::path
 256 DCP::write_pkl (Standard standard, string pkl_uuid, XMLMetadata metadata, shared_ptr<const CertificateChain> signer) const
 257 {
 258         boost::filesystem::path p = _directory;
 259         p /= String::compose ("pkl_%1.xml", pkl_uuid);
 260
 261         xmlpp::Document doc;
 262         xmlpp::Element* pkl;
 263         if (standard == INTEROP) {
 264                 pkl = doc.create_root_node("PackingList", "http://www.digicine.com/PROTO-ASDCP-PKL-20040311#");
 265         } else {
 266                 pkl = doc.create_root_node("PackingList", "http://www.smpte-ra.org/schemas/429-8/2007/PKL");
 267         }
 268
 269         if (signer) {
 270                 pkl->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig");
 271         }
 272
 273         pkl->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid);
 274
 275         /* XXX: this is a bit of a hack */
 276         DCP_ASSERT (cpls().size() > 0);
 277         pkl->add_child("AnnotationText")->add_child_text (cpls().front()->annotation_text ());
 278
 279         pkl->add_child("IssueDate")->add_child_text (metadata.issue_date);
 280         pkl->add_child("Issuer")->add_child_text (metadata.issuer);
 281         pkl->add_child("Creator")->add_child_text (metadata.creator);
 282
 283         xmlpp::Element* asset_list = pkl->add_child("AssetList");
 284         BOOST_FOREACH (shared_ptr<Asset> i, assets ()) {
 285                 i->write_to_pkl (asset_list, _directory, standard);
 286         }
 287
 288         if (signer) {
 289                 signer->sign (pkl, standard);
 290         }
 291
 292         doc.write_to_file (p.string (), "UTF-8");
 293         return p.string ();
 294 }
 295
 296 /** Write the VOLINDEX file.
 297  *  @param standard DCP standard to use (INTEROP or SMPTE)
 298  */
 299 void
 300 DCP::write_volindex (Standard standard) const
 301 {
 302         boost::filesystem::path p = _directory;
 303         switch (standard) {
 304         case INTEROP:
 305                 p /= "VOLINDEX";
 306                 break;
 307         case SMPTE:
 308                 p /= "VOLINDEX.xml";
 309                 break;
 310         default:
 311                 DCP_ASSERT (false);
 312         }
 313
 314         xmlpp::Document doc;
 315         xmlpp::Element* root;
 316
 317         switch (standard) {
 318         case INTEROP:
 319                 root = doc.create_root_node ("VolumeIndex", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#");
 320                 break;
 321         case SMPTE:
 322                 root = doc.create_root_node ("VolumeIndex", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
 323                 break;
 324         default:
 325                 DCP_ASSERT (false);
 326         }
 327
 328         root->add_child("Index")->add_child_text ("1");
 329         doc.write_to_file (p.string (), "UTF-8");
 330 }
 331
 332 void
 333 DCP::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMetadata metadata) const
 334 {
 335         boost::filesystem::path p = _directory;
 336
 337         switch (standard) {
 338         case INTEROP:
 339                 p /= "ASSETMAP";
 340                 break;
 341         case SMPTE:
 342                 p /= "ASSETMAP.xml";
 343                 break;
 344         default:
 345                 DCP_ASSERT (false);
 346         }
 347
 348         xmlpp::Document doc;
 349         xmlpp::Element* root;
 350
 351         switch (standard) {
 352         case INTEROP:
 353                 root = doc.create_root_node ("AssetMap", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#");
 354                 break;
 355         case SMPTE:
 356                 root = doc.create_root_node ("AssetMap", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
 357                 break;
 358         default:
 359                 DCP_ASSERT (false);
 360         }
 361
 362         root->add_child("Id")->add_child_text ("urn:uuid:" + make_uuid());
 363         root->add_child("AnnotationText")->add_child_text ("Created by " + metadata.creator);
 364
 365         switch (standard) {
 366         case INTEROP:
 367                 root->add_child("VolumeCount")->add_child_text ("1");
 368                 root->add_child("IssueDate")->add_child_text (metadata.issue_date);
 369                 root->add_child("Issuer")->add_child_text (metadata.issuer);
 370                 root->add_child("Creator")->add_child_text (metadata.creator);
 371                 break;
 372         case SMPTE:
 373                 root->add_child("Creator")->add_child_text (metadata.creator);
 374                 root->add_child("VolumeCount")->add_child_text ("1");
 375                 root->add_child("IssueDate")->add_child_text (metadata.issue_date);
 376                 root->add_child("Issuer")->add_child_text (metadata.issuer);
 377                 break;
 378         default:
 379                 DCP_ASSERT (false);
 380         }
 381
 382         xmlpp::Node* asset_list = root->add_child ("AssetList");
 383
 384         xmlpp::Node* asset = asset_list->add_child ("Asset");
 385         asset->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid);
 386         asset->add_child("PackingList")->add_child_text ("true");
 387         xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
 388         xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
 389         chunk->add_child("Path")->add_child_text ("pkl_" + pkl_uuid + ".xml");
 390         chunk->add_child("VolumeIndex")->add_child_text ("1");
 391         chunk->add_child("Offset")->add_child_text ("0");
 392         chunk->add_child("Length")->add_child_text (raw_convert<string> (pkl_length));
 393
 394         BOOST_FOREACH (shared_ptr<Asset> i, assets ()) {
 395                 i->write_to_assetmap (asset_list, _directory);
 396         }
 397
 398         /* This must not be the _formatted version otherwise signature digests will be wrong */
 399         doc.write_to_file (p.string (), "UTF-8");
 400 }
 401
 402 /** Write all the XML files for this DCP.
 403  *  @param standand INTEROP or SMPTE.
 404  *  @param metadata Metadata to use for PKL and asset map files.
 405  *  @param signer Signer to use, or 0.
 406  */
 407 void
 408 DCP::write_xml (
 409         Standard standard,
 410         XMLMetadata metadata,
 411         shared_ptr<const CertificateChain> signer
 412         )
 413 {
 414         BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
 415                 string const filename = "cpl_" + i->id() + ".xml";
 416                 i->write_xml (_directory / filename, standard, signer);
 417         }
 418
 419         string const pkl_uuid = make_uuid ();
 420         boost::filesystem::path const pkl_path = write_pkl (standard, pkl_uuid, metadata, signer);
 421
 422         write_volindex (standard);
 423         write_assetmap (standard, pkl_uuid, boost::filesystem::file_size (pkl_path), metadata);
 424 }
 425
 426 list<shared_ptr<CPL> >
 427 DCP::cpls () const
 428 {
 429         return _cpls;
 430 }
 431
 432 /** @return All assets (including CPLs) */
 433 list<shared_ptr<Asset> >
 434 DCP::assets () const
 435 {
 436         list<shared_ptr<Asset> > assets;
 437         BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
 438                 assets.push_back (i);
 439                 BOOST_FOREACH (shared_ptr<const ReelAsset> j, i->reel_assets ()) {
 440                         shared_ptr<Asset> o = j->asset_ref().asset ();
 441                         assets.push_back (o);
 442                         /* More Interop special-casing */
 443                         shared_ptr<InteropSubtitleAsset> sub = dynamic_pointer_cast<InteropSubtitleAsset> (o);
 444                         if (sub) {
 445                                 sub->add_font_assets (assets);
 446                         }
 447                 }
 448         }
 449
 450         return assets;
 451 }