Rename PKL::write to PKL::write_xml for consistency.
[libdcp.git] / src / dcp.cc
index 20ff82f864177231de0f6c4790575dfe8fbd4ce0..df5c89b4852c37863e54db522602f4a581576152 100644 (file)
  */
 
 
-#include "raw_convert.h"
-#include "dcp.h"
-#include "sound_asset.h"
+#include "asset_factory.h"
 #include "atmos_asset.h"
-#include "picture_asset.h"
-#include "interop_subtitle_asset.h"
-#include "smpte_subtitle_asset.h"
-#include "mono_picture_asset.h"
-#include "stereo_picture_asset.h"
-#include "reel_subtitle_asset.h"
-#include "util.h"
-#include "metadata.h"
-#include "exceptions.h"
-#include "cpl.h"
 #include "certificate_chain.h"
 #include "compose.hpp"
+#include "cpl.h"
+#include "dcp.h"
+#include "dcp_assert.h"
 #include "decrypted_kdm.h"
 #include "decrypted_kdm_key.h"
-#include "dcp_assert.h"
-#include "reel_asset.h"
+#include "exceptions.h"
 #include "font_asset.h"
+#include "interop_subtitle_asset.h"
+#include "metadata.h"
+#include "mono_picture_asset.h"
+#include "picture_asset.h"
 #include "pkl.h"
-#include "asset_factory.h"
+#include "raw_convert.h"
+#include "reel_asset.h"
+#include "reel_subtitle_asset.h"
+#include "smpte_subtitle_asset.h"
+#include "sound_asset.h"
+#include "stereo_picture_asset.h"
+#include "util.h"
 #include "verify.h"
+#include "warnings.h"
+LIBDCP_DISABLE_WARNINGS
 #include <asdcp/AS_DCP.h>
+LIBDCP_ENABLE_WARNINGS
 #include <xmlsec/xmldsig.h>
 #include <xmlsec/app.h>
+LIBDCP_DISABLE_WARNINGS
 #include <libxml++/libxml++.h>
-#include <boost/filesystem.hpp>
+LIBDCP_ENABLE_WARNINGS
 #include <boost/algorithm/string.hpp>
+#include <boost/filesystem.hpp>
+#include <numeric>
 
 
-using std::string;
-using std::list;
-using std::vector;
+using std::cerr;
 using std::cout;
+using std::dynamic_pointer_cast;
+using std::exception;
+using std::list;
 using std::make_pair;
-using std::map;
-using std::cerr;
 using std::make_shared;
-using std::exception;
+using std::map;
 using std::shared_ptr;
-using std::dynamic_pointer_cast;
-using boost::optional;
+using std::string;
+using std::vector;
 using boost::algorithm::starts_with;
+using boost::optional;
 using namespace dcp;
 
 
-static string const assetmap_interop_ns = "http://www.digicine.com/PROTO-ASDCP-AM-20040311#";
-static string const assetmap_smpte_ns   = "http://www.smpte-ra.org/schemas/429-9/2007/AM";
 static string const volindex_interop_ns = "http://www.digicine.com/PROTO-ASDCP-VL-20040311#";
 static string const volindex_smpte_ns   = "http://www.smpte-ra.org/schemas/429-9/2007/AM";
 
@@ -102,68 +106,59 @@ DCP::DCP (boost::filesystem::path directory)
 }
 
 
