src/cpl.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 #include "cpl.h"
  21 #include "util.h"
  22 #include "mono_picture_mxf.h"
  23 #include "stereo_picture_mxf.h"
  24 #include "sound_mxf.h"
  25 #include "subtitle_content.h"
  26 #include "reel.h"
  27 #include "metadata.h"
  28 #include "signer.h"
  29 #include "exceptions.h"
  30 #include "xml.h"
  31 #include "compose.hpp"
  32 #include "reel_picture_asset.h"
  33 #include "reel_sound_asset.h"
  34 #include "reel_subtitle_asset.h"
  35 #include <libxml/parser.h>
  36
  37 using std::string;
  38 using std::stringstream;
  39 using std::ostream;
  40 using std::list;
  41 using std::pair;
  42 using std::make_pair;
  43 using boost::shared_ptr;
  44 using boost::lexical_cast;
  45 using boost::optional;
  46 using namespace dcp;
  47
  48 CPL::CPL (string annotation_text, ContentKind content_kind)
  49         : _annotation_text (annotation_text)
  50         , _content_kind (content_kind)
  51 {
  52
  53 }
  54
  55 /** Construct a CPL object from a XML file */
  56 CPL::CPL (boost::filesystem::path file)
  57         : _content_kind (FEATURE)
  58 {
  59         cxml::Document f ("CompositionPlaylist");
  60         f.read_file (file);
  61
  62         _id = f.string_child ("Id");
  63         _annotation_text = f.optional_string_child ("AnnotationText").get_value_or ("");
  64         _issue_date = f.string_child ("IssueDate");
  65         _creator = f.optional_string_child ("Creator").get_value_or ("");
  66         _content_title_text = f.string_child ("ContentTitleText");
  67         _content_kind = content_kind_from_string (f.string_child ("ContentKind"));
  68         shared_ptr<cxml::Node> content_version = f.node_child ("ContentVersion");
  69         if (content_version) {
  70                 _content_version_id = content_version->optional_string_child ("Id").get_value_or ("");
  71                 _content_version_label_text = content_version->string_child ("LabelText");
  72                 content_version->done ();
  73         }
  74         f.ignore_child ("RatingList");
  75         _reels = type_grand_children<Reel> (f, "ReelList", "Reel");
  76
  77         f.ignore_child ("Issuer");
  78         f.ignore_child ("Signer");
  79         f.ignore_child ("Signature");
  80
  81         f.done ();
  82 }
  83
  84 /** Add a reel to this CPL.
  85  *  @param reel Reel to add.
  86  */
  87 void
  88 CPL::add (boost::shared_ptr<Reel> reel)
  89 {
  90         _reels.push_back (reel);
  91 }
  92
  93 void
  94 CPL::write_xml (boost::filesystem::path file, Standard standard, XMLMetadata metadata, shared_ptr<const Signer> signer) const
  95 {
  96         xmlpp::Document doc;
  97         xmlpp::Element* root;
  98         if (standard == INTEROP) {
  99                 root = doc.create_root_node ("CompositionPlaylist", "http://www.digicine.com/PROTO-ASDCP-CPL-20040511#");
 100         } else {
 101                 root = doc.create_root_node ("CompositionPlaylist", "http://www.smpte-ra.org/schemas/429-7/2006/CPL");
 102         }
 103
 104         if (signer) {
 105                 root->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig");
 106         }
 107
 108         root->add_child("Id")->add_child_text ("urn:uuid:" + _id);
 109         root->add_child("AnnotationText")->add_child_text (_annotation_text);
 110         root->add_child("IssueDate")->add_child_text (metadata.issue_date);
 111         root->add_child("Issuer")->add_child_text (metadata.issuer);
 112         root->add_child("Creator")->add_child_text (metadata.creator);
 113         root->add_child("ContentTitleText")->add_child_text (_content_version_label_text);
 114         root->add_child("ContentKind")->add_child_text (content_kind_to_string (_content_kind));
 115         {
 116                 xmlpp::Node* cv = root->add_child ("ContentVersion");
 117                 cv->add_child ("Id")->add_child_text (_content_version_id);
 118                 cv->add_child ("LabelText")->add_child_text (_content_version_label_text);
 119         }
 120         root->add_child("RatingList");
 121
 122         xmlpp::Element* reel_list = root->add_child ("ReelList");
 123
 124         for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
 125                 (*i)->write_to_cpl (reel_list, standard);
 126         }
 127
 128         if (signer) {
 129                 signer->sign (root, standard);
 130         }
 131
 132         /* This must not be the _formatted version otherwise signature digests will be wrong */
 133         doc.write_to_file (file.string (), "UTF-8");
 134
 135         set_file (file);
 136 }
 137
 138 list<shared_ptr<const Content> >
 139 CPL::assets () const
 140 {
 141         list<shared_ptr<const Content> > a;
 142         for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
 143                 if ((*i)->main_picture ()) {
 144                         a.push_back ((*i)->main_picture()->mxf ());
 145                 }
 146                 if ((*i)->main_sound ()) {
 147                         a.push_back ((*i)->main_sound()->mxf ());
 148                 }
 149                 if ((*i)->main_subtitle ()) {
 150                         a.push_back ((*i)->main_subtitle()->subtitle_content ());
 151                 }
 152         }
 153
 154         return a;
 155 }
 156
 157 bool
 158 CPL::equals (CPL const & other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
 159 {
 160         if (_annotation_text != other._annotation_text && !opt.cpl_annotation_texts_can_differ) {
 161                 stringstream s;
 162                 s << "annotation texts differ: " << _annotation_text << " vs " << other._annotation_text << "\n";
 163                 note (ERROR, s.str ());
 164                 return false;
 165         }
 166
 167         if (_content_kind != other._content_kind) {
 168                 note (ERROR, "content kinds differ");
 169                 return false;
 170         }
 171
 172         if (_reels.size() != other._reels.size()) {
 173                 note (ERROR, String::compose ("reel counts differ (%1 vs %2)", _reels.size(), other._reels.size()));
 174                 return false;
 175         }
 176
 177         list<shared_ptr<Reel> >::const_iterator a = _reels.begin ();
 178         list<shared_ptr<Reel> >::const_iterator b = other._reels.begin ();
 179
 180         while (a != _reels.end ()) {
 181                 if (!(*a)->equals (*b, opt, note)) {
 182                         return false;
 183                 }
 184                 ++a;
 185                 ++b;
 186         }
 187
 188         return true;
 189 }
 190
 191 /** @return true if we have any encrypted content */
 192 bool
 193 CPL::encrypted () const
 194 {
 195         for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
 196                 if ((*i)->encrypted ()) {
 197                         return true;
 198                 }
 199         }
 200
 201         return false;
 202 }
 203
 204 void
 205 CPL::add (KDM const & kdm)
 206 {
 207         for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
 208                 (*i)->add_kdm (kdm);
 209         }
 210 }
 211
 212 /** Set a private key for every MXF referenced by this CPL.  This will allow the data
 213  *  to be decrypted or encrypted.
 214  *  @param key Key to use.
 215  */
 216 void
 217 CPL::set_mxf_keys (Key key)
 218 {
 219         for (list<shared_ptr<Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
 220                 (*i)->set_mxf_keys (key);
 221         }
 222 }