Tidy up interop API.
[libdcp.git] / src / dcp.cc
index d446b2059c90bcc85909a0dcd9efe6923e647a79..30a3c3a430150cbc32e3ac7ff7a28af0e2921ccf 100644 (file)
 #include <cassert>
 #include <iostream>
 #include <boost/filesystem.hpp>
+#include <boost/lexical_cast.hpp>
 #include <boost/algorithm/string.hpp>
+#include <boost/lexical_cast.hpp>
 #include <libxml++/libxml++.h>
+#include <xmlsec/xmldsig.h>
+#include <xmlsec/app.h>
 #include "dcp.h"
 #include "asset.h"
 #include "sound_asset.h"
 #include "util.h"
 #include "metadata.h"
 #include "exceptions.h"
-#include "cpl_file.h"
-#include "pkl_file.h"
-#include "asset_map.h"
+#include "parse/pkl.h"
+#include "parse/asset_map.h"
 #include "reel.h"
+#include "cpl.h"
+#include "encryption.h"
+#include "kdm.h"
 
 using std::string;
 using std::list;
@@ -48,6 +54,7 @@ using std::stringstream;
 using std::ofstream;
 using std::ostream;
 using boost::shared_ptr;
+using boost::lexical_cast;
 using namespace libdcp;
 
 DCP::DCP (string directory)
@@ -57,21 +64,21 @@ DCP::DCP (string directory)
 }
 
 void
-DCP::write_xml () const
+DCP::write_xml (bool interop, XMLMetadata const & metadata, shared_ptr<Encryption> crypt) const
 {
-       for (list<shared_ptr<const CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
-               (*i)->write_xml ();
+       for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
+               (*i)->write_xml (interop, metadata, crypt);
        }
 
        string pkl_uuid = make_uuid ();
-       string pkl_path = write_pkl (pkl_uuid);
+       string pkl_path = write_pkl (pkl_uuid, interop, metadata, crypt);
        
        write_volindex ();
-       write_assetmap (pkl_uuid, boost::filesystem::file_size (pkl_path));
+       write_assetmap (pkl_uuid, boost::filesystem::file_size (pkl_path), interop, metadata);
 }
 
 std::string
-DCP::write_pkl (string pkl_uuid) const
+DCP::write_pkl (string pkl_uuid, bool interop, XMLMetadata const & metadata, shared_ptr<Encryption> crypt) const
 {
        assert (!_cpls.empty ());
        
@@ -80,30 +87,41 @@ DCP::write_pkl (string pkl_uuid) const
        stringstream s;
        s << pkl_uuid << "_pkl.xml";
        p /= s.str();
-       ofstream pkl (p.string().c_str());
-
-       pkl << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
-           << "<PackingList xmlns=\"http://www.smpte-ra.org/schemas/429-8/2007/PKL\">\n"
-           << "  <Id>urn:uuid:" << pkl_uuid << "</Id>\n"
-               /* XXX: this is a bit of a hack */
-           << "  <AnnotationText>" << _cpls.front()->name() << "</AnnotationText>\n"
-           << "  <IssueDate>" << Metadata::instance()->issue_date << "</IssueDate>\n"
-           << "  <Issuer>" << Metadata::instance()->issuer << "</Issuer>\n"
-           << "  <Creator>" << Metadata::instance()->creator << "</Creator>\n"
-           << "  <AssetList>\n";
 
+       xmlpp::Document doc;
+       xmlpp::Element* pkl;
+       if (interop) {
+               pkl = doc.create_root_node("PackingList", "http://www.digicine.com/PROTO-ASDCP-PKL-20040311#");
+       } else {
+               pkl = doc.create_root_node("PackingList", "http://www.smpte-ra.org/schemas/429-8/2007/PKL");
+       }
+       
+       if (crypt) {
+               pkl->set_namespace_declaration ("http://www.w3.org/2000/09/xmldsig#", "dsig");
+       }
+
+       pkl->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid);
+       /* XXX: this is a bit of a hack */
+       pkl->add_child("AnnotationText")->add_child_text(_cpls.front()->name());
+       pkl->add_child("IssueDate")->add_child_text (metadata.issue_date);
+       pkl->add_child("Issuer")->add_child_text (metadata.issuer);
+       pkl->add_child("Creator")->add_child_text (metadata.creator);
+
+       xmlpp::Element* asset_list = pkl->add_child("AssetList");
        list<shared_ptr<const Asset> > a = assets ();
        for (list<shared_ptr<const Asset> >::const_iterator i = a.begin(); i != a.end(); ++i) {
-               (*i)->write_to_pkl (pkl);
+               (*i)->write_to_pkl (asset_list);
        }
