Tidy up interop API.
[libdcp.git] / src / dcp.cc
index 8c74ea8e593e3ba2f4e1597249622a6e6e65f249..30a3c3a430150cbc32e3ac7ff7a28af0e2921ccf 100644 (file)
 #include <fstream>
 #include <iomanip>
 #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 "picture_asset.h"
+#include "subtitle_asset.h"
 #include "util.h"
 #include "metadata.h"
-
-using namespace std;
-using namespace boost;
+#include "exceptions.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;
+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, ContentType content_type, int fps, int length)
+DCP::DCP (string directory)
        : _directory (directory)
-       , _name (name)
-       , _content_type (content_type)
-       , _fps (fps)
-       , _length (length)
-{
-       
-}
-
-void
-DCP::add_sound_asset (vector<string> const & files)
-{
-       filesystem::path p;
-       p /= _directory;
-       p /= "audio.mxf";
-       _assets.push_back (shared_ptr<SoundAsset> (new SoundAsset (files, p.string(), &Progress, _fps, _length)));
-}
-
-void
-DCP::add_sound_asset (sigc::slot<string, Channel> get_path, int channels)
 {
-       filesystem::path p;
-       p /= _directory;
-       p /= "audio.mxf";
-       _assets.push_back (shared_ptr<SoundAsset> (new SoundAsset (get_path, p.string(), &Progress, _fps, _length, channels)));
-}
-
-void
-DCP::add_picture_asset (vector<string> const & files, int width, int height)
-{
-       filesystem::path p;
-       p /= _directory;
-       p /= "video.mxf";
-       _assets.push_back (shared_ptr<PictureAsset> (new PictureAsset (files, p.string(), &Progress, _fps, _length, width, height)));
+       boost::filesystem::create_directories (directory);
 }
 
 void
-DCP::add_picture_asset (sigc::slot<string, int> get_path, int width, int height)
+DCP::write_xml (bool interop, XMLMetadata const & metadata, shared_ptr<Encryption> crypt) const
 {
-       filesystem::path p;
-       p /= _directory;
-       p /= "video.mxf";
-       _assets.push_back (shared_ptr<PictureAsset> (new PictureAsset (get_path, p.string(), &Progress, _fps, _length, width, height)));
-}
-
-void
-DCP::write_xml () 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_type_string (_content_type) << "</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";
-
-       cpl << "    <Reel>\n"
-           << "      <Id>urn:uuid:" << make_uuid() << "</Id>\n"
-           << "      <AssetList>\n";
-
-       for (list<shared_ptr<Asset> >::const_iterator i = _assets.begin(); i != _assets.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<Asset> >::const_iterator i = _assets.begin(); i != _assets.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<Asset> >::const_iterator i = _assets.begin(); i != _assets.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);
        }
 
-       am << "  </AssetList>\n"
-          << "</AssetMap>\n";
+       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);
+       }
+
+       doc.write_to_file_formatted (p.string (), "UTF-8");
 }
 
 
