/*
- Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
This file is part of libdcp.
#include "font_asset.h"
#include "pkl.h"
#include "asset_factory.h"
+#include "verify.h"
#include <asdcp/AS_DCP.h>
#include <xmlsec/xmldsig.h>
#include <xmlsec/app.h>
_directory = boost::filesystem::canonical (_directory);
}
-/** Call this instead of throwing an exception if the error can be tolerated */
-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;
- }
-}
-
+/** Read a DCP. This method does not do any deep checking of the DCP's validity, but
+ * if it comes across any bad things it will do one of two things.
+ *
+ * Errors that are so serious that they prevent the method from working will result
+ * in an exception being thrown. For example, a missing ASSETMAP means that the DCP
+ * can't be read without a lot of guesswork, so this will throw.
+ *
+ * Errors that are not fatal will be added to notes, if it's non-0. For example,
+ * if the DCP contains a mixture of Interop and SMPTE elements this will result
+ * in a note being added to the list.
+ */
void
-DCP::read (bool keep_going, ReadErrors* errors, bool ignore_incorrect_picture_mxf_type)
+DCP::read (list<dcp::VerificationNote>* notes, bool ignore_incorrect_picture_mxf_type)
{
/* Read the ASSETMAP and PKL */
- boost::filesystem::path asset_map_file;
if (boost::filesystem::exists (_directory / "ASSETMAP")) {
- asset_map_file = _directory / "ASSETMAP";
+ _asset_map = _directory / "ASSETMAP";
} else if (boost::filesystem::exists (_directory / "ASSETMAP.xml")) {
- asset_map_file = _directory / "ASSETMAP.xml";
+ _asset_map = _directory / "ASSETMAP.xml";
} else {
- boost::throw_exception (DCPReadError (String::compose ("could not find AssetMap file in `%1'", _directory.string())));
+ boost::throw_exception (ReadError(String::compose("Could not find ASSETMAP nor ASSETMAP.xml in '%1'", _directory.string())));
}
cxml::Document asset_map ("AssetMap");
- asset_map.read_file (asset_map_file);
+ asset_map.read_file (_asset_map.get());
if (asset_map.namespace_uri() == assetmap_interop_ns) {
_standard = INTEROP;
} else if (asset_map.namespace_uri() == assetmap_smpte_ns) {
_pkls.push_back (shared_ptr<PKL>(new PKL(_directory / i)));
}
- /* Read all the assets from the asset map */
+ /* Now we have:
+ paths - map of files in the DCP that are not PKLs; key is ID, value is path.
+ _pkls - PKL objects for each PKL.
+
+ Read all the assets from the asset map.
+ */
/* Make a list of non-CPL/PKL assets so that we can resolve the references
from the CPLs.
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));
+ if (i->second.empty()) {
+ /* 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.
+ */
+ if (notes) {
+ notes->push_back (VerificationNote(VerificationNote::VERIFY_WARNING, VerificationNote::EMPTY_ASSET_PATH));
+ }
+ continue;
+ }
+
+ if (!boost::filesystem::exists(path)) {
+ if (notes) {
+ notes->push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::MISSING_ASSET, path));
+ }
continue;
}
+ /* Find the <Type> for this asset from the PKL that contains the asset */
optional<string> pkl_type;
BOOST_FOREACH (shared_ptr<PKL> j, _pkls) {
pkl_type = j->type(i->first);
}
}
- DCP_ASSERT (pkl_type);
+ if (!pkl_type) {
+ /* This asset is in the ASSETMAP but not mentioned in any PKL so we don't
+ * need to worry about it.
+ */
+ continue;
+ }
if (*pkl_type == CPL::static_pkl_type(*_standard) || *pkl_type == InteropSubtitleAsset::static_pkl_type(*_standard)) {
xmlpp::DomParser* p = new xmlpp::DomParser;
p->parse_file (path.string());
} catch (std::exception& e) {
delete p;
- throw DCPReadError(String::compose("XML error in %1", path.string()), e.what());
+ throw ReadError(String::compose("XML error in %1", path.string()), e.what());
}
string const root = p->get_document()->get_root_node()->get_name ();
if (root == "CompositionPlaylist") {
shared_ptr<CPL> cpl (new CPL (path));
- if (_standard && cpl->standard() && cpl->standard().get() != _standard.get()) {
- survivable_error (keep_going, errors, MismatchedStandardError ());
+ if (_standard && cpl->standard() && cpl->standard().get() != _standard.get() && notes) {
+ notes->push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::MISMATCHED_STANDARD));
}
_cpls.push_back (cpl);
} else if (root == "DCSubtitle") {
- if (_standard && _standard.get() == SMPTE) {
- survivable_error (keep_going, errors, MismatchedStandardError ());
+ if (_standard && _standard.get() == SMPTE && notes) {
+ notes->push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::MISMATCHED_STANDARD));
}
other_assets.push_back (shared_ptr<InteropSubtitleAsset> (new InteropSubtitleAsset (path)));
}
} else if (*pkl_type == "image/png") {
/* It's an Interop PNG subtitle; let it go */
} else {
- throw DCPReadError (String::compose("Unknown asset type %1 in PKL", *pkl_type));
+ throw ReadError (String::compose("Unknown asset type %1 in PKL", *pkl_type));
}
}
- BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
- i->resolve_refs (other_assets);
+ resolve_refs (other_assets);
+
+ /* While we've got the ASSETMAP lets look and see if this DCP refers to things that are not in its ASSETMAP */
+ if (notes) {
+ BOOST_FOREACH (shared_ptr<CPL> i, cpls()) {
+ BOOST_FOREACH (shared_ptr<const ReelMXF> j, i->reel_mxfs()) {
+ if (!j->asset_ref().resolved() && paths.find(j->asset_ref().id()) == paths.end()) {
+ notes->push_back (VerificationNote(VerificationNote::VERIFY_WARNING, VerificationNote::EXTERNAL_ASSET, j->asset_ref().id()));
+ }
+ }
+ }
}
}
}
void
-DCP::write_assetmap (Standard standard, string pkl_uuid, boost::filesystem::path pkl_path, XMLMetadata metadata) const
+DCP::write_assetmap (
+ Standard standard, string pkl_uuid, boost::filesystem::path pkl_path,
+ string issuer, string creator, string issue_date, string annotation_text
+ ) const
{
boost::filesystem::path p = _directory;
}
root->add_child("Id")->add_child_text ("urn:uuid:" + make_uuid());
- root->add_child("AnnotationText")->add_child_text (metadata.annotation_text);
+ root->add_child("AnnotationText")->add_child_text (annotation_text);
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);
+ 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 SMPTE:
- root->add_child("Creator")->add_child_text (metadata.creator);
+ root->add_child("Creator")->add_child_text (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);
+ root->add_child("IssueDate")->add_child_text (issue_date);
+ root->add_child("Issuer")->add_child_text (issuer);
break;
default:
DCP_ASSERT (false);
}
doc.write_to_file_formatted (p.string (), "UTF-8");
+ _asset_map = p;
}
/** Write all the XML files for this DCP.
void
DCP::write_xml (
Standard standard,
- XMLMetadata metadata,
+ string issuer,
+ string creator,
+ string issue_date,
+ string annotation_text,
shared_ptr<const CertificateChain> signer,
NameFormat name_format
)
shared_ptr<PKL> pkl;
if (_pkls.empty()) {
- pkl.reset (new PKL (standard, metadata.annotation_text, metadata.issue_date, metadata.issuer, metadata.creator));
+ pkl.reset (new PKL(standard, annotation_text, issue_date, issuer, creator));
_pkls.push_back (pkl);
BOOST_FOREACH (shared_ptr<Asset> i, assets ()) {
i->add_to_pkl (pkl, _directory);
pkl->write (pkl_path, signer);
write_volindex (standard);
- write_assetmap (standard, pkl->id(), pkl_path, metadata);
+ write_assetmap (standard, pkl->id(), pkl_path, issuer, creator, issue_date, annotation_text);
}
list<shared_ptr<CPL> >
list<shared_ptr<Asset> > assets;
BOOST_FOREACH (shared_ptr<CPL> i, cpls ()) {
assets.push_back (i);
- BOOST_FOREACH (shared_ptr<const ReelAsset> j, i->reel_assets ()) {
+ BOOST_FOREACH (shared_ptr<const ReelMXF> j, i->reel_mxfs()) {
if (ignore_unresolved && !j->asset_ref().resolved()) {
continue;
}
- shared_ptr<Asset> o = j->asset_ref().asset ();
- assets.push_back (o);
- /* More Interop special-casing */
- shared_ptr<InteropSubtitleAsset> sub = dynamic_pointer_cast<InteropSubtitleAsset> (o);
- if (sub) {
- sub->add_font_assets (assets);
+
+ string const id = j->asset_ref().id();
+ bool already_got = false;
+ BOOST_FOREACH (shared_ptr<Asset> k, assets) {
+ if (k->id() == id) {
+ already_got = true;
+ }
+ }
+
+ if (!already_got) {
+ shared_ptr<Asset> o = j->asset_ref().asset();
+ assets.push_back (o);
+ /* More Interop special-casing */
+ shared_ptr<InteropSubtitleAsset> sub = dynamic_pointer_cast<InteropSubtitleAsset> (o);
+ if (sub) {
+ sub->add_font_assets (assets);
+ }
}
}
}
projects / libdcp.git / blobdiff