src/dcp.cc

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