-DCP::DCP (string directory)
-       : _directory (directory)
+void
+DCP::read (bool require_mxfs)
 {
-       string cpl;
-       string pkl;
-       string asset_map;
-
-       for (filesystem::directory_iterator i = filesystem::directory_iterator(directory); i != filesystem::directory_iterator(); ++i) {
-               string const t = i->path()->string ();
-               if (ends_with (t, "_cpl.xml")) {
-                       if (cpl.empty ()) {
-                               cpl = t;
-                       } else {
-                               throw DCPReadError ("duplicate CPLs found");
-                       }
-               } else if (ends_with (t, "_pkl.xml")) {
-                       if (pkl.empty ()) {
-                               pkl = t;
+       Files files;
+
+       shared_ptr<parse::AssetMap> asset_map;
+       try {
+               boost::filesystem::path p = _directory;
+               p /= "ASSETMAP";
+               if (boost::filesystem::exists (p)) {
+                       asset_map.reset (new libdcp::parse::AssetMap (p.string ()));
+               } else {
+                       p = _directory;
+                       p /= "ASSETMAP.xml";
+                       if (boost::filesystem::exists (p)) {
+                               asset_map.reset (new libdcp::parse::AssetMap (p.string ()));
                        } else {
-                               throw DCPReadError ("duplicate PKLs found");
+                               boost::throw_exception (DCPReadError ("could not find AssetMap file"));
                        }
-               } else if (ends_with (t, "ASSETMAP.xml")) {
-                       if (asset_map.empty ()) {
-                               asset_map = t;
+               }
+               
+       } catch (FileError& e) {
+               boost::throw_exception (FileError ("could not load AssetMap file", files.asset_map));
+       }
+
+       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"));
+               }
+
+               boost::filesystem::path t = _directory;
+               t /= (*i)->chunks.front()->path;
+               
+               if (boost::algorithm::ends_with (t.string(), ".mxf") || boost::algorithm::ends_with (t.string(), ".ttf")) {
+                       continue;
+               }
+
+               xmlpp::DomParser* p = new xmlpp::DomParser;
+               try {
+                       p->parse_file (t.string());
+               } catch (std::exception& e) {
+                       delete p;
+                       continue;
+               }
+
+               string const root = p->get_document()->get_root_node()->get_name ();
+               delete p;
+
+               if (root == "CompositionPlaylist") {
+                       files.cpls.push_back (t.string());
+               } else if (root == "PackingList") {
+                       if (files.pkl.empty ()) {
+                               files.pkl = t.string();
                        } else {
-                               throw DCPReadError ("duplicate AssetMaps found");
+                               boost::throw_exception (DCPReadError ("duplicate PKLs found"));
                        }
                }
        }
+       
+       if (files.cpls.empty ()) {
+               boost::throw_exception (FileError ("no CPL files found", ""));
+       }
 
-       load_cpl (cpl);
-       load_pkl (pkl);
-       load_asset_map (asset_map);
+       if (files.pkl.empty ()) {
+               boost::throw_exception (FileError ("no PKL file found", ""));
+       }
+
+       shared_ptr<parse::PKL> pkl;
+       try {
+               pkl.reset (new parse::PKL (files.pkl));
+       } catch (FileError& e) {
+               boost::throw_exception (FileError ("could not load PKL file", files.pkl));
+       }
+
+       /* Cross-check */
+       /* XXX */
+
+       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)));
+       }
 }
 
