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, bool ignore_incorrect_picture_mxf_type)
  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                                         try {
 164                                                 other_assets.push_back (shared_ptr<MonoPictureAsset> (new MonoPictureAsset (path)));
 165                                         } catch (dcp::MXFFileError& e) {
 166                                                 if (ignore_incorrect_picture_mxf_type && e.number() == ASDCP::RESULT_SFORMAT) {
 167                                                         /* Tried to load it as mono but the error says it's stereo; try that instead */
 168                                                         other_assets.push_back (shared_ptr<StereoPictureAsset> (new StereoPictureAsset (path)));
 169                                                 } else {
 170                                                         throw;
 171                                                 }
 172                                         }
 173                                         break;
 174                                 case ASDCP::ESS_PCM_24b_48k:
 175                                 case ASDCP::ESS_PCM_24b_96k:
 176                                         other_assets.push_back (shared_ptr<SoundAsset> (new SoundAsset (path)));
 177                                         break;
 178                                 case ASDCP::ESS_JPEG_2000_S:
 179                                         other_assets.push_back (shared_ptr<StereoPictureAsset> (new StereoPictureAsset (path)));
 180                                         break;
 181                                 case ASDCP::ESS_TIMED_TEXT:
 182                                         other_assets.push_back (shared_ptr<SMPTESubtitleAsset> (new SMPTESubtitleAsset (path)));
 183                                         break;
 184                                 default:
 185                                         throw DCPReadError ("Unknown MXF essence type");
 186                         }
 187                 } else if (boost::filesystem::extension (path) == ".ttf") {
 188                         other_assets.push_back (shared_ptr<FontAsset> (new FontAsset (i->first, path)));
 189                 }
 190         }
 191
 192         BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
 193                 i->resolve_refs (other_assets);
 194         }
 195 }
 196
 197 void
 198 DCP::resolve_refs (list<shared_ptr<Asset> > assets)
 199 {
 200         BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
 201                 i->resolve_refs (assets);
 202         }
 203 }
 204
 205 bool
 206 DCP::equals (DCP const & other, EqualityOptions opt, NoteHandler note) const
 207 {
 208         list<shared_ptr<CPL> > a = cpls ();
 209         list<shared_ptr<CPL> > b = other.cpls ();
 210
 211         if (a.size() != b.size()) {
 212                 note (DCP_ERROR, String::compose ("CPL counts differ: %1 vs %2", a.size(), b.size()));
 213                 return false;
 214         }
 215
 216         bool r = true;
 217
 218         BOOST_FOREACH (shared_ptr<CPL> i, a) {
 219                 list<shared_ptr<CPL> >::const_iterator j = b.begin ();
 220                 while (j != b.end() && !(*j)->equals (i, opt, note)) {
 221                         ++j;
 222                 }
 223
 224                 if (j == b.end ()) {
 225                         r = false;
 226                 }
 227         }
 228
 229         return r;
 230 }
 231
 232 void
 233 DCP::add (boost::shared_ptr<CPL> cpl)
 234 {
 235         _cpls.push_back (cpl);
 236 }
 237
 238 bool
 239 DCP::encrypted () const
 240 {
 241         BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
 242                 if (i->encrypted ()) {
 243                         return true;
 244                 }
 245         }
 246
 247         return false;
 248 }
 249
 250 void
 251 DCP::add (DecryptedKDM const & kdm)
 252 {
 253         list<DecryptedKDMKey> keys = kdm.keys ();
 254
 255         BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
 256                 BOOST_FOREACH (DecryptedKDMKey const & j, kdm.keys ()) {
 257                         if (j.cpl_id() == i->id()) {
 258                                 i->add (kdm);
 259                         }
 260                 }
 261         }
 262 }
 263
 264 boost::filesystem::path
 265 DCP::write_pkl (Standard standard, string pkl_uuid, XMLMetadata metadata, shared_ptr<const CertificateChain> signer) const
 266 {
 267         boost::filesystem::path p = _directory;
 268         p /= String::compose ("pkl_%1.xml", pkl_uuid);
 269
 270         xmlpp::Document doc;
 271         xmlpp::Element* pkl;
 272         if (standard == INTEROP) {
 273                 pkl = doc.create_root_node("PackingList", "http://www.digicine.com/PROTO-ASDCP-PKL-20040311#");
 274         } else {
 275                 pkl = doc.create_root_node("PackingList", "http://www.smpte-ra.org/schemas/429-8/2007/PKL");
 276         }
 277
 278         if (signer) {
 279                 pkl->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig");
 280         }
 281
 282         pkl->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid);
 283
 284         /* XXX: this is a bit of a hack */
 285         DCP_ASSERT (cpls().size() > 0);
 286         pkl->add_child("AnnotationText")->add_child_text (cpls().front()->annotation_text ());
 287
 288         pkl->add_child("IssueDate")->add_child_text (metadata.issue_date);
 289         pkl->add_child("Issuer")->add_child_text (metadata.issuer);
 290         pkl->add_child("Creator")->add_child_text (metadata.creator);
 291
 292         xmlpp::Element* asset_list = pkl->add_child("AssetList");
 293         BOOST_FOREACH (shared_ptr<Asset> i, assets ()) {
 294                 i->write_to_pkl (asset_list, _directory, standard);
 295         }
 296
 297         if (signer) {
 298                 signer->sign (pkl, standard);
 299         }
 300
 301         doc.write_to_file (p.string (), "UTF-8");
 302         return p.string ();
 303 }
 304
 305 /** Write the VOLINDEX file.
 306  *  @param standard DCP standard to use (INTEROP or SMPTE)
 307  */
 308 void
 309 DCP::write_volindex (Standard standard) const
 310 {
 311         boost::filesystem::path p = _directory;
 312         switch (standard) {
 313         case INTEROP:
 314                 p /= "VOLINDEX";
 315                 break;
 316         case SMPTE:
 317                 p /= "VOLINDEX.xml";
 318                 break;
 319         default:
 320                 DCP_ASSERT (false);
 321         }
 322
 323         xmlpp::Document doc;
 324         xmlpp::Element* root;
 325
 326         switch (standard) {
 327         case INTEROP:
 328                 root = doc.create_root_node ("VolumeIndex", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#");
 329                 break;
 330         case SMPTE:
 331                 root = doc.create_root_node ("VolumeIndex", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
 332                 break;
 333         default:
 334                 DCP_ASSERT (false);
 335         }
 336
 337         root->add_child("Index")->add_child_text ("1");
 338         doc.write_to_file (p.string (), "UTF-8");
 339 }
 340
 341 void
 342 DCP::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMetadata metadata) const
 343 {
 344         boost::filesystem::path p = _directory;
 345
 346         switch (standard) {
 347         case INTEROP:
 348                 p /= "ASSETMAP";
 349                 break;
 350         case SMPTE:
 351                 p /= "ASSETMAP.xml";
 352                 break;
 353         default:
 354                 DCP_ASSERT (false);
 355         }
 356
 357         xmlpp::Document doc;
 358         xmlpp::Element* root;
 359
 360         switch (standard) {
 361         case INTEROP:
 362                 root = doc.create_root_node ("AssetMap", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#");
 363                 break;
 364         case SMPTE:
 365                 root = doc.create_root_node ("AssetMap", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
 366                 break;
 367         default:
 368                 DCP_ASSERT (false);
 369         }
 370
 371         root->add_child("Id")->add_child_text ("urn:uuid:" + make_uuid());
 372         root->add_child("AnnotationText")->add_child_text ("Created by " + metadata.creator);
 373
 374         switch (standard) {
 375         case INTEROP:
 376                 root->add_child("VolumeCount")->add_child_text ("1");
 377                 root->add_child("IssueDate")->add_child_text (metadata.issue_date);
 378                 root->add_child("Issuer")->add_child_text (metadata.issuer);
 379                 root->add_child("Creator")->add_child_text (metadata.creator);
 380                 break;
 381         case SMPTE:
 382                 root->add_child("Creator")->add_child_text (metadata.creator);
 383                 root->add_child("VolumeCount")->add_child_text ("1");
 384                 root->add_child("IssueDate")->add_child_text (metadata.issue_date);
 385                 root->add_child("Issuer")->add_child_text (metadata.issuer);
 386                 break;
 387         default:
 388                 DCP_ASSERT (false);
 389         }
 390
 391         xmlpp::Node* asset_list = root->add_child ("AssetList");
 392
 393         xmlpp::Node* asset = asset_list->add_child ("Asset");
 394         asset->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid);
 395         asset->add_child("PackingList")->add_child_text ("true");
 396         xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
 397         xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
 398         chunk->add_child("Path")->add_child_text ("pkl_" + pkl_uuid + ".xml");
 399         chunk->add_child("VolumeIndex")->add_child_text ("1");
 400         chunk->add_child("Offset")->add_child_text ("0");
 401         chunk->add_child("Length")->add_child_text (raw_convert<string> (pkl_length));
 402
 403         BOOST_FOREACH (shared_ptr<Asset> i, assets ()) {
 404                 i->write_to_assetmap (asset_list, _directory);
 405         }
 406
 407         /* This must not be the _formatted version otherwise signature digests will be wrong */
 408         doc.write_to_file (p.string (), "UTF-8");
 409 }
 410
 411 /** Write all the XML files for this DCP.
 412  *  @param standand INTEROP or SMPTE.
 413  *  @param metadata Metadata to use for PKL and asset map files.
 414  *  @param signer Signer to use, or 0.
 415  */
 416 void
 417 DCP::write_xml (
 418         Standard standard,
 419         XMLMetadata metadata,
 420         shared_ptr<const CertificateChain> signer
 421         )
 422 {
 423         BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
 424                 string const filename = "cpl_" + i->id() + ".xml";
 425                 i->write_xml (_directory / filename, standard, signer);
 426         }
 427
 428         string const pkl_uuid = make_uuid ();
 429         boost::filesystem::path const pkl_path = write_pkl (standard, pkl_uuid, metadata, signer);
 430
 431         write_volindex (standard);
 432         write_assetmap (standard, pkl_uuid, boost::filesystem::file_size (pkl_path), metadata);
 433 }
 434
 435 list<shared_ptr<CPL> >
 436 DCP::cpls () const
 437 {
 438         return _cpls;
 439 }
 440
 441 /** @return All assets (including CPLs) */
 442 list<shared_ptr<Asset> >
 443 DCP::assets () const
 444 {
 445         list<shared_ptr<Asset> > assets;
 446         BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
 447                 assets.push_back (i);
 448                 BOOST_FOREACH (shared_ptr<const ReelAsset> j, i->reel_assets ()) {
 449                         shared_ptr<Asset> o = j->asset_ref().asset ();
 450                         assets.push_back (o);
 451                         /* More Interop special-casing */
 452                         shared_ptr<InteropSubtitleAsset> sub = dynamic_pointer_cast<InteropSubtitleAsset> (o);
 453                         if (sub) {
 454                                 sub->add_font_assets (assets);
 455                         }
 456                 }
 457         }
 458
 459         return assets;
 460 }