Tidy up interop API.
[libdcp.git] / src / dcp.cc
index f7ded2c44ea6e2a91e0bd5fe1257dcc6234f7682..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.h"
-#include "asset_map.h"
+#include "parse/pkl.h"
+#include "parse/asset_map.h"
 #include "reel.h"
-
-using namespace std;
-using namespace boost;
+#include "cpl.h"
+#include "encryption.h"
+#include "kdm.h"
+
+using std::string;
+using std::list;
+using std::stringstream;
+using std::ofstream;
+using std::ostream;
+using boost::shared_ptr;
+using boost::lexical_cast;
 using namespace libdcp;
 
-DCP::DCP (string directory, string name, ContentKind content_kind, int fps, int length)
+DCP::DCP (string directory)
        : _directory (directory)
-       , _name (name)
-       , _content_kind (content_kind)
-       , _fps (fps)
-       , _length (length)
-{
-       filesystem::create_directories (directory);
-}
-
-void
-DCP::add_reel (shared_ptr<const Reel> reel)
 {
-       _reels.push_back (reel);
+       boost::filesystem::create_directories (directory);
 }
 
 void
-DCP::write_xml () const
+DCP::write_xml (bool interop, XMLMetadata const & metadata, shared_ptr<Encryption> crypt) const
 {
-       string cpl_uuid = make_uuid ();
-       string cpl_path = write_cpl (cpl_uuid);
-       int cpl_length = filesystem::file_size (cpl_path);
-       string cpl_digest = make_digest (cpl_path, 0);
+       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, cpl_uuid, cpl_digest, cpl_length);
+       string pkl_path = write_pkl (pkl_uuid, interop, metadata, crypt);
        
        write_volindex ();
-       write_assetmap (cpl_uuid, cpl_length, pkl_uuid, filesystem::file_size (pkl_path));
-}
-
-string
-DCP::write_cpl (string cpl_uuid) const
-{
-       filesystem::path p;
-       p /= _directory;
-       stringstream s;
-       s << cpl_uuid << "_cpl.xml";
-       p /= s.str();
-       ofstream cpl (p.string().c_str());
-       
-       cpl << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
-           << "<CompositionPlaylist xmlns=\"http://www.smpte-ra.org/schemas/429-7/2006/CPL\">\n"
-           << "  <Id>urn:uuid:" << cpl_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:" << cpl_uuid << "_" << Metadata::instance()->issue_date << "</Id>\n"
-           << "    <LabelText>" << cpl_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 (cpl);
-       }
-
-       cpl << "      </AssetList>\n"
-           << "    </Reel>\n"
-           << "  </ReelList>\n"
-           << "</CompositionPlaylist>\n";
-
-       return p.string ();
+       write_assetmap (pkl_uuid, boost::filesystem::file_size (pkl_path), interop, metadata);
 }
 
 std::string
-DCP::write_pkl (string pkl_uuid, string cpl_uuid, string cpl_digest, int cpl_length) const
+DCP::write_pkl (string pkl_uuid, bool interop, XMLMetadata const & metadata, shared_ptr<Encryption> crypt) const
 {
-       filesystem::path p;
+       assert (!_cpls.empty ());
+       
+       boost::filesystem::path p;
        p /= _directory;
        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"
-           << "  <AnnotationText>" << _name << "</AnnotationText>\n"
-           << "  <IssueDate>" << Metadata::instance()->issue_date << "</IssueDate>\n"
-           << "  <Issuer>" << Metadata::instance()->issuer << "</Issuer>\n"
-           << "  <Creator>" << Metadata::instance()->creator << "</Creator>\n"
-           << "  <AssetList>\n";
-
-       for (list<shared_ptr<const Reel> >::const_iterator i = _reels.begin(); i != _reels.end(); ++i) {
-               (*i)->write_to_pkl (pkl);
-       }
 
-       pkl << "    <Asset>\n"
-           << "      <Id>urn:uuid:" << cpl_uuid << "</Id>\n"
-           << "      <Hash>" << cpl_digest << "</Hash>\n"
-           << "      <Size>" << cpl_length << "</Size>\n"
-           << "      <Type>text/xml</Type>\n"
-           << "    </Asset>\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 << "  </AssetList>\n"
-           << "</PackingList>\n";
+       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 (asset_list);
+       }
+       
+       for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
+               (*i)->write_to_pkl (asset_list);
+       }
 