-void
-DCP::load_cpl (string file)
+bool
+DCP::equals (DCP const & other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
 {
-       xmlpp::DOMParser parser;
-       parser.parser_file (file);
-       if (!parser) {
-               throw DCPReadError ("could not create parser for CPL");
+       if (_cpls.size() != other._cpls.size()) {
+               note (ERROR, "CPL counts differ");
+               return false;
        }
 
-       xmlpp::Element* root = parser.get_document()->get_root_node ();
-       dcp_read_assert (root->get_name() == "CompositionPlaylist", "unrecognised CPL format");
-
-       xmlpp::Node::NodeList children = root->get_children ();
-       for (xmlpp::Node::NodeList::iterator i = children.begin(); i != children.end(); ++i) {
-               bool taken = false;
-               xml_maybe (*i, taken, _cpl_id, "Id");
-               xml_maybe (*i, taken, _annotation_text, "AnnotationText");
-               xml_maybe (*i, taken, _issue_date, "IssueDate");
-               xml_maybe (*i, taken, _creator, "Creator");
-               xml_maybe (*i, taken, _content_title_text, "ContentTitleText");
-               xml_maybe (*i, taken, _content_kind, "ContentKind");
-
-               if ((*i)->get_name() == "ContentVersion") {
-                       taken = true;
-                       load_cpl_content_version (*i);
-               }
-
-               if ((*i)->get_name() == "RatingList") {
-                       taken = true;
-               }
+       list<shared_ptr<CPL> >::const_iterator a = _cpls.begin ();
+       list<shared_ptr<CPL> >::const_iterator b = other._cpls.begin ();
 
-               if ((*i)->get_name() == "ReelList") {
-                       taken = true;
-                       load_cpl_reel_list (*i);
+       while (a != _cpls.end ()) {
+               if (!(*a)->equals (*b->get(), opt, note)) {
+                       return false;
                }
-
-               xml_assert_taken (*i, taken);
+               ++a;
+               ++b;
        }
+
+       return true;
 }
 
 void
-DCP::load_cpl_content_version (xmlpp::Node const * node)
+DCP::add_cpl (shared_ptr<CPL> cpl)
 {
-       xmlpp::Node::NodeList children = node->get_children ();
-       for (xmlpp::Node::NodeList::iterator i = children.begin(); i != children.end(); ++i) {
-               bool taken = false;
-               xml_maybe (*i, taken, _content_version_id, "Id");
-               xml_maybe (*i, taken, _content_version_label_text, "LabelText");
-               xml_assert_taken (*i, taken);
-       }
+       _cpls.push_back (cpl);
 }
 
-void
-DCP::load_cpl_reel_list (xmlpp::Node const * node)
+class AssetComparator
 {
-       xmlpp::Node::NodeList children = node->get_children ();
-       bool had_reel = false;
-       for (xmlpp::Node::NodeList::iterator i = children.begin(); i != children.end(); ++i) {
-               bool taken = false;
-               if ((*i)->get_name() == "Reel") {
-                       if (!had_reel) {
-                               load_cpl_reel (*i);
-                               had_reel = true;
-                       } else {
-                               throw DCPReadError ("multiple reels not supported");
-                       }
-               }
-               xml_assert_taken (*i, taken);
+public:
+       bool operator() (shared_ptr<const Asset> a, shared_ptr<const Asset> b) {
+               return a->uuid() < b->uuid();
        }
-}
+};
 
-void
-DCP::load_cpl_reel (xmlpp::Node const * node)
+list<shared_ptr<const Asset> >
+DCP::assets () const
 {
-       xmlpp::Node::NodeList children = node->get_children ();
-       for (xmlpp::Node::NodeList::iterator i = children.begin(); i != children.end(); ++i) {
-               bool taken = false;
-               xml_taken (*i, taken, _reel_id, "Id");
-               if ((*i)->name() == "AssetList") {
-                       taken = true;
-                       load_cpl_asset_list (*i);
-               }
-               xml_assert_taken (*i, taken);
+       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);
        }
+
+       a.sort (AssetComparator ());
+       a.unique ();
+       return a;
 }
 
-void
-DCP::load_cpl_asset_list (xmlpp::Node const * node)
+bool
+DCP::encrypted () const
 {
-       xmlpp::Node::NodeList children = node->get_children ();
-       for (xmlpp::Node::NodeList::iterator i = children.begin(); i != children.end(); ++i) {
-               bool taken = false;
-               if ((*i)->name() == "MainPicture") {
-                       taken = true;
-                       load_cpl_main_picture (*i);
-               } else if ((*i)->name() == "MainSound") {
-                       taken = true;
-                       load_cpl_main_sound (*i);
+       for (list<shared_ptr<CPL> >::const_iterator i = _cpls.begin(); i != _cpls.end(); ++i) {
+               if ((*i)->encrypted ()) {
+                       return true;
                }
-               xml_assert_taken (*i, taken);
        }
+
+       return false;
 }
 
 void
-DCP::load_cpl_main_picture (xmlpp::Node const * node)
+DCP::add_kdm (KDM const & kdm)
 {
-       xmlpp::Node::NodeList children = node->get_children ();
-       for (xmlpp::Node::NodeList::iterator i = children.begin(); i != children.end(); ++i) {
-               bool taken = false;
-               xml_maybe (*i, taken, _video_id, "Id");
-               
+       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);
+                       }                               
+               }
        }
 }