Various attempts to clean up DCP comparison code.
[libdcp.git] / src / dcp.cc
index 6af33663781e982b2c5840a8d81d7439d2d0fc7f..ca1c23d9a9df0fdaf7e85a75769c380781f4cf05 100644 (file)
@@ -21,6 +21,7 @@
  *  @brief DCP class.
  */
 
+#include "raw_convert.h"
 #include "dcp.h"
 #include "sound_mxf.h"
 #include "picture_mxf.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 <xmlsec/xmldsig.h>
 #include <xmlsec/app.h>
 #include <libxml++/libxml++.h>
 #include <boost/filesystem.hpp>
-#include <boost/lexical_cast.hpp>
 #include <boost/algorithm/string.hpp>
-#include <boost/lexical_cast.hpp>
 #include <sstream>
 #include <iomanip>
 #include <cassert>
 
 using std::string;
 using std::list;
+using std::cout;
 using std::stringstream;
 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::dynamic_pointer_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 */
        
@@ -76,30 +94,37 @@ 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 `%1'", asset_map_file.string())));
        }
 
        cxml::Document asset_map ("AssetMap");
        asset_map.read_file (asset_map_file);
-       list<shared_ptr<cxml::Node> > assets = asset_map.node_child("AssetList")->node_children ("Asset");
+       list<shared_ptr<cxml::Node> > asset_nodes = asset_map.node_child("AssetList")->node_children ("Asset");
        map<string, boost::filesystem::path> paths;
-       for (list<shared_ptr<cxml::Node> >::const_iterator i = assets.begin(); i != assets.end(); ++i) {
+       for (list<shared_ptr<cxml::Node> >::const_iterator i = asset_nodes.begin(); i != asset_nodes.end(); ++i) {
                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 */
-       
        for (map<string, boost::filesystem::path>::const_iterator i = paths.begin(); i != paths.end(); ++i) {
-               if (boost::algorithm::ends_with (i->second.string(), ".xml")) {
+               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 {
-                               p->parse_file (i->second.string());
+                               p->parse_file (path.string());
                        } catch (std::exception& e) {
                                delete p;
                                continue;
@@ -109,13 +134,13 @@ DCP::read ()
                        delete p;
                        
                        if (root == "CompositionPlaylist") {
-                               _assets.push_back (shared_ptr<CPL> (new CPL (i->second)));
+                               _assets.push_back (shared_ptr<CPL> (new CPL (path)));
                        } else if (root == "DCSubtitle") {
-                               _assets.push_back (shared_ptr<SubtitleContent> (new SubtitleContent (i->second)));
+                               _assets.push_back (shared_ptr<SubtitleContent> (new SubtitleContent (path, false)));
                        }
-               } else if (boost::algorithm::ends_with (i->second.string(), ".mxf")) {
+               } else if (boost::algorithm::ends_with (path.string(), ".mxf")) {
                        ASDCP::EssenceType_t type;
-                       if (ASDCP::EssenceType (i->second.string().c_str(), type) != ASDCP::RESULT_OK) {
+                       if (ASDCP::EssenceType (path.string().c_str(), type) != ASDCP::RESULT_OK) {
                                throw DCPReadError ("Could not find essence type");
                        }
                        switch (type) {
@@ -123,42 +148,55 @@ DCP::read ()
                                case ASDCP::ESS_MPEG2_VES:
                                        throw DCPReadError ("MPEG2 video essences are not supported");
                                case ASDCP::ESS_JPEG_2000:
-                                       _assets.push_back (shared_ptr<MonoPictureMXF> (new MonoPictureMXF (i->second)));
+                                       _assets.push_back (shared_ptr<MonoPictureMXF> (new MonoPictureMXF (path)));
                                        break;
                                case ASDCP::ESS_PCM_24b_48k:
                                case ASDCP::ESS_PCM_24b_96k:
-                                       _assets.push_back (shared_ptr<SoundMXF> (new SoundMXF (i->second)));
+                                       _assets.push_back (shared_ptr<SoundMXF> (new SoundMXF (path)));
                                        break;
                                case ASDCP::ESS_JPEG_2000_S:
-                                       _assets.push_back (shared_ptr<StereoPictureMXF> (new StereoPictureMXF (i->second)));
+                                       _assets.push_back (shared_ptr<StereoPictureMXF> (new StereoPictureMXF (path)));
+                                       break;
+                               case ASDCP::ESS_TIMED_TEXT:
+                                       _assets.push_back (shared_ptr<SubtitleContent> (new SubtitleContent (path, true)));
                                        break;
                                default:
                                        throw DCPReadError ("Unknown MXF essence type");
                                }
                }
        }
+
+       list<shared_ptr<CPL> > cpl = cpls ();
+       for (list<shared_ptr<CPL> >::const_iterator i = cpl.begin(); i != cpl.end(); ++i) {
+               (*i)->resolve_refs (list_of_type<Asset, Object> (assets ()));
+       }
 }
 
 bool
 DCP::equals (DCP const & other, EqualityOptions opt, boost::function<void (NoteType, string)> 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;
 
-       while (a != _assets.end ()) {
-               if (!(*a)->equals (*b, opt, note)) {
-                       return false;
+       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;
+               }
+
+               if (j == b.end ()) {
+                       r = false;
                }
-               ++a;
-               ++b;
        }
 
-       return true;
+       return r;
 }
 
 void
@@ -167,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
 {
@@ -189,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);
                        }                               
@@ -226,29 +256,16 @@ 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 */
-       list<shared_ptr<Asset> >::const_iterator i = _assets.begin();
-       shared_ptr<CPL> first_cpl;
-       while (i != _assets.end()) {
-               first_cpl = dynamic_pointer_cast<CPL> (*i);
-               if (first_cpl) {
-                       break;
-               }
-       }
-
-       assert (first_cpl);
-       pkl->add_child("AnnotationText")->add_child_text (first_cpl->annotation_text ());
+       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);
        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");
-
        for (list<shared_ptr<Asset> >::const_iterator i = _assets.begin(); i != _assets.end(); ++i) {
-               shared_ptr<Content> c = dynamic_pointer_cast<Content> (*i);
-               if (c) {
-                       c->write_to_pkl (asset_list);
-               }
+               (*i)->write_to_pkl (asset_list, standard);
        }
 
        if (signer) {
@@ -266,14 +283,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:
+               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:
+               assert (false);
+       }
+       
        root->add_child("Index")->add_child_text ("1");
        doc.write_to_file (p.string (), "UTF-8");
 }
@@ -282,32 +316,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:
+               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:
+               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:
+               assert (false);
        }
                
        xmlpp::Node* asset_list = root->add_child ("AssetList");
@@ -320,16 +372,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,
@@ -337,33 +394,21 @@ DCP::write_xml (
        shared_ptr<const Signer> signer
        )
 {
+       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, signer);
+       }
+
        string const pkl_uuid = make_uuid ();
        boost::filesystem::path const pkl_path = write_pkl (standard, pkl_uuid, metadata, signer);
        
        write_volindex (standard);
        write_assetmap (standard, pkl_uuid, boost::filesystem::file_size (pkl_path), metadata);
-
-       for (list<shared_ptr<Asset> >::const_iterator i = _assets.begin(); i != _assets.end(); ++i) {
-               shared_ptr<CPL> c = dynamic_pointer_cast<CPL> (*i);
-               if (c) {
-                       string const filename = c->id() + "_cpl.xml";
-                       c->write_xml (_directory / filename, standard, metadata, signer);
-               }
-       }
 }
 
 list<shared_ptr<CPL> >
 DCP::cpls () const
 {
-       list<shared_ptr<CPL> > cpls;
-       for (list<shared_ptr<Asset> >::const_iterator i = _assets.begin(); i != _assets.end(); ++i) {
-               shared_ptr<CPL> c = dynamic_pointer_cast<CPL> (*i);
-               if (c) {
-                       cpls.push_back (c);
-               }
-       }
-
-       return cpls;
+       return list_of_type<Asset, CPL> (_assets);
 }
-
-