+DCP::DCP(DCP&& other)
+       : _directory(std::move(other._directory))
+       , _cpls(std::move(other._cpls))
+       , _pkls(std::move(other._pkls))
+       , _asset_map(std::move(other._asset_map))
+       , _new_issuer(std::move(other._new_issuer))
+       , _new_creator(std::move(other._new_creator))
+       , _new_issue_date(std::move(other._new_issue_date))
+       , _new_annotation_text(std::move(other._new_annotation_text))
+{
+
+}
+
+
+DCP&
+DCP::operator=(DCP&& other)
+{
+       _directory = std::move(other._directory);
+       _cpls = std::move(other._cpls);
+       _pkls = std::move(other._pkls);
+       _asset_map = std::move(other._asset_map);
+       _new_issuer = std::move(other._new_issuer);
+       _new_creator = std::move(other._new_creator);
+       _new_issue_date = std::move(other._new_issue_date);
+       _new_annotation_text = std::move(other._new_annotation_text);
+       return *this;
+}
+
+
 void
 DCP::read (vector<dcp::VerificationNote>* notes, bool ignore_incorrect_picture_mxf_type)
 {
        /* Read the ASSETMAP and PKL */
 
-       if (boost::filesystem::exists (_directory / "ASSETMAP")) {
-               _asset_map = _directory / "ASSETMAP";
-       } else if (boost::filesystem::exists (_directory / "ASSETMAP.xml")) {
-               _asset_map = _directory / "ASSETMAP.xml";
+       boost::filesystem::path asset_map_path;
+       if (boost::filesystem::exists(_directory / "ASSETMAP")) {
+               asset_map_path = _directory / "ASSETMAP";
+       } else if (boost::filesystem::exists(_directory / "ASSETMAP.xml")) {
+               asset_map_path = _directory / "ASSETMAP.xml";
        } else {
-               boost::throw_exception (MissingAssetmapError(_directory));
+               boost::throw_exception(MissingAssetmapError(_directory));
        }
 
-       cxml::Document asset_map ("AssetMap");
-
-       asset_map.read_file (_asset_map.get());
-       if (asset_map.namespace_uri() == assetmap_interop_ns) {
-               _standard = Standard::INTEROP;
-       } else if (asset_map.namespace_uri() == assetmap_smpte_ns) {
-               _standard = Standard::SMPTE;
-       } else {
-               boost::throw_exception (XMLError ("Unrecognised Assetmap namespace " + asset_map.namespace_uri()));
-       }
-
-       auto asset_nodes = asset_map.node_child("AssetList")->node_children ("Asset");
-       map<string, boost::filesystem::path> paths;
-       vector<boost::filesystem::path> pkl_paths;
-       for (auto i: asset_nodes) {
-               if (i->node_child("ChunkList")->node_children("Chunk").size() != 1) {
-                       boost::throw_exception (XMLError ("unsupported asset chunk count"));
-               }
-               auto p = i->node_child("ChunkList")->node_child("Chunk")->string_child ("Path");
-               if (starts_with (p, "file://")) {
-                       p = p.substr (7);
-               }
-               switch (*_standard) {
-               case Standard::INTEROP:
-                       if (i->optional_node_child("PackingList")) {
-                               pkl_paths.push_back (p);
-                       } else {
-                               paths.insert (make_pair(remove_urn_uuid(i->string_child("Id")), p));
-                       }
-                       break;
-               case Standard::SMPTE:
-               {
-                       auto pkl_bool = i->optional_string_child("PackingList");
-                       if (pkl_bool && *pkl_bool == "true") {
-                               pkl_paths.push_back (p);
-                       } else {
-                               paths.insert (make_pair(remove_urn_uuid(i->string_child("Id")), p));
-                       }
-                       break;
-               }
-               }
-       }
+       _asset_map = AssetMap(asset_map_path);
+       auto const pkl_paths = _asset_map->pkl_paths();
+       auto const standard = _asset_map->standard();
 
        if (pkl_paths.empty()) {
                boost::throw_exception (XMLError ("No packing lists found in asset map"));
        }
 
        for (auto i: pkl_paths) {
-               _pkls.push_back (make_shared<PKL>(_directory / i));
+               _pkls.push_back(make_shared<PKL>(i));
        }
 
        /* Now we have:
@@ -178,10 +173,11 @@ DCP::read (vector<dcp::VerificationNote>* notes, bool ignore_incorrect_picture_m
        */
        vector<shared_ptr<Asset>> other_assets;
 
-       for (auto i: paths) {
-               auto path = _directory / i.second;
+       auto ids_and_paths = _asset_map->asset_ids_and_paths();
+       for (auto i: ids_and_paths) {
+               auto path = i.second;
 
-               if (i.second.empty()) {
+               if (path == _directory) {
                        /* I can't see how this is valid, but it's
                           been seen in the wild with a DCP that
                           claims to come from ClipsterDCI 5.10.0.5.
@@ -215,7 +211,16 @@ DCP::read (vector<dcp::VerificationNote>* notes, bool ignore_incorrect_picture_m
                        continue;
                }
 
-               if (*pkl_type == CPL::static_pkl_type(*_standard) || *pkl_type == InteropSubtitleAsset::static_pkl_type(*_standard)) {
+               auto remove_parameters = [](string const& n) {
+                       return n.substr(0, n.find(";"));
+               };
+
+               /* Remove any optional parameters (after ;) */
+               pkl_type = pkl_type->substr(0, pkl_type->find(";"));
+
+               if (
+                       pkl_type == remove_parameters(CPL::static_pkl_type(standard)) ||
+                       pkl_type == remove_parameters(InteropSubtitleAsset::static_pkl_type(standard))) {
                        auto p = new xmlpp::DomParser;
                        try {
                                p->parse_file (path.string());
@@ -229,25 +234,29 @@ DCP::read (vector<dcp::VerificationNote>* notes, bool ignore_incorrect_picture_m
 
                        if (root == "CompositionPlaylist") {
                                auto cpl = make_shared<CPL>(path);
-                               if (_standard && cpl->standard() && cpl->standard().get() != _standard.get() && notes) {
+                               if (cpl->standard() != standard && notes) {
                                        notes->push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::MISMATCHED_STANDARD});
                                }
                                _cpls.push_back (cpl);
                        } else if (root == "DCSubtitle") {
-                               if (_standard && _standard.get() == Standard::SMPTE && notes) {
+                               if (standard == Standard::SMPTE && notes) {
                                        notes->push_back (VerificationNote(VerificationNote::Type::ERROR, VerificationNote::Code::MISMATCHED_STANDARD));
                                }
                                other_assets.push_back (make_shared<InteropSubtitleAsset>(path));
                        }
                } else if (
-                       *pkl_type == PictureAsset::static_pkl_type(*_standard) ||
-                       *pkl_type == SoundAsset::static_pkl_type(*_standard) ||
-                       *pkl_type == AtmosAsset::static_pkl_type(*_standard) ||
-                       *pkl_type == SMPTESubtitleAsset::static_pkl_type(*_standard)
+                       *pkl_type == remove_parameters(PictureAsset::static_pkl_type(standard)) ||
+                       *pkl_type == remove_parameters(SoundAsset::static_pkl_type(standard)) ||
+                       *pkl_type == remove_parameters(AtmosAsset::static_pkl_type(standard)) ||
+                       *pkl_type == remove_parameters(SMPTESubtitleAsset::static_pkl_type(standard))
                        ) {
 
-                       other_assets.push_back (asset_factory(path, ignore_incorrect_picture_mxf_type));
-               } else if (*pkl_type == FontAsset::static_pkl_type(*_standard)) {
+                       bool found_threed_marked_as_twod = false;
+                       other_assets.push_back (asset_factory(path, ignore_incorrect_picture_mxf_type, &found_threed_marked_as_twod));
+                       if (found_threed_marked_as_twod && notes) {
+                               notes->push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::THREED_ASSET_MARKED_AS_TWOD, path});
+                       }
+               } else if (*pkl_type == remove_parameters(FontAsset::static_pkl_type(standard))) {
                        other_assets.push_back (make_shared<FontAsset>(i.first, path));
                } else if (*pkl_type == "image/png") {
                        /* It's an Interop PNG subtitle; let it go */
@@ -262,7 +271,7 @@ DCP::read (vector<dcp::VerificationNote>* notes, bool ignore_incorrect_picture_m
        if (notes) {
                for (auto i: cpls()) {
                        for (auto j: i->reel_file_assets()) {
-                               if (!j->asset_ref().resolved() && paths.find(j->asset_ref().id()) == paths.end()) {
+                               if (!j->asset_ref().resolved() && ids_and_paths.find(j->asset_ref().id()) == ids_and_paths.end()) {
                                        notes->push_back (VerificationNote(VerificationNote::Type::WARNING, VerificationNote::Code::EXTERNAL_ASSET, j->asset_ref().id()));
                                }
                        }
@@ -344,13 +353,10 @@ DCP::all_encrypted () const
 void
 DCP::add (DecryptedKDM const & kdm)
 {
-       auto keys = kdm.keys ();
-
-       for (auto i: cpls()) {
-               for (auto const& j: kdm.keys()) {
-                       if (j.cpl_id() == i->id()) {
-                               i->add (kdm);
-                       }
+       auto keys = kdm.keys();
+       for (auto cpl: cpls()) {
+               if (std::any_of(keys.begin(), keys.end(), [cpl](DecryptedKDMKey const& key) { return key.cpl_id() == cpl->id(); })) {
+                       cpl->add (kdm);
                }
        }
 }
@@ -394,115 +400,75 @@ DCP::write_volindex (Standard standard) const
 
 
 void
-DCP::write_assetmap (
-       Standard standard, string pkl_uuid, boost::filesystem::path pkl_path,
-       string issuer, string creator, string issue_date, string annotation_text
-       ) const
+DCP::write_xml (shared_ptr<const CertificateChain> signer, NameFormat name_format)
 {
-       auto p = _directory;
-
-       switch (standard) {
-       case Standard::INTEROP:
-               p /= "ASSETMAP";
-               break;
-       case Standard::SMPTE:
-               p /= "ASSETMAP.xml";
-               break;
-       default:
-               DCP_ASSERT (false);
-       }
-
-       xmlpp::Document doc;
-       xmlpp::Element* root;
-
-       switch (standard) {
-       case Standard::INTEROP:
-               root = doc.create_root_node ("AssetMap", assetmap_interop_ns);
-               break;
-       case Standard::SMPTE:
-               root = doc.create_root_node ("AssetMap", assetmap_smpte_ns);
-               break;
-       default:
-               DCP_ASSERT (false);
+       if (_cpls.empty()) {
+               throw MiscError ("Cannot write DCP with no CPLs.");
        }
 
-       root->add_child("Id")->add_child_text ("urn:uuid:" + make_uuid());
-       root->add_child("AnnotationText")->add_child_text (annotation_text);
-
-       switch (standard) {
-       case Standard::INTEROP:
-               root->add_child("VolumeCount")->add_child_text ("1");
-               root->add_child("IssueDate")->add_child_text (issue_date);
-               root->add_child("Issuer")->add_child_text (issuer);
-               root->add_child("Creator")->add_child_text (creator);
-               break;
-       case Standard::SMPTE:
-               root->add_child("Creator")->add_child_text (creator);
-               root->add_child("VolumeCount")->add_child_text ("1");
-               root->add_child("IssueDate")->add_child_text (issue_date);
-               root->add_child("Issuer")->add_child_text (issuer);
-               break;
-       default:
-               DCP_ASSERT (false);
-       }
-
-       auto asset_list = root->add_child ("AssetList");
-
-       auto 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");
-       auto chunk_list = asset->add_child ("ChunkList");
-       auto chunk = chunk_list->add_child ("Chunk");
-       chunk->add_child("Path")->add_child_text (pkl_path.filename().string());
-       chunk->add_child("VolumeIndex")->add_child_text ("1");
-       chunk->add_child("Offset")->add_child_text ("0");
-       chunk->add_child("Length")->add_child_text (raw_convert<string> (boost::filesystem::file_size (pkl_path)));
-
-       for (auto i: assets()) {
-               i->write_to_assetmap (asset_list, _directory);
-       }
-
-       doc.write_to_file_formatted (p.string (), "UTF-8");
-       _asset_map = p;
-}
-
+       auto standard = std::accumulate (
+               std::next(_cpls.begin()), _cpls.end(), _cpls[0]->standard(),
+               [](Standard s, shared_ptr<CPL> c) {
+                       if (s != c->standard()) {
+                               throw MiscError ("Cannot make DCP with mixed Interop and SMPTE CPLs.");
+                       }
+                       return s;
+               }
+               );
 
-void
-DCP::write_xml (
-       Standard standard,
-       string issuer,
-       string creator,
-       string issue_date,
-       string annotation_text,
-       shared_ptr<const CertificateChain> signer,
-       NameFormat name_format
-       )
-{
        for (auto i: cpls()) {
                NameFormat::Map values;
                values['t'] = "cpl";
-               i->write_xml (_directory / (name_format.get(values, "_" + i->id() + ".xml")), standard, signer);
+               i->write_xml (_directory / (name_format.get(values, "_" + i->id() + ".xml")), signer);
        }
 
-       shared_ptr<PKL> pkl;
-
        if (_pkls.empty()) {
-               pkl = make_shared<PKL>(standard, annotation_text, issue_date, issuer, creator);
-               _pkls.push_back (pkl);
-               for (auto i: assets()) {
-                       i->add_to_pkl (pkl, _directory);
-               }
-        } else {
-               pkl = _pkls.front ();
+               _pkls.push_back(
+                       make_shared<PKL>(
+                               standard,
+                               _new_annotation_text.get_value_or(String::compose("Created by libdcp %1", dcp::version)),
+                               _new_issue_date.get_value_or(LocalTime().as_string()),
+                               _new_issuer.get_value_or(String::compose("libdcp %1", dcp::version)),
+                               _new_creator.get_value_or(String::compose("libdcp %1", dcp::version))
+                               )
+                       );
+       }
+
+       auto pkl = _pkls.front();
+
+       /* The assets may have changed since we read the PKL, so re-add them */
+       pkl->clear_assets();
+       for (auto asset: assets()) {
+               asset->add_to_pkl(pkl, _directory);
        }
 
        NameFormat::Map values;
        values['t'] = "pkl";
        auto pkl_path = _directory / name_format.get(values, "_" + pkl->id() + ".xml");
-       pkl->write (pkl_path, signer);
+       pkl->write_xml (pkl_path, signer);
+
+       if (!_asset_map) {
+               _asset_map = AssetMap(
+                       standard,
+                       _new_annotation_text.get_value_or(String::compose("Created by libdcp %1", dcp::version)),
+                       _new_issue_date.get_value_or(LocalTime().as_string()),
+                       _new_issuer.get_value_or(String::compose("libdcp %1", dcp::version)),
+                       _new_creator.get_value_or(String::compose("libdcp %1", dcp::version))
+                       );
+       }
+
+       /* The assets may have changed since we read the asset map, so re-add them */
+       _asset_map->clear_assets();
+       _asset_map->add_asset(pkl->id(), pkl_path, true);
+       for (auto asset: assets()) {
+               asset->add_to_assetmap(*_asset_map, _directory);
+       }
+
+       _asset_map->write_xml(
+               _directory / (standard == Standard::INTEROP ? "ASSETMAP" : "ASSETMAP.xml")
+               );
 
        write_volindex (standard);
-       write_assetmap (standard, pkl->id(), pkl_path, issuer, creator, issue_date, annotation_text);
 }
 
 
@@ -560,3 +526,56 @@ DCP::directories_from_files (vector<boost::filesystem::path> files)
        }
        return d;
 }
+
+
+void
+DCP::set_issuer(string issuer)
+{
+       for (auto pkl: _pkls) {
+               pkl->set_issuer(issuer);
+       }
+       if (_asset_map) {
+               _asset_map->set_issuer(issuer);
+       }
+       _new_issuer = issuer;
+}
+
+
+void
+DCP::set_creator(string creator)
+{
+       for (auto pkl: _pkls) {
+               pkl->set_creator(creator);
+       }
+       if (_asset_map) {
+               _asset_map->set_creator(creator);
+       }
+       _new_creator = creator;
+}
+
+
+void
+DCP::set_issue_date(string issue_date)
+{
+       for (auto pkl: _pkls) {
+               pkl->set_issue_date(issue_date);
+       }
+       if (_asset_map) {
+               _asset_map->set_issue_date(issue_date);
+       }
+       _new_issue_date = issue_date;
+}
+
+
+void
+DCP::set_annotation_text(string annotation_text)
+{
+       for (auto pkl: _pkls) {
+               pkl->set_annotation_text(annotation_text);
+       }
+       if (_asset_map) {
+               _asset_map->set_annotation_text(annotation_text);
+       }
+       _new_annotation_text = annotation_text;
+}
+