-
-       for (list<shared_ptr<const CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
-               (*i)->write_to_pkl (pkl);
+       
+       for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
+               (*i)->write_to_pkl (asset_list);
        }
 
-       pkl << "  </AssetList>\n"
-           << "</PackingList>\n";
-
+       if (crypt) {
+               sign (pkl, crypt->certificates, crypt->signer_key, interop);
+       }
+               
+       doc.write_to_file_formatted (p.string (), "UTF-8");
        return p.string ();
 }
 
@@ -113,55 +131,55 @@ DCP::write_volindex () const
        boost::filesystem::path p;
        p /= _directory;
        p /= "VOLINDEX.xml";
-       ofstream vi (p.string().c_str());
 
-       vi << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
-          << "<VolumeIndex xmlns=\"http://www.smpte-ra.org/schemas/429-9/2007/AM\">\n"
-          << "  <Index>1</Index>\n"
-          << "</VolumeIndex>\n";
+       xmlpp::Document doc;
+       xmlpp::Element* root = doc.create_root_node ("VolumeIndex", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
+       root->add_child("Index")->add_child_text ("1");
+       doc.write_to_file_formatted (p.string (), "UTF-8");
 }
 
 void
-DCP::write_assetmap (string pkl_uuid, int pkl_length) const
+DCP::write_assetmap (string pkl_uuid, int pkl_length, bool interop, XMLMetadata const & metadata) const
 {
        boost::filesystem::path p;
        p /= _directory;
        p /= "ASSETMAP.xml";
-       ofstream am (p.string().c_str());
-
-       am << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
-          << "<AssetMap xmlns=\"http://www.smpte-ra.org/schemas/429-9/2007/AM\">\n"
-          << "  <Id>urn:uuid:" << make_uuid() << "</Id>\n"
-          << "  <Creator>" << Metadata::instance()->creator << "</Creator>\n"
-          << "  <VolumeCount>1</VolumeCount>\n"
-          << "  <IssueDate>" << Metadata::instance()->issue_date << "</IssueDate>\n"
-          << "  <Issuer>" << Metadata::instance()->issuer << "</Issuer>\n"
-          << "  <AssetList>\n";
-
-       am << "    <Asset>\n"
-          << "      <Id>urn:uuid:" << pkl_uuid << "</Id>\n"
-          << "      <PackingList>true</PackingList>\n"
-          << "      <ChunkList>\n"
-          << "        <Chunk>\n"
-          << "          <Path>" << pkl_uuid << "_pkl.xml</Path>\n"
-          << "          <VolumeIndex>1</VolumeIndex>\n"
-          << "          <Offset>0</Offset>\n"
-          << "          <Length>" << pkl_length << "</Length>\n"
-          << "        </Chunk>\n"
-          << "      </ChunkList>\n"
-          << "    </Asset>\n";
+
+       xmlpp::Document doc;
+       xmlpp::Element* root;
+       if (interop) {
+               root = doc.create_root_node ("AssetMap", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#");
+       } else {
+               root = doc.create_root_node ("AssetMap", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
+       }
+
+       root->add_child("Id")->add_child_text ("urn:uuid:" + make_uuid());
+       root->add_child("Creator")->add_child_text (metadata.creator);
+       root->add_child("VolumeCount")->add_child_text ("1");
+       root->add_child("IssueDate")->add_child_text (metadata.issue_date);
+       root->add_child("Issuer")->add_child_text (metadata.issuer);
+       xmlpp::Node* asset_list = root->add_child ("AssetList");
+
+       xmlpp::Node* asset = asset_list->add_child ("Asset");
+       asset->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid);
+       asset->add_child("PackingList")->add_child_text ("true");
+       xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
+       xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
+       chunk->add_child("Path")->add_child_text (pkl_uuid + "_pkl.xml");
+       chunk->add_child("VolumeIndex")->add_child_text ("1");
+       chunk->add_child("Offset")->add_child_text ("0");
+       chunk->add_child("Length")->add_child_text (lexical_cast<string> (pkl_length));
        
-       for (list<shared_ptr<const CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
-               (*i)->write_to_assetmap (am);
+       for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
+               (*i)->write_to_assetmap (asset_list);
        }
 
        list<shared_ptr<const Asset> > a = assets ();
        for (list<shared_ptr<const Asset> >::const_iterator i = a.begin(); i != a.end(); ++i) {
-               (*i)->write_to_assetmap (am);
+               (*i)->write_to_assetmap (asset_list);
        }
 
-       am << "  </AssetList>\n"
-          << "</AssetMap>\n";
+       doc.write_to_file_formatted (p.string (), "UTF-8");
 }
 
 
@@ -170,17 +188,17 @@ DCP::read (bool require_mxfs)
 {
        Files files;
 
-       shared_ptr<AssetMap> asset_map;
+       shared_ptr<parse::AssetMap> asset_map;
        try {
                boost::filesystem::path p = _directory;
                p /= "ASSETMAP";
                if (boost::filesystem::exists (p)) {
-                       asset_map.reset (new AssetMap (p.string ()));
+                       asset_map.reset (new libdcp::parse::AssetMap (p.string ()));
                } else {
                        p = _directory;
                        p /= "ASSETMAP.xml";
                        if (boost::filesystem::exists (p)) {
-                               asset_map.reset (new AssetMap (p.string ()));
+                               asset_map.reset (new libdcp::parse::AssetMap (p.string ()));
                        } else {
                                boost::throw_exception (DCPReadError ("could not find AssetMap file"));
                        }
@@ -190,7 +208,7 @@ DCP::read (bool require_mxfs)
                boost::throw_exception (FileError ("could not load AssetMap file", files.asset_map));
        }
 
-       for (list<shared_ptr<AssetMapAsset> >::const_iterator i = asset_map->assets.begin(); i != asset_map->assets.end(); ++i) {
+       for (list<shared_ptr<libdcp::parse::AssetMapAsset> >::const_iterator i = asset_map->assets.begin(); i != asset_map->assets.end(); ++i) {
                if ((*i)->chunks.size() != 1) {
                        boost::throw_exception (XMLError ("unsupported asset chunk count"));
                }
@@ -232,9 +250,9 @@ DCP::read (bool require_mxfs)
                boost::throw_exception (FileError ("no PKL file found", ""));
        }
 
-       shared_ptr<PKLFile> pkl;
+       shared_ptr<parse::PKL> pkl;
        try {
-               pkl.reset (new PKLFile (files.pkl));
+               pkl.reset (new parse::PKL (files.pkl));
        } catch (FileError& e) {
                boost::throw_exception (FileError ("could not load PKL file", files.pkl));
        }
@@ -248,18 +266,18 @@ DCP::read (bool require_mxfs)
 }
 
 bool
-DCP::equals (DCP const & other, EqualityOptions opt, list<string>& notes) const
+DCP::equals (DCP const & other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
 {
        if (_cpls.size() != other._cpls.size()) {
-               notes.push_back ("CPL counts differ");
+               note (ERROR, "CPL counts differ");
                return false;
        }
 
-       list<shared_ptr<const CPL> >::const_iterator a = _cpls.begin ();
-       list<shared_ptr<const CPL> >::const_iterator b = other._cpls.begin ();
+       list<shared_ptr<CPL> >::const_iterator a = _cpls.begin ();
+       list<shared_ptr<CPL> >::const_iterator b = other._cpls.begin ();
 
        while (a != _cpls.end ()) {
-               if (!(*a)->equals (*b->get(), opt, notes)) {
+               if (!(*a)->equals (*b->get(), opt, note)) {
                        return false;
                }
                ++a;
@@ -269,7 +287,6 @@ DCP::equals (DCP const & other, EqualityOptions opt, list<string>& notes) const
        return true;
 }
 
-
 void
 DCP::add_cpl (shared_ptr<CPL> cpl)
 {
@@ -288,271 +305,38 @@ list<shared_ptr<const Asset> >
 DCP::assets () const
 {
        list<shared_ptr<const Asset> > a;
-       for (list<shared_ptr<const CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
+       for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
                list<shared_ptr<const Asset> > t = (*i)->assets ();
                a.merge (t);
        }
 
-       a.sort ();
+       a.sort (AssetComparator ());
        a.unique ();
        return a;
 }
 
-CPL::CPL (string directory, string name, ContentKind content_kind, int length, int frames_per_second)
-       : _directory (directory)
-       , _name (name)
-       , _content_kind (content_kind)
-       , _length (length)
-       , _fps (frames_per_second)
-{
-       _uuid = make_uuid ();
-}
-
-/** Construct a CPL object from a XML file.
- *  @param directory The directory containing this CPL's DCP.
- *  @param file The CPL XML filename.
- *  @param asset_map The corresponding asset map.
- *  @param require_mxfs true to throw an exception if a required MXF file does not exist.
- */
-CPL::CPL (string directory, string file, shared_ptr<const AssetMap> asset_map, bool require_mxfs)
-       : _directory (directory)
-       , _content_kind (FEATURE)
-       , _length (0)
-       , _fps (0)
-{
-       /* Read the XML */
-       shared_ptr<CPLFile> cpl;
-       try {
-               cpl.reset (new CPLFile (file));
-       } catch (FileError& e) {
-               boost::throw_exception (FileError ("could not load CPL file", file));
-       }
-       
-       /* Now cherry-pick the required bits into our own data structure */
-       
-       _name = cpl->annotation_text;
-       _content_kind = cpl->content_kind;
-
-       for (list<shared_ptr<CPLReel> >::iterator i = cpl->reels.begin(); i != cpl->reels.end(); ++i) {
-
-               shared_ptr<Picture> p;
-
-               if ((*i)->asset_list->main_picture) {
-                       p = (*i)->asset_list->main_picture;
-               } else {
-                       p = (*i)->asset_list->main_stereoscopic_picture;
-               }
-               
-               _fps = p->edit_rate.numerator;
-               _length += p->duration;
-
-               shared_ptr<PictureAsset> picture;
-               shared_ptr<SoundAsset> sound;
-               shared_ptr<SubtitleAsset> subtitle;
-
-               /* Some rather twisted logic to decide if we are 3D or not;
-                  some DCPs give a MainStereoscopicPicture to indicate 3D, others
-                  just have a FrameRate twice the EditRate and apparently
-                  expect you to divine the fact that they are hence 3D.
-               */
-
-               if (!(*i)->asset_list->main_stereoscopic_picture && p->edit_rate == p->frame_rate) {
-
-                       try {
-                               picture.reset (new MonoPictureAsset (
-                                                      _directory,
-                                                      asset_map->asset_from_id (p->id)->chunks.front()->path
-                                                      )
-                                       );
-
-                               picture->set_entry_point ((*i)->asset_list->main_picture->entry_point);
-                       } catch (MXFFileError) {
-                               if (require_mxfs) {
-                                       throw;
-                               }
-                       }
-                       
-               } else {
-
-                       try {
-                               picture.reset (new StereoPictureAsset (
-                                                      _directory,
-                                                      asset_map->asset_from_id (p->id)->chunks.front()->path,
-                                                      _fps,
-                                                      p->duration
-                                                      )
-                                       );
-
-                               picture->set_entry_point (p->entry_point);
-                               
-                       } catch (MXFFileError) {
-                               if (require_mxfs) {
-                                       throw;
-                               }
-                       }
-                       
-               }
-               
-               if ((*i)->asset_list->main_sound) {
-                       
-                       try {
-                               sound.reset (new SoundAsset (
-                                                    _directory,
-                                                    asset_map->asset_from_id ((*i)->asset_list->main_sound->id)->chunks.front()->path
-                                                    )
-                                       );
-
-                               sound->set_entry_point ((*i)->asset_list->main_sound->entry_point);
-                       } catch (MXFFileError) {
-                               if (require_mxfs) {
-                                       throw;
-                               }
-                       }
-               }
-
-               if ((*i)->asset_list->main_subtitle) {
-                       
-                       subtitle.reset (new SubtitleAsset (
-                                               _directory,
-                                               asset_map->asset_from_id ((*i)->asset_list->main_subtitle->id)->chunks.front()->path
-                                               )
-                               );
-               }
-                       
-               _reels.push_back (shared_ptr<Reel> (new Reel (picture, sound, subtitle)));
-       }
-}
-
-void
-CPL::add_reel (shared_ptr<const Reel> reel)
-{
-       _reels.push_back (reel);
-}
-
-void
-CPL::write_xml () const
-{
-       boost::filesystem::path p;
-       p /= _directory;
-       stringstream s;
-       s << _uuid << "_cpl.xml";
-       p /= s.str();
-       ofstream os (p.string().c_str());
-       
-       os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
-          << "<CompositionPlaylist xmlns=\"http://www.smpte-ra.org/schemas/429-7/2006/CPL\">\n"
-          << "  <Id>urn:uuid:" << _uuid << "</Id>\n"
-          << "  <AnnotationText>" << _name << "</AnnotationText>\n"
-          << "  <IssueDate>" << Metadata::instance()->issue_date << "</IssueDate>\n"
-          << "  <Creator>" << Metadata::instance()->creator << "</Creator>\n"
-          << "  <ContentTitleText>" << _name << "</ContentTitleText>\n"
-          << "  <ContentKind>" << content_kind_to_string (_content_kind) << "</ContentKind>\n"
-          << "  <ContentVersion>\n"
-          << "    <Id>urn:uri:" << _uuid << "_" << Metadata::instance()->issue_date << "</Id>\n"
-          << "    <LabelText>" << _uuid << "_" << Metadata::instance()->issue_date << "</LabelText>\n"
-          << "  </ContentVersion>\n"
-          << "  <RatingList/>\n"
-          << "  <ReelList>\n";
-       
-       for (list<shared_ptr<const Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
-               (*i)->write_to_cpl (os);
-       }
-
-       os << "  </ReelList>\n"
-          << "</CompositionPlaylist>\n";
-
-       os.close ();
-
-       _digest = make_digest (p.string ());
-       _length = boost::filesystem::file_size (p.string ());
-}
-
-void
-CPL::write_to_pkl (ostream& s) const
-{
-       s << "    <Asset>\n"
-         << "      <Id>urn:uuid:" << _uuid << "</Id>\n"
-         << "      <Hash>" << _digest << "</Hash>\n"
-         << "      <Size>" << _length << "</Size>\n"
-         << "      <Type>text/xml</Type>\n"
-         << "    </Asset>\n";
-}
-
-list<shared_ptr<const Asset> >
-CPL::assets () const
+bool
+DCP::encrypted () const
 {
-       list<shared_ptr<const Asset> > a;
-       for (list<shared_ptr<const Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
-               if ((*i)->main_picture ()) {
-                       a.push_back ((*i)->main_picture ());
-               }
-               if ((*i)->main_sound ()) {
-                       a.push_back ((*i)->main_sound ());
-               }
-               if ((*i)->main_subtitle ()) {
-                       a.push_back ((*i)->main_subtitle ());
+       for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
+               if ((*i)->encrypted ()) {
+                       return true;
                }
        }
 
-       return a;
+       return false;
 }
 
 void
-CPL::write_to_assetmap (ostream& s) const
+DCP::add_kdm (KDM const & kdm)
 {
-       s << "    <Asset>\n"
-         << "      <Id>urn:uuid:" << _uuid << "</Id>\n"
-         << "      <ChunkList>\n"
-         << "        <Chunk>\n"
-         << "          <Path>" << _uuid << "_cpl.xml</Path>\n"
-         << "          <VolumeIndex>1</VolumeIndex>\n"
-         << "          <Offset>0</Offset>\n"
-         << "          <Length>" << _length << "</Length>\n"
-         << "        </Chunk>\n"
-         << "      </ChunkList>\n"
-         << "    </Asset>\n";
-}
-       
+       list<KDMCipher> ciphers = kdm.ciphers ();
        
-       
-bool
-CPL::equals (CPL const & other, EqualityOptions opt, list<string>& notes) const
-{
-       if (_name != other._name) {
-               notes.push_back ("names differ");
-               return false;
-       }
-
-       if (_content_kind != other._content_kind) {
-               notes.push_back ("content kinds differ");
-               return false;
-       }
-
-       if (_fps != other._fps) {
-               notes.push_back ("frames per second differ");
-               return false;
-       }
-
-       if (_length != other._length) {
-               notes.push_back ("lengths differ");
-               return false;
-       }
-
-       if (_reels.size() != other._reels.size()) {
-               notes.push_back ("reel counts differ");
-               return false;
-       }
-       
-       list<shared_ptr<const Reel> >::const_iterator a = _reels.begin ();
-       list<shared_ptr<const Reel> >::const_iterator b = other._reels.begin ();
-       
-       while (a != _reels.end ()) {
-               if (!(*a)->equals (*b, opt, notes)) {
-                       return false;
+       for (list<shared_ptr<CPL> >::iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
+               for (list<KDMCipher>::iterator j = ciphers.begin(); j != ciphers.end(); ++j) {
+                       if (j->cpl_id() == (*i)->id()) {
+                               (*i)->add_kdm (kdm);
+                       }                               
                }
-               ++a;
-               ++b;
        }
-
-       return true;
 }