files in the program, then also delete it here.
*/
-#include "verify.h"
-#include "dcp.h"
+
+/** @file src/verify.cc
+ * @brief dcp::verify() method and associated code
+ */
+
+
+#include "compose.hpp"
#include "cpl.h"
+#include "dcp.h"
+#include "exceptions.h"
+#include "interop_subtitle_asset.h"
+#include "mono_picture_asset.h"
+#include "mono_picture_frame.h"
+#include "raw_convert.h"
#include "reel.h"
#include "reel_closed_caption_asset.h"
+#include "reel_interop_subtitle_asset.h"
+#include "reel_markers_asset.h"
#include "reel_picture_asset.h"
#include "reel_sound_asset.h"
+#include "reel_smpte_subtitle_asset.h"
#include "reel_subtitle_asset.h"
-#include "interop_subtitle_asset.h"
-#include "mono_picture_asset.h"
-#include "mono_picture_frame.h"
+#include "smpte_subtitle_asset.h"
#include "stereo_picture_asset.h"
#include "stereo_picture_frame.h"
-#include "exceptions.h"
-#include "compose.hpp"
-#include "raw_convert.h"
-#include "reel_markers_asset.h"
-#include "smpte_subtitle_asset.h"
-#include <xercesc/util/PlatformUtils.hpp>
-#include <xercesc/parsers/XercesDOMParser.hpp>
-#include <xercesc/parsers/AbstractDOMParser.hpp>
-#include <xercesc/sax/HandlerBase.hpp>
+#include "verify.h"
+#include "verify_j2k.h"
+#include <xercesc/dom/DOMAttr.hpp>
+#include <xercesc/dom/DOMDocument.hpp>
+#include <xercesc/dom/DOMError.hpp>
+#include <xercesc/dom/DOMErrorHandler.hpp>
+#include <xercesc/dom/DOMException.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/dom/DOMNodeList.hpp>
#include <xercesc/framework/LocalFileInputSource.hpp>
#include <xercesc/framework/MemBufInputSource.hpp>
-#include <boost/noncopyable.hpp>
+#include <xercesc/parsers/AbstractDOMParser.hpp>
+#include <xercesc/parsers/XercesDOMParser.hpp>
+#include <xercesc/sax/HandlerBase.hpp>
+#include <xercesc/util/PlatformUtils.hpp>
#include <boost/algorithm/string.hpp>
+#include <iostream>
#include <map>
#include <vector>
-#include <iostream>
+
using std::list;
using std::vector;
using boost::function;
using std::dynamic_pointer_cast;
+
using namespace dcp;
using namespace xercesc;
+
static
string
xml_ch_to_string (XMLCh const * a)
return o;
}
+
class XMLValidationError
{
public:
class DCPErrorHandler : public ErrorHandler
{
public:
- void warning(const SAXParseException& e)
+ void warning(const SAXParseException& e) override
{
maybe_add (XMLValidationError(e));
}
- void error(const SAXParseException& e)
+ void error(const SAXParseException& e) override
{
maybe_add (XMLValidationError(e));
}
- void fatalError(const SAXParseException& e)
+ void fatalError(const SAXParseException& e) override
{
maybe_add (XMLValidationError(e));
}
- void resetErrors() {
+ void resetErrors() override {
_errors.clear ();
}
list<XMLValidationError> _errors;
};
-class StringToXMLCh : public boost::noncopyable
+
+class StringToXMLCh
{
public:
StringToXMLCh (string a)
_buffer = XMLString::transcode(a.c_str());
}
+ StringToXMLCh (StringToXMLCh const&) = delete;
+ StringToXMLCh& operator= (StringToXMLCh const&) = delete;
+
~StringToXMLCh ()
{
XMLString::release (&_buffer);
XMLCh* _buffer;
};
+
class LocalFileResolver : public EntityResolver
{
public:
add("http://www.smpte-ra.org/schemas/429-10/2008/Main-Stereo-Picture-CPL", "SMPTE-429-10-2008.xsd");
}
- InputSource* resolveEntity(XMLCh const *, XMLCh const * system_id)
+ InputSource* resolveEntity(XMLCh const *, XMLCh const * system_id) override
{
if (!system_id) {
return 0;
for (auto i: error_handler.errors()) {
notes.push_back ({
- VerificationNote::VERIFY_ERROR,
- VerificationNote::INVALID_XML,
+ VerificationNote::Type::ERROR,
+ VerificationNote::Code::INVALID_XML,
i.message(),
boost::trim_copy(i.public_id() + " " + i.system_id()),
i.line()
}
-enum VerifyAssetResult {
- VERIFY_ASSET_RESULT_GOOD,
- VERIFY_ASSET_RESULT_CPL_PKL_DIFFER,
- VERIFY_ASSET_RESULT_BAD
+enum class VerifyAssetResult {
+ GOOD,
+ CPL_PKL_DIFFER,
+ BAD
};
static VerifyAssetResult
-verify_asset (shared_ptr<const DCP> dcp, shared_ptr<const ReelMXF> reel_mxf, function<void (float)> progress)
+verify_asset (shared_ptr<const DCP> dcp, shared_ptr<const ReelFileAsset> reel_file_asset, function<void (float)> progress)
{
- auto const actual_hash = reel_mxf->asset_ref()->hash(progress);
+ auto const actual_hash = reel_file_asset->asset_ref()->hash(progress);
auto pkls = dcp->pkls();
/* We've read this DCP in so it must have at least one PKL */
DCP_ASSERT (!pkls.empty());
- auto asset = reel_mxf->asset_ref().asset();
+ auto asset = reel_file_asset->asset_ref().asset();
optional<string> pkl_hash;
for (auto i: pkls) {
- pkl_hash = i->hash (reel_mxf->asset_ref()->id());
+ pkl_hash = i->hash (reel_file_asset->asset_ref()->id());
if (pkl_hash) {
break;
}
DCP_ASSERT (pkl_hash);
- auto cpl_hash = reel_mxf->hash();
+ auto cpl_hash = reel_file_asset->hash();
if (cpl_hash && *cpl_hash != *pkl_hash) {
- return VERIFY_ASSET_RESULT_CPL_PKL_DIFFER;
+ return VerifyAssetResult::CPL_PKL_DIFFER;
}
if (actual_hash != *pkl_hash) {
- return VERIFY_ASSET_RESULT_BAD;
+ return VerifyAssetResult::BAD;
}
- return VERIFY_ASSET_RESULT_GOOD;
+ return VerifyAssetResult::GOOD;
}
try {
LanguageTag test (tag);
} catch (LanguageTagError &) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::INVALID_LANGUAGE, tag});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_LANGUAGE, tag});
}
}
-enum VerifyPictureAssetResult
-{
- VERIFY_PICTURE_ASSET_RESULT_GOOD,
- VERIFY_PICTURE_ASSET_RESULT_FRAME_NEARLY_TOO_LARGE,
- VERIFY_PICTURE_ASSET_RESULT_BAD,
-};
-
-
-int
-biggest_frame_size (shared_ptr<const MonoPictureFrame> frame)
-{
- return frame->size ();
-}
-
-int
-biggest_frame_size (shared_ptr<const StereoPictureFrame> frame)
+static void
+verify_picture_asset (shared_ptr<const ReelFileAsset> reel_file_asset, boost::filesystem::path file, vector<VerificationNote>& notes, function<void (float)> progress)
{
- return max(frame->left()->size(), frame->right()->size());
-}
+ int biggest_frame = 0;
+ auto asset = dynamic_pointer_cast<PictureAsset>(reel_file_asset->asset_ref().asset());
+ auto const duration = asset->intrinsic_duration ();
+ auto check_and_add = [¬es](vector<VerificationNote> const& j2k_notes) {
+ for (auto i: j2k_notes) {
+ if (find(notes.begin(), notes.end(), i) == notes.end()) {
+ notes.push_back (i);
+ }
+ }
+ };
-template <class A, class R, class F>
-optional<VerifyPictureAssetResult>
-verify_picture_asset_type (shared_ptr<const ReelMXF> reel_mxf, function<void (float)> progress)
-{
- auto asset = dynamic_pointer_cast<A>(reel_mxf->asset_ref().asset());
- if (!asset) {
- return optional<VerifyPictureAssetResult>();
- }
+ if (auto mono_asset = dynamic_pointer_cast<MonoPictureAsset>(reel_file_asset->asset_ref().asset())) {
+ auto reader = mono_asset->start_read ();
+ for (int64_t i = 0; i < duration; ++i) {
+ auto frame = reader->get_frame (i);
+ biggest_frame = max(biggest_frame, frame->size());
+ if (!mono_asset->encrypted() || mono_asset->key()) {
+ vector<VerificationNote> j2k_notes;
+ verify_j2k (frame, j2k_notes);
+ check_and_add (j2k_notes);
+ }
+ progress (float(i) / duration);
+ }
+ } else if (auto stereo_asset = dynamic_pointer_cast<StereoPictureAsset>(asset)) {
+ auto reader = stereo_asset->start_read ();
+ for (int64_t i = 0; i < duration; ++i) {
+ auto frame = reader->get_frame (i);
+ biggest_frame = max(biggest_frame, max(frame->left()->size(), frame->right()->size()));
+ if (!stereo_asset->encrypted() || mono_asset->key()) {
+ vector<VerificationNote> j2k_notes;
+ verify_j2k (frame->left(), j2k_notes);
+ verify_j2k (frame->right(), j2k_notes);
+ check_and_add (j2k_notes);
+ }
+ progress (float(i) / duration);
+ }
- int biggest_frame = 0;
- auto reader = asset->start_read ();
- auto const duration = asset->intrinsic_duration ();
- for (int64_t i = 0; i < duration; ++i) {
- shared_ptr<const F> frame = reader->get_frame (i);
- biggest_frame = max(biggest_frame, biggest_frame_size(frame));
- progress (float(i) / duration);
}
static const int max_frame = rint(250 * 1000000 / (8 * asset->edit_rate().as_float()));
static const int risky_frame = rint(230 * 1000000 / (8 * asset->edit_rate().as_float()));
if (biggest_frame > max_frame) {
- return VERIFY_PICTURE_ASSET_RESULT_BAD;
+ notes.push_back ({
+ VerificationNote::Type::ERROR, VerificationNote::Code::INVALID_PICTURE_FRAME_SIZE_IN_BYTES, file
+ });
} else if (biggest_frame > risky_frame) {
- return VERIFY_PICTURE_ASSET_RESULT_FRAME_NEARLY_TOO_LARGE;
- }
-
- return VERIFY_PICTURE_ASSET_RESULT_GOOD;
-}
-
-
-static VerifyPictureAssetResult
-verify_picture_asset (shared_ptr<const ReelMXF> reel_mxf, function<void (float)> progress)
-{
- auto r = verify_picture_asset_type<MonoPictureAsset, MonoPictureAssetReader, MonoPictureFrame>(reel_mxf, progress);
- if (!r) {
- r = verify_picture_asset_type<StereoPictureAsset, StereoPictureAssetReader, StereoPictureFrame>(reel_mxf, progress);
+ notes.push_back ({
+ VerificationNote::Type::WARNING, VerificationNote::Code::NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES, file
+ });
}
-
- DCP_ASSERT (r);
- return *r;
}
stage ("Checking picture asset hash", file);
auto const r = verify_asset (dcp, reel_asset, progress);
switch (r) {
- case VERIFY_ASSET_RESULT_BAD:
+ case VerifyAssetResult::BAD:
notes.push_back ({
- VerificationNote::VERIFY_ERROR, VerificationNote::INCORRECT_PICTURE_HASH, file
+ VerificationNote::Type::ERROR, VerificationNote::Code::INCORRECT_PICTURE_HASH, file
});
break;
- case VERIFY_ASSET_RESULT_CPL_PKL_DIFFER:
+ case VerifyAssetResult::CPL_PKL_DIFFER:
notes.push_back ({
- VerificationNote::VERIFY_ERROR, VerificationNote::MISMATCHED_PICTURE_HASHES, file
+ VerificationNote::Type::ERROR, VerificationNote::Code::MISMATCHED_PICTURE_HASHES, file
});
break;
default:
break;
}
stage ("Checking picture frame sizes", asset->file());
- auto const pr = verify_picture_asset (reel_asset, progress);
- switch (pr) {
- case VERIFY_PICTURE_ASSET_RESULT_BAD:
- notes.push_back ({
- VerificationNote::VERIFY_ERROR, VerificationNote::INVALID_PICTURE_FRAME_SIZE_IN_BYTES, file
- });
- break;
- case VERIFY_PICTURE_ASSET_RESULT_FRAME_NEARLY_TOO_LARGE:
- notes.push_back ({
- VerificationNote::VERIFY_WARNING, VerificationNote::NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES, file
- });
- break;
- default:
- break;
- }
+ verify_picture_asset (reel_asset, file, notes, progress);
/* Only flat/scope allowed by Bv2.1 */
if (
asset->size() != Size(4096, 1716) &&
asset->size() != Size(3996, 2160)) {
notes.push_back({
- VerificationNote::VERIFY_BV21_ERROR,
- VerificationNote::INVALID_PICTURE_SIZE_IN_PIXELS,
+ VerificationNote::Type::BV21_ERROR,
+ VerificationNote::Code::INVALID_PICTURE_SIZE_IN_PIXELS,
String::compose("%1x%2", asset->size().width, asset->size().height),
file
});
(asset->edit_rate() != Fraction(24, 1) && asset->edit_rate() != Fraction(25, 1) && asset->edit_rate() != Fraction(48, 1))
) {
notes.push_back({
- VerificationNote::VERIFY_BV21_ERROR,
- VerificationNote::INVALID_PICTURE_FRAME_RATE_FOR_2K,
+ VerificationNote::Type::BV21_ERROR,
+ VerificationNote::Code::INVALID_PICTURE_FRAME_RATE_FOR_2K,
String::compose("%1/%2", asset->edit_rate().numerator, asset->edit_rate().denominator),
file
});
/* Only 24fps allowed for 4K */
if (asset->edit_rate() != Fraction(24, 1)) {
notes.push_back({
- VerificationNote::VERIFY_BV21_ERROR,
- VerificationNote::INVALID_PICTURE_FRAME_RATE_FOR_4K,
+ VerificationNote::Type::BV21_ERROR,
+ VerificationNote::Code::INVALID_PICTURE_FRAME_RATE_FOR_4K,
String::compose("%1/%2", asset->edit_rate().numerator, asset->edit_rate().denominator),
file
});
/* Only 2D allowed for 4K */
if (dynamic_pointer_cast<const StereoPictureAsset>(asset)) {
notes.push_back({
- VerificationNote::VERIFY_BV21_ERROR,
- VerificationNote::INVALID_PICTURE_ASSET_RESOLUTION_FOR_3D,
+ VerificationNote::Type::BV21_ERROR,
+ VerificationNote::Code::INVALID_PICTURE_ASSET_RESOLUTION_FOR_3D,
String::compose("%1/%2", asset->edit_rate().numerator, asset->edit_rate().denominator),
file
});
stage ("Checking sound asset hash", asset->file());
auto const r = verify_asset (dcp, reel_asset, progress);
switch (r) {
- case VERIFY_ASSET_RESULT_BAD:
- notes.push_back ({VerificationNote::VERIFY_ERROR, VerificationNote::INCORRECT_SOUND_HASH, *asset->file()});
+ case VerifyAssetResult::BAD:
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::INCORRECT_SOUND_HASH, *asset->file()});
break;
- case VERIFY_ASSET_RESULT_CPL_PKL_DIFFER:
- notes.push_back ({VerificationNote::VERIFY_ERROR, VerificationNote::MISMATCHED_SOUND_HASHES, *asset->file()});
+ case VerifyAssetResult::CPL_PKL_DIFFER:
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::MISMATCHED_SOUND_HASHES, *asset->file()});
break;
default:
break;
stage ("Checking sound asset metadata", asset->file());
- verify_language_tag (asset->language(), notes);
+ if (auto lang = asset->language()) {
+ verify_language_tag (*lang, notes);
+ }
if (asset->sampling_rate() != 48000) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::INVALID_SOUND_FRAME_RATE, raw_convert<string>(asset->sampling_rate()), *asset->file()});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_SOUND_FRAME_RATE, raw_convert<string>(asset->sampling_rate()), *asset->file()});
}
}
}
if (!reel_asset->entry_point()) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_SUBTITLE_ENTRY_POINT, reel_asset->id() });
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_SUBTITLE_ENTRY_POINT, reel_asset->id() });
} else if (reel_asset->entry_point().get()) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::INCORRECT_SUBTITLE_ENTRY_POINT, reel_asset->id() });
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INCORRECT_SUBTITLE_ENTRY_POINT, reel_asset->id() });
}
}
}
if (!reel_asset->entry_point()) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_CLOSED_CAPTION_ENTRY_POINT, reel_asset->id() });
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_CLOSED_CAPTION_ENTRY_POINT, reel_asset->id() });
} else if (reel_asset->entry_point().get()) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::INCORRECT_CLOSED_CAPTION_ENTRY_POINT, reel_asset->id() });
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INCORRECT_CLOSED_CAPTION_ENTRY_POINT, reel_asset->id() });
}
}
};
-
+/** Verify stuff that is common to both subtitles and closed captions */
void
-verify_smpte_subtitle_asset (
+verify_smpte_timed_text_asset (
shared_ptr<const SMPTESubtitleAsset> asset,
- vector<VerificationNote>& notes,
- State& state
+ optional<int64_t> reel_asset_duration,
+ vector<VerificationNote>& notes
)
{
if (asset->language()) {
- auto const language = *asset->language();
- verify_language_tag (language, notes);
- if (!state.subtitle_language) {
- state.subtitle_language = language;
- } else if (state.subtitle_language != language) {
- notes.push_back ({ VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISMATCHED_SUBTITLE_LANGUAGES });
- }
+ verify_language_tag (*asset->language(), notes);
} else {
- notes.push_back ({ VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_SUBTITLE_LANGUAGE, *asset->file() });
+ notes.push_back ({ VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE, *asset->file() });
}
+
auto const size = boost::filesystem::file_size(asset->file().get());
if (size > 115 * 1024 * 1024) {
notes.push_back (
- { VerificationNote::VERIFY_BV21_ERROR, VerificationNote::INVALID_TIMED_TEXT_SIZE_IN_BYTES, raw_convert<string>(size), *asset->file() }
+ { VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_TIMED_TEXT_SIZE_IN_BYTES, raw_convert<string>(size), *asset->file() }
);
}
+
/* XXX: I'm not sure what Bv2.1_7.2.1 means when it says "the font resource shall not be larger than 10MB"
* but I'm hoping that checking for the total size of all fonts being <= 10MB will do.
*/
total_size += i.second.size();
}
if (total_size > 10 * 1024 * 1024) {
- notes.push_back ({ VerificationNote::VERIFY_BV21_ERROR, VerificationNote::INVALID_TIMED_TEXT_FONT_SIZE_IN_BYTES, raw_convert<string>(total_size), asset->file().get() });
+ notes.push_back ({ VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_TIMED_TEXT_FONT_SIZE_IN_BYTES, raw_convert<string>(total_size), asset->file().get() });
}
if (!asset->start_time()) {
- notes.push_back ({ VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_SUBTITLE_START_TIME, asset->file().get() });
+ notes.push_back ({ VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_SUBTITLE_START_TIME, asset->file().get() });
} else if (asset->start_time() != Time()) {
- notes.push_back ({ VerificationNote::VERIFY_BV21_ERROR, VerificationNote::INVALID_SUBTITLE_START_TIME, asset->file().get() });
+ notes.push_back ({ VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_SUBTITLE_START_TIME, asset->file().get() });
+ }
+
+ if (reel_asset_duration && *reel_asset_duration != asset->intrinsic_duration()) {
+ notes.push_back (
+ {
+ VerificationNote::Type::BV21_ERROR,
+ VerificationNote::Code::MISMATCHED_TIMED_TEXT_DURATION,
+ String::compose("%1 %2", *reel_asset_duration, asset->intrinsic_duration()),
+ asset->file().get()
+ });
+ }
+}
+
+
+/** Verify SMPTE subtitle-only stuff */
+void
+verify_smpte_subtitle_asset (
+ shared_ptr<const SMPTESubtitleAsset> asset,
+ vector<VerificationNote>& notes,
+ State& state
+ )
+{
+ if (asset->language()) {
+ if (!state.subtitle_language) {
+ state.subtitle_language = *asset->language();
+ } else if (state.subtitle_language != *asset->language()) {
+ notes.push_back ({ VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISMATCHED_SUBTITLE_LANGUAGES });
+ }
+ }
+
+ DCP_ASSERT (asset->resource_id());
+ auto xml_id = asset->xml_id();
+ if (xml_id) {
+ if (asset->resource_id().get() != xml_id) {
+ notes.push_back ({ VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISMATCHED_TIMED_TEXT_RESOURCE_ID });
+ }
+
+ if (asset->id() == asset->resource_id().get() || asset->id() == xml_id) {
+ notes.push_back ({ VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INCORRECT_TIMED_TEXT_ASSET_ID });
+ }
+ } else {
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::MISSED_CHECK_OF_ENCRYPTED});
}
}
+/** Verify all subtitle stuff */
static void
verify_subtitle_asset (
shared_ptr<const SubtitleAsset> asset,
+ optional<int64_t> reel_asset_duration,
function<void (string, optional<boost::filesystem::path>)> stage,
boost::filesystem::path xsd_dtd_directory,
vector<VerificationNote>& notes,
/* Note: we must not use SubtitleAsset::xml_as_string() here as that will mean the data on disk
* gets passed through libdcp which may clean up and therefore hide errors.
*/
- validate_xml (asset->raw_xml(), xsd_dtd_directory, notes);
+ if (asset->raw_xml()) {
+ validate_xml (asset->raw_xml().get(), xsd_dtd_directory, notes);
+ } else {
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::MISSED_CHECK_OF_ENCRYPTED});
+ }
auto smpte = dynamic_pointer_cast<const SMPTESubtitleAsset>(asset);
if (smpte) {
+ verify_smpte_timed_text_asset (smpte, reel_asset_duration, notes);
verify_smpte_subtitle_asset (smpte, notes, state);
}
}
+/** Verify all closed caption stuff */
static void
verify_closed_caption_asset (
shared_ptr<const SubtitleAsset> asset,
+ optional<int64_t> reel_asset_duration,
function<void (string, optional<boost::filesystem::path>)> stage,
boost::filesystem::path xsd_dtd_directory,
- vector<VerificationNote>& notes,
- State& state
+ vector<VerificationNote>& notes
)
{
- verify_subtitle_asset (asset, stage, xsd_dtd_directory, notes, state);
+ stage ("Checking closed caption XML", asset->file());
+ /* Note: we must not use SubtitleAsset::xml_as_string() here as that will mean the data on disk
+ * gets passed through libdcp which may clean up and therefore hide errors.
+ */
+ auto raw_xml = asset->raw_xml();
+ if (raw_xml) {
+ validate_xml (*raw_xml, xsd_dtd_directory, notes);
+ if (raw_xml->size() > 256 * 1024) {
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_CLOSED_CAPTION_XML_SIZE_IN_BYTES, raw_convert<string>(raw_xml->size()), *asset->file()});
+ }
+ } else {
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::MISSED_CHECK_OF_ENCRYPTED});
+ }
- if (asset->raw_xml().size() > 256 * 1024) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::INVALID_CLOSED_CAPTION_XML_SIZE_IN_BYTES, raw_convert<string>(asset->raw_xml().size()), *asset->file()});
+ auto smpte = dynamic_pointer_cast<const SMPTESubtitleAsset>(asset);
+ if (smpte) {
+ verify_smpte_timed_text_asset (smpte, reel_asset_duration, notes);
}
}
void
verify_text_timing (
vector<shared_ptr<Reel>> reels,
- optional<int> picture_frame_rate,
+ int edit_rate,
vector<VerificationNote>& notes,
std::function<bool (shared_ptr<Reel>)> check,
- std::function<string (shared_ptr<Reel>)> xml,
+ std::function<optional<string> (shared_ptr<Reel>)> xml,
std::function<int64_t (shared_ptr<Reel>)> duration
)
{
auto too_short = false;
auto too_close = false;
auto too_early = false;
+ auto reel_overlap = false;
/* current reel start time (in editable units) */
int64_t reel_offset = 0;
- std::function<void (cxml::ConstNodePtr, int, int, bool)> parse;
- parse = [&parse, &last_out, &too_short, &too_close, &too_early, &reel_offset](cxml::ConstNodePtr node, int tcr, int pfr, bool first_reel) {
+ std::function<void (cxml::ConstNodePtr, optional<int>, optional<Time>, int, bool)> parse;
+ parse = [&parse, &last_out, &too_short, &too_close, &too_early, &reel_offset](cxml::ConstNodePtr node, optional<int> tcr, optional<Time> start_time, int er, bool first_reel) {
if (node->name() == "Subtitle") {
Time in (node->string_attribute("TimeIn"), tcr);
+ if (start_time) {
+ in -= *start_time;
+ }
Time out (node->string_attribute("TimeOut"), tcr);
- if (first_reel && in < Time(0, 0, 4, 0, tcr)) {
+ if (start_time) {
+ out -= *start_time;
+ }
+ if (first_reel && tcr && in < Time(0, 0, 4, 0, *tcr)) {
too_early = true;
}
auto length = out - in;
- if (length.as_editable_units(pfr) < 15) {
+ if (length.as_editable_units_ceil(er) < 15) {
too_short = true;
}
if (last_out) {
/* XXX: this feels dubious - is it really what Bv2.1 means? */
- auto distance = reel_offset + in.as_editable_units(pfr) - *last_out;
+ auto distance = reel_offset + in.as_editable_units_ceil(er) - *last_out;
if (distance >= 0 && distance < 2) {
too_close = true;
}
}
- last_out = reel_offset + out.as_editable_units(pfr);
+ last_out = reel_offset + out.as_editable_units_floor(er);
} else {
for (auto i: node->node_children()) {
- parse(i, tcr, pfr, first_reel);
+ parse(i, tcr, start_time, er, first_reel);
}
}
};
continue;
}
+ auto reel_xml = xml(reels[i]);
+ if (!reel_xml) {
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::MISSED_CHECK_OF_ENCRYPTED});
+ continue;
+ }
+
/* We need to look at <Subtitle> instances in the XML being checked, so we can't use the subtitles
* read in by libdcp's parser.
*/
- auto doc = make_shared<cxml::Document>("SubtitleReel");
- doc->read_string (xml(reels[i]));
- auto const tcr = doc->number_child<int>("TimeCodeRate");
- parse (doc, tcr, picture_frame_rate.get_value_or(24), i == 0);
- reel_offset += duration(reels[i]);
+ shared_ptr<cxml::Document> doc;
+ optional<int> tcr;
+ optional<Time> start_time;
+ try {
+ doc = make_shared<cxml::Document>("SubtitleReel");
+ doc->read_string (*reel_xml);
+ tcr = doc->number_child<int>("TimeCodeRate");
+ auto start_time_string = doc->optional_string_child("StartTime");
+ if (start_time_string) {
+ start_time = Time(*start_time_string, tcr);
+ }
+ } catch (...) {
+ doc = make_shared<cxml::Document>("DCSubtitle");
+ doc->read_string (*reel_xml);
+ }
+ parse (doc, tcr, start_time, edit_rate, i == 0);
+ auto end = reel_offset + duration(reels[i]);
+ if (last_out && *last_out > end) {
+ reel_overlap = true;
+ }
+ reel_offset = end;
+ }
+
+ if (last_out && *last_out > reel_offset) {
+ reel_overlap = true;
}
if (too_early) {
notes.push_back({
- VerificationNote::VERIFY_WARNING, VerificationNote::INVALID_SUBTITLE_FIRST_TEXT_TIME
+ VerificationNote::Type::WARNING, VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME
});
}
if (too_short) {
notes.push_back ({
- VerificationNote::VERIFY_WARNING, VerificationNote::INVALID_SUBTITLE_DURATION
+ VerificationNote::Type::WARNING, VerificationNote::Code::INVALID_SUBTITLE_DURATION
});
}
if (too_close) {
notes.push_back ({
- VerificationNote::VERIFY_WARNING, VerificationNote::INVALID_SUBTITLE_SPACING
+ VerificationNote::Type::WARNING, VerificationNote::Code::INVALID_SUBTITLE_SPACING
+ });
+ }
+
+ if (reel_overlap) {
+ notes.push_back ({
+ VerificationNote::Type::ERROR, VerificationNote::Code::SUBTITLE_OVERLAPS_REEL_BOUNDARY
});
}
}
return;
}
- optional<int> picture_frame_rate;
- if (reels[0]->main_picture()) {
- picture_frame_rate = reels[0]->main_picture()->frame_rate().numerator;
- }
-
if (reels[0]->main_subtitle()) {
- verify_text_timing (reels, picture_frame_rate, notes,
+ verify_text_timing (reels, reels[0]->main_subtitle()->edit_rate().numerator, notes,
[](shared_ptr<Reel> reel) {
return static_cast<bool>(reel->main_subtitle());
},
[](shared_ptr<Reel> reel) {
- return reel->main_subtitle()->asset()->raw_xml();
+ auto interop = dynamic_pointer_cast<ReelInteropSubtitleAsset>(reel->main_subtitle());
+ if (interop) {
+ return interop->asset()->raw_xml();
+ }
+ auto smpte = dynamic_pointer_cast<ReelSMPTESubtitleAsset>(reel->main_subtitle());
+ DCP_ASSERT (smpte);
+ return smpte->asset()->raw_xml();
},
[](shared_ptr<Reel> reel) {
return reel->main_subtitle()->actual_duration();
}
for (auto i = 0U; i < reels[0]->closed_captions().size(); ++i) {
- verify_text_timing (reels, picture_frame_rate, notes,
+ verify_text_timing (reels, reels[0]->closed_captions()[i]->edit_rate().numerator, notes,
[i](shared_ptr<Reel> reel) {
return i < reel->closed_captions().size();
},
}
if (missing) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_EXTENSION_METADATA, cpl->id(), cpl->file().get()});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_EXTENSION_METADATA, cpl->id(), cpl->file().get()});
} else if (!malformed.empty()) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::INVALID_EXTENSION_METADATA, malformed, cpl->file().get()});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_EXTENSION_METADATA, malformed, cpl->file().get()});
}
}
{
vector<string> encrypted;
for (auto i: dcp->cpls()) {
- for (auto j: i->reel_mxfs()) {
+ for (auto j: i->reel_file_assets()) {
if (j->asset_ref().resolved()) {
- /* It's a bit surprising / broken but Interop subtitle assets are represented
- * in reels by ReelSubtitleAsset which inherits ReelMXF, so it's possible for
- * ReelMXFs to have assets which are not MXFs.
- */
- if (auto asset = dynamic_pointer_cast<MXF>(j->asset_ref().asset())) {
- if (asset->encrypted()) {
- encrypted.push_back(j->asset_ref().id());
- }
+ auto mxf = dynamic_pointer_cast<MXF>(j->asset_ref().asset());
+ if (mxf && mxf->encrypted()) {
+ encrypted.push_back(j->asset_ref().id());
}
}
}
vector<boost::filesystem::path> directories,
function<void (string, optional<boost::filesystem::path>)> stage,
function<void (float)> progress,
- boost::filesystem::path xsd_dtd_directory
+ optional<boost::filesystem::path> xsd_dtd_directory
)
{
- xsd_dtd_directory = boost::filesystem::canonical (xsd_dtd_directory);
+ if (!xsd_dtd_directory) {
+ xsd_dtd_directory = resources_directory() / "xsd";
+ }
+ *xsd_dtd_directory = boost::filesystem::canonical (*xsd_dtd_directory);
vector<VerificationNote> notes;
State state{};
vector<shared_ptr<DCP>> dcps;
for (auto i: directories) {
- dcps.push_back (shared_ptr<DCP> (new DCP (i)));
+ dcps.push_back (make_shared<DCP>(i));
}
for (auto dcp: dcps) {
stage ("Checking DCP", dcp->directory());
+ bool carry_on = true;
try {
- dcp->read (¬es);
+ dcp->read (¬es, true);
+ } catch (MissingAssetmapError& e) {
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
+ carry_on = false;
} catch (ReadError& e) {
- notes.push_back ({VerificationNote::VERIFY_ERROR, VerificationNote::FAILED_READ, string(e.what())});
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
} catch (XMLError& e) {
- notes.push_back ({VerificationNote::VERIFY_ERROR, VerificationNote::FAILED_READ, string(e.what())});
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
} catch (MXFFileError& e) {
- notes.push_back ({VerificationNote::VERIFY_ERROR, VerificationNote::FAILED_READ, string(e.what())});
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
} catch (cxml::Error& e) {
- notes.push_back ({VerificationNote::VERIFY_ERROR, VerificationNote::FAILED_READ, string(e.what())});
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
+ }
+
+ if (!carry_on) {
+ continue;
}
if (dcp->standard() != Standard::SMPTE) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::INVALID_STANDARD});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_STANDARD});
}
for (auto cpl: dcp->cpls()) {
stage ("Checking CPL", cpl->file());
- validate_xml (cpl->file().get(), xsd_dtd_directory, notes);
+ validate_xml (cpl->file().get(), *xsd_dtd_directory, notes);
if (cpl->any_encrypted() && !cpl->all_encrypted()) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::PARTIALLY_ENCRYPTED});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::PARTIALLY_ENCRYPTED});
}
for (auto const& i: cpl->additional_subtitle_languages()) {
LanguageTag::RegionSubtag test (terr);
} catch (...) {
if (terr != "001") {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::INVALID_LANGUAGE, terr});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_LANGUAGE, terr});
}
}
}
if (dcp->standard() == Standard::SMPTE) {
if (!cpl->annotation_text()) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_CPL_ANNOTATION_TEXT, cpl->id(), cpl->file().get()});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_CPL_ANNOTATION_TEXT, cpl->id(), cpl->file().get()});
} else if (cpl->annotation_text().get() != cpl->content_title_text()) {
- notes.push_back ({VerificationNote::VERIFY_WARNING, VerificationNote::MISMATCHED_CPL_ANNOTATION_TEXT, cpl->id(), cpl->file().get()});
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::MISMATCHED_CPL_ANNOTATION_TEXT, cpl->id(), cpl->file().get()});
}
}
/* Check that the CPL's hash corresponds to the PKL */
optional<string> h = i->hash(cpl->id());
if (h && make_digest(ArrayData(*cpl->file())) != *h) {
- notes.push_back ({VerificationNote::VERIFY_ERROR, VerificationNote::MISMATCHED_CPL_HASHES, cpl->id(), cpl->file().get()});
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::MISMATCHED_CPL_HASHES, cpl->id(), cpl->file().get()});
}
/* Check that any PKL with a single CPL has its AnnotationText the same as the CPL's ContentTitleText */
}
if (required_annotation_text && i->annotation_text() != required_annotation_text) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISMATCHED_PKL_ANNOTATION_TEXT_WITH_CPL, i->id(), i->file().get()});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISMATCHED_PKL_ANNOTATION_TEXT_WITH_CPL, i->id(), i->file().get()});
}
}
for (auto i: reel->assets()) {
if (i->duration() && (i->duration().get() * i->edit_rate().denominator / i->edit_rate().numerator) < 1) {
- notes.push_back ({VerificationNote::VERIFY_ERROR, VerificationNote::INVALID_DURATION, i->id()});
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::INVALID_DURATION, i->id()});
}
if ((i->intrinsic_duration() * i->edit_rate().denominator / i->edit_rate().numerator) < 1) {
- notes.push_back ({VerificationNote::VERIFY_ERROR, VerificationNote::INVALID_INTRINSIC_DURATION, i->id()});
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::INVALID_INTRINSIC_DURATION, i->id()});
}
- auto mxf = dynamic_pointer_cast<ReelMXF>(i);
- if (mxf && !mxf->hash()) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_HASH, i->id()});
+ auto file_asset = dynamic_pointer_cast<ReelFileAsset>(i);
+ if (i->encryptable() && !file_asset->hash()) {
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_HASH, i->id()});
}
}
if (!duration) {
duration = i->actual_duration();
} else if (*duration != i->actual_duration()) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISMATCHED_ASSET_DURATION});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISMATCHED_ASSET_DURATION});
break;
}
}
frame_rate.numerator != 60 &&
frame_rate.numerator != 96)) {
notes.push_back ({
- VerificationNote::VERIFY_ERROR,
- VerificationNote::INVALID_PICTURE_FRAME_RATE,
+ VerificationNote::Type::ERROR,
+ VerificationNote::Code::INVALID_PICTURE_FRAME_RATE,
String::compose("%1/%2", frame_rate.numerator, frame_rate.denominator)
});
}
if (reel->main_subtitle()) {
verify_main_subtitle_reel (reel->main_subtitle(), notes);
if (reel->main_subtitle()->asset_ref().resolved()) {
- verify_subtitle_asset (reel->main_subtitle()->asset(), stage, xsd_dtd_directory, notes, state);
+ verify_subtitle_asset (reel->main_subtitle()->asset(), reel->main_subtitle()->duration(), stage, *xsd_dtd_directory, notes, state);
}
have_main_subtitle = true;
} else {
for (auto i: reel->closed_captions()) {
verify_closed_caption_reel (i, notes);
if (i->asset_ref().resolved()) {
- verify_closed_caption_asset (i->asset(), stage, xsd_dtd_directory, notes, state);
+ verify_closed_caption_asset (i->asset(), i->duration(), stage, *xsd_dtd_directory, notes);
}
}
most_closed_captions = std::max (most_closed_captions, reel->closed_captions().size());
}
+ verify_text_timing (cpl->reels(), notes);
+
if (dcp->standard() == Standard::SMPTE) {
if (have_main_subtitle && have_no_main_subtitle) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_MAIN_SUBTITLE_FROM_SOME_REELS});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_MAIN_SUBTITLE_FROM_SOME_REELS});
}
if (fewest_closed_captions != most_closed_captions) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISMATCHED_CLOSED_CAPTION_ASSET_COUNTS});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISMATCHED_CLOSED_CAPTION_ASSET_COUNTS});
}
if (cpl->content_kind() == ContentKind::FEATURE) {
if (markers_seen.find(Marker::FFEC) == markers_seen.end()) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_FFEC_IN_FEATURE});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_FFEC_IN_FEATURE});
}
if (markers_seen.find(Marker::FFMC) == markers_seen.end()) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_FFMC_IN_FEATURE});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_FFMC_IN_FEATURE});
}
}
auto ffoc = markers_seen.find(Marker::FFOC);
if (ffoc == markers_seen.end()) {
- notes.push_back ({VerificationNote::VERIFY_WARNING, VerificationNote::MISSING_FFOC});
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::MISSING_FFOC});
} else if (ffoc->second.e != 1) {
- notes.push_back ({VerificationNote::VERIFY_WARNING, VerificationNote::INCORRECT_FFOC, raw_convert<string>(ffoc->second.e)});
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::INCORRECT_FFOC, raw_convert<string>(ffoc->second.e)});
}
auto lfoc = markers_seen.find(Marker::LFOC);
if (lfoc == markers_seen.end()) {
- notes.push_back ({VerificationNote::VERIFY_WARNING, VerificationNote::MISSING_LFOC});
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::MISSING_LFOC});
} else {
- auto lfoc_time = lfoc->second.as_editable_units(lfoc->second.tcr);
+ auto lfoc_time = lfoc->second.as_editable_units_ceil(lfoc->second.tcr);
if (lfoc_time != (cpl->reels().back()->duration() - 1)) {
- notes.push_back ({VerificationNote::VERIFY_WARNING, VerificationNote::INCORRECT_LFOC, raw_convert<string>(lfoc_time)});
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::INCORRECT_LFOC, raw_convert<string>(lfoc_time)});
}
}
- verify_text_timing (cpl->reels(), notes);
-
LinesCharactersResult result;
for (auto reel: cpl->reels()) {
if (reel->main_subtitle() && reel->main_subtitle()->asset()) {
}
if (result.line_count_exceeded) {
- notes.push_back ({VerificationNote::VERIFY_WARNING, VerificationNote::INVALID_SUBTITLE_LINE_COUNT});
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::INVALID_SUBTITLE_LINE_COUNT});
}
if (result.error_length_exceeded) {
- notes.push_back ({VerificationNote::VERIFY_WARNING, VerificationNote::INVALID_SUBTITLE_LINE_LENGTH});
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::INVALID_SUBTITLE_LINE_LENGTH});
} else if (result.warning_length_exceeded) {
- notes.push_back ({VerificationNote::VERIFY_WARNING, VerificationNote::NEARLY_INVALID_SUBTITLE_LINE_LENGTH});
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::NEARLY_INVALID_SUBTITLE_LINE_LENGTH});
}
result = LinesCharactersResult();
}
if (result.line_count_exceeded) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::INVALID_CLOSED_CAPTION_LINE_COUNT});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_CLOSED_CAPTION_LINE_COUNT});
}
if (result.error_length_exceeded) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::INVALID_CLOSED_CAPTION_LINE_LENGTH});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_CLOSED_CAPTION_LINE_LENGTH});
}
if (!cpl->full_content_title_text()) {
/* Since FullContentTitleText is assumed always to exist if there's a CompositionMetadataAsset we
* can use it as a proxy for CompositionMetadataAsset's existence.
*/
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_CPL_METADATA, cpl->id(), cpl->file().get()});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_CPL_METADATA, cpl->id(), cpl->file().get()});
} else if (!cpl->version_number()) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_CPL_METADATA_VERSION_NUMBER, cpl->id(), cpl->file().get()});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_CPL_METADATA_VERSION_NUMBER, cpl->id(), cpl->file().get()});
}
verify_extension_metadata (cpl, notes);
DCP_ASSERT (cpl->file());
doc.read_file (cpl->file().get());
if (!doc.optional_node_child("Signature")) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::UNSIGNED_CPL_WITH_ENCRYPTED_CONTENT, cpl->id(), cpl->file().get()});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::UNSIGNED_CPL_WITH_ENCRYPTED_CONTENT, cpl->id(), cpl->file().get()});
}
}
}
for (auto pkl: dcp->pkls()) {
stage ("Checking PKL", pkl->file());
- validate_xml (pkl->file().get(), xsd_dtd_directory, notes);
+ validate_xml (pkl->file().get(), *xsd_dtd_directory, notes);
if (pkl_has_encrypted_assets(dcp, pkl)) {
cxml::Document doc ("PackingList");
doc.read_file (pkl->file().get());
if (!doc.optional_node_child("Signature")) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::UNSIGNED_PKL_WITH_ENCRYPTED_CONTENT, pkl->id(), pkl->file().get()});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::UNSIGNED_PKL_WITH_ENCRYPTED_CONTENT, pkl->id(), pkl->file().get()});
}
}
}
if (dcp->asset_map_path()) {
stage ("Checking ASSETMAP", dcp->asset_map_path().get());
- validate_xml (dcp->asset_map_path().get(), xsd_dtd_directory, notes);
+ validate_xml (dcp->asset_map_path().get(), *xsd_dtd_directory, notes);
} else {
- notes.push_back ({VerificationNote::VERIFY_ERROR, VerificationNote::MISSING_ASSETMAP});
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::MISSING_ASSETMAP});
}
}
return notes;
}
+
string
dcp::note_to_string (VerificationNote note)
{
* Messages should not mention whether or not their errors are a part of Bv2.1.
*/
switch (note.code()) {
- case VerificationNote::FAILED_READ:
+ case VerificationNote::Code::FAILED_READ:
return *note.note();
- case VerificationNote::MISMATCHED_CPL_HASHES:
+ case VerificationNote::Code::MISMATCHED_CPL_HASHES:
return String::compose("The hash of the CPL %1 in the PKL does not agree with the CPL file.", note.note().get());
- case VerificationNote::INVALID_PICTURE_FRAME_RATE:
+ case VerificationNote::Code::INVALID_PICTURE_FRAME_RATE:
return String::compose("The picture in a reel has an invalid frame rate %1.", note.note().get());
- case VerificationNote::INCORRECT_PICTURE_HASH:
+ case VerificationNote::Code::INCORRECT_PICTURE_HASH:
return String::compose("The hash of the picture asset %1 does not agree with the PKL file.", note.file()->filename());
- case VerificationNote::MISMATCHED_PICTURE_HASHES:
+ case VerificationNote::Code::MISMATCHED_PICTURE_HASHES:
return String::compose("The PKL and CPL hashes differ for the picture asset %1.", note.file()->filename());
- case VerificationNote::INCORRECT_SOUND_HASH:
+ case VerificationNote::Code::INCORRECT_SOUND_HASH:
return String::compose("The hash of the sound asset %1 does not agree with the PKL file.", note.file()->filename());
- case VerificationNote::MISMATCHED_SOUND_HASHES:
+ case VerificationNote::Code::MISMATCHED_SOUND_HASHES:
return String::compose("The PKL and CPL hashes differ for the sound asset %1.", note.file()->filename());
- case VerificationNote::EMPTY_ASSET_PATH:
+ case VerificationNote::Code::EMPTY_ASSET_PATH:
return "The asset map contains an empty asset path.";
- case VerificationNote::MISSING_ASSET:
+ case VerificationNote::Code::MISSING_ASSET:
return String::compose("The file %1 for an asset in the asset map cannot be found.", note.file()->filename());
- case VerificationNote::MISMATCHED_STANDARD:
+ case VerificationNote::Code::MISMATCHED_STANDARD:
return "The DCP contains both SMPTE and Interop parts.";
- case VerificationNote::INVALID_XML:
+ case VerificationNote::Code::INVALID_XML:
return String::compose("An XML file is badly formed: %1 (%2:%3)", note.note().get(), note.file()->filename(), note.line().get());
- case VerificationNote::MISSING_ASSETMAP:
+ case VerificationNote::Code::MISSING_ASSETMAP:
return "No ASSETMAP or ASSETMAP.xml was found.";
- case VerificationNote::INVALID_INTRINSIC_DURATION:
- return String::compose("The intrinsic duration of the asset %1 is less than 1 second long.", note.note().get());
- case VerificationNote::INVALID_DURATION:
- return String::compose("The duration of the asset %1 is less than 1 second long.", note.note().get());
- case VerificationNote::INVALID_PICTURE_FRAME_SIZE_IN_BYTES:
+ case VerificationNote::Code::INVALID_INTRINSIC_DURATION:
+ return String::compose("The intrinsic duration of the asset %1 is less than 1 second.", note.note().get());
+ case VerificationNote::Code::INVALID_DURATION:
+ return String::compose("The duration of the asset %1 is less than 1 second.", note.note().get());
+ case VerificationNote::Code::INVALID_PICTURE_FRAME_SIZE_IN_BYTES:
return String::compose("The instantaneous bit rate of the picture asset %1 is larger than the limit of 250Mbit/s in at least one place.", note.file()->filename());
- case VerificationNote::NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES:
+ case VerificationNote::Code::NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES:
return String::compose("The instantaneous bit rate of the picture asset %1 is close to the limit of 250Mbit/s in at least one place.", note.file()->filename());
- case VerificationNote::EXTERNAL_ASSET:
+ case VerificationNote::Code::EXTERNAL_ASSET:
return String::compose("The asset %1 that this DCP refers to is not included in the DCP. It may be a VF.", note.note().get());
- case VerificationNote::INVALID_STANDARD:
+ case VerificationNote::Code::THREED_ASSET_MARKED_AS_TWOD:
+ return String::compose("The asset %1 is 3D but its MXF is marked as 2D.", note.file()->filename());
+ case VerificationNote::Code::INVALID_STANDARD:
return "This DCP does not use the SMPTE standard.";
- case VerificationNote::INVALID_LANGUAGE:
+ case VerificationNote::Code::INVALID_LANGUAGE:
return String::compose("The DCP specifies a language '%1' which does not conform to the RFC 5646 standard.", note.note().get());
- case VerificationNote::INVALID_PICTURE_SIZE_IN_PIXELS:
+ case VerificationNote::Code::INVALID_PICTURE_SIZE_IN_PIXELS:
return String::compose("The size %1 of picture asset %2 is not allowed.", note.note().get(), note.file()->filename());
- case VerificationNote::INVALID_PICTURE_FRAME_RATE_FOR_2K:
+ case VerificationNote::Code::INVALID_PICTURE_FRAME_RATE_FOR_2K:
return String::compose("The frame rate %1 of picture asset %2 is not allowed for 2K DCPs.", note.note().get(), note.file()->filename());
- case VerificationNote::INVALID_PICTURE_FRAME_RATE_FOR_4K:
+ case VerificationNote::Code::INVALID_PICTURE_FRAME_RATE_FOR_4K:
return String::compose("The frame rate %1 of picture asset %2 is not allowed for 4K DCPs.", note.note().get(), note.file()->filename());
- case VerificationNote::INVALID_PICTURE_ASSET_RESOLUTION_FOR_3D:
+ case VerificationNote::Code::INVALID_PICTURE_ASSET_RESOLUTION_FOR_3D:
return "3D 4K DCPs are not allowed.";
- case VerificationNote::INVALID_CLOSED_CAPTION_XML_SIZE_IN_BYTES:
+ case VerificationNote::Code::INVALID_CLOSED_CAPTION_XML_SIZE_IN_BYTES:
return String::compose("The size %1 of the closed caption asset %2 is larger than the 256KB maximum.", note.note().get(), note.file()->filename());
- case VerificationNote::INVALID_TIMED_TEXT_SIZE_IN_BYTES:
+ case VerificationNote::Code::INVALID_TIMED_TEXT_SIZE_IN_BYTES:
return String::compose("The size %1 of the timed text asset %2 is larger than the 115MB maximum.", note.note().get(), note.file()->filename());
- case VerificationNote::INVALID_TIMED_TEXT_FONT_SIZE_IN_BYTES:
+ case VerificationNote::Code::INVALID_TIMED_TEXT_FONT_SIZE_IN_BYTES:
return String::compose("The size %1 of the fonts in timed text asset %2 is larger than the 10MB maximum.", note.note().get(), note.file()->filename());
- case VerificationNote::MISSING_SUBTITLE_LANGUAGE:
+ case VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE:
return String::compose("The XML for the SMPTE subtitle asset %1 has no <Language> tag.", note.file()->filename());
- case VerificationNote::MISMATCHED_SUBTITLE_LANGUAGES:
+ case VerificationNote::Code::MISMATCHED_SUBTITLE_LANGUAGES:
return "Some subtitle assets have different <Language> tags than others";
- case VerificationNote::MISSING_SUBTITLE_START_TIME:
+ case VerificationNote::Code::MISSING_SUBTITLE_START_TIME:
return String::compose("The XML for the SMPTE subtitle asset %1 has no <StartTime> tag.", note.file()->filename());
- case VerificationNote::INVALID_SUBTITLE_START_TIME:
+ case VerificationNote::Code::INVALID_SUBTITLE_START_TIME:
return String::compose("The XML for a SMPTE subtitle asset %1 has a non-zero <StartTime> tag.", note.file()->filename());
- case VerificationNote::INVALID_SUBTITLE_FIRST_TEXT_TIME:
+ case VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME:
return "The first subtitle or closed caption is less than 4 seconds from the start of the DCP.";
- case VerificationNote::INVALID_SUBTITLE_DURATION:
+ case VerificationNote::Code::INVALID_SUBTITLE_DURATION:
return "At least one subtitle lasts less than 15 frames.";
- case VerificationNote::INVALID_SUBTITLE_SPACING:
+ case VerificationNote::Code::INVALID_SUBTITLE_SPACING:
return "At least one pair of subtitles is separated by less than 2 frames.";
- case VerificationNote::INVALID_SUBTITLE_LINE_COUNT:
+ case VerificationNote::Code::SUBTITLE_OVERLAPS_REEL_BOUNDARY:
+ return "At least one subtitle extends outside of its reel.";
+ case VerificationNote::Code::INVALID_SUBTITLE_LINE_COUNT:
return "There are more than 3 subtitle lines in at least one place in the DCP.";
- case VerificationNote::NEARLY_INVALID_SUBTITLE_LINE_LENGTH:
+ case VerificationNote::Code::NEARLY_INVALID_SUBTITLE_LINE_LENGTH:
return "There are more than 52 characters in at least one subtitle line.";
- case VerificationNote::INVALID_SUBTITLE_LINE_LENGTH:
+ case VerificationNote::Code::INVALID_SUBTITLE_LINE_LENGTH:
return "There are more than 79 characters in at least one subtitle line.";
- case VerificationNote::INVALID_CLOSED_CAPTION_LINE_COUNT:
+ case VerificationNote::Code::INVALID_CLOSED_CAPTION_LINE_COUNT:
return "There are more than 3 closed caption lines in at least one place.";
- case VerificationNote::INVALID_CLOSED_CAPTION_LINE_LENGTH:
+ case VerificationNote::Code::INVALID_CLOSED_CAPTION_LINE_LENGTH:
return "There are more than 32 characters in at least one closed caption line.";
- case VerificationNote::INVALID_SOUND_FRAME_RATE:
+ case VerificationNote::Code::INVALID_SOUND_FRAME_RATE:
return String::compose("The sound asset %1 has a sampling rate of %2", note.file()->filename(), note.note().get());
- case VerificationNote::MISSING_CPL_ANNOTATION_TEXT:
+ case VerificationNote::Code::MISSING_CPL_ANNOTATION_TEXT:
return String::compose("The CPL %1 has no <AnnotationText> tag.", note.note().get());
- case VerificationNote::MISMATCHED_CPL_ANNOTATION_TEXT:
+ case VerificationNote::Code::MISMATCHED_CPL_ANNOTATION_TEXT:
return String::compose("The CPL %1 has an <AnnotationText> which differs from its <ContentTitleText>", note.note().get());
- case VerificationNote::MISMATCHED_ASSET_DURATION:
+ case VerificationNote::Code::MISMATCHED_ASSET_DURATION:
return "All assets in a reel do not have the same duration.";
- case VerificationNote::MISSING_MAIN_SUBTITLE_FROM_SOME_REELS:
+ case VerificationNote::Code::MISSING_MAIN_SUBTITLE_FROM_SOME_REELS:
return "At least one reel contains a subtitle asset, but some reel(s) do not";
- case VerificationNote::MISMATCHED_CLOSED_CAPTION_ASSET_COUNTS:
+ case VerificationNote::Code::MISMATCHED_CLOSED_CAPTION_ASSET_COUNTS:
return "At least one reel has closed captions, but reels have different numbers of closed caption assets.";
- case VerificationNote::MISSING_SUBTITLE_ENTRY_POINT:
+ case VerificationNote::Code::MISSING_SUBTITLE_ENTRY_POINT:
return String::compose("The subtitle asset %1 has no <EntryPoint> tag.", note.note().get());
- case VerificationNote::INCORRECT_SUBTITLE_ENTRY_POINT:
+ case VerificationNote::Code::INCORRECT_SUBTITLE_ENTRY_POINT:
return String::compose("The subtitle asset %1 has an <EntryPoint> other than 0.", note.note().get());
- case VerificationNote::MISSING_CLOSED_CAPTION_ENTRY_POINT:
+ case VerificationNote::Code::MISSING_CLOSED_CAPTION_ENTRY_POINT:
return String::compose("The closed caption asset %1 has no <EntryPoint> tag.", note.note().get());
- case VerificationNote::INCORRECT_CLOSED_CAPTION_ENTRY_POINT:
+ case VerificationNote::Code::INCORRECT_CLOSED_CAPTION_ENTRY_POINT:
return String::compose("The closed caption asset %1 has an <EntryPoint> other than 0.", note.note().get());
- case VerificationNote::MISSING_HASH:
+ case VerificationNote::Code::MISSING_HASH:
return String::compose("The asset %1 has no <Hash> tag in the CPL.", note.note().get());
- case VerificationNote::MISSING_FFEC_IN_FEATURE:
+ case VerificationNote::Code::MISSING_FFEC_IN_FEATURE:
return "The DCP is marked as a Feature but there is no FFEC (first frame of end credits) marker";
- case VerificationNote::MISSING_FFMC_IN_FEATURE:
+ case VerificationNote::Code::MISSING_FFMC_IN_FEATURE:
return "The DCP is marked as a Feature but there is no FFMC (first frame of moving credits) marker";
- case VerificationNote::MISSING_FFOC:
+ case VerificationNote::Code::MISSING_FFOC:
return "There should be a FFOC (first frame of content) marker";
- case VerificationNote::MISSING_LFOC:
+ case VerificationNote::Code::MISSING_LFOC:
return "There should be a LFOC (last frame of content) marker";
- case VerificationNote::INCORRECT_FFOC:
+ case VerificationNote::Code::INCORRECT_FFOC:
return String::compose("The FFOC marker is %1 instead of 1", note.note().get());
- case VerificationNote::INCORRECT_LFOC:
+ case VerificationNote::Code::INCORRECT_LFOC:
return String::compose("The LFOC marker is %1 instead of 1 less than the duration of the last reel.", note.note().get());
- case VerificationNote::MISSING_CPL_METADATA:
+ case VerificationNote::Code::MISSING_CPL_METADATA:
return String::compose("The CPL %1 has no <CompositionMetadataAsset> tag.", note.note().get());
- case VerificationNote::MISSING_CPL_METADATA_VERSION_NUMBER:
+ case VerificationNote::Code::MISSING_CPL_METADATA_VERSION_NUMBER:
return String::compose("The CPL %1 has no <VersionNumber> in its <CompositionMetadataAsset>.", note.note().get());
- case VerificationNote::MISSING_EXTENSION_METADATA:
+ case VerificationNote::Code::MISSING_EXTENSION_METADATA:
return String::compose("The CPL %1 has no <ExtensionMetadata> in its <CompositionMetadataAsset>.", note.note().get());
- case VerificationNote::INVALID_EXTENSION_METADATA:
+ case VerificationNote::Code::INVALID_EXTENSION_METADATA:
return String::compose("The CPL %1 has a malformed <ExtensionMetadata> (%2).", note.file()->filename(), note.note().get());
- case VerificationNote::UNSIGNED_CPL_WITH_ENCRYPTED_CONTENT:
+ case VerificationNote::Code::UNSIGNED_CPL_WITH_ENCRYPTED_CONTENT:
return String::compose("The CPL %1, which has encrypted content, is not signed.", note.note().get());
- case VerificationNote::UNSIGNED_PKL_WITH_ENCRYPTED_CONTENT:
+ case VerificationNote::Code::UNSIGNED_PKL_WITH_ENCRYPTED_CONTENT:
return String::compose("The PKL %1, which has encrypted content, is not signed.", note.note().get());
- case VerificationNote::MISMATCHED_PKL_ANNOTATION_TEXT_WITH_CPL:
- return String::compose("The PKL %1 has only one CPL but its <AnnotationText> does not match the CPL's <ContentTitleText>", note.note().get());
- case VerificationNote::PARTIALLY_ENCRYPTED:
- return "Some assets are encrypted but some are not";
+ case VerificationNote::Code::MISMATCHED_PKL_ANNOTATION_TEXT_WITH_CPL:
+ return String::compose("The PKL %1 has only one CPL but its <AnnotationText> does not match the CPL's <ContentTitleText>.", note.note().get());
+ case VerificationNote::Code::PARTIALLY_ENCRYPTED:
+ return "Some assets are encrypted but some are not.";
+ case VerificationNote::Code::INVALID_JPEG2000_CODESTREAM:
+ return String::compose("The JPEG2000 codestream for at least one frame is invalid (%1)", note.note().get());
+ case VerificationNote::Code::INVALID_JPEG2000_GUARD_BITS_FOR_2K:
+ return String::compose("The JPEG2000 codestream uses %1 guard bits in a 2K image instead of 1.", note.note().get());
+ case VerificationNote::Code::INVALID_JPEG2000_GUARD_BITS_FOR_4K:
+ return String::compose("The JPEG2000 codestream uses %1 guard bits in a 4K image instead of 2.", note.note().get());
+ case VerificationNote::Code::INVALID_JPEG2000_TILE_SIZE:
+ return "The JPEG2000 tile size is not the same as the image size.";
+ case VerificationNote::Code::INVALID_JPEG2000_CODE_BLOCK_WIDTH:
+ return String::compose("The JPEG2000 codestream uses a code block width of %1 instead of 32.", note.note().get());
+ case VerificationNote::Code::INVALID_JPEG2000_CODE_BLOCK_HEIGHT:
+ return String::compose("The JPEG2000 codestream uses a code block height of %1 instead of 32.", note.note().get());
+ case VerificationNote::Code::INCORRECT_JPEG2000_POC_MARKER_COUNT_FOR_2K:
+ return String::compose("%1 POC markers found in 2K JPEG2000 codestream instead of 0.", note.note().get());
+ case VerificationNote::Code::INCORRECT_JPEG2000_POC_MARKER_COUNT_FOR_4K:
+ return String::compose("%1 POC markers found in 4K JPEG2000 codestream instead of 1.", note.note().get());
+ case VerificationNote::Code::INCORRECT_JPEG2000_POC_MARKER:
+ return String::compose("Incorrect POC marker content found (%1)", note.note().get());
+ case VerificationNote::Code::INVALID_JPEG2000_POC_MARKER_LOCATION:
+ return "POC marker found outside main header";
+ case VerificationNote::Code::INVALID_JPEG2000_TILE_PARTS_FOR_2K:
+ return String::compose("The JPEG2000 codestream has %1 tile parts in a 2K image instead of 3.", note.note().get());
+ case VerificationNote::Code::INVALID_JPEG2000_TILE_PARTS_FOR_4K:
+ return String::compose("The JPEG2000 codestream has %1 tile parts in a 4K image instead of 6.", note.note().get());
+ case VerificationNote::Code::MISSING_JPEG200_TLM_MARKER:
+ return "No TLM marker was found in a JPEG2000 codestream.";
+ case VerificationNote::Code::MISMATCHED_TIMED_TEXT_RESOURCE_ID:
+ return "The Resource ID in a timed text MXF did not match the ID of the contained XML.";
+ case VerificationNote::Code::INCORRECT_TIMED_TEXT_ASSET_ID:
+ return "The Asset ID in a timed text MXF is the same as the Resource ID or that of the contained XML.";
+ case VerificationNote::Code::MISMATCHED_TIMED_TEXT_DURATION:
+ {
+ vector<string> parts;
+ boost::split (parts, note.note().get(), boost::is_any_of(" "));
+ DCP_ASSERT (parts.size() == 2);
+ return String::compose("The reel duration of some timed text (%1) is not the same as the ContainerDuration of its MXF (%2).", parts[0], parts[1]);
+ }
+ case VerificationNote::Code::MISSED_CHECK_OF_ENCRYPTED:
+ return "Some aspect of this DCP could not be checked because it is encrypted.";
}
return "";
return a.type() == b.type() && a.code() == b.code() && a.note() == b.note() && a.file() == b.file() && a.line() == b.line();
}
+
+bool
+dcp::operator< (dcp::VerificationNote const& a, dcp::VerificationNote const& b)
+{
+ if (a.type() != b.type()) {
+ return a.type() < b.type();
+ }
+
+ if (a.code() != b.code()) {
+ return a.code() < b.code();
+ }
+
+ if (a.note() != b.note()) {
+ return a.note().get_value_or("") < b.note().get_value_or("");
+ }
+
+ if (a.file() != b.file()) {
+ return a.file().get_value_or("") < b.file().get_value_or("");
+ }
+
+ return a.line().get_value_or(0) < b.line().get_value_or(0);
+}
+
+
std::ostream&
dcp::operator<< (std::ostream& s, dcp::VerificationNote const& note)
{
projects / libdcp.git / blobdiff