Use a typedef for a note-taking functor.
[libdcp.git] / src / dcp.cc
index e4a5678c922600ac79823dd8a1a4ad290dd6f7c8..dd360edd5f22f21d5095fa3cf30b88cea753368f 100644 (file)
  *  @brief DCP class.
  */
 
+#include "raw_convert.h"
 #include "dcp.h"
 #include "sound_mxf.h"
 #include "picture_mxf.h"
-#include "subtitle_content.h"
+#include "interop_subtitle_content.h"
+#include "smpte_subtitle_content.h"
 #include "mono_picture_mxf.h"
 #include "stereo_picture_mxf.h"
 #include "util.h"
 #include "metadata.h"
 #include "exceptions.h"
-#include "reel.h"
 #include "cpl.h"
 #include "signer.h"
-#include "kdm.h"
 #include "compose.hpp"
 #include "AS_DCP.h"
+#include "decrypted_kdm.h"
+#include "decrypted_kdm_key.h"
+#include "dcp_assert.h"
 #include <xmlsec/xmldsig.h>
 #include <xmlsec/app.h>
 #include <libxml++/libxml++.h>
 #include <boost/filesystem.hpp>
 #include <boost/algorithm/string.hpp>
-#include <boost/lexical_cast.hpp>
-#include <sstream>
-#include <iomanip>
-#include <cassert>
 #include <iostream>
 
 using std::string;
 using std::list;
-using std::stringstream;
+using std::cout;
 using std::ostream;
 using std::make_pair;
 using std::map;
+using std::cout;
+using std::exception;
 using boost::shared_ptr;
-using boost::lexical_cast;
+using boost::algorithm::starts_with;
 using namespace dcp;
 
 DCP::DCP (boost::filesystem::path directory)
        : _directory (directory)
 {
-       boost::filesystem::create_directories (directory);
+       if (!boost::filesystem::exists (directory)) {
+               boost::filesystem::create_directories (directory);
+       }
+       
+       _directory = boost::filesystem::canonical (_directory);
+}
+
+template<class T> void
+survivable_error (bool keep_going, dcp::DCP::ReadErrors* errors, T const & e)
+{
+       if (keep_going) {
+               if (errors) {
+                       errors->push_back (shared_ptr<T> (new T (e)));
+               }
+       } else {
+               throw e;
+       }
 }
 
 void
-DCP::read ()
+DCP::read (bool keep_going, ReadErrors* errors)
 {
        /* Read the ASSETMAP */
        
@@ -74,7 +91,7 @@ DCP::read ()
        } else if (boost::filesystem::exists (_directory / "ASSETMAP.xml")) {
                asset_map_file = _directory / "ASSETMAP.xml";
        } else {
-               boost::throw_exception (DCPReadError ("could not find AssetMap file"));
+               boost::throw_exception (DCPReadError (String::compose ("could not find AssetMap file in `%1'", _directory.string())));
        }
 
        cxml::Document asset_map ("AssetMap");
@@ -85,16 +102,25 @@ DCP::read ()
                if ((*i)->node_child("ChunkList")->node_children("Chunk").size() != 1) {
                        boost::throw_exception (XMLError ("unsupported asset chunk count"));
                }
-               paths.insert (make_pair (
-                       (*i)->string_child ("Id"),
-                       (*i)->node_child("ChunkList")->node_child("Chunk")->string_child ("Path")
-                                     ));
+               string p = (*i)->node_child("ChunkList")->node_child("Chunk")->string_child ("Path");
+               if (starts_with (p, "file://")) {
+                       p = p.substr (7);
+               }
+               paths.insert (make_pair ((*i)->string_child ("Id"), p));
        }
 
        /* Read all the assets from the asset map */