+       if (crypt) {
+               sign (pkl, crypt->certificates, crypt->signer_key, interop);
+       }
+               
+       doc.write_to_file_formatted (p.string (), "UTF-8");
        return p.string ();
 }
 
 void
 DCP::write_volindex () const
 {
-       filesystem::path p;
+       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 cpl_uuid, int cpl_length, string pkl_uuid, int pkl_length) const
+DCP::write_assetmap (string pkl_uuid, int pkl_length, bool interop, XMLMetadata const & metadata) const
 {
-       filesystem::path p;
+       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";
-
-       am << "    <Asset>\n"
-          << "      <Id>urn:uuid:" << cpl_uuid << "</Id>\n"
-          << "      <ChunkList>\n"
-          << "        <Chunk>\n"
-          << "          <Path>" << cpl_uuid << "_cpl.xml</Path>\n"
-          << "          <VolumeIndex>1</VolumeIndex>\n"
-          << "          <Offset>0</Offset>\n"
-          << "          <Length>" << cpl_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 Reel> >::const_iterator i = _reels.begin(); i != _reels.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 (asset_list);
        }
 
-       am << "  </AssetList>\n"
-          << "</AssetMap>\n";
+       doc.write_to_file_formatted (p.string (), "UTF-8");
 }
 
 
-DCP::DCP (string directory, bool require_mxfs)
-       : _directory (directory)
+void
+DCP::read (bool require_mxfs)
 {
        Files files;
 
-       shared_ptr<AssetMap> asset_map;
+       shared_ptr<parse::AssetMap> asset_map;
        try {
-               filesystem::path p = _directory;
+               boost::filesystem::path p = _directory;
                p /= "ASSETMAP";
-               if (filesystem::exists (p)) {
-                       asset_map.reset (new AssetMap (p.string ()));
+               if (boost::filesystem::exists (p)) {
+                       asset_map.reset (new libdcp::parse::AssetMap (p.string ()));
                } else {
                        p = _directory;
                        p /= "ASSETMAP.xml";
-                       if (filesystem::exists (p)) {
-                               asset_map.reset (new AssetMap (p.string ()));
+                       if (boost::filesystem::exists (p)) {
+                               asset_map.reset (new libdcp::parse::AssetMap (p.string ()));
                        } else {
-                               throw DCPReadError ("could not find AssetMap file");
+                               boost::throw_exception (DCPReadError ("could not find AssetMap file"));
                        }
                }
                
        } catch (FileError& e) {
-               throw FileError ("could not load AssetMap file", files.asset_map);
+               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) {
-                       throw XMLError ("unsupported asset chunk count");
+                       boost::throw_exception (XMLError ("unsupported asset chunk count"));
                }
 
-               filesystem::path t = _directory;
+               boost::filesystem::path t = _directory;
                t /= (*i)->chunks.front()->path;
                
-               if (ends_with (t.string(), ".mxf") || ends_with (t.string(), ".ttf")) {
+               if (boost::algorithm::ends_with (t.string(), ".mxf") || boost::algorithm::ends_with (t.string(), ".ttf")) {
                        continue;
                }
 
@@ -263,174 +232,111 @@ DCP::DCP (string directory, bool require_mxfs)
                delete p;
 
                if (root == "CompositionPlaylist") {
-                       if (files.cpl.empty ()) {
-                               files.cpl = t.string();
-                       } else {
-                               throw DCPReadError ("duplicate CPLs found");
-                       }
+                       files.cpls.push_back (t.string());
                } else if (root == "PackingList") {
                        if (files.pkl.empty ()) {
                                files.pkl = t.string();
                        } else {
-                               throw DCPReadError ("duplicate PKLs found");
+                               boost::throw_exception (DCPReadError ("duplicate PKLs found"));
                        }
-               } else if (root == "DCSubtitle") {
-                       files.subtitles.push_back (t.string());
                }
        }
        
-       if (files.cpl.empty ()) {
-               throw FileError ("no CPL file found", "");
+       if (files.cpls.empty ()) {
+               boost::throw_exception (FileError ("no CPL files found", ""));
        }
 
        if (files.pkl.empty ()) {
-               throw FileError ("no PKL file found", "");
-       }
-
-       /* Read the XML */
-       shared_ptr<CPLFile> cpl;
-       try {
-               cpl.reset (new CPLFile (files.cpl));
-       } catch (FileError& e) {
-               throw FileError ("could not load CPL file", files.cpl);
+               boost::throw_exception (FileError ("no PKL file found", ""));
        }
 
-       shared_ptr<PKL> pkl;
+       shared_ptr<parse::PKL> pkl;
        try {
-               pkl.reset (new PKL (files.pkl));
+               pkl.reset (new parse::PKL (files.pkl));
        } catch (FileError& e) {
-               throw FileError ("could not load PKL file", files.pkl);
+               boost::throw_exception (FileError ("could not load PKL file", files.pkl));
        }
 
        /* Cross-check */
        /* XXX */
 
-       /* Now cherry-pick the required bits into our own data structure */
-       
-       _name = cpl->annotation_text;
-       _content_kind = cpl->content_kind;
-       _length = 0;
-       _fps = 0;
-
-       for (list<shared_ptr<CPLReel> >::iterator i = cpl->reels.begin(); i != cpl->reels.end(); ++i) {
+       for (list<string>::iterator i = files.cpls.begin(); i != files.cpls.end(); ++i) {
+               _cpls.push_back (shared_ptr<CPL> (new CPL (_directory, *i, asset_map, require_mxfs)));
+       }
+}
 
-               shared_ptr<Picture> p;
+bool
+DCP::equals (DCP const & other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
+{
+       if (_cpls.size() != other._cpls.size()) {
+               note (ERROR, "CPL counts differ");
+               return false;
+       }
 
-               if ((*i)->asset_list->main_picture) {
-                       p = (*i)->asset_list->main_picture;
-               } else {
-                       p = (*i)->asset_list->main_stereoscopic_picture;
-               }
-               
-               assert (_fps == 0 || _fps == p->edit_rate.numerator);
-               _fps = p->edit_rate.numerator;
-               _length += p->duration;
-
-               shared_ptr<PictureAsset> picture;
-               shared_ptr<SoundAsset> sound;
-               shared_ptr<SubtitleAsset> subtitle;
-
-               if ((*i)->asset_list->main_picture) {
-
-                       try {
-                               picture.reset (new MonoPictureAsset (
-                                                      _directory,
-                                                      asset_map->asset_from_id ((*i)->asset_list->main_picture->id)->chunks.front()->path,
-                                                      _fps,
-                                                      (*i)->asset_list->main_picture->entry_point,
-                                                      (*i)->asset_list->main_picture->duration
-                                                      )
-                                       );
-                       } catch (MXFFileError) {
-                               if (require_mxfs) {
-                                       throw;
-                               }
-                       }
-                       
-               } else if ((*i)->asset_list->main_stereoscopic_picture) {
-                       
-                       try {
-                               picture.reset (new StereoPictureAsset (
-                                                      _directory,
-                                                      asset_map->asset_from_id ((*i)->asset_list->main_stereoscopic_picture->id)->chunks.front()->path,
-                                                      _fps,
-                                                      (*i)->asset_list->main_stereoscopic_picture->entry_point,
-                                                      (*i)->asset_list->main_stereoscopic_picture->duration
-                                                      )
-                                       );
-                       } 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,
-                                                    _fps,
-                                                    (*i)->asset_list->main_sound->entry_point,
-                                                    (*i)->asset_list->main_sound->duration
-                                                    )
-                                       );
-                       } catch (MXFFileError) {
-                               if (require_mxfs) {
-                                       throw;
-                               }
-                       }
-               }
+       list<shared_ptr<CPL> >::const_iterator a = _cpls.begin ();
+       list<shared_ptr<CPL> >::const_iterator b = other._cpls.begin ();
 
-               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
-                                               )
-                               );
+       while (a != _cpls.end ()) {
+               if (!(*a)->equals (*b->get(), opt, note)) {
+                       return false;
                }
-                       
-               _reels.push_back (shared_ptr<Reel> (new Reel (picture, sound, subtitle)));
+               ++a;
+               ++b;
        }
+
+       return true;
 }
 
