/*
- Copyright (C) 2018 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2018-2020 Carl Hetherington <cth@carlh.net>
This file is part of libdcp.
#include "reel_picture_asset.h"
#include "reel_sound_asset.h"
#include "exceptions.h"
+#include "compose.hpp"
+#include "raw_convert.h"
+#include <xercesc/util/PlatformUtils.hpp>
+#include <xercesc/parsers/XercesDOMParser.hpp>
+#include <xercesc/parsers/AbstractDOMParser.hpp>
+#include <xercesc/sax/HandlerBase.hpp>
+#include <xercesc/dom/DOMImplementation.hpp>
+#include <xercesc/dom/DOMImplementationLS.hpp>
+#include <xercesc/dom/DOMImplementationRegistry.hpp>
+#include <xercesc/dom/DOMLSParser.hpp>
+#include <xercesc/dom/DOMException.hpp>
+#include <xercesc/dom/DOMDocument.hpp>
+#include <xercesc/dom/DOMNodeList.hpp>
+#include <xercesc/dom/DOMError.hpp>
+#include <xercesc/dom/DOMLocator.hpp>
+#include <xercesc/dom/DOMNamedNodeMap.hpp>
+#include <xercesc/dom/DOMAttr.hpp>
+#include <xercesc/dom/DOMErrorHandler.hpp>
+#include <xercesc/framework/LocalFileInputSource.hpp>
+#include <boost/noncopyable.hpp>
#include <boost/foreach.hpp>
+#include <boost/algorithm/string.hpp>
+#include <map>
#include <list>
#include <vector>
#include <iostream>
using std::vector;
using std::string;
using std::cout;
+using std::map;
using boost::shared_ptr;
using boost::optional;
using boost::function;
using namespace dcp;
+using namespace xercesc;
-static bool
-verify_asset (shared_ptr<ReelAsset> asset, function<void (float)> progress)
+enum Result {
+ RESULT_GOOD,
+ RESULT_CPL_PKL_DIFFER,
+ RESULT_BAD
+};
+
+static
+string
+xml_ch_to_string (XMLCh const * a)
+{
+ char* x = XMLString::transcode(a);
+ string const o(x);
+ XMLString::release(&x);
+ return o;
+}
+
+class XMLValidationError
+{
+public:
+ XMLValidationError (SAXParseException const & e)
+ : _message (xml_ch_to_string(e.getMessage()))
+ , _line (e.getLineNumber())
+ , _column (e.getColumnNumber())
+ {
+
+ }
+
+ string message () const {
+ return _message;
+ }
+
+ uint64_t line () const {
+ return _line;
+ }
+
+ uint64_t column () const {
+ return _column;
+ }
+
+private:
+ string _message;
+ uint64_t _line;
+ uint64_t _column;
+};
+
+
+class DCPErrorHandler : public ErrorHandler
+{
+public:
+ void warning(const SAXParseException& e)
+ {
+ maybe_add (XMLValidationError(e));
+ }
+
+ void error(const SAXParseException& e)
+ {
+ maybe_add (XMLValidationError(e));
+ }
+
+ void fatalError(const SAXParseException& e)
+ {
+ maybe_add (XMLValidationError(e));
+ }
+
+ void resetErrors() {
+ _errors.clear ();
+ }
+
+ list<XMLValidationError> errors () const {
+ return _errors;
+ }
+
+private:
+ void maybe_add (XMLValidationError e)
+ {
+ /* XXX: nasty hack */
+ if (
+ e.message().find("schema document") != string::npos &&
+ e.message().find("has different target namespace from the one specified in instance document") != string::npos
+ ) {
+ return;
+ }
+
+ _errors.push_back (e);
+ }
+
+ list<XMLValidationError> _errors;
+};
+
+class StringToXMLCh : public boost::noncopyable
+{
+public:
+ StringToXMLCh (string a)
+ {
+ _buffer = XMLString::transcode(a.c_str());
+ }
+
+ ~StringToXMLCh ()
+ {
+ XMLString::release (&_buffer);
+ }
+
+ XMLCh const * get () const {
+ return _buffer;
+ }
+
+private:
+ XMLCh* _buffer;
+};
+
+class LocalFileResolver : public EntityResolver
+{
+public:
+ LocalFileResolver (boost::filesystem::path xsd_dtd_directory)
+ : _xsd_dtd_directory (xsd_dtd_directory)
+ {
+ add("http://www.w3.org/2001/XMLSchema.dtd", "XMLSchema.dtd");
+ add("http://www.w3.org/2001/03/xml.xsd", "xml.xsd");
+ add("http://www.w3.org/TR/2002/REC-xmldsig-core-20020212/xmldsig-core-schema.xsd", "xmldsig-core-schema.xsd");
+ add("http://www.digicine.com/schemas/437-Y/2007/Main-Stereo-Picture-CPL.xsd", "Main-Stereo-Picture-CPL.xsd");
+ add("http://www.digicine.com/PROTO-ASDCP-CPL-20040511.xsd", "PROTO-ASDCP-CPL-20040511.xsd");
+ add("http://www.digicine.com/PROTO-ASDCP-PKL-20040311.xsd", "PROTO-ASDCP-PKL-20040311.xsd");
+ add("http://www.digicine.com/PROTO-ASDCP-AM-20040311.xsd", "PROTO-ASDCP-AM-20040311.xsd");
+ }
+
+ InputSource* resolveEntity(XMLCh const *, XMLCh const * system_id)
+ {
+ string system_id_str = xml_ch_to_string (system_id);
+ if (_files.find(system_id_str) == _files.end()) {
+ return 0;
+ }
+
+ boost::filesystem::path p = _xsd_dtd_directory / _files[system_id_str];
+ StringToXMLCh ch (p.string());
+ return new LocalFileInputSource(ch.get());
+ }
+
+private:
+ void add (string uri, string file)
+ {
+ _files[uri] = file;
+ }
+
+ std::map<string, string> _files;
+ boost::filesystem::path _xsd_dtd_directory;
+};
+
+static
+void
+validate_xml (boost::filesystem::path xml_file, boost::filesystem::path xsd_dtd_directory, list<VerificationNote>& notes)
{
- string actual_hash = asset->asset_ref()->hash(progress);
- optional<string> cpl_hash = asset->hash();
- DCP_ASSERT (cpl_hash);
- return actual_hash != *cpl_hash;
+ try {
+ XMLPlatformUtils::Initialize ();
+ } catch (XMLException& e) {
+ throw MiscError ("Failed to initialise xerces library");
+ }
+
+ DCPErrorHandler error_handler;
+
+ /* All the xerces objects in this scope must be destroyed before XMLPlatformUtils::Terminate() is called */
+ {
+ XercesDOMParser parser;
+ parser.setValidationScheme(XercesDOMParser::Val_Always);
+ parser.setDoNamespaces(true);
+ parser.setDoSchema(true);
+
+ map<string, string> schema;
+ schema["http://www.w3.org/2000/09/xmldsig#"] = "xmldsig-core-schema.xsd";
+ schema["http://www.w3.org/TR/2002/REC-xmldsig-core-20020212/xmldsig-core-schema.xsd"] = "xmldsig-core-schema.xsd";
+ schema["http://www.smpte-ra.org/schemas/429-7/2006/CPL"] = "SMPTE-429-7-2006-CPL.xsd";
+ schema["http://www.smpte-ra.org/schemas/429-8/2006/PKL"] = "SMPTE-429-8-2006-PKL.xsd";
+ schema["http://www.smpte-ra.org/schemas/429-9/2007/AM"] = "SMPTE-429-9-2007-AM.xsd";
+ schema["http://www.digicine.com/schemas/437-Y/2007/Main-Stereo-Picture-CPL.xsd"] = "Main-Stereo-Picture-CPL.xsd";
+ schema["http://www.digicine.com/PROTO-ASDCP-CPL-20040511#"] = "PROTO-ASDCP-CPL-20040511.xsd";
+ schema["http://www.digicine.com/PROTO-ASDCP-PKL-20040311#"] = "PROTO-ASDCP-PKL-20040311.xsd";
+ schema["http://www.digicine.com/PROTO-ASDCP-AM-20040311#"] = "PROTO-ASDCP-AM-20040311.xsd";
+
+ string locations;
+ for (map<string, string>::const_iterator i = schema.begin(); i != schema.end(); ++i) {
+ locations += i->first;
+ locations += " ";
+ boost::filesystem::path p = xsd_dtd_directory / i->second;
+ locations += p.string() + " ";
+ }
+
+ parser.setExternalSchemaLocation(locations.c_str());
+ parser.setValidationSchemaFullChecking(true);
+ parser.setErrorHandler(&error_handler);
+
+ LocalFileResolver resolver (xsd_dtd_directory);
+ parser.setEntityResolver(&resolver);
+
+ try {
+ parser.resetDocumentPool();
+ parser.parse(xml_file.string().c_str());
+ } catch (XMLException& e) {
+ throw MiscError(xml_ch_to_string(e.getMessage()));
+ } catch (DOMException& e) {
+ throw MiscError(xml_ch_to_string(e.getMessage()));
+ } catch (...) {
+ throw MiscError("Unknown exception from xerces");
+ }
+ }
+
+ XMLPlatformUtils::Terminate ();
+
+ BOOST_FOREACH (XMLValidationError i, error_handler.errors()) {
+ notes.push_back (
+ VerificationNote(
+ VerificationNote::VERIFY_ERROR,
+ VerificationNote::XML_VALIDATION_ERROR,
+ i.message(),
+ xml_file,
+ i.line()
+ )
+ );
+ }
+}
+
+static Result
+verify_asset (shared_ptr<DCP> dcp, shared_ptr<ReelMXF> reel_mxf, function<void (float)> progress)
+{
+ string const actual_hash = reel_mxf->asset_ref()->hash(progress);
+
+ list<shared_ptr<PKL> > pkls = dcp->pkls();
+ /* We've read this DCP in so it must have at least one PKL */
+ DCP_ASSERT (!pkls.empty());
+
+ shared_ptr<Asset> asset = reel_mxf->asset_ref().asset();
+
+ optional<string> pkl_hash;
+ BOOST_FOREACH (shared_ptr<PKL> i, pkls) {
+ pkl_hash = i->hash (reel_mxf->asset_ref()->id());
+ if (pkl_hash) {
+ break;
+ }
+ }
+
+ DCP_ASSERT (pkl_hash);
+
+ optional<string> cpl_hash = reel_mxf->hash();
+ if (cpl_hash && *cpl_hash != *pkl_hash) {
+ return RESULT_CPL_PKL_DIFFER;
+ }
+
+ if (actual_hash != *pkl_hash) {
+ return RESULT_BAD;
+ }
+
+ return RESULT_GOOD;
}
+
list<VerificationNote>
-dcp::verify (vector<boost::filesystem::path> directories, function<void (string, optional<boost::filesystem::path>)> stage, function<void (float)> progress)
+dcp::verify (
+ vector<boost::filesystem::path> directories,
+ function<void (string, optional<boost::filesystem::path>)> stage,
+ function<void (float)> progress,
+ boost::filesystem::path xsd_dtd_directory
+ )
{
+ xsd_dtd_directory = boost::filesystem::canonical (xsd_dtd_directory);
+
list<VerificationNote> notes;
list<shared_ptr<DCP> > dcps;
BOOST_FOREACH (shared_ptr<DCP> dcp, dcps) {
stage ("Checking DCP", dcp->directory());
- DCP::ReadErrors errors;
try {
- dcp->read (true, &errors);
+ dcp->read (¬es);
} catch (DCPReadError& e) {
- notes.push_back (VerificationNote (VerificationNote::VERIFY_ERROR, e.what ()));
+ notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::GENERAL_READ, string(e.what())));
} catch (XMLError& e) {
- notes.push_back (VerificationNote (VerificationNote::VERIFY_ERROR, e.what ()));
+ notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::GENERAL_READ, string(e.what())));
}
BOOST_FOREACH (shared_ptr<CPL> cpl, dcp->cpls()) {
stage ("Checking CPL", cpl->file());
+ validate_xml (cpl->file().get(), xsd_dtd_directory, notes);
+
+ /* Check that the CPL's hash corresponds to the PKL */
+ BOOST_FOREACH (shared_ptr<PKL> i, dcp->pkls()) {
+ optional<string> h = i->hash(cpl->id());
+ if (h && make_digest(Data(*cpl->file())) != *h) {
+ notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::CPL_HASH_INCORRECT));
+ }
+ }
+
BOOST_FOREACH (shared_ptr<Reel> reel, cpl->reels()) {
stage ("Checking reel", optional<boost::filesystem::path>());
+
+ BOOST_FOREACH (shared_ptr<ReelAsset> i, reel->assets()) {
+ if (i->duration() && (i->duration().get() * i->edit_rate().denominator / i->edit_rate().numerator) < 1) {
+ notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::DURATION_TOO_SMALL, i->id()));
+ }
+ if ((i->intrinsic_duration() * i->edit_rate().denominator / i->edit_rate().numerator) < 1) {
+ notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::INTRINSIC_DURATION_TOO_SMALL, i->id()));
+ }
+ }
+
if (reel->main_picture()) {
- stage ("Checking picture asset hash", reel->main_picture()->asset()->file());
- if (verify_asset (reel->main_picture(), progress)) {
- notes.push_back (VerificationNote (VerificationNote::VERIFY_ERROR, "Picture asset hash is incorrect."));
+ /* Check reel stuff */
+ Fraction const frame_rate = reel->main_picture()->frame_rate();
+ if (frame_rate.denominator != 1 ||
+ (frame_rate.numerator != 24 &&
+ frame_rate.numerator != 25 &&
+ frame_rate.numerator != 30 &&
+ frame_rate.numerator != 48 &&
+ frame_rate.numerator != 50 &&
+ frame_rate.numerator != 60 &&
+ frame_rate.numerator != 96)) {
+ notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::INVALID_PICTURE_FRAME_RATE));
+ }
+ /* Check asset */
+ if (reel->main_picture()->asset_ref().resolved()) {
+ stage ("Checking picture asset hash", reel->main_picture()->asset()->file());
+ Result const r = verify_asset (dcp, reel->main_picture(), progress);
+ switch (r) {
+ case RESULT_BAD:
+ notes.push_back (
+ VerificationNote(
+ VerificationNote::VERIFY_ERROR, VerificationNote::PICTURE_HASH_INCORRECT, *reel->main_picture()->asset()->file()
+ )
+ );
+ break;
+ case RESULT_CPL_PKL_DIFFER:
+ notes.push_back (
+ VerificationNote(
+ VerificationNote::VERIFY_ERROR, VerificationNote::PKL_CPL_PICTURE_HASHES_DISAGREE, *reel->main_picture()->asset()->file()
+ )
+ );
+ break;
+ default:
+ break;
+ }
}
}
- if (reel->main_sound()) {
+ if (reel->main_sound() && reel->main_sound()->asset_ref().resolved()) {
stage ("Checking sound asset hash", reel->main_sound()->asset()->file());
- if (verify_asset (reel->main_sound(), progress)) {
- notes.push_back (VerificationNote (VerificationNote::VERIFY_ERROR, "Sound asset hash is incorrect."));
+ Result const r = verify_asset (dcp, reel->main_sound(), progress);
+ switch (r) {
+ case RESULT_BAD:
+ notes.push_back (
+ VerificationNote(
+ VerificationNote::VERIFY_ERROR, VerificationNote::SOUND_HASH_INCORRECT, *reel->main_sound()->asset()->file()
+ )
+ );
+ break;
+ case RESULT_CPL_PKL_DIFFER:
+ notes.push_back (
+ VerificationNote(
+ VerificationNote::VERIFY_ERROR, VerificationNote::PKL_CPL_SOUND_HASHES_DISAGREE, *reel->main_sound()->asset()->file()
+ )
+ );
+ break;
+ default:
+ break;
}
}
}
}
+
+ BOOST_FOREACH (shared_ptr<PKL> pkl, dcp->pkls()) {
+ stage ("Checking PKL", pkl->file());
+ validate_xml (pkl->file().get(), xsd_dtd_directory, notes);
+ }
+
+ if (dcp->asset_map_path()) {
+ stage ("Checking ASSETMAP", dcp->asset_map_path().get());
+ validate_xml (dcp->asset_map_path().get(), xsd_dtd_directory, notes);
+ } else {
+ notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::MISSING_ASSETMAP));
+ }
}
return notes;
}
+
+string
+dcp::note_to_string (dcp::VerificationNote note)
+{
+ switch (note.code()) {
+ case dcp::VerificationNote::GENERAL_READ:
+ return *note.note();
+ case dcp::VerificationNote::CPL_HASH_INCORRECT:
+ return "The hash of the CPL in the PKL does not agree with the CPL file";
+ case dcp::VerificationNote::INVALID_PICTURE_FRAME_RATE:
+ return "The picture in a reel has an invalid frame rate";
+ case dcp::VerificationNote::PICTURE_HASH_INCORRECT:
+ return dcp::String::compose("The hash of the picture asset %1 does not agree with the PKL file", note.file()->filename());
+ case dcp::VerificationNote::PKL_CPL_PICTURE_HASHES_DISAGREE:
+ return dcp::String::compose("The PKL and CPL hashes disagree for the picture asset %1", note.file()->filename());
+ case dcp::VerificationNote::SOUND_HASH_INCORRECT:
+ return dcp::String::compose("The hash of the sound asset %1 does not agree with the PKL file", note.file()->filename());
+ case dcp::VerificationNote::PKL_CPL_SOUND_HASHES_DISAGREE:
+ return dcp::String::compose("The PKL and CPL hashes disagree for the sound asset %1", note.file()->filename());
+ case dcp::VerificationNote::EMPTY_ASSET_PATH:
+ return "The asset map contains an empty asset path.";
+ case dcp::VerificationNote::MISSING_ASSET:
+ return String::compose("The file for an asset in the asset map cannot be found; missing file is %1.", note.file()->filename());
+ case dcp::VerificationNote::MISMATCHED_STANDARD:
+ return "The DCP contains both SMPTE and Interop parts.";
+ case dcp::VerificationNote::XML_VALIDATION_ERROR:
+ return String::compose("An XML file is badly formed: %1 (%2:%3)", note.note().get(), note.file()->filename(), note.line().get());
+ case dcp::VerificationNote::MISSING_ASSETMAP:
+ return "No ASSETMAP or ASSETMAP.xml was found";
+ case dcp::VerificationNote::INTRINSIC_DURATION_TOO_SMALL:
+ return String::compose("The intrinsic duration of an asset is less than 1 second long: %1", note.note().get());
+ case dcp::VerificationNote::DURATION_TOO_SMALL:
+ return String::compose("The duration of an asset is less than 1 second long: %1", note.note().get());
+ }
+
+ return "";
+}
projects / libdcp.git / blobdiff