src/cpl.cc

   1 /*
   2     Copyright (C) 2012-2013 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 #include <fstream>
  21 #include <libxml/parser.h>
  22 #include "cpl.h"
  23 #include "parse/cpl.h"
  24 #include "util.h"
  25 #include "picture_asset.h"
  26 #include "sound_asset.h"
  27 #include "subtitle_asset.h"
  28 #include "parse/asset_map.h"
  29 #include "reel.h"
  30 #include "metadata.h"
  31 #include "signer.h"
  32 #include "exceptions.h"
  33 #include "compose.hpp"
  34
  35 using std::string;
  36 using std::stringstream;
  37 using std::ofstream;
  38 using std::ostream;
  39 using std::list;
  40 using std::pair;
  41 using std::make_pair;
  42 using boost::shared_ptr;
  43 using boost::lexical_cast;
  44 using boost::optional;
  45 using namespace libdcp;
  46
  47 CPL::CPL (boost::filesystem::path directory, string name, ContentKind content_kind, int length, int frames_per_second)
  48         : _directory (directory)
  49         , _name (name)
  50         , _content_kind (content_kind)
  51         , _length (length)
  52         , _fps (frames_per_second)
  53 {
  54         _id = make_uuid ();
  55 }
  56
  57 /** Construct a CPL object from a XML file.
  58  *  @param directory The directory containing this CPL's DCP.
  59  *  @param file The CPL XML filename.
  60  *  @param asset_maps AssetMaps to look for assets in.
  61  *  @param require_mxfs true to throw an exception if a required MXF file does not exist.
  62  */
  63 CPL::CPL (boost::filesystem::path directory, string file, list<PathAssetMap> asset_maps, bool require_mxfs)
  64         : _directory (directory)
  65         , _content_kind (FEATURE)
  66         , _length (0)
  67         , _fps (0)
  68 {
  69         /* Read the XML */
  70         shared_ptr<parse::CPL> cpl;
  71         try {
  72                 cpl.reset (new parse::CPL (file));
  73         } catch (FileError& e) {
  74                 boost::throw_exception (FileError ("could not load CPL file", file));
  75         }
  76
  77         /* Now cherry-pick the required bits into our own data structure */
  78
  79         _name = cpl->annotation_text;
  80         _content_kind = cpl->content_kind;
  81
  82         /* Trim urn:uuid: off the front */
  83         _id = cpl->id.substr (9);
  84
  85         for (list<shared_ptr<parse::Reel> >::iterator i = cpl->reels.begin(); i != cpl->reels.end(); ++i) {
  86
  87                 shared_ptr<parse::Picture> p;
  88
  89                 if ((*i)->asset_list->main_picture) {
  90                         p = (*i)->asset_list->main_picture;
  91                 } else {
  92                         p = (*i)->asset_list->main_stereoscopic_picture;
  93                 }
  94
  95                 _fps = p->edit_rate.numerator;
  96                 _length += p->duration;
  97
  98                 shared_ptr<PictureAsset> picture;
  99                 shared_ptr<SoundAsset> sound;
 100                 shared_ptr<SubtitleAsset> subtitle;
 101
 102                 /* Some rather twisted logic to decide if we are 3D or not;
 103                    some DCPs give a MainStereoscopicPicture to indicate 3D, others
 104                    just have a FrameRate twice the EditRate and apparently
 105                    expect you to divine the fact that they are hence 3D.
 106                 */
 107
 108                 if (!(*i)->asset_list->main_stereoscopic_picture && p->edit_rate == p->frame_rate) {
 109
 110                         pair<string, shared_ptr<const parse::AssetMapAsset> > asset = asset_from_id (asset_maps, p->id);
 111
 112                         try {
 113                                 picture.reset (new MonoPictureAsset (
 114                                                        asset.first,
 115                                                        asset.second->chunks.front()->path
 116                                                        )
 117                                         );
 118
 119                                 picture->set_entry_point (p->entry_point);
 120                                 picture->set_duration (p->duration);
 121                                 if (p->key_id.length() > 9) {
 122                                         /* Trim urn:uuid: */
 123                                         picture->set_key_id (p->key_id.substr (9));
 124                                 }
 125                         } catch (MXFFileError) {
 126                                 if (require_mxfs) {
 127                                         throw;
 128                                 }
 129                         }
 130
 131                 } else {
 132                         try {
 133                                 pair<string, shared_ptr<const parse::AssetMapAsset> > asset = asset_from_id (asset_maps, p->id);
 134
 135                                 picture.reset (new StereoPictureAsset (
 136                                                        asset.first,
 137                                                        asset.second->chunks.front()->path,
 138                                                        _fps,
 139                                                        p->duration
 140                                                        )
 141                                         );
 142
 143                                 picture->set_entry_point (p->entry_point);
 144                                 picture->set_duration (p->duration);
 145                                 if (p->key_id.length() > 9) {
 146                                         /* Trim urn:uuid: */
 147                                         picture->set_key_id (p->key_id.substr (9));
 148                                 }
 149
 150                         } catch (MXFFileError) {
 151                                 if (require_mxfs) {
 152                                         throw;
 153                                 }
 154                         }
 155
 156                 }
 157
 158                 if ((*i)->asset_list->main_sound) {
 159
 160                         try {
 161                                 pair<string, shared_ptr<const parse::AssetMapAsset> > asset = asset_from_id (asset_maps, (*i)->asset_list->main_sound->id);
 162
 163                                 sound.reset (new SoundAsset (
 164                                                      asset.first,
 165                                                      asset.second->chunks.front()->path
 166                                                      )
 167                                         );
 168
 169                                 shared_ptr<parse::MainSound> s = (*i)->asset_list->main_sound;
 170
 171                                 sound->set_entry_point (s->entry_point);
 172                                 sound->set_duration (s->duration);
 173                                 if (s->key_id.length() > 9) {
 174                                         /* Trim urn:uuid: */
 175                                         sound->set_key_id (s->key_id.substr (9));
 176                                 }
 177                         } catch (MXFFileError) {
 178                                 if (require_mxfs) {
 179                                         throw;
 180                                 }
 181                         }
 182                 }
 183
 184                 if ((*i)->asset_list->main_subtitle) {
 185
 186                         pair<string, shared_ptr<const parse::AssetMapAsset> > asset = asset_from_id (asset_maps, (*i)->asset_list->main_subtitle->id);
 187
 188                         subtitle.reset (new SubtitleAsset (
 189                                                 asset.first,
 190                                                 asset.second->chunks.front()->path
 191                                                 )
 192                                 );
 193
 194                         subtitle->set_entry_point ((*i)->asset_list->main_subtitle->entry_point);
 195                         subtitle->set_duration ((*i)->asset_list->main_subtitle->duration);
 196                 }
 197
 198                 _reels.push_back (shared_ptr<Reel> (new Reel (picture, sound, subtitle)));
 199         }
 200 }
 201
 202 void
 203 CPL::add_reel (shared_ptr<Reel> reel)
 204 {
 205         _reels.push_back (reel);
 206 }
 207
 208 void
 209 CPL::write_xml (bool interop, XMLMetadata const & metadata, shared_ptr<const Signer> signer) const
 210 {
 211         boost::filesystem::path p;
 212         p /= _directory;
 213         stringstream s;
 214         s << _id << "_cpl.xml";
 215         p /= s.str();
 216
 217         xmlpp::Document doc;
 218         xmlpp::Element* root;
 219         if (interop) {
 220                 root = doc.create_root_node ("CompositionPlaylist", "http://www.digicine.com/PROTO-ASDCP-CPL-20040511#");
 221         } else {
 222                 root = doc.create_root_node ("CompositionPlaylist", "http://www.smpte-ra.org/schemas/429-7/2006/CPL");
 223         }
 224
 225         if (signer) {
 226                 root->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig");
 227         }
 228
 229         root->add_child("Id")->add_child_text ("urn:uuid:" + _id);
 230         root->add_child("AnnotationText")->add_child_text (_name);
 231         root->add_child("IssueDate")->add_child_text (metadata.issue_date);
 232         root->add_child("Issuer")->add_child_text (metadata.issuer);
 233         root->add_child("Creator")->add_child_text (metadata.creator);
 234         root->add_child("ContentTitleText")->add_child_text (_name);
 235         root->add_child("ContentKind")->add_child_text (content_kind_to_string (_content_kind));
 236         {
 237                 xmlpp::Node* cv = root->add_child ("ContentVersion");
 238                 cv->add_child ("Id")->add_child_text ("urn:uri:" + _id + "_" + metadata.issue_date);
 239                 cv->add_child ("LabelText")->add_child_text (_id + "_" + metadata.issue_date);
 240         }
 241         root->add_child("RatingList");
 242
 243         xmlpp::Element* reel_list = root->add_child ("ReelList");
 244
 245         for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
 246                 (*i)->write_to_cpl (reel_list, interop);
 247         }
 248
 249         if (signer) {
 250                 signer->sign (root, interop);
 251         }
 252
 253         doc.write_to_file_formatted (p.string (), "UTF-8");
 254
 255         _digest = make_digest (p.string (), 0);
 256         _length = boost::filesystem::file_size (p.string ());
 257 }
 258
 259 void
 260 CPL::write_to_pkl (xmlpp::Node* node) const
 261 {
 262         xmlpp::Node* asset = node->add_child ("Asset");
 263         asset->add_child("Id")->add_child_text ("urn:uuid:" + _id);
 264         asset->add_child("Hash")->add_child_text (_digest);
 265         asset->add_child("Size")->add_child_text (lexical_cast<string> (_length));
 266         asset->add_child("Type")->add_child_text ("text/xml");
 267 }
 268
 269 list<shared_ptr<const Asset> >
 270 CPL::assets () const
 271 {
 272         list<shared_ptr<const Asset> > a;
 273         for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
 274                 if ((*i)->main_picture ()) {
 275                         a.push_back ((*i)->main_picture ());
 276                 }
 277                 if ((*i)->main_sound ()) {
 278                         a.push_back ((*i)->main_sound ());
 279                 }
 280                 if ((*i)->main_subtitle ()) {
 281                         a.push_back ((*i)->main_subtitle ());
 282                 }
 283         }
 284
 285         return a;
 286 }
 287
 288 void
 289 CPL::write_to_assetmap (xmlpp::Node* node) const
 290 {
 291         xmlpp::Node* asset = node->add_child ("Asset");
 292         asset->add_child("Id")->add_child_text ("urn:uuid:" + _id);
 293         xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
 294         xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
 295         chunk->add_child("Path")->add_child_text (_id + "_cpl.xml");
 296         chunk->add_child("VolumeIndex")->add_child_text ("1");
 297         chunk->add_child("Offset")->add_child_text("0");
 298         chunk->add_child("Length")->add_child_text(lexical_cast<string> (_length));
 299 }
 300
 301
 302
 303 bool
 304 CPL::equals (CPL const & other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
 305 {
 306         if (_name != other._name && !opt.cpl_names_can_differ) {
 307                 stringstream s;
 308                 s << "names differ: " << _name << " vs " << other._name << "\n";
 309                 note (ERROR, s.str ());
 310                 return false;
 311         }
 312
 313         if (_content_kind != other._content_kind) {
 314                 note (ERROR, "content kinds differ");
 315                 return false;
 316         }
 317
 318         if (_fps != other._fps) {
 319                 note (ERROR, String::compose ("frames per second differ (%1 vs %2)", _fps, other._fps));
 320                 return false;
 321         }
 322
 323         if (_length != other._length) {
 324                 stringstream s;
 325                 note (ERROR, String::compose ("lengths differ (%1 vs %2)", _length, other._length));
 326         }
 327
 328         if (_reels.size() != other._reels.size()) {
 329                 note (ERROR, String::compose ("reel counts differ (%1 vs %2)", _reels.size(), other._reels.size()));
 330                 return false;
 331         }
 332
 333         list<shared_ptr<Reel> >::const_iterator a = _reels.begin ();
 334         list<shared_ptr<Reel> >::const_iterator b = other._reels.begin ();
 335
 336         while (a != _reels.end ()) {
 337                 if (!(*a)->equals (*b, opt, note)) {
 338                         return false;
 339                 }
 340                 ++a;
 341                 ++b;
 342         }
 343
 344         return true;
 345 }
 346
 347 /** @return true if we have any encrypted content */
 348 bool
 349 CPL::encrypted () const
 350 {
 351         for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
 352                 if ((*i)->encrypted ()) {
 353                         return true;
 354                 }
 355         }
 356
 357         return false;
 358 }
 359
 360 void
 361 CPL::add_kdm (KDM const & kdm)
 362 {
 363         for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
 364                 (*i)->add_kdm (kdm);
 365         }
 366 }
 367
 368 pair<string, shared_ptr<const parse::AssetMapAsset> >
 369 CPL::asset_from_id (list<PathAssetMap> asset_maps, string id) const
 370 {
 371         for (list<PathAssetMap>::const_iterator i = asset_maps.begin(); i != asset_maps.end(); ++i) {
 372                 shared_ptr<parse::AssetMapAsset> a = i->second->asset_from_id (id);
 373                 if (a) {
 374                         return make_pair (i->first, a);
 375                 }
 376         }
 377
 378         return make_pair ("", shared_ptr<const parse::AssetMapAsset> ());
 379 }