#include "cpl.h"
#include "dcp.h"
#include "exceptions.h"
+#include "filesystem.h"
#include "interop_subtitle_asset.h"
#include "mono_picture_asset.h"
#include "mono_picture_frame.h"
#include "stereo_picture_frame.h"
#include "verify.h"
#include "verify_j2k.h"
+#include <libxml/parserInternals.h>
#include <xercesc/dom/DOMAttr.hpp>
#include <xercesc/dom/DOMDocument.hpp>
#include <xercesc/dom/DOMError.hpp>
#include <boost/algorithm/string.hpp>
#include <iostream>
#include <map>
+#include <regex>
+#include <set>
#include <vector>
-using std::list;
-using std::vector;
-using std::string;
using std::cout;
+using std::dynamic_pointer_cast;
+using std::function;
+using std::list;
+using std::make_shared;
using std::map;
using std::max;
+using std::set;
using std::shared_ptr;
-using std::make_shared;
+using std::string;
+using std::vector;
using boost::optional;
-using boost::function;
-using std::dynamic_pointer_cast;
using namespace dcp;
add("http://www.digicine.com/PROTO-ASDCP-AM-20040311.xsd", "PROTO-ASDCP-AM-20040311.xsd");
add("http://www.digicine.com/PROTO-ASDCP-CC-CPL-20070926#", "PROTO-ASDCP-CC-CPL-20070926.xsd");
add("interop-subs", "DCSubtitle.v1.mattsson.xsd");
- add("http://www.smpte-ra.org/schemas/428-7/2010/DCST.xsd", "SMPTE-428-7-2010-DCST.xsd");
+ add("http://www.smpte-ra.org/schemas/428-7/2010/DCST.xsd", "DCDMSubtitle-2010.xsd");
+ add("http://www.smpte-ra.org/schemas/428-7/2014/DCST.xsd", "DCDMSubtitle-2014.xsd");
add("http://www.smpte-ra.org/schemas/429-16/2014/CPL-Metadata", "SMPTE-429-16.xsd");
add("http://www.dolby.com/schemas/2012/AD", "Dolby-2012-AD.xsd");
add("http://www.smpte-ra.org/schemas/429-10/2008/Main-Stereo-Picture-CPL", "SMPTE-429-10-2008.xsd");
static void
parse (XercesDOMParser& parser, boost::filesystem::path xml)
{
- parser.parse(xml.string().c_str());
+ parser.parse(xml.c_str());
}
}
+class Context
+{
+public:
+ Context(
+ std::vector<VerificationNote>& notes_,
+ boost::filesystem::path xsd_dtd_directory_,
+ function<void (string, optional<boost::filesystem::path>)> stage_,
+ function<void (float)> progress_,
+ VerificationOptions options_
+ )
+ : notes(notes_)
+ , xsd_dtd_directory(xsd_dtd_directory_)
+ , stage(stage_)
+ , progress(progress_)
+ , options(options_)
+ {
+
+ }
+
+ Context(Context const&) = delete;
+ Context& operator=(Context const&) = delete;
+
+ template<typename... Args>
+ void ok(dcp::VerificationNote::Code code, Args... args)
+ {
+ add_note({dcp::VerificationNote::Type::OK, code, std::forward<Args>(args)...});
+ }
+
+ template<typename... Args>
+ void warning(dcp::VerificationNote::Code code, Args... args)
+ {
+ add_note({dcp::VerificationNote::Type::WARNING, code, std::forward<Args>(args)...});
+ }
+
+ template<typename... Args>
+ void bv21_error(dcp::VerificationNote::Code code, Args... args)
+ {
+ add_note({dcp::VerificationNote::Type::BV21_ERROR, code, std::forward<Args>(args)...});
+ }
+
+ template<typename... Args>
+ void error(dcp::VerificationNote::Code code, Args... args)
+ {
+ add_note({dcp::VerificationNote::Type::ERROR, code, std::forward<Args>(args)...});
+ }
+
+ void add_note(dcp::VerificationNote note)
+ {
+ if (cpl) {
+ note.set_cpl_id(cpl->id());
+ }
+ notes.push_back(std::move(note));
+ }
+
+ void add_note_if_not_existing(dcp::VerificationNote note)
+ {
+ if (find(notes.begin(), notes.end(), note) == notes.end()) {
+ add_note(note);
+ }
+ }
+
+ std::vector<VerificationNote>& notes;
+ std::shared_ptr<const DCP> dcp;
+ std::shared_ptr<const CPL> cpl;
+ boost::filesystem::path xsd_dtd_directory;
+ function<void (string, optional<boost::filesystem::path>)> stage;
+ function<void (float)> progress;
+ VerificationOptions options;
+
+ boost::optional<string> subtitle_language;
+ boost::optional<int> audio_channels;
+};
+
+
template <class T>
void
-validate_xml (T xml, boost::filesystem::path xsd_dtd_directory, vector<VerificationNote>& notes)
+validate_xml(Context& context, T xml)
{
try {
XMLPlatformUtils::Initialize ();
schema.push_back("PROTO-ASDCP-AM-20040311.xsd");
schema.push_back("DCSubtitle.v1.mattsson.xsd");
schema.push_back("DCDMSubtitle-2010.xsd");
+ schema.push_back("DCDMSubtitle-2014.xsd");
schema.push_back("PROTO-ASDCP-CC-CPL-20070926.xsd");
schema.push_back("SMPTE-429-16.xsd");
schema.push_back("Dolby-2012-AD.xsd");
parser.setValidationSchemaFullChecking(true);
parser.setErrorHandler(&error_handler);
- LocalFileResolver resolver (xsd_dtd_directory);
+ LocalFileResolver resolver(context.xsd_dtd_directory);
parser.setEntityResolver(&resolver);
try {
XMLPlatformUtils::Terminate ();
for (auto i: error_handler.errors()) {
- notes.push_back ({
- VerificationNote::Type::ERROR,
+ context.error(
VerificationNote::Code::INVALID_XML,
i.message(),
boost::trim_copy(i.public_id() + " " + i.system_id()),
i.line()
- });
+ );
}
}
static VerifyAssetResult
-verify_asset (shared_ptr<const DCP> dcp, shared_ptr<const ReelFileAsset> reel_file_asset, function<void (float)> progress)
+verify_asset(
+ Context& context,
+ shared_ptr<const ReelFileAsset> reel_file_asset,
+ string* reference_hash,
+ string* calculated_hash
+ )
{
- auto const actual_hash = reel_file_asset->asset_ref()->hash(progress);
+ DCP_ASSERT(reference_hash);
+ DCP_ASSERT(calculated_hash);
+
+ /* When reading the DCP the hash will have been set to the one from the PKL/CPL.
+ * We want to calculate the hash of the actual file contents here, so that we
+ * can check it. unset_hash() means that this calculation will happen on the
+ * call to hash().
+ */
+ reel_file_asset->asset_ref()->unset_hash();
+ *calculated_hash = reel_file_asset->asset_ref()->hash([&context](int64_t done, int64_t total) {
+ context.progress(float(done) / total);
+ });
- auto pkls = dcp->pkls();
+ auto pkls = context.dcp->pkls();
/* We've read this DCP in so it must have at least one PKL */
DCP_ASSERT (!pkls.empty());
auto asset = reel_file_asset->asset_ref().asset();
- optional<string> pkl_hash;
+ optional<string> maybe_pkl_hash;
for (auto i: pkls) {
- pkl_hash = i->hash (reel_file_asset->asset_ref()->id());
- if (pkl_hash) {
+ maybe_pkl_hash = i->hash (reel_file_asset->asset_ref()->id());
+ if (maybe_pkl_hash) {
break;
}
}
- DCP_ASSERT (pkl_hash);
+ DCP_ASSERT(maybe_pkl_hash);
+ *reference_hash = *maybe_pkl_hash;
auto cpl_hash = reel_file_asset->hash();
- if (cpl_hash && *cpl_hash != *pkl_hash) {
+ if (cpl_hash && *cpl_hash != *reference_hash) {
return VerifyAssetResult::CPL_PKL_DIFFER;
}
- if (actual_hash != *pkl_hash) {
+ if (*calculated_hash != *reference_hash) {
return VerifyAssetResult::BAD;
}
}
-void
-verify_language_tag (string tag, vector<VerificationNote>& notes)
+static void
+verify_language_tag(Context& context, string tag)
{
try {
LanguageTag test (tag);
} catch (LanguageTagError &) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_LANGUAGE, tag});
+ context.bv21_error(VerificationNote::Code::INVALID_LANGUAGE, tag);
}
}
static void
-verify_picture_asset (shared_ptr<const ReelFileAsset> reel_file_asset, boost::filesystem::path file, vector<VerificationNote>& notes, function<void (float)> progress)
+verify_picture_asset(
+ Context& context,
+ shared_ptr<const ReelFileAsset> reel_file_asset,
+ boost::filesystem::path file,
+ int64_t start_frame
+ )
{
- 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) {
+ auto check_and_add = [&context](vector<VerificationNote> const& j2k_notes) {
for (auto i: j2k_notes) {
- if (find(notes.begin(), notes.end(), i) == notes.end()) {
- notes.push_back (i);
- }
+ context.add_note_if_not_existing(i);
+ }
+ };
+
+ int const max_frame = rint(250 * 1000000 / (8 * asset->edit_rate().as_float()));
+ int const risky_frame = rint(230 * 1000000 / (8 * asset->edit_rate().as_float()));
+
+ bool any_bad_frames_seen = false;
+
+ auto check_frame_size = [max_frame, risky_frame, file, start_frame, &any_bad_frames_seen](Context& context, int index, int size, int frame_rate) {
+ if (size > max_frame) {
+ context.add_note(
+ VerificationNote(
+ VerificationNote::Type::ERROR, VerificationNote::Code::INVALID_PICTURE_FRAME_SIZE_IN_BYTES, file
+ ).set_frame(start_frame + index).set_frame_rate(frame_rate)
+ );
+ any_bad_frames_seen = true;
+ } else if (size > risky_frame) {
+ context.add_note(
+ VerificationNote(
+ VerificationNote::Type::WARNING, VerificationNote::Code::NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES, file
+ ).set_frame(start_frame + index).set_frame_rate(frame_rate)
+ );
+ any_bad_frames_seen = true;
}
};
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());
+ check_frame_size(context, i, frame->size(), mono_asset->frame_rate().numerator);
if (!mono_asset->encrypted() || mono_asset->key()) {
vector<VerificationNote> j2k_notes;
- verify_j2k (frame, j2k_notes);
+ verify_j2k(frame, start_frame, i, mono_asset->frame_rate().numerator, j2k_notes);
check_and_add (j2k_notes);
}
- progress (float(i) / duration);
+ context.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()) {
+ check_frame_size(context, i, frame->left()->size(), stereo_asset->frame_rate().numerator);
+ check_frame_size(context, i, frame->right()->size(), stereo_asset->frame_rate().numerator);
+ if (!stereo_asset->encrypted() || stereo_asset->key()) {
vector<VerificationNote> j2k_notes;
- verify_j2k (frame->left(), j2k_notes);
- verify_j2k (frame->right(), j2k_notes);
+ verify_j2k(frame->left(), start_frame, i, stereo_asset->frame_rate().numerator, j2k_notes);
+ verify_j2k(frame->right(), start_frame, i, stereo_asset->frame_rate().numerator, j2k_notes);
check_and_add (j2k_notes);
}
- progress (float(i) / duration);
+ context.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) {
- notes.push_back ({
- VerificationNote::Type::ERROR, VerificationNote::Code::INVALID_PICTURE_FRAME_SIZE_IN_BYTES, file
- });
- } else if (biggest_frame > risky_frame) {
- notes.push_back ({
- VerificationNote::Type::WARNING, VerificationNote::Code::NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES, file
- });
+ if (!any_bad_frames_seen) {
+ context.ok(VerificationNote::Code::VALID_PICTURE_FRAME_SIZES_IN_BYTES, file);
}
}
static void
-verify_main_picture_asset (
- shared_ptr<const DCP> dcp,
- shared_ptr<const ReelPictureAsset> reel_asset,
- function<void (string, optional<boost::filesystem::path>)> stage,
- function<void (float)> progress,
- vector<VerificationNote>& notes
- )
+verify_main_picture_asset(Context& context, shared_ptr<const ReelPictureAsset> reel_asset, int64_t start_frame)
{
auto asset = reel_asset->asset();
auto const file = *asset->file();
- stage ("Checking picture asset hash", file);
- auto const r = verify_asset (dcp, reel_asset, progress);
- switch (r) {
- case VerifyAssetResult::BAD:
- notes.push_back ({
- VerificationNote::Type::ERROR, VerificationNote::Code::INCORRECT_PICTURE_HASH, file
- });
- break;
- case VerifyAssetResult::CPL_PKL_DIFFER:
- notes.push_back ({
- VerificationNote::Type::ERROR, VerificationNote::Code::MISMATCHED_PICTURE_HASHES, file
- });
- break;
- default:
- break;
+
+ if (context.options.check_asset_hashes && (!context.options.maximum_asset_size_for_hash_check || filesystem::file_size(file) < *context.options.maximum_asset_size_for_hash_check)) {
+ context.stage("Checking picture asset hash", file);
+ string reference_hash;
+ string calculated_hash;
+ auto const r = verify_asset(context, reel_asset, &reference_hash, &calculated_hash);
+ switch (r) {
+ case VerifyAssetResult::BAD:
+ context.add_note(
+ dcp::VerificationNote(
+ VerificationNote::Type::ERROR,
+ VerificationNote::Code::INCORRECT_PICTURE_HASH,
+ file
+ ).set_reference_hash(reference_hash).set_calculated_hash(calculated_hash)
+ );
+ break;
+ case VerifyAssetResult::CPL_PKL_DIFFER:
+ context.error(VerificationNote::Code::MISMATCHED_PICTURE_HASHES, file);
+ break;
+ default:
+ context.ok(VerificationNote::Code::CORRECT_PICTURE_HASH, file);
+ break;
+ }
}
- stage ("Checking picture frame sizes", asset->file());
- verify_picture_asset (reel_asset, file, notes, progress);
+
+ context.stage("Checking picture frame sizes", asset->file());
+ verify_picture_asset(context, reel_asset, file, start_frame);
/* Only flat/scope allowed by Bv2.1 */
if (
asset->size() != Size(1998, 1080) &&
asset->size() != Size(4096, 1716) &&
asset->size() != Size(3996, 2160)) {
- notes.push_back({
- VerificationNote::Type::BV21_ERROR,
- VerificationNote::Code::INVALID_PICTURE_SIZE_IN_PIXELS,
- String::compose("%1x%2", asset->size().width, asset->size().height),
- file
- });
+ context.bv21_error(VerificationNote::Code::INVALID_PICTURE_SIZE_IN_PIXELS, String::compose("%1x%2", asset->size().width, asset->size().height), file);
}
/* Only 24, 25, 48fps allowed for 2K */
(asset->size() == Size(2048, 858) || asset->size() == Size(1998, 1080)) &&
(asset->edit_rate() != Fraction(24, 1) && asset->edit_rate() != Fraction(25, 1) && asset->edit_rate() != Fraction(48, 1))
) {
- notes.push_back({
- VerificationNote::Type::BV21_ERROR,
+ context.bv21_error(
VerificationNote::Code::INVALID_PICTURE_FRAME_RATE_FOR_2K,
String::compose("%1/%2", asset->edit_rate().numerator, asset->edit_rate().denominator),
file
- });
+ );
}
if (asset->size() == Size(4096, 1716) || asset->size() == Size(3996, 2160)) {
/* Only 24fps allowed for 4K */
if (asset->edit_rate() != Fraction(24, 1)) {
- notes.push_back({
- VerificationNote::Type::BV21_ERROR,
+ context.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::Type::BV21_ERROR,
+ context.bv21_error(
VerificationNote::Code::INVALID_PICTURE_ASSET_RESOLUTION_FOR_3D,
String::compose("%1/%2", asset->edit_rate().numerator, asset->edit_rate().denominator),
file
- });
+ );
}
}
-
}
static void
-verify_main_sound_asset (
- shared_ptr<const DCP> dcp,
- shared_ptr<const ReelSoundAsset> reel_asset,
- function<void (string, optional<boost::filesystem::path>)> stage,
- function<void (float)> progress,
- vector<VerificationNote>& notes
- )
+verify_main_sound_asset(Context& context, shared_ptr<const ReelSoundAsset> reel_asset)
{
auto asset = reel_asset->asset();
- stage ("Checking sound asset hash", asset->file());
- auto const r = verify_asset (dcp, reel_asset, progress);
- switch (r) {
- case VerifyAssetResult::BAD:
- notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::INCORRECT_SOUND_HASH, *asset->file()});
- break;
- case VerifyAssetResult::CPL_PKL_DIFFER:
- notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::MISMATCHED_SOUND_HASHES, *asset->file()});
- break;
- default:
- break;
+ auto const file = *asset->file();
+
+ if (context.options.check_asset_hashes && (!context.options.maximum_asset_size_for_hash_check || filesystem::file_size(file) < *context.options.maximum_asset_size_for_hash_check)) {
+ context.stage("Checking sound asset hash", file);
+ string reference_hash;
+ string calculated_hash;
+ auto const r = verify_asset(context, reel_asset, &reference_hash, &calculated_hash);
+ switch (r) {
+ case VerifyAssetResult::BAD:
+ context.add_note(
+ dcp::VerificationNote(
+ VerificationNote::Type::ERROR,
+ VerificationNote::Code::INCORRECT_SOUND_HASH,
+ file
+ ).set_reference_hash(reference_hash).set_calculated_hash(calculated_hash)
+ );
+ break;
+ case VerifyAssetResult::CPL_PKL_DIFFER:
+ context.error(VerificationNote::Code::MISMATCHED_SOUND_HASHES, file);
+ break;
+ default:
+ break;
+ }
}
- stage ("Checking sound asset metadata", asset->file());
+ if (!context.audio_channels) {
+ context.audio_channels = asset->channels();
+ } else if (*context.audio_channels != asset->channels()) {
+ context.error(VerificationNote::Code::MISMATCHED_SOUND_CHANNEL_COUNTS, file);
+ }
+
+ context.stage("Checking sound asset metadata", file);
if (auto lang = asset->language()) {
- verify_language_tag (*lang, notes);
+ verify_language_tag(context, *lang);
}
if (asset->sampling_rate() != 48000) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_SOUND_FRAME_RATE, raw_convert<string>(asset->sampling_rate()), *asset->file()});
+ context.bv21_error(VerificationNote::Code::INVALID_SOUND_FRAME_RATE, raw_convert<string>(asset->sampling_rate()), file);
}
}
static void
-verify_main_subtitle_reel (shared_ptr<const ReelSubtitleAsset> reel_asset, vector<VerificationNote>& notes)
+verify_main_subtitle_reel(Context& context, shared_ptr<const ReelSubtitleAsset> reel_asset)
{
/* XXX: is Language compulsory? */
if (reel_asset->language()) {
- verify_language_tag (*reel_asset->language(), notes);
+ verify_language_tag(context, *reel_asset->language());
}
if (!reel_asset->entry_point()) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_SUBTITLE_ENTRY_POINT, reel_asset->id() });
+ context.bv21_error(VerificationNote::Code::MISSING_SUBTITLE_ENTRY_POINT, reel_asset->id());
} else if (reel_asset->entry_point().get()) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INCORRECT_SUBTITLE_ENTRY_POINT, reel_asset->id() });
+ context.bv21_error(VerificationNote::Code::INCORRECT_SUBTITLE_ENTRY_POINT, reel_asset->id());
}
}
static void
-verify_closed_caption_reel (shared_ptr<const ReelClosedCaptionAsset> reel_asset, vector<VerificationNote>& notes)
+verify_closed_caption_reel(Context& context, shared_ptr<const ReelClosedCaptionAsset> reel_asset)
{
/* XXX: is Language compulsory? */
if (reel_asset->language()) {
- verify_language_tag (*reel_asset->language(), notes);
+ verify_language_tag(context, *reel_asset->language());
}
if (!reel_asset->entry_point()) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_CLOSED_CAPTION_ENTRY_POINT, reel_asset->id() });
+ context.bv21_error(VerificationNote::Code::MISSING_CLOSED_CAPTION_ENTRY_POINT, reel_asset->id());
} else if (reel_asset->entry_point().get()) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INCORRECT_CLOSED_CAPTION_ENTRY_POINT, reel_asset->id() });
+ context.bv21_error(VerificationNote::Code::INCORRECT_CLOSED_CAPTION_ENTRY_POINT, reel_asset->id());
}
}
-struct State
-{
- boost::optional<string> subtitle_language;
-};
-
-
/** Verify stuff that is common to both subtitles and closed captions */
void
verify_smpte_timed_text_asset (
+ Context& context,
shared_ptr<const SMPTESubtitleAsset> asset,
- optional<int64_t> reel_asset_duration,
- vector<VerificationNote>& notes
+ optional<int64_t> reel_asset_duration
)
{
if (asset->language()) {
- verify_language_tag (*asset->language(), notes);
+ verify_language_tag(context, *asset->language());
} else {
- notes.push_back ({ VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE, *asset->file() });
+ context.bv21_error(VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE, *asset->file());
}
- auto const size = boost::filesystem::file_size(asset->file().get());
+ auto const size = filesystem::file_size(asset->file().get());
if (size > 115 * 1024 * 1024) {
- notes.push_back (
- { VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_TIMED_TEXT_SIZE_IN_BYTES, raw_convert<string>(size), *asset->file() }
- );
+ context.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"
total_size += i.second.size();
}
if (total_size > 10 * 1024 * 1024) {
- notes.push_back ({ VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_TIMED_TEXT_FONT_SIZE_IN_BYTES, raw_convert<string>(total_size), asset->file().get() });
+ context.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::Type::BV21_ERROR, VerificationNote::Code::MISSING_SUBTITLE_START_TIME, asset->file().get() });
+ context.bv21_error(VerificationNote::Code::MISSING_SUBTITLE_START_TIME, asset->file().get());
} else if (asset->start_time() != Time()) {
- notes.push_back ({ VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_SUBTITLE_START_TIME, asset->file().get() });
+ context.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()
- });
+ context.bv21_error(
+ VerificationNote::Code::MISMATCHED_TIMED_TEXT_DURATION,
+ String::compose("%1 %2", *reel_asset_duration, asset->intrinsic_duration()),
+ asset->file().get()
+ );
+ }
+}
+
+
+/** Verify Interop subtitle / CCAP stuff */
+void
+verify_interop_text_asset(Context& context, shared_ptr<const InteropSubtitleAsset> asset)
+{
+ if (asset->subtitles().empty()) {
+ context.error(VerificationNote::Code::MISSING_SUBTITLE, asset->id(), asset->file().get());
+ }
+ auto const unresolved = asset->unresolved_fonts();
+ if (!unresolved.empty()) {
+ context.error(VerificationNote::Code::MISSING_FONT, unresolved.front());
}
}
/** Verify SMPTE subtitle-only stuff */
void
-verify_smpte_subtitle_asset (
- shared_ptr<const SMPTESubtitleAsset> asset,
- vector<VerificationNote>& notes,
- State& state
- )
+verify_smpte_subtitle_asset(Context& context, shared_ptr<const SMPTESubtitleAsset> asset)
{
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 });
+ if (!context.subtitle_language) {
+ context.subtitle_language = *asset->language();
+ } else if (context.subtitle_language != *asset->language()) {
+ context.bv21_error(VerificationNote::Code::MISMATCHED_SUBTITLE_LANGUAGES);
}
}
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 });
+ context.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 });
+ context.bv21_error(VerificationNote::Code::INCORRECT_TIMED_TEXT_ASSET_ID);
}
} else {
- notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::MISSED_CHECK_OF_ENCRYPTED});
+ context.warning(VerificationNote::Code::MISSED_CHECK_OF_ENCRYPTED);
+ }
+
+ if (asset->raw_xml()) {
+ /* Deluxe require this in their QC even if it seems never to be mentioned in any standard */
+ cxml::Document doc("SubtitleReel");
+ doc.read_string(*asset->raw_xml());
+ auto issue_date = doc.string_child("IssueDate");
+ std::regex reg("^\\d\\d\\d\\d-\\d\\d-\\d\\dT\\d\\d:\\d\\d:\\d\\d$");
+ if (!std::regex_match(issue_date, reg)) {
+ context.warning(VerificationNote::Code::INVALID_SUBTITLE_ISSUE_DATE, issue_date);
+ }
}
}
/** 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,
- State& state
- )
+verify_subtitle_asset(Context& context, shared_ptr<const SubtitleAsset> asset, optional<int64_t> reel_asset_duration)
{
- stage ("Checking subtitle XML", asset->file());
+ context.stage("Checking subtitle 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.
*/
if (asset->raw_xml()) {
- validate_xml (asset->raw_xml().get(), xsd_dtd_directory, notes);
+ validate_xml(context, asset->raw_xml().get());
} else {
- notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::MISSED_CHECK_OF_ENCRYPTED});
+ context.warning(VerificationNote::Code::MISSED_CHECK_OF_ENCRYPTED);
+ }
+
+ auto namespace_count = [](shared_ptr<const SubtitleAsset> asset, string root_node) {
+ cxml::Document doc(root_node);
+ doc.read_string(asset->raw_xml().get());
+ auto root = dynamic_cast<xmlpp::Element*>(doc.node())->cobj();
+ int count = 0;
+ for (auto ns = root->nsDef; ns != nullptr; ns = ns->next) {
+ ++count;
+ }
+ return count;
+ };
+
+ auto interop = dynamic_pointer_cast<const InteropSubtitleAsset>(asset);
+ if (interop) {
+ verify_interop_text_asset(context, interop);
+ if (namespace_count(asset, "DCSubtitle") > 1) {
+ context.warning(VerificationNote::Code::INCORRECT_SUBTITLE_NAMESPACE_COUNT, asset->id());
+ }
}
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_smpte_timed_text_asset(context, smpte, reel_asset_duration);
+ verify_smpte_subtitle_asset(context, smpte);
+ /* This asset may be encrypted and in that case we'll have no raw_xml() */
+ if (asset->raw_xml() && namespace_count(asset, "SubtitleReel") > 1) {
+ context.warning(VerificationNote::Code::INCORRECT_SUBTITLE_NAMESPACE_COUNT, asset->id());
+ }
}
}
/** Verify all closed caption stuff */
static void
verify_closed_caption_asset (
+ Context& context,
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
+ optional<int64_t> reel_asset_duration
)
{
- stage ("Checking closed caption XML", asset->file());
+ context.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);
+ validate_xml(context, *raw_xml);
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()});
+ context.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});
+ context.warning(VerificationNote::Code::MISSED_CHECK_OF_ENCRYPTED);
+ }
+
+ auto interop = dynamic_pointer_cast<const InteropSubtitleAsset>(asset);
+ if (interop) {
+ verify_interop_text_asset(context, interop);
}
auto smpte = dynamic_pointer_cast<const SMPTESubtitleAsset>(asset);
if (smpte) {
- verify_smpte_timed_text_asset (smpte, reel_asset_duration, notes);
+ verify_smpte_timed_text_asset(context, smpte, reel_asset_duration);
}
}
-/** Check the timing of the individual subtitles and make sure there are no empty <Text> nodes */
+/** Check the timing of the individual subtitles and make sure there are no empty <Text> nodes etc. */
static
void
verify_text_details (
+ Context& context,
vector<shared_ptr<Reel>> reels,
int edit_rate,
- vector<VerificationNote>& notes,
std::function<bool (shared_ptr<Reel>)> check,
std::function<optional<string> (shared_ptr<Reel>)> xml,
- std::function<int64_t (shared_ptr<Reel>)> duration
+ std::function<int64_t (shared_ptr<Reel>)> duration,
+ std::function<std::string (shared_ptr<Reel>)> id
)
{
/* end of last subtitle (in editable units) */
auto empty_text = false;
/* current reel start time (in editable units) */
int64_t reel_offset = 0;
-
- std::function<void (cxml::ConstNodePtr, optional<int>, optional<Time>, int, bool)> parse;
- parse = [&parse, &last_out, &too_short, &too_close, &too_early, &empty_text, &reel_offset](cxml::ConstNodePtr node, optional<int> tcr, optional<Time> start_time, int er, bool first_reel) {
+ optional<string> missing_load_font_id;
+
+ std::function<void (cxml::ConstNodePtr, optional<int>, optional<Time>, int, bool, bool&, vector<string>&)> parse;
+
+ parse = [&parse, &last_out, &too_short, &too_close, &too_early, &empty_text, &reel_offset, &missing_load_font_id](
+ cxml::ConstNodePtr node,
+ optional<int> tcr,
+ optional<Time> start_time,
+ int er,
+ bool first_reel,
+ bool& has_text,
+ vector<string>& font_ids
+ ) {
if (node->name() == "Subtitle") {
Time in (node->string_attribute("TimeIn"), tcr);
if (start_time) {
if (!node_has_content(node)) {
empty_text = true;
}
+ has_text = true;
+ } else if (node->name() == "LoadFont") {
+ if (auto const id = node->optional_string_attribute("Id")) {
+ font_ids.push_back(*id);
+ } else if (auto const id = node->optional_string_attribute("ID")) {
+ font_ids.push_back(*id);
+ }
+ } else if (node->name() == "Font") {
+ if (auto const font_id = node->optional_string_attribute("Id")) {
+ if (std::find_if(font_ids.begin(), font_ids.end(), [font_id](string const& id) { return id == font_id; }) == font_ids.end()) {
+ missing_load_font_id = font_id;
+ }
+ }
}
-
for (auto i: node->node_children()) {
- parse(i, tcr, start_time, er, first_reel);
+ parse(i, tcr, start_time, er, first_reel, has_text, font_ids);
}
};
auto reel_xml = xml(reels[i]);
if (!reel_xml) {
- notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::MISSED_CHECK_OF_ENCRYPTED});
+ context.warning(VerificationNote::Code::MISSED_CHECK_OF_ENCRYPTED);
continue;
}
shared_ptr<cxml::Document> doc;
optional<int> tcr;
optional<Time> start_time;
- try {
+ switch (context.dcp->standard().get_value_or(dcp::Standard::SMPTE)) {
+ case dcp::Standard::INTEROP:
+ doc = make_shared<cxml::Document>("DCSubtitle");
+ doc->read_string (*reel_xml);
+ break;
+ case dcp::Standard::SMPTE:
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) {
+ if (auto start_time_string = doc->optional_string_child("StartTime")) {
start_time = Time(*start_time_string, tcr);
}
- } catch (...) {
- doc = make_shared<cxml::Document>("DCSubtitle");
- doc->read_string (*reel_xml);
+ break;
}
- parse (doc, tcr, start_time, edit_rate, i == 0);
+ bool has_text = false;
+ vector<string> font_ids;
+ parse(doc, tcr, start_time, edit_rate, i == 0, has_text, font_ids);
auto end = reel_offset + duration(reels[i]);
if (last_out && *last_out > end) {
reel_overlap = true;
}
reel_offset = end;
+
+ if (context.dcp->standard() && *context.dcp->standard() == dcp::Standard::SMPTE && has_text && font_ids.empty()) {
+ context.add_note(dcp::VerificationNote(dcp::VerificationNote::Type::ERROR, VerificationNote::Code::MISSING_LOAD_FONT).set_id(id(reels[i])));
+ }
}
if (last_out && *last_out > reel_offset) {
}
if (too_early) {
- notes.push_back({
- VerificationNote::Type::WARNING, VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME
- });
+ context.warning(VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME);
}
if (too_short) {
- notes.push_back ({
- VerificationNote::Type::WARNING, VerificationNote::Code::INVALID_SUBTITLE_DURATION
- });
+ context.warning(VerificationNote::Code::INVALID_SUBTITLE_DURATION);
}
if (too_close) {
- notes.push_back ({
- VerificationNote::Type::WARNING, VerificationNote::Code::INVALID_SUBTITLE_SPACING
- });
+ context.warning(VerificationNote::Code::INVALID_SUBTITLE_SPACING);
}
if (reel_overlap) {
- notes.push_back ({
- VerificationNote::Type::ERROR, VerificationNote::Code::SUBTITLE_OVERLAPS_REEL_BOUNDARY
- });
+ context.error(VerificationNote::Code::SUBTITLE_OVERLAPS_REEL_BOUNDARY);
}
if (empty_text) {
- notes.push_back ({
- VerificationNote::Type::WARNING, VerificationNote::Code::EMPTY_TEXT
- });
+ context.warning(VerificationNote::Code::EMPTY_TEXT);
+ }
+
+ if (missing_load_font_id) {
+ context.add_note(dcp::VerificationNote(VerificationNote::Type::ERROR, VerificationNote::Code::MISSING_LOAD_FONT_FOR_FONT).set_id(*missing_load_font_id));
}
}
static
void
-verify_closed_caption_details (
- vector<shared_ptr<Reel>> reels,
- vector<VerificationNote>& notes
- )
+verify_closed_caption_details(Context& context, vector<shared_ptr<Reel>> reels)
{
std::function<void (cxml::ConstNodePtr node, std::vector<cxml::ConstNodePtr>& text_or_image)> find_text_or_image;
find_text_or_image = [&find_text_or_image](cxml::ConstNodePtr node, std::vector<cxml::ConstNodePtr>& text_or_image) {
for (auto ccap: reel->closed_captions()) {
auto reel_xml = ccap->asset()->raw_xml();
if (!reel_xml) {
- notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::MISSED_CHECK_OF_ENCRYPTED});
+ context.warning(VerificationNote::Code::MISSED_CHECK_OF_ENCRYPTED);
continue;
}
}
if (mismatched_valign) {
- notes.push_back ({
- VerificationNote::Type::ERROR, VerificationNote::Code::MISMATCHED_CLOSED_CAPTION_VALIGN,
- });
+ context.error(VerificationNote::Code::MISMATCHED_CLOSED_CAPTION_VALIGN);
}
if (incorrect_order) {
- notes.push_back ({
- VerificationNote::Type::ERROR, VerificationNote::Code::INCORRECT_CLOSED_CAPTION_ORDERING,
- });
+ context.error(VerificationNote::Code::INCORRECT_CLOSED_CAPTION_ORDERING);
}
}
static
void
-verify_text_details (vector<shared_ptr<Reel>> reels, vector<VerificationNote>& notes)
+verify_text_details(Context& context, vector<shared_ptr<Reel>> reels)
{
if (reels.empty()) {
return;
}
- if (reels[0]->main_subtitle()) {
- verify_text_details (reels, reels[0]->main_subtitle()->edit_rate().numerator, notes,
+ if (reels[0]->main_subtitle() && reels[0]->main_subtitle()->asset_ref().resolved()) {
+ verify_text_details(context, reels, reels[0]->main_subtitle()->edit_rate().numerator,
[](shared_ptr<Reel> reel) {
return static_cast<bool>(reel->main_subtitle());
},
[](shared_ptr<Reel> reel) {
- 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();
+ return reel->main_subtitle()->asset()->raw_xml();
},
[](shared_ptr<Reel> reel) {
return reel->main_subtitle()->actual_duration();
+ },
+ [](shared_ptr<Reel> reel) {
+ return reel->main_subtitle()->id();
}
);
}
for (auto i = 0U; i < reels[0]->closed_captions().size(); ++i) {
- verify_text_details (reels, reels[0]->closed_captions()[i]->edit_rate().numerator, notes,
+ verify_text_details(context, reels, reels[0]->closed_captions()[i]->edit_rate().numerator,
[i](shared_ptr<Reel> reel) {
return i < reel->closed_captions().size();
},
},
[i](shared_ptr<Reel> reel) {
return reel->closed_captions()[i]->actual_duration();
+ },
+ [i](shared_ptr<Reel> reel) {
+ return reel->closed_captions()[i]->id();
}
);
}
- verify_closed_caption_details (reels, notes);
+ verify_closed_caption_details(context, reels);
}
void
-verify_extension_metadata (shared_ptr<CPL> cpl, vector<VerificationNote>& notes)
+verify_extension_metadata(Context& context, shared_ptr<const CPL> cpl)
{
DCP_ASSERT (cpl->file());
cxml::Document doc ("CompositionPlaylist");
- doc.read_file (cpl->file().get());
+ doc.read_file(dcp::filesystem::fix_long_path(cpl->file().get()));
auto missing = false;
string malformed;
}
if (missing) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_EXTENSION_METADATA, cpl->id(), cpl->file().get()});
+ context.bv21_error(VerificationNote::Code::MISSING_EXTENSION_METADATA, cpl->file().get());
} else if (!malformed.empty()) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_EXTENSION_METADATA, malformed, cpl->file().get()});
+ context.bv21_error(VerificationNote::Code::INVALID_EXTENSION_METADATA, malformed, cpl->file().get());
}
}
bool
-pkl_has_encrypted_assets (shared_ptr<DCP> dcp, shared_ptr<PKL> pkl)
+pkl_has_encrypted_assets(shared_ptr<const DCP> dcp, shared_ptr<const PKL> pkl)
{
vector<string> encrypted;
for (auto i: dcp->cpls()) {
}
}
- for (auto i: pkl->asset_list()) {
+ for (auto i: pkl->assets()) {
if (find(encrypted.begin(), encrypted.end(), i->id()) != encrypted.end()) {
return true;
}
}
-vector<VerificationNote>
-dcp::verify (
- vector<boost::filesystem::path> directories,
- function<void (string, optional<boost::filesystem::path>)> stage,
- function<void (float)> progress,
- optional<boost::filesystem::path> xsd_dtd_directory
+static
+void
+verify_reel(
+ Context& context,
+ shared_ptr<const Reel> reel,
+ int64_t start_frame,
+ optional<dcp::Size> main_picture_active_area,
+ bool* have_main_subtitle,
+ bool* have_no_main_subtitle,
+ size_t* most_closed_captions,
+ size_t* fewest_closed_captions,
+ map<Marker, Time>* markers_seen
)
{
- if (!xsd_dtd_directory) {
- xsd_dtd_directory = resources_directory() / "xsd";
+ for (auto i: reel->assets()) {
+ if (i->duration() && (i->duration().get() * i->edit_rate().denominator / i->edit_rate().numerator) < 1) {
+ context.error(VerificationNote::Code::INVALID_DURATION, i->id());
+ }
+ if ((i->intrinsic_duration() * i->edit_rate().denominator / i->edit_rate().numerator) < 1) {
+ context.error(VerificationNote::Code::INVALID_INTRINSIC_DURATION, i->id());
+ }
+ auto file_asset = dynamic_pointer_cast<ReelFileAsset>(i);
+ if (i->encryptable() && !file_asset->hash()) {
+ context.bv21_error(VerificationNote::Code::MISSING_HASH, i->id());
+ }
}
- *xsd_dtd_directory = boost::filesystem::canonical (*xsd_dtd_directory);
- vector<VerificationNote> notes;
- State state{};
+ if (context.dcp->standard() == Standard::SMPTE) {
+ boost::optional<int64_t> duration;
+ for (auto i: reel->assets()) {
+ if (!duration) {
+ duration = i->actual_duration();
+ } else if (*duration != i->actual_duration()) {
+ context.bv21_error(VerificationNote::Code::MISMATCHED_ASSET_DURATION);
+ break;
+ }
+ }
+ }
+
+ if (reel->main_picture()) {
+ /* Check reel stuff */
+ auto 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)) {
+ context.error(VerificationNote::Code::INVALID_PICTURE_FRAME_RATE, String::compose("%1/%2", frame_rate.numerator, frame_rate.denominator));
+ }
+ /* Check asset */
+ if (reel->main_picture()->asset_ref().resolved()) {
+ verify_main_picture_asset(context, reel->main_picture(), start_frame);
+ auto const asset_size = reel->main_picture()->asset()->size();
+ if (main_picture_active_area) {
+ if (main_picture_active_area->width > asset_size.width) {
+ context.error(
+ VerificationNote::Code::INVALID_MAIN_PICTURE_ACTIVE_AREA,
+ String::compose("width %1 is bigger than the asset width %2", main_picture_active_area->width, asset_size.width),
+ context.cpl->file().get()
+ );
+ }
+ if (main_picture_active_area->height > asset_size.height) {
+ context.error(
+ VerificationNote::Code::INVALID_MAIN_PICTURE_ACTIVE_AREA,
+ String::compose("height %1 is bigger than the asset height %2", main_picture_active_area->height, asset_size.height),
+ context.cpl->file().get()
+ );
+ }
+ }
+ }
- vector<shared_ptr<DCP>> dcps;
- for (auto i: directories) {
- dcps.push_back (make_shared<DCP>(i));
}
- for (auto dcp: dcps) {
- stage ("Checking DCP", dcp->directory());
- bool carry_on = true;
- try {
- 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::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
- } catch (XMLError& e) {
- notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
- } catch (MXFFileError& e) {
- notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
- } catch (cxml::Error& e) {
- notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
+ if (reel->main_sound() && reel->main_sound()->asset_ref().resolved()) {
+ verify_main_sound_asset(context, reel->main_sound());
+ }
+
+ if (reel->main_subtitle()) {
+ verify_main_subtitle_reel(context, reel->main_subtitle());
+ if (reel->main_subtitle()->asset_ref().resolved()) {
+ verify_subtitle_asset(context, reel->main_subtitle()->asset(), reel->main_subtitle()->duration());
}
+ *have_main_subtitle = true;
+ } else {
+ *have_no_main_subtitle = true;
+ }
- if (!carry_on) {
- continue;
+ for (auto i: reel->closed_captions()) {
+ verify_closed_caption_reel(context, i);
+ if (i->asset_ref().resolved()) {
+ verify_closed_caption_asset(context, i->asset(), i->duration());
}
+ }
- if (dcp->standard() != Standard::SMPTE) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_STANDARD});
+ if (reel->main_markers()) {
+ for (auto const& i: reel->main_markers()->get()) {
+ markers_seen->insert(i);
+ }
+ if (reel->main_markers()->entry_point()) {
+ context.error(VerificationNote::Code::UNEXPECTED_ENTRY_POINT);
}
+ if (reel->main_markers()->duration()) {
+ context.error(VerificationNote::Code::UNEXPECTED_DURATION);
+ }
+ }
- for (auto cpl: dcp->cpls()) {
- stage ("Checking CPL", cpl->file());
- validate_xml (cpl->file().get(), *xsd_dtd_directory, notes);
+ *fewest_closed_captions = std::min(*fewest_closed_captions, reel->closed_captions().size());
+ *most_closed_captions = std::max(*most_closed_captions, reel->closed_captions().size());
+
+}
- if (cpl->any_encrypted() && !cpl->all_encrypted()) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::PARTIALLY_ENCRYPTED});
- }
- for (auto const& i: cpl->additional_subtitle_languages()) {
- verify_language_tag (i, notes);
+static
+void
+verify_cpl(Context& context, shared_ptr<const CPL> cpl)
+{
+ context.stage("Checking CPL", cpl->file());
+ validate_xml(context, cpl->file().get());
+
+ if (cpl->any_encrypted() && !cpl->all_encrypted()) {
+ context.bv21_error(VerificationNote::Code::PARTIALLY_ENCRYPTED);
+ } else if (cpl->all_encrypted()) {
+ context.ok(VerificationNote::Code::ALL_ENCRYPTED);
+ } else if (!cpl->all_encrypted()) {
+ context.ok(VerificationNote::Code::NONE_ENCRYPTED);
+ }
+
+ for (auto const& i: cpl->additional_subtitle_languages()) {
+ verify_language_tag(context, i);
+ }
+
+ if (!cpl->content_kind().scope() || *cpl->content_kind().scope() == "http://www.smpte-ra.org/schemas/429-7/2006/CPL#standard-content") {
+ /* This is a content kind from http://www.smpte-ra.org/schemas/429-7/2006/CPL#standard-content; make sure it's one
+ * of the approved ones.
+ */
+ auto all = ContentKind::all();
+ auto name = cpl->content_kind().name();
+ transform(name.begin(), name.end(), name.begin(), ::tolower);
+ auto iter = std::find_if(all.begin(), all.end(), [name](ContentKind const& k) { return !k.scope() && k.name() == name; });
+ if (iter == all.end()) {
+ context.error(VerificationNote::Code::INVALID_CONTENT_KIND, cpl->content_kind().name());
+ }
+ }
+
+ if (cpl->release_territory()) {
+ if (!cpl->release_territory_scope() || cpl->release_territory_scope().get() != "http://www.smpte-ra.org/schemas/429-16/2014/CPL-Metadata#scope/release-territory/UNM49") {
+ auto terr = cpl->release_territory().get();
+ bool valid = true;
+ /* Must be a valid region tag, or "001" */
+ try {
+ LanguageTag::RegionSubtag test(terr);
+ } catch (...) {
+ if (terr != "001") {
+ context.bv21_error(VerificationNote::Code::INVALID_LANGUAGE, terr);
+ valid = false;
+ }
}
+ if (valid) {
+ context.ok(VerificationNote::Code::VALID_RELEASE_TERRITORY, terr);
+ }
+ }
+ }
- if (cpl->release_territory()) {
- if (!cpl->release_territory_scope() || cpl->release_territory_scope().get() != "http://www.smpte-ra.org/schemas/429-16/2014/CPL-Metadata#scope/release-territory/UNM49") {
- auto terr = cpl->release_territory().get();
- /* Must be a valid region tag, or "001" */
- try {
- LanguageTag::RegionSubtag test (terr);
- } catch (...) {
- if (terr != "001") {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_LANGUAGE, terr});
- }
+ for (auto version: cpl->content_versions()) {
+ if (version.label_text.empty()) {
+ context.warning(VerificationNote::Code::EMPTY_CONTENT_VERSION_LABEL_TEXT, cpl->file().get());
+ break;
+ }
+ }
+
+ if (context.dcp->standard() == Standard::SMPTE) {
+ if (!cpl->annotation_text()) {
+ context.bv21_error(VerificationNote::Code::MISSING_CPL_ANNOTATION_TEXT, cpl->file().get());
+ } else if (cpl->annotation_text().get() != cpl->content_title_text()) {
+ context.warning(VerificationNote::Code::MISMATCHED_CPL_ANNOTATION_TEXT, cpl->file().get());
+ } else {
+ context.ok(VerificationNote::Code::VALID_CPL_ANNOTATION_TEXT, cpl->annotation_text().get());
+ }
+ }
+
+ for (auto i: context.dcp->pkls()) {
+ /* Check that the CPL's hash corresponds to the PKL */
+ optional<string> h = i->hash(cpl->id());
+ auto calculated_cpl_hash = make_digest(ArrayData(*cpl->file()));
+ if (h && calculated_cpl_hash != *h) {
+ context.add_note(
+ dcp::VerificationNote(
+ VerificationNote::Type::ERROR,
+ VerificationNote::Code::MISMATCHED_CPL_HASHES,
+ cpl->file().get()
+ ).set_calculated_hash(calculated_cpl_hash).set_reference_hash(*h)
+ );
+ } else {
+ context.ok(VerificationNote::Code::MATCHING_CPL_HASHES);
+ }
+
+ /* Check that any PKL with a single CPL has its AnnotationText the same as the CPL's ContentTitleText */
+ optional<string> required_annotation_text;
+ for (auto j: i->assets()) {
+ /* See if this is a CPL */
+ for (auto k: context.dcp->cpls()) {
+ if (j->id() == k->id()) {
+ if (!required_annotation_text) {
+ /* First CPL we have found; this is the required AnnotationText unless we find another */
+ required_annotation_text = cpl->content_title_text();
+ } else {
+ /* There's more than one CPL so we don't care what the PKL's AnnotationText is */
+ required_annotation_text = boost::none;
}
}
}
+ }
- if (dcp->standard() == Standard::SMPTE) {
- if (!cpl->annotation_text()) {
- 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::Type::WARNING, VerificationNote::Code::MISMATCHED_CPL_ANNOTATION_TEXT, cpl->id(), cpl->file().get()});
- }
+ if (required_annotation_text && i->annotation_text() != required_annotation_text) {
+ context.bv21_error(VerificationNote::Code::MISMATCHED_PKL_ANNOTATION_TEXT_WITH_CPL, i->id(), i->file().get());
+ } else {
+ context.ok(VerificationNote::Code::MATCHING_PKL_ANNOTATION_TEXT_WITH_CPL);
+ }
+ }
+
+ /* set to true if any reel has a MainSubtitle */
+ auto have_main_subtitle = false;
+ /* set to true if any reel has no MainSubtitle */
+ auto have_no_main_subtitle = false;
+ /* fewest number of closed caption assets seen in a reel */
+ size_t fewest_closed_captions = SIZE_MAX;
+ /* most number of closed caption assets seen in a reel */
+ size_t most_closed_captions = 0;
+ map<Marker, Time> markers_seen;
+
+ auto const main_picture_active_area = cpl->main_picture_active_area();
+ bool active_area_ok = true;
+ if (main_picture_active_area && (main_picture_active_area->width % 2)) {
+ context.error(
+ VerificationNote::Code::INVALID_MAIN_PICTURE_ACTIVE_AREA,
+ String::compose("width %1 is not a multiple of 2", main_picture_active_area->width),
+ cpl->file().get()
+ );
+ active_area_ok = false;
+ }
+ if (main_picture_active_area && (main_picture_active_area->height % 2)) {
+ context.error(
+ VerificationNote::Code::INVALID_MAIN_PICTURE_ACTIVE_AREA,
+ String::compose("height %1 is not a multiple of 2", main_picture_active_area->height),
+ cpl->file().get()
+ );
+ active_area_ok = false;
+ }
+
+ if (main_picture_active_area && active_area_ok) {
+ context.ok(
+ VerificationNote::Code::VALID_MAIN_PICTURE_ACTIVE_AREA, String::compose("%1x%2", main_picture_active_area->width, main_picture_active_area->height),
+ cpl->file().get()
+ );
+ }
+
+ int64_t frame = 0;
+ for (auto reel: cpl->reels()) {
+ context.stage("Checking reel", optional<boost::filesystem::path>());
+ verify_reel(
+ context,
+ reel,
+ frame,
+ main_picture_active_area,
+ &have_main_subtitle,
+ &have_no_main_subtitle,
+ &most_closed_captions,
+ &fewest_closed_captions,
+ &markers_seen
+ );
+ frame += reel->duration();
+ }
+
+ verify_text_details(context, cpl->reels());
+
+ if (context.dcp->standard() == Standard::SMPTE) {
+ if (auto msc = cpl->main_sound_configuration()) {
+ if (context.audio_channels && msc->channels() != *context.audio_channels) {
+ context.error(
+ VerificationNote::Code::INVALID_MAIN_SOUND_CONFIGURATION,
+ String::compose("MainSoundConfiguration has %1 channels but sound assets have %2", msc->channels(), *context.audio_channels),
+ cpl->file().get()
+ );
}
+ }
- for (auto i: dcp->pkls()) {
- /* 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::Type::ERROR, VerificationNote::Code::MISMATCHED_CPL_HASHES, cpl->id(), cpl->file().get()});
- }
+ if (have_main_subtitle && have_no_main_subtitle) {
+ context.bv21_error(VerificationNote::Code::MISSING_MAIN_SUBTITLE_FROM_SOME_REELS);
+ }
- /* Check that any PKL with a single CPL has its AnnotationText the same as the CPL's ContentTitleText */
- optional<string> required_annotation_text;
- for (auto j: i->asset_list()) {
- /* See if this is a CPL */
- for (auto k: dcp->cpls()) {
- if (j->id() == k->id()) {
- if (!required_annotation_text) {
- /* First CPL we have found; this is the required AnnotationText unless we find another */
- required_annotation_text = cpl->content_title_text();
- } else {
- /* There's more than one CPL so we don't care what the PKL's AnnotationText is */
- required_annotation_text = boost::none;
- }
- }
- }
- }
+ if (fewest_closed_captions != most_closed_captions) {
+ context.bv21_error(VerificationNote::Code::MISMATCHED_CLOSED_CAPTION_ASSET_COUNTS);
+ }
- if (required_annotation_text && i->annotation_text() != required_annotation_text) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISMATCHED_PKL_ANNOTATION_TEXT_WITH_CPL, i->id(), i->file().get()});
- }
+ if (cpl->content_kind() == ContentKind::FEATURE) {
+ if (markers_seen.find(Marker::FFEC) == markers_seen.end()) {
+ context.bv21_error(VerificationNote::Code::MISSING_FFEC_IN_FEATURE);
+ }
+ if (markers_seen.find(Marker::FFMC) == markers_seen.end()) {
+ context.bv21_error(VerificationNote::Code::MISSING_FFMC_IN_FEATURE);
}
+ }
- /* set to true if any reel has a MainSubtitle */
- auto have_main_subtitle = false;
- /* set to true if any reel has no MainSubtitle */
- auto have_no_main_subtitle = false;
- /* fewest number of closed caption assets seen in a reel */
- size_t fewest_closed_captions = SIZE_MAX;
- /* most number of closed caption assets seen in a reel */
- size_t most_closed_captions = 0;
- map<Marker, Time> markers_seen;
-
- for (auto reel: cpl->reels()) {
- stage ("Checking reel", optional<boost::filesystem::path>());
-
- for (auto i: reel->assets()) {
- if (i->duration() && (i->duration().get() * i->edit_rate().denominator / i->edit_rate().numerator) < 1) {
- 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::Type::ERROR, VerificationNote::Code::INVALID_INTRINSIC_DURATION, 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()});
- }
- }
+ auto ffoc = markers_seen.find(Marker::FFOC);
+ if (ffoc == markers_seen.end()) {
+ context.warning(VerificationNote::Code::MISSING_FFOC);
+ } else if (ffoc->second.e != 1) {
+ context.warning(VerificationNote::Code::INCORRECT_FFOC, raw_convert<string>(ffoc->second.e));
+ }
- if (dcp->standard() == Standard::SMPTE) {
- boost::optional<int64_t> duration;
- for (auto i: reel->assets()) {
- if (!duration) {
- duration = i->actual_duration();
- } else if (*duration != i->actual_duration()) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISMATCHED_ASSET_DURATION});
- break;
- }
- }
- }
+ auto lfoc = markers_seen.find(Marker::LFOC);
+ if (lfoc == markers_seen.end()) {
+ context.warning(VerificationNote::Code::MISSING_LFOC);
+ } else {
+ auto lfoc_time = lfoc->second.as_editable_units_ceil(lfoc->second.tcr);
+ if (lfoc_time != (cpl->reels().back()->duration() - 1)) {
+ context.warning(VerificationNote::Code::INCORRECT_LFOC, raw_convert<string>(lfoc_time));
+ }
+ }
- if (reel->main_picture()) {
- /* Check reel stuff */
- auto 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::Type::ERROR,
- VerificationNote::Code::INVALID_PICTURE_FRAME_RATE,
- String::compose("%1/%2", frame_rate.numerator, frame_rate.denominator)
- });
- }
- /* Check asset */
- if (reel->main_picture()->asset_ref().resolved()) {
- verify_main_picture_asset (dcp, reel->main_picture(), stage, progress, notes);
- }
- }
+ LinesCharactersResult result;
+ for (auto reel: cpl->reels()) {
+ if (reel->main_subtitle() && reel->main_subtitle()->asset_ref().resolved()) {
+ verify_text_lines_and_characters(reel->main_subtitle()->asset(), 52, 79, &result);
+ }
+ }
- if (reel->main_sound() && reel->main_sound()->asset_ref().resolved()) {
- verify_main_sound_asset (dcp, reel->main_sound(), stage, progress, notes);
- }
+ if (result.line_count_exceeded) {
+ context.warning(VerificationNote::Code::INVALID_SUBTITLE_LINE_COUNT);
+ }
+ if (result.error_length_exceeded) {
+ context.warning(VerificationNote::Code::INVALID_SUBTITLE_LINE_LENGTH);
+ } else if (result.warning_length_exceeded) {
+ context.warning(VerificationNote::Code::NEARLY_INVALID_SUBTITLE_LINE_LENGTH);
+ }
- 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(), reel->main_subtitle()->duration(), stage, *xsd_dtd_directory, notes, state);
- }
- have_main_subtitle = true;
- } else {
- have_no_main_subtitle = true;
+ result = LinesCharactersResult();
+ for (auto reel: cpl->reels()) {
+ for (auto i: reel->closed_captions()) {
+ if (i->asset()) {
+ verify_text_lines_and_characters(i->asset(), 32, 32, &result);
}
+ }
+ }
- for (auto i: reel->closed_captions()) {
- verify_closed_caption_reel (i, notes);
- if (i->asset_ref().resolved()) {
- verify_closed_caption_asset (i->asset(), i->duration(), stage, *xsd_dtd_directory, notes);
- }
- }
+ if (result.line_count_exceeded) {
+ context.bv21_error(VerificationNote::Code::INVALID_CLOSED_CAPTION_LINE_COUNT);
+ }
+ if (result.error_length_exceeded) {
+ context.bv21_error(VerificationNote::Code::INVALID_CLOSED_CAPTION_LINE_LENGTH);
+ }
- if (reel->main_markers()) {
- for (auto const& i: reel->main_markers()->get()) {
- markers_seen.insert (i);
- }
- if (reel->main_markers()->entry_point()) {
- notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::UNEXPECTED_ENTRY_POINT});
- }
- if (reel->main_markers()->duration()) {
- notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::UNEXPECTED_DURATION});
- }
- }
+ if (!cpl->read_composition_metadata()) {
+ context.bv21_error(VerificationNote::Code::MISSING_CPL_METADATA, cpl->file().get());
+ } else if (!cpl->version_number()) {
+ context.bv21_error(VerificationNote::Code::MISSING_CPL_METADATA_VERSION_NUMBER, cpl->file().get());
+ }
+
+ verify_extension_metadata(context, cpl);
- fewest_closed_captions = std::min (fewest_closed_captions, reel->closed_captions().size());
- most_closed_captions = std::max (most_closed_captions, reel->closed_captions().size());
+ if (cpl->any_encrypted()) {
+ cxml::Document doc("CompositionPlaylist");
+ DCP_ASSERT(cpl->file());
+ doc.read_file(dcp::filesystem::fix_long_path(cpl->file().get()));
+ if (!doc.optional_node_child("Signature")) {
+ context.bv21_error(VerificationNote::Code::UNSIGNED_CPL_WITH_ENCRYPTED_CONTENT, cpl->file().get());
}
+ }
+ }
+}
- verify_text_details (cpl->reels(), notes);
- if (dcp->standard() == Standard::SMPTE) {
+static
+void
+verify_pkl(Context& context, shared_ptr<const PKL> pkl)
+{
+ validate_xml(context, pkl->file().get());
- if (have_main_subtitle && have_no_main_subtitle) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_MAIN_SUBTITLE_FROM_SOME_REELS});
- }
+ if (pkl_has_encrypted_assets(context.dcp, pkl)) {
+ cxml::Document doc("PackingList");
+ doc.read_file(dcp::filesystem::fix_long_path(pkl->file().get()));
+ if (!doc.optional_node_child("Signature")) {
+ context.bv21_error(VerificationNote::Code::UNSIGNED_PKL_WITH_ENCRYPTED_CONTENT, pkl->id(), pkl->file().get());
+ }
+ }
- if (fewest_closed_captions != most_closed_captions) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISMATCHED_CLOSED_CAPTION_ASSET_COUNTS});
- }
+ set<string> uuid_set;
+ for (auto asset: pkl->assets()) {
+ if (!uuid_set.insert(asset->id()).second) {
+ context.error(VerificationNote::Code::DUPLICATE_ASSET_ID_IN_PKL, pkl->id(), pkl->file().get());
+ break;
+ }
+ }
+}
- if (cpl->content_kind() == ContentKind::FEATURE) {
- if (markers_seen.find(Marker::FFEC) == markers_seen.end()) {
- 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::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::Type::WARNING, VerificationNote::Code::MISSING_FFOC});
- } else if (ffoc->second.e != 1) {
- 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::Type::WARNING, VerificationNote::Code::MISSING_LFOC});
- } else {
- auto lfoc_time = lfoc->second.as_editable_units_ceil(lfoc->second.tcr);
- if (lfoc_time != (cpl->reels().back()->duration() - 1)) {
- notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::INCORRECT_LFOC, raw_convert<string>(lfoc_time)});
- }
- }
+static
+void
+verify_assetmap(Context& context, shared_ptr<const DCP> dcp)
+{
+ auto asset_map = dcp->asset_map();
+ DCP_ASSERT(asset_map);
- LinesCharactersResult result;
- for (auto reel: cpl->reels()) {
- if (reel->main_subtitle() && reel->main_subtitle()->asset()) {
- verify_text_lines_and_characters (reel->main_subtitle()->asset(), 52, 79, &result);
- }
- }
+ validate_xml(context, asset_map->file().get());
- if (result.line_count_exceeded) {
- notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::INVALID_SUBTITLE_LINE_COUNT});
- }
- if (result.error_length_exceeded) {
- notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::INVALID_SUBTITLE_LINE_LENGTH});
- } else if (result.warning_length_exceeded) {
- notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::NEARLY_INVALID_SUBTITLE_LINE_LENGTH});
- }
+ set<string> uuid_set;
+ for (auto const& asset: asset_map->assets()) {
+ if (!uuid_set.insert(asset.id()).second) {
+ context.error(VerificationNote::Code::DUPLICATE_ASSET_ID_IN_ASSETMAP, asset_map->id(), asset_map->file().get());
+ break;
+ }
+ }
+}
- result = LinesCharactersResult();
- for (auto reel: cpl->reels()) {
- for (auto i: reel->closed_captions()) {
- if (i->asset()) {
- verify_text_lines_and_characters (i->asset(), 32, 32, &result);
- }
- }
- }
- if (result.line_count_exceeded) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_CLOSED_CAPTION_LINE_COUNT});
- }
- if (result.error_length_exceeded) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_CLOSED_CAPTION_LINE_LENGTH});
- }
+dcp::VerifyResult
+dcp::verify (
+ vector<boost::filesystem::path> directories,
+ vector<dcp::DecryptedKDM> kdms,
+ function<void (string, optional<boost::filesystem::path>)> stage,
+ function<void (float)> progress,
+ VerificationOptions options,
+ optional<boost::filesystem::path> xsd_dtd_directory
+ )
+{
+ if (!xsd_dtd_directory) {
+ xsd_dtd_directory = resources_directory() / "xsd";
+ }
+ *xsd_dtd_directory = filesystem::canonical(*xsd_dtd_directory);
- if (!cpl->read_composition_metadata()) {
- 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::Type::BV21_ERROR, VerificationNote::Code::MISSING_CPL_METADATA_VERSION_NUMBER, cpl->id(), cpl->file().get()});
- }
+ vector<VerificationNote> notes;
+ Context context(notes, *xsd_dtd_directory, stage, progress, options);
+
+ vector<shared_ptr<DCP>> dcps;
+ for (auto i: directories) {
+ dcps.push_back (make_shared<DCP>(i));
+ }
- verify_extension_metadata (cpl, notes);
+ for (auto dcp: dcps) {
+ stage ("Checking DCP", dcp->directory());
- if (cpl->any_encrypted()) {
- cxml::Document doc ("CompositionPlaylist");
- DCP_ASSERT (cpl->file());
- doc.read_file (cpl->file().get());
- if (!doc.optional_node_child("Signature")) {
- notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::UNSIGNED_CPL_WITH_ENCRYPTED_CONTENT, cpl->id(), cpl->file().get()});
- }
- }
+ context.dcp = dcp;
+
+ bool carry_on = true;
+ try {
+ dcp->read (¬es, true);
+ } catch (MissingAssetmapError& e) {
+ context.error(VerificationNote::Code::FAILED_READ, string(e.what()));
+ carry_on = false;
+ } catch (ReadError& e) {
+ context.error(VerificationNote::Code::FAILED_READ, string(e.what()));
+ } catch (XMLError& e) {
+ context.error(VerificationNote::Code::FAILED_READ, string(e.what()));
+ } catch (MXFFileError& e) {
+ context.error(VerificationNote::Code::FAILED_READ, string(e.what()));
+ } catch (BadURNUUIDError& e) {
+ context.error(VerificationNote::Code::FAILED_READ, string(e.what()));
+ } catch (cxml::Error& e) {
+ context.error(VerificationNote::Code::FAILED_READ, string(e.what()));
+ }
+
+ if (!carry_on) {
+ continue;
+ }
+
+ if (dcp->standard() != Standard::SMPTE) {
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_STANDARD});
+ }
+
+ for (auto kdm: kdms) {
+ dcp->add(kdm);
+ }
+
+ for (auto cpl: dcp->cpls()) {
+ try {
+ context.cpl = cpl;
+ verify_cpl(context, cpl);
+ context.cpl.reset();
+ } catch (ReadError& e) {
+ notes.push_back({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
}
}
for (auto pkl: dcp->pkls()) {
- stage ("Checking PKL", pkl->file());
- 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::Type::BV21_ERROR, VerificationNote::Code::UNSIGNED_PKL_WITH_ENCRYPTED_CONTENT, pkl->id(), pkl->file().get()});
- }
- }
+ stage("Checking PKL", pkl->file());
+ verify_pkl(context, pkl);
}
- if (dcp->asset_map_path()) {
- stage ("Checking ASSETMAP", dcp->asset_map_path().get());
- validate_xml (dcp->asset_map_path().get(), *xsd_dtd_directory, notes);
+ if (dcp->asset_map_file()) {
+ stage("Checking ASSETMAP", dcp->asset_map_file().get());
+ verify_assetmap(context, dcp);
} else {
- notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::MISSING_ASSETMAP});
+ context.error(VerificationNote::Code::MISSING_ASSETMAP);
}
}
- return notes;
+ return { notes, dcps };
}
switch (note.code()) {
case VerificationNote::Code::FAILED_READ:
return *note.note();
+ case VerificationNote::Code::MATCHING_CPL_HASHES:
+ return "The hash of the CPL in the PKL matches the CPL file.";
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());
+ return String::compose("The hash (%1) of the CPL (%2) in the PKL does not agree with the CPL file (%3).", note.reference_hash().get(), note.cpl_id().get(), note.calculated_hash().get());
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::Code::INCORRECT_PICTURE_HASH:
- return String::compose("The hash of the picture asset %1 does not agree with the PKL file.", note.file()->filename());
+ return String::compose("The hash (%1) of the picture asset %2 does not agree with the PKL file (%3).", note.calculated_hash().get(), note.file()->filename(), note.reference_hash().get());
+ case VerificationNote::Code::CORRECT_PICTURE_HASH:
+ return String::compose("The picture asset %1 has the expected hashes in the CPL and PKL.", note.file()->filename());
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::Code::INCORRECT_SOUND_HASH:
- return String::compose("The hash of the sound asset %1 does not agree with the PKL file.", note.file()->filename());
+ return String::compose("The hash (%1) of the sound asset %2 does not agree with the PKL file (%3).", note.calculated_hash().get(), note.file()->filename(), note.reference_hash().get());
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::Code::EMPTY_ASSET_PATH:
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::Code::MISSING_ASSETMAP:
- return "No ASSETMAP or ASSETMAP.xml was found.";
+ return "No valid ASSETMAP or ASSETMAP.xml was found.";
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::VALID_PICTURE_FRAME_SIZES_IN_BYTES:
+ return String::compose("Each frame of the picture asset %1 has a bit rate safely under the limit of 250Mbit/s.", note.file()->filename());
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());
+ return String::compose(
+ "Frame %1 (timecode %2) in asset %3 has an instantaneous bit rate that is larger than the limit of 250Mbit/s.",
+ note.frame().get(),
+ dcp::Time(note.frame().get(), note.frame_rate().get(), note.frame_rate().get()).as_string(dcp::Standard::SMPTE),
+ note.file()->filename()
+ );
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());
+ return String::compose(
+ "Frame %1 (timecode %2) in asset %3 has an instantaneous bit rate that is close to the limit of 250Mbit/s.",
+ note.frame().get(),
+ dcp::Time(note.frame().get(), note.frame_rate().get(), note.frame_rate().get()).as_string(dcp::Standard::SMPTE),
+ note.file()->filename()
+ );
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::Code::THREED_ASSET_MARKED_AS_TWOD:
return "This DCP does not use the SMPTE standard.";
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::Code::VALID_RELEASE_TERRITORY:
+ return String::compose("Valid release territory %1.", note.note().get());
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::Code::INVALID_PICTURE_FRAME_RATE_FOR_2K:
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::Code::MISSING_CPL_ANNOTATION_TEXT:
- return String::compose("The CPL %1 has no <AnnotationText> tag.", note.note().get());
+ return String::compose("The CPL %1 has no <AnnotationText> tag.", note.cpl_id().get());
case VerificationNote::Code::MISMATCHED_CPL_ANNOTATION_TEXT:
- return String::compose("The CPL %1 has an <AnnotationText> which differs from its <ContentTitleText>.", note.note().get());
+ return String::compose("The CPL %1 has an <AnnotationText> which differs from its <ContentTitleText>.", note.cpl_id().get());
+ case VerificationNote::Code::VALID_CPL_ANNOTATION_TEXT:
+ return String::compose("Valid CPL annotation text %1", note.note().get());
case VerificationNote::Code::MISMATCHED_ASSET_DURATION:
return "All assets in a reel do not have the same duration.";
case VerificationNote::Code::MISSING_MAIN_SUBTITLE_FROM_SOME_REELS:
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::Code::MISSING_CPL_METADATA:
- return String::compose("The CPL %1 has no <CompositionMetadataAsset> tag.", note.note().get());
+ return String::compose("The CPL %1 has no <CompositionMetadataAsset> tag.", note.cpl_id().get());
case VerificationNote::Code::MISSING_CPL_METADATA_VERSION_NUMBER:
- return String::compose("The CPL %1 has no <VersionNumber> in its <CompositionMetadataAsset>.", note.note().get());
+ return String::compose("The CPL %1 has no <VersionNumber> in its <CompositionMetadataAsset>.", note.cpl_id().get());
case VerificationNote::Code::MISSING_EXTENSION_METADATA:
- return String::compose("The CPL %1 has no <ExtensionMetadata> in its <CompositionMetadataAsset>.", note.note().get());
+ return String::compose("The CPL %1 has no <ExtensionMetadata> in its <CompositionMetadataAsset>.", note.cpl_id().get());
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::Code::UNSIGNED_CPL_WITH_ENCRYPTED_CONTENT:
- return String::compose("The CPL %1, which has encrypted content, is not signed.", note.note().get());
+ return String::compose("The CPL %1, which has encrypted content, is not signed.", note.cpl_id().get());
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::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::MATCHING_PKL_ANNOTATION_TEXT_WITH_CPL:
+ return "The PKL and CPL annotation texts match.";
+ case VerificationNote::Code::ALL_ENCRYPTED:
+ return "All the assets are encrypted.";
+ case VerificationNote::Code::NONE_ENCRYPTED:
+ return "All the assets are unencrypted.";
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());
+ return String::compose(
+ "Frame %1 (timecode %2) has an invalid JPEG2000 codestream (%3).",
+ note.frame().get(),
+ dcp::Time(note.frame().get(), note.frame_rate().get(), note.frame_rate().get()).as_string(dcp::Standard::SMPTE),
+ 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 "There is an <EntryPoint> node inside a <MainMarkers>.";
case VerificationNote::Code::UNEXPECTED_DURATION:
return "There is an <Duration> node inside a <MainMarkers>.";
+ case VerificationNote::Code::INVALID_CONTENT_KIND:
+ return String::compose("<ContentKind> has an invalid value %1.", note.note().get());
+ case VerificationNote::Code::INVALID_MAIN_PICTURE_ACTIVE_AREA:
+ return String::compose("<MainPictureActiveaArea> has an invalid value: %1", note.note().get());
+ case VerificationNote::Code::VALID_MAIN_PICTURE_ACTIVE_AREA:
+ return String::compose("<MainPictureActiveaArea> %1 is valid", note.note().get());
+ case VerificationNote::Code::DUPLICATE_ASSET_ID_IN_PKL:
+ return String::compose("The PKL %1 has more than one asset with the same ID.", note.note().get());
+ case VerificationNote::Code::DUPLICATE_ASSET_ID_IN_ASSETMAP:
+ return String::compose("The ASSETMAP %1 has more than one asset with the same ID.", note.note().get());
+ case VerificationNote::Code::MISSING_SUBTITLE:
+ return String::compose("The subtitle asset %1 has no subtitles.", note.note().get());
+ case VerificationNote::Code::INVALID_SUBTITLE_ISSUE_DATE:
+ return String::compose("<IssueDate> has an invalid value: %1", note.note().get());
+ case VerificationNote::Code::MISMATCHED_SOUND_CHANNEL_COUNTS:
+ return String::compose("The sound assets do not all have the same channel count; the first to differ is %1", note.file()->filename());
+ case VerificationNote::Code::INVALID_MAIN_SOUND_CONFIGURATION:
+ return String::compose("<MainSoundConfiguration> has an invalid value: %1", note.note().get());
+ case VerificationNote::Code::MISSING_FONT:
+ return String::compose("The font file for font ID \"%1\" was not found, or was not referred to in the ASSETMAP.", note.note().get());
+ case VerificationNote::Code::INVALID_JPEG2000_TILE_PART_SIZE:
+ return String::compose(
+ "Frame %1 has an image component that is too large (component %2 is %3 bytes in size).",
+ note.frame().get(), note.component().get(), note.size().get()
+ );
+ case VerificationNote::Code::INCORRECT_SUBTITLE_NAMESPACE_COUNT:
+ return String::compose("The XML in the subtitle asset %1 has more than one namespace declaration.", note.note().get());
+ case VerificationNote::Code::MISSING_LOAD_FONT_FOR_FONT:
+ return String::compose("A subtitle or closed caption refers to a font with ID %1 that does not have a corresponding <LoadFont> node", note.id().get());
+ case VerificationNote::Code::MISSING_LOAD_FONT:
+ return String::compose("The SMPTE subtitle asset %1 has <Text> nodes but no <LoadFont> node", note.id().get());
+ case VerificationNote::Code::MISMATCHED_ASSET_MAP_ID:
+ return String::compose("The asset with ID %1 in the asset map actually has an id of %2", note.id().get(), note.other_id().get());
+ case VerificationNote::Code::EMPTY_CONTENT_VERSION_LABEL_TEXT:
+ return String::compose("The <LabelText> in a <ContentVersion> in CPL %1 is empty", note.cpl_id().get());
}
return "";
bool
dcp::operator== (dcp::VerificationNote const& a, dcp::VerificationNote const& b)
{
- return a.type() == b.type() && a.code() == b.code() && a.note() == b.note() && a.file() == b.file() && a.line() == b.line();
+ return a.type() == b.type() &&
+ a.code() == b.code() &&
+ a.note() == b.note() &&
+ a.file() == b.file() &&
+ a.line() == b.line() &&
+ a.frame() == b.frame() &&
+ a.component() == b.component() &&
+ a.size() == b.size() &&
+ a.id() == b.id() &&
+ a.other_id() == b.other_id() &&
+ a.frame_rate() == b.frame_rate() &&
+ a.cpl_id() == b.cpl_id() &&
+ a.reference_hash() == b.reference_hash() &&
+ a.calculated_hash() == b.calculated_hash();
+}
+
+
+bool
+dcp::operator!=(dcp::VerificationNote const& a, dcp::VerificationNote const& b)
+{
+ return !(a == b);
}
return a.file().get_value_or("") < b.file().get_value_or("");
}
- return a.line().get_value_or(0) < b.line().get_value_or(0);
+ if (a.line() != b.line()) {
+ return a.line().get_value_or(0) < b.line().get_value_or(0);
+ }
+
+ if (a.frame() != b.frame()) {
+ return a.frame().get_value_or(0) < b.frame().get_value_or(0);
+ }
+
+ if (a.component() != b.component()) {
+ return a.component().get_value_or(0) < b.component().get_value_or(0);
+ }
+
+ if (a.size() != b.size()) {
+ return a.size().get_value_or(0) < b.size().get_value_or(0);
+ }
+
+ if (a.id() != b.id()) {
+ return a.id().get_value_or("") < b.id().get_value_or("");
+ }
+
+ if (a.other_id() != b.other_id()) {
+ return a.other_id().get_value_or("") < b.other_id().get_value_or("");
+ }
+
+ return a.frame_rate().get_value_or(0) != b.frame_rate().get_value_or(0);
}
projects / libdcp.git / blobdiff