-       
+       /* XXX: I think we should be looking at the PKL here to decide type, not
+          the extension of the file.
+       */
        for (map<string, boost::filesystem::path>::const_iterator i = paths.begin(); i != paths.end(); ++i) {
                boost::filesystem::path path = _directory / i->second;
+
+               if (!boost::filesystem::exists (path)) {
+                       survivable_error (keep_going, errors, MissingAssetError (path));
+                       continue;
+               }
+               
                if (boost::algorithm::ends_with (path.string(), ".xml")) {
                        xmlpp::DomParser* p = new xmlpp::DomParser;
                        try {
@@ -110,7 +136,7 @@ DCP::read ()
                        if (root == "CompositionPlaylist") {
                                _assets.push_back (shared_ptr<CPL> (new CPL (path)));
                        } else if (root == "DCSubtitle") {
-                               _assets.push_back (shared_ptr<SubtitleContent> (new SubtitleContent (path)));
+                               _assets.push_back (shared_ptr<InteropSubtitleContent> (new InteropSubtitleContent (path)));
                        }
                } else if (boost::algorithm::ends_with (path.string(), ".mxf")) {
                        ASDCP::EssenceType_t type;
@@ -131,6 +157,9 @@ DCP::read ()
                                case ASDCP::ESS_JPEG_2000_S:
                                        _assets.push_back (shared_ptr<StereoPictureMXF> (new StereoPictureMXF (path)));
                                        break;
+                               case ASDCP::ESS_TIMED_TEXT:
+                                       _assets.push_back (shared_ptr<SMPTESubtitleContent> (new SMPTESubtitleContent (path)));
+                                       break;
                                default:
                                        throw DCPReadError ("Unknown MXF essence type");
                                }
@@ -144,25 +173,30 @@ DCP::read ()
 }
 
 bool
-DCP::equals (DCP const & other, EqualityOptions opt, boost::function<void (NoteType, string)> note) const
+DCP::equals (DCP const & other, EqualityOptions opt, NoteHandler note) const
 {
-       if (_assets.size() != other._assets.size()) {
-               note (ERROR, "Asset counts differ");
+       list<shared_ptr<CPL> > a = cpls ();
+       list<shared_ptr<CPL> > b = other.cpls ();
+       
+       if (a.size() != b.size()) {
+               note (DCP_ERROR, String::compose ("CPL counts differ: %1 vs %2", a.size(), b.size()));
                return false;
        }
 
-       list<shared_ptr<Asset> >::const_iterator a = _assets.begin ();
-       list<shared_ptr<Asset> >::const_iterator b = other._assets.begin ();
+       bool r = true;
+
+       for (list<shared_ptr<CPL> >::const_iterator i = a.begin(); i != a.end(); ++i) {
+               list<shared_ptr<CPL> >::const_iterator j = b.begin ();
+               while (j != b.end() && !(*j)->equals (*i, opt, note)) {
+                       ++j;
+               }
 
-       while (a != _assets.end ()) {
-               if (!(*a)->equals (*b, opt, note)) {
-                       return false;
+               if (j == b.end ()) {
+                       r = false;
                }
-               ++a;
-               ++b;
        }
 
-       return true;
+       return r;
 }
 
 void
@@ -171,14 +205,6 @@ DCP::add (boost::shared_ptr<Asset> asset)
        _assets.push_back (asset);
 }
 
-class AssetComparator
-{
-public:
-       bool operator() (shared_ptr<const Content> a, shared_ptr<const Content> b) {
-               return a->id() < b->id();
-       }
-};
-
 bool
 DCP::encrypted () const
 {
@@ -193,13 +219,13 @@ DCP::encrypted () const
 }
 
 void
-DCP::add (KDM const & kdm)
+DCP::add (DecryptedKDM const & kdm)
 {
-       list<KDMKey> keys = kdm.keys ();
+       list<DecryptedKDMKey> keys = kdm.keys ();
        list<shared_ptr<CPL> > cpl = cpls ();
        
        for (list<shared_ptr<CPL> >::iterator i = cpl.begin(); i != cpl.end(); ++i) {
-               for (list<KDMKey>::iterator j = keys.begin(); j != keys.end(); ++j) {
+               for (list<DecryptedKDMKey>::iterator j = keys.begin(); j != keys.end(); ++j) {
                        if (j->cpl_id() == (*i)->id()) {
                                (*i)->add (kdm);
                        }                               
@@ -211,9 +237,7 @@ boost::filesystem::path
 DCP::write_pkl (Standard standard, string pkl_uuid, XMLMetadata metadata, shared_ptr<const Signer> signer) const
 {
        boost::filesystem::path p = _directory;
-       stringstream s;
-       s << pkl_uuid << "_pkl.xml";
-       p /= s.str();
+       p /= String::compose ("%1_pkl.xml", pkl_uuid);
 
        xmlpp::Document doc;
        xmlpp::Element* pkl;
@@ -230,7 +254,7 @@ DCP::write_pkl (Standard standard, string pkl_uuid, XMLMetadata metadata, shared
        pkl->add_child("Id")->add_child_text ("urn:uuid:" + pkl_uuid);
 
        /* XXX: this is a bit of a hack */
-       assert (cpls().size() > 0);
+       DCP_ASSERT (cpls().size() > 0);
        pkl->add_child("AnnotationText")->add_child_text (cpls().front()->annotation_text ());
        
        pkl->add_child("IssueDate")->add_child_text (metadata.issue_date);
@@ -239,7 +263,7 @@ DCP::write_pkl (Standard standard, string pkl_uuid, XMLMetadata metadata, shared
 
        xmlpp::Element* asset_list = pkl->add_child("AssetList");
        for (list<shared_ptr<Asset> >::const_iterator i = _assets.begin(); i != _assets.end(); ++i) {
-               (*i)->write_to_pkl (asset_list);
+               (*i)->write_to_pkl (asset_list, standard);
        }
 
        if (signer) {
@@ -257,14 +281,31 @@ void
 DCP::write_volindex (Standard standard) const
 {
        boost::filesystem::path p = _directory;
-       if (standard == INTEROP) {
+       switch (standard) {
+       case INTEROP:
                p /= "VOLINDEX";
-       } else {
+               break;
+       case SMPTE:
                p /= "VOLINDEX.xml";
+               break;
+       default:
+               DCP_ASSERT (false);
        }
 
        xmlpp::Document doc;
-       xmlpp::Element* root = doc.create_root_node ("VolumeIndex", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
+       xmlpp::Element* root;
+
+       switch (standard) {
+       case INTEROP:
+               root = doc.create_root_node ("VolumeIndex", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#");
+               break;
+       case SMPTE:
+               root = doc.create_root_node ("VolumeIndex", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
+               break;
+       default:
+               DCP_ASSERT (false);
+       }
+       
        root->add_child("Index")->add_child_text ("1");
        doc.write_to_file (p.string (), "UTF-8");
 }
@@ -273,32 +314,50 @@ void
 DCP::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMetadata metadata) const
 {
        boost::filesystem::path p = _directory;
-       if (standard == INTEROP) {
+       
+       switch (standard) {
+       case INTEROP:
                p /= "ASSETMAP";
-       } else {
+               break;
+       case SMPTE:
                p /= "ASSETMAP.xml";
+               break;
+       default:
+               DCP_ASSERT (false);
        }
 
        xmlpp::Document doc;
        xmlpp::Element* root;
-       if (standard == INTEROP) {
+
+       switch (standard) {
+       case INTEROP:
                root = doc.create_root_node ("AssetMap", "http://www.digicine.com/PROTO-ASDCP-AM-20040311#");
-       } else {
+               break;
+       case SMPTE:
                root = doc.create_root_node ("AssetMap", "http://www.smpte-ra.org/schemas/429-9/2007/AM");
+               break;
+       default:
+               DCP_ASSERT (false);
        }
 
        root->add_child("Id")->add_child_text ("urn:uuid:" + make_uuid());
        root->add_child("AnnotationText")->add_child_text ("Created by " + metadata.creator);
-       if (standard == INTEROP) {
+
+       switch (standard) {
+       case INTEROP:
                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);
                root->add_child("Creator")->add_child_text (metadata.creator);
-       } else {
+               break;
+       case SMPTE:
                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);
+               break;
+       default:
+               DCP_ASSERT (false);
        }
                
        xmlpp::Node* asset_list = root->add_child ("AssetList");
@@ -311,16 +370,21 @@ DCP::write_assetmap (Standard standard, string pkl_uuid, int pkl_length, XMLMeta
        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));
+       chunk->add_child("Length")->add_child_text (raw_convert<string> (pkl_length));
        
        for (list<shared_ptr<Asset> >::const_iterator i = _assets.begin(); i != _assets.end(); ++i) {
-               (*i)->write_to_assetmap (asset_list);
+               (*i)->write_to_assetmap (asset_list, _directory);
        }
 
        /* This must not be the _formatted version otherwise signature digests will be wrong */
        doc.write_to_file (p.string (), "UTF-8");
 }
 
+/** Write all the XML files for this DCP.
+ *  @param standand INTEROP or SMPTE.
+ *  @param metadata Metadata to use for PKL and asset map files.
+ *  @param signer Signer to use, or 0.
+ */
 void
 DCP::write_xml (
        Standard standard,
@@ -331,7 +395,7 @@ DCP::write_xml (
        list<shared_ptr<CPL> > cpl = cpls ();
        for (list<shared_ptr<CPL> >::const_iterator i = cpl.begin(); i != cpl.end(); ++i) {
                string const filename = (*i)->id() + "_cpl.xml";
-               (*i)->write_xml (_directory / filename, standard, metadata, signer);
+               (*i)->write_xml (_directory / filename, standard, signer);
        }
 
        string const pkl_uuid = make_uuid ();