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 <fstream>
  26 #include <iomanip>
  27 #include <cassert>
  28 #include <iostream>
  29 #include <boost/filesystem.hpp>
  30 #include <boost/algorithm/string.hpp>
  31 #include <libxml++/libxml++.h>
  32 #include "dcp.h"
  33 #include "asset.h"
  34 #include "sound_asset.h"
  35 #include "picture_asset.h"
  36 #include "subtitle_asset.h"
  37 #include "util.h"
  38 #include "metadata.h"
  39 #include "exceptions.h"
  40 #include "cpl_file.h"
  41 #include "pkl_file.h"
  42 #include "asset_map.h"
  43 #include "reel.h"
  44
  45 using std::string;
  46 using std::list;
  47 using std::stringstream;
  48 using std::ofstream;
  49 using std::ostream;
  50 using boost::shared_ptr;
  51 using namespace libdcp;
  52
  53 DCP::DCP (string directory)
  54         : _directory (directory)
  55 {
  56         boost::filesystem::create_directories (directory);
  57 }
  58
  59 void
  60 DCP::write_xml () const
  61 {
  62         for (list<shared_ptr<const CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
  63                 (*i)->write_xml ();
  64         }
  65
  66         string pkl_uuid = make_uuid ();
  67         string pkl_path = write_pkl (pkl_uuid);
  68
  69         write_volindex ();
  70         write_assetmap (pkl_uuid, boost::filesystem::file_size (pkl_path));
  71 }
  72
  73 std::string
  74 DCP::write_pkl (string pkl_uuid) const
  75 {
  76         assert (!_cpls.empty ());
  77
  78         boost::filesystem::path p;
  79         p /= _directory;
  80         stringstream s;
  81         s << pkl_uuid << "_pkl.xml";
  82         p /= s.str();
  83         ofstream pkl (p.string().c_str());
  84
  85         pkl << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
  86             << "<PackingList xmlns=\"http://www.smpte-ra.org/schemas/429-8/2007/PKL\">\n"
  87             << "  <Id>urn:uuid:" << pkl_uuid << "</Id>\n"
  88                 /* XXX: this is a bit of a hack */
  89             << "  <AnnotationText>" << _cpls.front()->name() << "</AnnotationText>\n"
  90             << "  <IssueDate>" << Metadata::instance()->issue_date << "</IssueDate>\n"
  91             << "  <Issuer>" << Metadata::instance()->issuer << "</Issuer>\n"
  92             << "  <Creator>" << Metadata::instance()->creator << "</Creator>\n"
  93             << "  <AssetList>\n";
  94
  95         list<shared_ptr<const Asset> > a = assets ();
  96         for (list<shared_ptr<const Asset> >::const_iterator i = a.begin(); i != a.end(); ++i) {
  97                 (*i)->write_to_pkl (pkl);
  98         }
  99
 100         for (list<shared_ptr<const CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
 101                 (*i)->write_to_pkl (pkl);
 102         }
 103
 104         pkl << "  </AssetList>\n"
 105             << "</PackingList>\n";
 106
 107         return p.string ();
 108 }
 109
 110 void
 111 DCP::write_volindex () const
 112 {
 113         boost::filesystem::path p;
 114         p /= _directory;
 115         p /= "VOLINDEX.xml";
 116         ofstream vi (p.string().c_str());
 117
 118         vi << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 119            << "<VolumeIndex xmlns=\"http://www.smpte-ra.org/schemas/429-9/2007/AM\">\n"
 120            << "  <Index>1</Index>\n"
 121            << "</VolumeIndex>\n";
 122 }
 123
 124 void
 125 DCP::write_assetmap (string pkl_uuid, int pkl_length) const
 126 {
 127         boost::filesystem::path p;
 128         p /= _directory;
 129         p /= "ASSETMAP.xml";
 130         ofstream am (p.string().c_str());
 131
 132         am << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 133            << "<AssetMap xmlns=\"http://www.smpte-ra.org/schemas/429-9/2007/AM\">\n"
 134            << "  <Id>urn:uuid:" << make_uuid() << "</Id>\n"
 135            << "  <Creator>" << Metadata::instance()->creator << "</Creator>\n"
 136            << "  <VolumeCount>1</VolumeCount>\n"
 137            << "  <IssueDate>" << Metadata::instance()->issue_date << "</IssueDate>\n"
 138            << "  <Issuer>" << Metadata::instance()->issuer << "</Issuer>\n"
 139            << "  <AssetList>\n";
 140
 141         am << "    <Asset>\n"
 142            << "      <Id>urn:uuid:" << pkl_uuid << "</Id>\n"
 143            << "      <PackingList>true</PackingList>\n"
 144            << "      <ChunkList>\n"
 145            << "        <Chunk>\n"
 146            << "          <Path>" << pkl_uuid << "_pkl.xml</Path>\n"
 147            << "          <VolumeIndex>1</VolumeIndex>\n"
 148            << "          <Offset>0</Offset>\n"
 149            << "          <Length>" << pkl_length << "</Length>\n"
 150            << "        </Chunk>\n"
 151            << "      </ChunkList>\n"
 152            << "    </Asset>\n";
 153
 154         for (list<shared_ptr<const CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
 155                 (*i)->write_to_assetmap (am);
 156         }
 157
 158         list<shared_ptr<const Asset> > a = assets ();
 159         for (list<shared_ptr<const Asset> >::const_iterator i = a.begin(); i != a.end(); ++i) {
 160                 (*i)->write_to_assetmap (am);
 161         }
 162
 163         am << "  </AssetList>\n"
 164            << "</AssetMap>\n";
 165 }
 166
 167
 168 void
 169 DCP::read (bool require_mxfs)
 170 {
 171         Files files;
 172
 173         shared_ptr<AssetMap> asset_map;
 174         try {
 175                 boost::filesystem::path p = _directory;
 176                 p /= "ASSETMAP";
 177                 if (boost::filesystem::exists (p)) {
 178                         asset_map.reset (new AssetMap (p.string ()));
 179                 } else {
 180                         p = _directory;
 181                         p /= "ASSETMAP.xml";
 182                         if (boost::filesystem::exists (p)) {
 183                                 asset_map.reset (new AssetMap (p.string ()));
 184                         } else {
 185                                 boost::throw_exception (DCPReadError ("could not find AssetMap file"));
 186                         }
 187                 }
 188
 189         } catch (FileError& e) {
 190                 boost::throw_exception (FileError ("could not load AssetMap file", files.asset_map));
 191         }
 192
 193         for (list<shared_ptr<AssetMapAsset> >::const_iterator i = asset_map->assets.begin(); i != asset_map->assets.end(); ++i) {
 194                 if ((*i)->chunks.size() != 1) {
 195                         boost::throw_exception (XMLError ("unsupported asset chunk count"));
 196                 }
 197
 198                 boost::filesystem::path t = _directory;
 199                 t /= (*i)->chunks.front()->path;
 200
 201                 if (boost::algorithm::ends_with (t.string(), ".mxf") || boost::algorithm::ends_with (t.string(), ".ttf")) {
 202                         continue;
 203                 }
 204
 205                 xmlpp::DomParser* p = new xmlpp::DomParser;
 206                 try {
 207                         p->parse_file (t.string());
 208                 } catch (std::exception& e) {
 209                         delete p;
 210                         continue;
 211                 }
 212
 213                 string const root = p->get_document()->get_root_node()->get_name ();
 214                 delete p;
 215
 216                 if (root == "CompositionPlaylist") {
 217                         files.cpls.push_back (t.string());
 218                 } else if (root == "PackingList") {
 219                         if (files.pkl.empty ()) {
 220                                 files.pkl = t.string();
 221                         } else {
 222                                 boost::throw_exception (DCPReadError ("duplicate PKLs found"));
 223                         }
 224                 }
 225         }
 226
 227         if (files.cpls.empty ()) {
 228                 boost::throw_exception (FileError ("no CPL files found", ""));
 229         }
 230
 231         if (files.pkl.empty ()) {
 232                 boost::throw_exception (FileError ("no PKL file found", ""));
 233         }
 234
 235         shared_ptr<PKLFile> pkl;
 236         try {
 237                 pkl.reset (new PKLFile (files.pkl));
 238         } catch (FileError& e) {
 239                 boost::throw_exception (FileError ("could not load PKL file", files.pkl));
 240         }
 241
 242         /* Cross-check */
 243         /* XXX */
 244
 245         for (list<string>::iterator i = files.cpls.begin(); i != files.cpls.end(); ++i) {
 246                 _cpls.push_back (shared_ptr<CPL> (new CPL (_directory, *i, asset_map, require_mxfs)));
 247         }
 248 }
 249
 250 bool
 251 DCP::equals (DCP const & other, EqualityOptions opt, list<string>& notes) const
 252 {
 253         if (_cpls.size() != other._cpls.size()) {
 254                 notes.push_back ("CPL counts differ");
 255                 return false;
 256         }
 257
 258         list<shared_ptr<const CPL> >::const_iterator a = _cpls.begin ();
 259         list<shared_ptr<const CPL> >::const_iterator b = other._cpls.begin ();
 260
 261         while (a != _cpls.end ()) {
 262                 if (!(*a)->equals (*b->get(), opt, notes)) {
 263                         return false;
 264                 }
 265                 ++a;
 266                 ++b;
 267         }
 268
 269         return true;
 270 }
 271
 272
 273 void
 274 DCP::add_cpl (shared_ptr<CPL> cpl)
 275 {
 276         _cpls.push_back (cpl);
 277 }
 278
 279 class AssetComparator
 280 {
 281 public:
 282         bool operator() (shared_ptr<const Asset> a, shared_ptr<const Asset> b) {
 283                 return a->uuid() < b->uuid();
 284         }
 285 };
 286
 287 list<shared_ptr<const Asset> >
 288 DCP::assets () const
 289 {
 290         list<shared_ptr<const Asset> > a;
 291         for (list<shared_ptr<const CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
 292                 list<shared_ptr<const Asset> > t = (*i)->assets ();
 293                 a.merge (t);
 294         }
 295
 296         a.sort ();
 297         a.unique ();
 298         return a;
 299 }
 300
 301 CPL::CPL (string directory, string name, ContentKind content_kind, int length, int frames_per_second)
 302         : _directory (directory)
 303         , _name (name)
 304         , _content_kind (content_kind)
 305         , _length (length)
 306         , _fps (frames_per_second)
 307 {
 308         _uuid = make_uuid ();
 309 }
 310
 311 /** Construct a CPL object from a XML file.
 312  *  @param directory The directory containing this CPL's DCP.
 313  *  @param file The CPL XML filename.
 314  *  @param asset_map The corresponding asset map.
 315  *  @param require_mxfs true to throw an exception if a required MXF file does not exist.
 316  */
 317 CPL::CPL (string directory, string file, shared_ptr<const AssetMap> asset_map, bool require_mxfs)
 318         : _directory (directory)
 319         , _content_kind (FEATURE)
 320         , _length (0)
 321         , _fps (0)
 322 {
 323         /* Read the XML */
 324         shared_ptr<CPLFile> cpl;
 325         try {
 326                 cpl.reset (new CPLFile (file));
 327         } catch (FileError& e) {
 328                 boost::throw_exception (FileError ("could not load CPL file", file));
 329         }
 330
 331         /* Now cherry-pick the required bits into our own data structure */
 332
 333         _name = cpl->annotation_text;
 334         _content_kind = cpl->content_kind;
 335
 336         for (list<shared_ptr<CPLReel> >::iterator i = cpl->reels.begin(); i != cpl->reels.end(); ++i) {
 337
 338                 shared_ptr<Picture> p;
 339
 340                 if ((*i)->asset_list->main_picture) {
 341                         p = (*i)->asset_list->main_picture;
 342                 } else {
 343                         p = (*i)->asset_list->main_stereoscopic_picture;
 344                 }
 345
 346                 _fps = p->edit_rate.numerator;
 347                 _length += p->duration;
 348
 349                 shared_ptr<PictureAsset> picture;
 350                 shared_ptr<SoundAsset> sound;
 351                 shared_ptr<SubtitleAsset> subtitle;
 352
 353                 /* Some rather twisted logic to decide if we are 3D or not;
 354                    some DCPs give a MainStereoscopicPicture to indicate 3D, others
 355                    just have a FrameRate twice the EditRate and apparently
 356                    expect you to divine the fact that they are hence 3D.
 357                 */
 358
 359                 if (!(*i)->asset_list->main_stereoscopic_picture && p->edit_rate == p->frame_rate) {
 360
 361                         try {
 362                                 picture.reset (new MonoPictureAsset (
 363                                                        _directory,
 364                                                        asset_map->asset_from_id (p->id)->chunks.front()->path
 365                                                        )
 366                                         );
 367
 368                                 picture->set_entry_point ((*i)->asset_list->main_picture->entry_point);
 369                         } catch (MXFFileError) {
 370                                 if (require_mxfs) {
 371                                         throw;
 372                                 }
 373                         }
 374
 375                 } else {
 376
 377                         try {
 378                                 picture.reset (new StereoPictureAsset (
 379                                                        _directory,
 380                                                        asset_map->asset_from_id (p->id)->chunks.front()->path,
 381                                                        _fps,
 382                                                        p->duration
 383                                                        )
 384                                         );
 385
 386                                 picture->set_entry_point (p->entry_point);
 387
 388                         } catch (MXFFileError) {
 389                                 if (require_mxfs) {
 390                                         throw;
 391                                 }
 392                         }
 393
 394                 }
 395
 396                 if ((*i)->asset_list->main_sound) {
 397
 398                         try {
 399                                 sound.reset (new SoundAsset (
 400                                                      _directory,
 401                                                      asset_map->asset_from_id ((*i)->asset_list->main_sound->id)->chunks.front()->path
 402                                                      )
 403                                         );
 404
 405                                 sound->set_entry_point ((*i)->asset_list->main_sound->entry_point);
 406                         } catch (MXFFileError) {
 407                                 if (require_mxfs) {
 408                                         throw;
 409                                 }
 410                         }
 411                 }
 412
 413                 if ((*i)->asset_list->main_subtitle) {
 414
 415                         subtitle.reset (new SubtitleAsset (
 416                                                 _directory,
 417                                                 asset_map->asset_from_id ((*i)->asset_list->main_subtitle->id)->chunks.front()->path
 418                                                 )
 419                                 );
 420                 }
 421
 422                 _reels.push_back (shared_ptr<Reel> (new Reel (picture, sound, subtitle)));
 423         }
 424 }
 425
 426 void
 427 CPL::add_reel (shared_ptr<const Reel> reel)
 428 {
 429         _reels.push_back (reel);
 430 }
 431
 432 void
 433 CPL::write_xml () const
 434 {
 435         boost::filesystem::path p;
 436         p /= _directory;
 437         stringstream s;
 438         s << _uuid << "_cpl.xml";
 439         p /= s.str();
 440         ofstream os (p.string().c_str());
 441
 442         os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 443            << "<CompositionPlaylist xmlns=\"http://www.smpte-ra.org/schemas/429-7/2006/CPL\">\n"
 444            << "  <Id>urn:uuid:" << _uuid << "</Id>\n"
 445            << "  <AnnotationText>" << _name << "</AnnotationText>\n"
 446            << "  <IssueDate>" << Metadata::instance()->issue_date << "</IssueDate>\n"
 447            << "  <Creator>" << Metadata::instance()->creator << "</Creator>\n"
 448            << "  <ContentTitleText>" << _name << "</ContentTitleText>\n"
 449            << "  <ContentKind>" << content_kind_to_string (_content_kind) << "</ContentKind>\n"
 450            << "  <ContentVersion>\n"
 451            << "    <Id>urn:uri:" << _uuid << "_" << Metadata::instance()->issue_date << "</Id>\n"
 452            << "    <LabelText>" << _uuid << "_" << Metadata::instance()->issue_date << "</LabelText>\n"
 453            << "  </ContentVersion>\n"
 454            << "  <RatingList/>\n"
 455            << "  <ReelList>\n";
 456
 457         for (list<shared_ptr<const Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
 458                 (*i)->write_to_cpl (os);
 459         }
 460
 461         os << "  </ReelList>\n"
 462            << "</CompositionPlaylist>\n";
 463
 464         os.close ();
 465
 466         _digest = make_digest (p.string ());
 467         _length = boost::filesystem::file_size (p.string ());
 468 }
 469
 470 void
 471 CPL::write_to_pkl (ostream& s) const
 472 {
 473         s << "    <Asset>\n"
 474           << "      <Id>urn:uuid:" << _uuid << "</Id>\n"
 475           << "      <Hash>" << _digest << "</Hash>\n"
 476           << "      <Size>" << _length << "</Size>\n"
 477           << "      <Type>text/xml</Type>\n"
 478           << "    </Asset>\n";
 479 }
 480
 481 list<shared_ptr<const Asset> >
 482 CPL::assets () const
 483 {
 484         list<shared_ptr<const Asset> > a;
 485         for (list<shared_ptr<const Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
 486                 if ((*i)->main_picture ()) {
 487                         a.push_back ((*i)->main_picture ());
 488                 }
 489                 if ((*i)->main_sound ()) {
 490                         a.push_back ((*i)->main_sound ());
 491                 }
 492                 if ((*i)->main_subtitle ()) {
 493                         a.push_back ((*i)->main_subtitle ());
 494                 }
 495         }
 496
 497         return a;
 498 }
 499
 500 void
 501 CPL::write_to_assetmap (ostream& s) const
 502 {
 503         s << "    <Asset>\n"
 504           << "      <Id>urn:uuid:" << _uuid << "</Id>\n"
 505           << "      <ChunkList>\n"
 506           << "        <Chunk>\n"
 507           << "          <Path>" << _uuid << "_cpl.xml</Path>\n"
 508           << "          <VolumeIndex>1</VolumeIndex>\n"
 509           << "          <Offset>0</Offset>\n"
 510           << "          <Length>" << _length << "</Length>\n"
 511           << "        </Chunk>\n"
 512           << "      </ChunkList>\n"
 513           << "    </Asset>\n";
 514 }
 515
 516
 517
 518 bool
 519 CPL::equals (CPL const & other, EqualityOptions opt, list<string>& notes) const
 520 {
 521         if (_name != other._name) {
 522                 notes.push_back ("names differ");
 523                 return false;
 524         }
 525
 526         if (_content_kind != other._content_kind) {
 527                 notes.push_back ("content kinds differ");
 528                 return false;
 529         }
 530
 531         if (_fps != other._fps) {
 532                 notes.push_back ("frames per second differ");
 533                 return false;
 534         }
 535
 536         if (_length != other._length) {
 537                 notes.push_back ("lengths differ");
 538                 return false;
 539         }
 540
 541         if (_reels.size() != other._reels.size()) {
 542                 notes.push_back ("reel counts differ");
 543                 return false;
 544         }
 545
 546         list<shared_ptr<const Reel> >::const_iterator a = _reels.begin ();
 547         list<shared_ptr<const Reel> >::const_iterator b = other._reels.begin ();
 548
 549         while (a != _reels.end ()) {
 550                 if (!(*a)->equals (*b, opt, notes)) {
 551                         return false;
 552                 }
 553                 ++a;
 554                 ++b;
 555         }
 556
 557         return true;
 558 }