-list<string>
-DCP::equals (DCP const & other, EqualityOptions opt) const
+void
+DCP::add_cpl (shared_ptr<CPL> cpl)
 {
-       list<string> notes;
-       
-       if (opt.flags & LIBDCP_METADATA) {
-               if (_name != other._name) {
-                       notes.push_back ("names differ");
-               }
-               if (_content_kind != other._content_kind) {
-                       notes.push_back ("content kinds differ");
-               }
-               if (_fps != other._fps) {
-                       notes.push_back ("frames per second differ");
-               }
-               if (_length != other._length) {
-                       notes.push_back ("lengths differ");
-               }
+       _cpls.push_back (cpl);
+}
+
+class AssetComparator
+{
+public:
+       bool operator() (shared_ptr<const Asset> a, shared_ptr<const Asset> b) {
+               return a->uuid() < b->uuid();
        }
+};
 
-       if (_reels.size() != other._reels.size()) {
-               notes.push_back ("reel counts differ");
+list<shared_ptr<const Asset> >
+DCP::assets () const
+{
+       list<shared_ptr<const Asset> > a;
+       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);
        }
-       
-       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 ()) {
-               list<string> n = (*a)->equals (*b, opt);
-               notes.merge (n);
-               ++a;
-               ++b;
+
+       a.sort (AssetComparator ());
+       a.unique ();
+       return a;
+}
+
+bool
+DCP::encrypted () const
+{
+       for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
+               if ((*i)->encrypted ()) {
+                       return true;
+               }
        }
 
-       return notes;
+       return false;
 }
 
+void
+DCP::add_kdm (KDM const & kdm)
+{
+       list<KDMCipher> ciphers = kdm.ciphers ();
+       
+       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);
+                       }                               
+               }
+       }
+}