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