#include "reel_asset.h"
#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>
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";
-/* XXX: these can be removed when PKL is all in pkl.cc */
-static string const pkl_interop_ns = "http://www.digicine.com/PROTO-ASDCP-PKL-20040311#";
-static string const pkl_smpte_ns = "http://www.smpte-ra.org/schemas/429-8/2007/PKL";
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";
_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 */
+ /* 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 (DCPReadError (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) {
list<shared_ptr<cxml::Node> > asset_nodes = asset_map.node_child("AssetList")->node_children ("Asset");
map<string, boost::filesystem::path> paths;
- optional<boost::filesystem::path> pkl_path;
+ list<boost::filesystem::path> pkl_paths;
BOOST_FOREACH (shared_ptr<cxml::Node> i, asset_nodes) {
if (i->node_child("ChunkList")->node_children("Chunk").size() != 1) {
boost::throw_exception (XMLError ("unsupported asset chunk count"));
if (starts_with (p, "file://")) {
p = p.substr (7);
}
- paths.insert (make_pair (remove_urn_uuid (i->string_child ("Id")), p));
- optional<string> pkl_bool = i->optional_string_child("PackingList");
- if (pkl_bool && *pkl_bool == "true") {
- pkl_path = p;
+ switch (*_standard) {
+ case 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 SMPTE:
+ {
+ optional<string> 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;
+ }
}
}
- if (!pkl_path) {
- boost::throw_exception (XMLError ("No packing list found in asset map"));
+ if (pkl_paths.empty()) {
+ boost::throw_exception (XMLError ("No packing lists found in asset map"));
}
- _pkl.reset (new PKL (_directory / *pkl_path));
+ BOOST_FOREACH (boost::filesystem::path i, pkl_paths) {
+ _pkls.push_back (shared_ptr<PKL>(new PKL(_directory / i)));
+ }
- /* 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.
- */
+ /* Now we have:
+ paths - files in the DCP that are not PKLs.
+ _pkls - PKL objects for each PKL.
- /* Make a list of non-CPL assets so that we can resolve the references
+ 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.
*/
list<shared_ptr<Asset> > other_assets;
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::extension (path) == ".xml") {
+ 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);
+ if (pkl_type) {
+ break;
+ }
+ }
+
+ DCP_ASSERT (pkl_type);
+
+ if (*pkl_type == CPL::static_pkl_type(*_standard) || *pkl_type == InteropSubtitleAsset::static_pkl_type(*_standard)) {
xmlpp::DomParser* p = new xmlpp::DomParser;
try {
p->parse_file (path.string());
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 ());
+ notes->push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::MISMATCHED_STANDARD));
}
other_assets.push_back (shared_ptr<InteropSubtitleAsset> (new InteropSubtitleAsset (path)));
}
- } else if (boost::filesystem::extension (path) == ".mxf") {
-
- /* XXX: asdcplib does not appear to support discovery of read MXFs standard
- (Interop / SMPTE)
- */
-
- ASDCP::EssenceType_t type;
- if (ASDCP::EssenceType (path.string().c_str(), type) != ASDCP::RESULT_OK) {
- throw DCPReadError ("Could not find essence type");
- }
- switch (type) {
- case ASDCP::ESS_UNKNOWN:
- case ASDCP::ESS_MPEG2_VES:
- throw DCPReadError ("MPEG2 video essences are not supported");
- case ASDCP::ESS_JPEG_2000:
- try {
- other_assets.push_back (shared_ptr<MonoPictureAsset> (new MonoPictureAsset (path)));
- } catch (dcp::MXFFileError& e) {
- if (ignore_incorrect_picture_mxf_type && e.number() == ASDCP::RESULT_SFORMAT) {
- /* Tried to load it as mono but the error says it's stereo; try that instead */
- other_assets.push_back (shared_ptr<StereoPictureAsset> (new StereoPictureAsset (path)));
- } else {
- throw;
- }
- }
- break;
- case ASDCP::ESS_PCM_24b_48k:
- case ASDCP::ESS_PCM_24b_96k:
- other_assets.push_back (shared_ptr<SoundAsset> (new SoundAsset (path)));
- break;
- case ASDCP::ESS_JPEG_2000_S:
- other_assets.push_back (shared_ptr<StereoPictureAsset> (new StereoPictureAsset (path)));
- break;
- case ASDCP::ESS_TIMED_TEXT:
- other_assets.push_back (shared_ptr<SMPTESubtitleAsset> (new SMPTESubtitleAsset (path)));
- break;
- case ASDCP::ESS_DCDATA_DOLBY_ATMOS:
- other_assets.push_back (shared_ptr<AtmosAsset> (new AtmosAsset (path)));
- break;
- default:
- throw DCPReadError (String::compose ("Unknown MXF essence type %1 in %2", int(type), path.string()));
- }
- } else if (boost::filesystem::extension (path) == ".ttf") {
+ } 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)
+ ) {
+
+ other_assets.push_back (asset_factory(path, ignore_incorrect_picture_mxf_type));
+ } else if (*pkl_type == FontAsset::static_pkl_type(*_standard)) {
other_assets.push_back (shared_ptr<FontAsset> (new FontAsset (i->first, 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));
}
}
}
root->add_child("Index")->add_child_text ("1");
- doc.write_to_file (p.string (), "UTF-8");
+ doc.write_to_file_formatted (p.string (), "UTF-8");
}
void
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");
+ doc.write_to_file_formatted (p.string (), "UTF-8");
+ _asset_map = p;
}
/** Write all the XML files for this DCP.
i->write_xml (_directory / (name_format.get(values, "_" + i->id() + ".xml")), standard, signer);
}
- if (!_pkl) {
- _pkl.reset (new PKL (standard, metadata.annotation_text, metadata.issue_date, metadata.issuer, metadata.creator));
+ shared_ptr<PKL> pkl;
+
+ if (_pkls.empty()) {
+ pkl.reset (new PKL (standard, metadata.annotation_text, metadata.issue_date, metadata.issuer, metadata.creator));
+ _pkls.push_back (pkl);
BOOST_FOREACH (shared_ptr<Asset> i, assets ()) {
- i->add_to_pkl (_pkl, _directory);
+ i->add_to_pkl (pkl, _directory);
}
+ } else {
+ pkl = _pkls.front ();
}
NameFormat::Map values;
values['t'] = "pkl";
- boost::filesystem::path pkl_path = _directory / name_format.get(values, "_" + _pkl->id() + ".xml");
- _pkl->write (pkl_path, signer);
+ boost::filesystem::path pkl_path = _directory / name_format.get(values, "_" + pkl->id() + ".xml");
+ pkl->write (pkl_path, signer);
write_volindex (standard);
- write_assetmap (standard, _pkl->id(), pkl_path, metadata);
+ write_assetmap (standard, pkl->id(), pkl_path, metadata);
}
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;
}
projects / libdcp.git / blobdiff