files in the program, then also delete it here.
*/
+
+/** @file src/verify.cc
+ * @brief dcp::verify() method and associated code
+ */
+
+
#include "verify.h"
#include "dcp.h"
#include "cpl.h"
#include <xercesc/dom/DOMErrorHandler.hpp>
#include <xercesc/framework/LocalFileInputSource.hpp>
#include <xercesc/framework/MemBufInputSource.hpp>
-#include <boost/noncopyable.hpp>
#include <boost/algorithm/string.hpp>
#include <map>
#include <vector>
#include <iostream>
+
using std::list;
using std::vector;
using std::string;
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:
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:
XMLPlatformUtils::Terminate ();
for (auto i: error_handler.errors()) {
- notes.push_back (
- VerificationNote(
- VerificationNote::VERIFY_ERROR,
- VerificationNote::XML_VALIDATION_ERROR,
- i.message(),
- boost::trim_copy(i.public_id() + " " + i.system_id()),
- i.line()
- )
- );
+ notes.push_back ({
+ 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;
}
verify_language_tag (string tag, vector<VerificationNote>& notes)
{
try {
- dcp::LanguageTag test (tag);
- } catch (dcp::LanguageTagError &) {
- notes.push_back (VerificationNote(VerificationNote::VERIFY_BV21_ERROR, VerificationNote::BAD_LANGUAGE, tag));
+ LanguageTag test (tag);
+ } catch (LanguageTagError &) {
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_LANGUAGE, tag});
}
}
-enum VerifyPictureAssetResult
+enum class VerifyPictureAssetResult
{
- VERIFY_PICTURE_ASSET_RESULT_GOOD,
- VERIFY_PICTURE_ASSET_RESULT_FRAME_NEARLY_TOO_LARGE,
- VERIFY_PICTURE_ASSET_RESULT_BAD,
+ GOOD,
+ FRAME_NEARLY_TOO_LARGE,
+ BAD,
};
template <class A, class R, class F>
optional<VerifyPictureAssetResult>
-verify_picture_asset_type (shared_ptr<const ReelMXF> reel_mxf, function<void (float)> progress)
+verify_picture_asset_type (shared_ptr<const ReelFileAsset> reel_file_asset, function<void (float)> progress)
{
- auto asset = dynamic_pointer_cast<A>(reel_mxf->asset_ref().asset());
+ auto asset = dynamic_pointer_cast<A>(reel_file_asset->asset_ref().asset());
if (!asset) {
return optional<VerifyPictureAssetResult>();
}
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;
+ return VerifyPictureAssetResult::BAD;
} else if (biggest_frame > risky_frame) {
- return VERIFY_PICTURE_ASSET_RESULT_FRAME_NEARLY_TOO_LARGE;
+ return VerifyPictureAssetResult::FRAME_NEARLY_TOO_LARGE;
}
- return VERIFY_PICTURE_ASSET_RESULT_GOOD;
+ return VerifyPictureAssetResult::GOOD;
}
static VerifyPictureAssetResult
-verify_picture_asset (shared_ptr<const ReelMXF> reel_mxf, function<void (float)> progress)
+verify_picture_asset (shared_ptr<const ReelFileAsset> reel_file_asset, function<void (float)> progress)
{
- auto r = verify_picture_asset_type<MonoPictureAsset, MonoPictureAssetReader, MonoPictureFrame>(reel_mxf, progress);
+ auto r = verify_picture_asset_type<MonoPictureAsset, MonoPictureAssetReader, MonoPictureFrame>(reel_file_asset, progress);
if (!r) {
- r = verify_picture_asset_type<StereoPictureAsset, StereoPictureAssetReader, StereoPictureFrame>(reel_mxf, progress);
+ r = verify_picture_asset_type<StereoPictureAsset, StereoPictureAssetReader, StereoPictureFrame>(reel_file_asset, progress);
}
DCP_ASSERT (r);
stage ("Checking picture asset hash", file);
auto const r = verify_asset (dcp, reel_asset, progress);
switch (r) {
- case VERIFY_ASSET_RESULT_BAD:
- notes.push_back (
- VerificationNote(
- VerificationNote::VERIFY_ERROR, VerificationNote::PICTURE_HASH_INCORRECT, file
- )
- );
+ case VerifyAssetResult::BAD:
+ notes.push_back ({
+ VerificationNote::Type::ERROR, VerificationNote::Code::INCORRECT_PICTURE_HASH, file
+ });
break;
- case VERIFY_ASSET_RESULT_CPL_PKL_DIFFER:
- notes.push_back (
- VerificationNote(
- VerificationNote::VERIFY_ERROR, VerificationNote::PKL_CPL_PICTURE_HASHES_DIFFER, file
- )
- );
+ case VerifyAssetResult::CPL_PKL_DIFFER:
+ notes.push_back ({
+ 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(
- VerificationNote::VERIFY_ERROR, VerificationNote::PICTURE_FRAME_TOO_LARGE_IN_BYTES, file
- )
- );
+ case VerifyPictureAssetResult::BAD:
+ notes.push_back ({
+ VerificationNote::Type::ERROR, VerificationNote::Code::INVALID_PICTURE_FRAME_SIZE_IN_BYTES, file
+ });
break;
- case VERIFY_PICTURE_ASSET_RESULT_FRAME_NEARLY_TOO_LARGE:
- notes.push_back (
- VerificationNote(
- VerificationNote::VERIFY_WARNING, VerificationNote::PICTURE_FRAME_NEARLY_TOO_LARGE_IN_BYTES, file
- )
- );
+ case VerifyPictureAssetResult::FRAME_NEARLY_TOO_LARGE:
+ notes.push_back ({
+ VerificationNote::Type::WARNING, VerificationNote::Code::NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES, file
+ });
break;
default:
break;
/* Only flat/scope allowed by Bv2.1 */
if (
- asset->size() != dcp::Size(2048, 858) &&
- asset->size() != dcp::Size(1998, 1080) &&
- asset->size() != dcp::Size(4096, 1716) &&
- asset->size() != dcp::Size(3996, 2160)) {
- notes.push_back(
- VerificationNote(
- VerificationNote::VERIFY_BV21_ERROR,
- VerificationNote::PICTURE_ASSET_INVALID_SIZE_IN_PIXELS,
- String::compose("%1x%2", asset->size().width, asset->size().height),
- file
- )
- );
+ asset->size() != Size(2048, 858) &&
+ 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
+ });
}
/* Only 24, 25, 48fps allowed for 2K */
if (
- (asset->size() == dcp::Size(2048, 858) || asset->size() == dcp::Size(1998, 1080)) &&
- (asset->edit_rate() != dcp::Fraction(24, 1) && asset->edit_rate() != dcp::Fraction(25, 1) && asset->edit_rate() != dcp::Fraction(48, 1))
+ (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(
- VerificationNote::VERIFY_BV21_ERROR,
- VerificationNote::PICTURE_ASSET_INVALID_FRAME_RATE_FOR_2K,
- String::compose("%1/%2", asset->edit_rate().numerator, asset->edit_rate().denominator),
- file
- )
- );
+ notes.push_back({
+ 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
+ });
}
- if (asset->size() == dcp::Size(4096, 1716) || asset->size() == dcp::Size(3996, 2160)) {
+ if (asset->size() == Size(4096, 1716) || asset->size() == Size(3996, 2160)) {
/* Only 24fps allowed for 4K */
- if (asset->edit_rate() != dcp::Fraction(24, 1)) {
- notes.push_back(
- VerificationNote(
- VerificationNote::VERIFY_BV21_ERROR,
- VerificationNote::PICTURE_ASSET_INVALID_FRAME_RATE_FOR_4K,
- String::compose("%1/%2", asset->edit_rate().numerator, asset->edit_rate().denominator),
- file
- )
- );
+ if (asset->edit_rate() != Fraction(24, 1)) {
+ notes.push_back({
+ 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(
- VerificationNote::VERIFY_BV21_ERROR,
- VerificationNote::PICTURE_ASSET_4K_3D,
- file
- )
- );
+ notes.push_back({
+ 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(
- VerificationNote::VERIFY_ERROR, VerificationNote::SOUND_HASH_INCORRECT, *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(
- VerificationNote::VERIFY_ERROR, VerificationNote::PKL_CPL_SOUND_HASHES_DIFFER, *asset->file()
- )
- );
+ case VerifyAssetResult::CPL_PKL_DIFFER:
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::MISMATCHED_SOUND_HASHES, *asset->file()});
break;
default:
break;
verify_language_tag (asset->language(), notes);
if (asset->sampling_rate() != 48000) {
- notes.push_back (
- VerificationNote(
- VerificationNote::VERIFY_BV21_ERROR, VerificationNote::INVALID_SOUND_FRAME_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 });
+ 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::SUBTITLE_ENTRY_POINT_NON_ZERO });
+ 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 });
+ 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::CLOSED_CAPTION_ENTRY_POINT_NON_ZERO });
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INCORRECT_CLOSED_CAPTION_ENTRY_POINT, reel_asset->id() });
}
}
void
verify_smpte_subtitle_asset (
- shared_ptr<const dcp::SMPTESubtitleAsset> asset,
+ shared_ptr<const SMPTESubtitleAsset> asset,
vector<VerificationNote>& notes,
State& state
)
if (!state.subtitle_language) {
state.subtitle_language = language;
} else if (state.subtitle_language != language) {
- notes.push_back (
- VerificationNote(
- VerificationNote::VERIFY_BV21_ERROR, VerificationNote::SUBTITLE_LANGUAGES_DIFFER, *asset->file()
- )
- );
+ notes.push_back ({ VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISMATCHED_SUBTITLE_LANGUAGES });
}
} else {
- notes.push_back (
- VerificationNote(
- VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_SUBTITLE_LANGUAGE, *asset->file()
- )
- );
+ notes.push_back ({ VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_SUBTITLE_LANGUAGE, *asset->file() });
}
- if (boost::filesystem::file_size(*asset->file()) > 115 * 1024 * 1024) {
+ auto const size = boost::filesystem::file_size(asset->file().get());
+ if (size > 115 * 1024 * 1024) {
notes.push_back (
- VerificationNote(
- VerificationNote::VERIFY_BV21_ERROR, VerificationNote::TIMED_TEXT_ASSET_TOO_LARGE_IN_BYTES, *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"
total_size += i.second.size();
}
if (total_size > 10 * 1024 * 1024) {
- notes.push_back (
- VerificationNote(
- VerificationNote::VERIFY_BV21_ERROR, VerificationNote::TIMED_TEXT_FONTS_TOO_LARGE_IN_BYTES, *asset->file()
- )
- );
+ 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(
- VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_SUBTITLE_START_TIME, *asset->file())
- );
- } else if (asset->start_time() != dcp::Time()) {
- notes.push_back (
- VerificationNote(
- VerificationNote::VERIFY_BV21_ERROR, VerificationNote::SUBTITLE_START_TIME_NON_ZERO, *asset->file())
- );
+ 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::Type::BV21_ERROR, VerificationNote::Code::INVALID_SUBTITLE_START_TIME, asset->file().get() });
}
}
verify_subtitle_asset (asset, stage, xsd_dtd_directory, notes, state);
if (asset->raw_xml().size() > 256 * 1024) {
- notes.push_back (
- VerificationNote(
- VerificationNote::VERIFY_BV21_ERROR, VerificationNote::CLOSED_CAPTION_XML_TOO_LARGE_IN_BYTES, *asset->file()
- )
- );
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_CLOSED_CAPTION_XML_SIZE_IN_BYTES, raw_convert<string>(asset->raw_xml().size()), *asset->file()});
}
}
static
void
-check_text_timing (
- vector<shared_ptr<dcp::Reel>> reels,
+verify_text_timing (
+ vector<shared_ptr<Reel>> reels,
optional<int> picture_frame_rate,
vector<VerificationNote>& notes,
- std::function<bool (shared_ptr<dcp::Reel>)> check,
- std::function<string (shared_ptr<dcp::Reel>)> xml,
- std::function<int64_t (shared_ptr<dcp::Reel>)> duration
+ std::function<bool (shared_ptr<Reel>)> check,
+ std::function<string (shared_ptr<Reel>)> xml,
+ std::function<int64_t (shared_ptr<Reel>)> duration
)
{
/* end of last subtitle (in editable units) */
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) {
if (node->name() == "Subtitle") {
- dcp::Time in (node->string_attribute("TimeIn"), tcr);
- dcp::Time out (node->string_attribute("TimeOut"), tcr);
- if (first_reel && in < dcp::Time(0, 0, 4, 0, tcr)) {
+ Time in (node->string_attribute("TimeIn"), tcr);
+ Time out (node->string_attribute("TimeOut"), tcr);
+ if (first_reel && in < Time(0, 0, 4, 0, tcr)) {
too_early = true;
}
auto length = out - in;
}
if (too_early) {
- notes.push_back(
- VerificationNote(
- VerificationNote::VERIFY_WARNING, VerificationNote::FIRST_TEXT_TOO_EARLY
- )
- );
+ notes.push_back({
+ VerificationNote::Type::WARNING, VerificationNote::Code::INVALID_SUBTITLE_FIRST_TEXT_TIME
+ });
}
if (too_short) {
- notes.push_back (
- VerificationNote(
- VerificationNote::VERIFY_WARNING, VerificationNote::SUBTITLE_TOO_SHORT
- )
- );
+ notes.push_back ({
+ VerificationNote::Type::WARNING, VerificationNote::Code::INVALID_SUBTITLE_DURATION
+ });
}
if (too_close) {
- notes.push_back (
- VerificationNote(
- VerificationNote::VERIFY_WARNING, VerificationNote::SUBTITLE_TOO_CLOSE
- )
- );
+ notes.push_back ({
+ VerificationNote::Type::WARNING, VerificationNote::Code::INVALID_SUBTITLE_SPACING
+ });
}
}
static
void
-check_text_lines_and_characters (
+verify_text_lines_and_characters (
shared_ptr<SubtitleAsset> asset,
int warning_length,
int error_length,
class Event
{
public:
- Event (dcp::Time time_, float position_, int characters_)
+ Event (Time time_, float position_, int characters_)
: time (time_)
, position (position_)
, characters (characters_)
{}
- Event (dcp::Time time_, shared_ptr<Event> start_)
+ Event (Time time_, shared_ptr<Event> start_)
: time (time_)
, start (start_)
{}
- dcp::Time time;
+ Time time;
int position; //< position from 0 at top of screen to 100 at bottom
int characters;
shared_ptr<Event> start;
auto position = [](shared_ptr<const SubtitleString> sub) {
switch (sub->v_align()) {
- case VALIGN_TOP:
+ case VAlign::TOP:
return lrintf(sub->v_position() * 100);
- case VALIGN_CENTER:
+ case VAlign::CENTER:
return lrintf((0.5f + sub->v_position()) * 100);
- case VALIGN_BOTTOM:
+ case VAlign::BOTTOM:
return lrintf((1.0f - sub->v_position()) * 100);
}
static
void
-check_text_timing (vector<shared_ptr<dcp::Reel>> reels, vector<VerificationNote>& notes)
+verify_text_timing (vector<shared_ptr<Reel>> reels, vector<VerificationNote>& notes)
{
if (reels.empty()) {
return;
}
if (reels[0]->main_subtitle()) {
- check_text_timing (reels, picture_frame_rate, notes,
- [](shared_ptr<dcp::Reel> reel) {
+ verify_text_timing (reels, picture_frame_rate, notes,
+ [](shared_ptr<Reel> reel) {
return static_cast<bool>(reel->main_subtitle());
},
- [](shared_ptr<dcp::Reel> reel) {
+ [](shared_ptr<Reel> reel) {
return reel->main_subtitle()->asset()->raw_xml();
},
- [](shared_ptr<dcp::Reel> reel) {
+ [](shared_ptr<Reel> reel) {
return reel->main_subtitle()->actual_duration();
}
);
}
for (auto i = 0U; i < reels[0]->closed_captions().size(); ++i) {
- check_text_timing (reels, picture_frame_rate, notes,
- [i](shared_ptr<dcp::Reel> reel) {
+ verify_text_timing (reels, picture_frame_rate, notes,
+ [i](shared_ptr<Reel> reel) {
return i < reel->closed_captions().size();
},
- [i](shared_ptr<dcp::Reel> reel) {
+ [i](shared_ptr<Reel> reel) {
return reel->closed_captions()[i]->asset()->raw_xml();
},
- [i](shared_ptr<dcp::Reel> reel) {
+ [i](shared_ptr<Reel> reel) {
return reel->closed_captions()[i]->actual_duration();
}
);
void
-check_extension_metadata (shared_ptr<dcp::CPL> cpl, vector<VerificationNote>& notes)
+verify_extension_metadata (shared_ptr<CPL> cpl, vector<VerificationNote>& notes)
{
DCP_ASSERT (cpl->file());
cxml::Document doc ("CompositionPlaylist");
}
if (missing) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_EXTENSION_METADATA});
+ 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});
+ 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.
+ * in reels by ReelSubtitleAsset which inherits ReelFileAsset, so it's possible for
+ * ReelFileAssets to have assets which are not MXFs.
*/
if (auto asset = dynamic_pointer_cast<MXF>(j->asset_ref().asset())) {
if (asset->encrypted()) {
xsd_dtd_directory = boost::filesystem::canonical (xsd_dtd_directory);
vector<VerificationNote> notes;
- State state;
+ State state{};
vector<shared_ptr<DCP>> dcps;
for (auto i: directories) {
try {
dcp->read (¬es);
} catch (ReadError& e) {
- notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::GENERAL_READ, string(e.what())));
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
} catch (XMLError& e) {
- notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::GENERAL_READ, string(e.what())));
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
} catch (MXFFileError& e) {
- notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::GENERAL_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(VerificationNote::VERIFY_ERROR, VerificationNote::GENERAL_READ, string(e.what())));
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::FAILED_READ, string(e.what())});
}
- if (dcp->standard() != dcp::SMPTE) {
- notes.push_back (VerificationNote(VerificationNote::VERIFY_BV21_ERROR, VerificationNote::NOT_SMPTE));
+ if (dcp->standard() != Standard::SMPTE) {
+ 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);
+ 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);
}
LanguageTag::RegionSubtag test (terr);
} catch (...) {
if (terr != "001") {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::BAD_LANGUAGE, terr});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_LANGUAGE, terr});
}
}
}
}
- if (dcp->standard() == dcp::SMPTE) {
+ if (dcp->standard() == Standard::SMPTE) {
if (!cpl->annotation_text()) {
- notes.push_back (VerificationNote(VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_ANNOTATION_TEXT_IN_CPL));
+ 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(VerificationNote::VERIFY_WARNING, VerificationNote::CPL_ANNOTATION_TEXT_DIFFERS_FROM_CONTENT_TITLE_TEXT));
+ 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(VerificationNote::VERIFY_ERROR, VerificationNote::CPL_HASH_INCORRECT));
+ 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::PKL_ANNOTATION_TEXT_DOES_NOT_MATCH_CPL_CONTENT_TITLE_TEXT, 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(VerificationNote::VERIFY_ERROR, VerificationNote::DURATION_TOO_SMALL, 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(VerificationNote::VERIFY_ERROR, VerificationNote::INTRINSIC_DURATION_TOO_SMALL, 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 (file_asset && !file_asset->hash()) {
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_HASH, i->id()});
}
}
- if (dcp->standard() == dcp::SMPTE) {
+ 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(VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISMATCHED_ASSET_DURATION, i->id()));
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISMATCHED_ASSET_DURATION});
break;
}
}
frame_rate.numerator != 50 &&
frame_rate.numerator != 60 &&
frame_rate.numerator != 96)) {
- notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::INVALID_PICTURE_FRAME_RATE));
+ 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()) {
most_closed_captions = std::max (most_closed_captions, reel->closed_captions().size());
}
- if (dcp->standard() == dcp::SMPTE) {
+ if (dcp->standard() == Standard::SMPTE) {
if (have_main_subtitle && have_no_main_subtitle) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MAIN_SUBTITLE_NOT_IN_ALL_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::CLOSED_CAPTION_ASSET_COUNTS_DIFFER});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISMATCHED_CLOSED_CAPTION_ASSET_COUNTS});
}
- if (cpl->content_kind() == FEATURE) {
- if (markers_seen.find(dcp::Marker::FFEC) == markers_seen.end()) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_FFEC_IN_FEATURE});
+ 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(dcp::Marker::FFMC) == markers_seen.end()) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_FFMC_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(dcp::Marker::FFOC);
+ 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});
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::INCORRECT_FFOC, raw_convert<string>(ffoc->second.e)});
}
- auto lfoc = markers_seen.find(dcp::Marker::LFOC);
+ auto lfoc = markers_seen.find(Marker::LFOC);
if (lfoc == markers_seen.end()) {
- notes.push_back ({VerificationNote::VERIFY_WARNING, VerificationNote::MISSING_LFOC});
- } else if (lfoc->second.as_editable_units(lfoc->second.tcr) != (cpl->reels().back()->duration() - 1)) {
- notes.push_back ({VerificationNote::VERIFY_WARNING, VerificationNote::INCORRECT_LFOC});
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::MISSING_LFOC});
+ } else {
+ auto lfoc_time = lfoc->second.as_editable_units(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)});
+ }
}
- check_text_timing (cpl->reels(), notes);
+ verify_text_timing (cpl->reels(), notes);
LinesCharactersResult result;
for (auto reel: cpl->reels()) {
if (reel->main_subtitle() && reel->main_subtitle()->asset()) {
- check_text_lines_and_characters (reel->main_subtitle()->asset(), 52, 79, &result);
+ verify_text_lines_and_characters (reel->main_subtitle()->asset(), 52, 79, &result);
}
}
if (result.line_count_exceeded) {
- notes.push_back (VerificationNote(VerificationNote::VERIFY_WARNING, VerificationNote::TOO_MANY_SUBTITLE_LINES));
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::INVALID_SUBTITLE_LINE_COUNT});
}
if (result.error_length_exceeded) {
- notes.push_back (VerificationNote(VerificationNote::VERIFY_WARNING, VerificationNote::SUBTITLE_LINE_TOO_LONG));
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::INVALID_SUBTITLE_LINE_LENGTH});
} else if (result.warning_length_exceeded) {
- notes.push_back (VerificationNote(VerificationNote::VERIFY_WARNING, VerificationNote::SUBTITLE_LINE_LONGER_THAN_RECOMMENDED));
+ notes.push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::NEARLY_INVALID_SUBTITLE_LINE_LENGTH});
}
result = LinesCharactersResult();
for (auto reel: cpl->reels()) {
for (auto i: reel->closed_captions()) {
if (i->asset()) {
- check_text_lines_and_characters (i->asset(), 32, 32, &result);
+ verify_text_lines_and_characters (i->asset(), 32, 32, &result);
}
}
}
if (result.line_count_exceeded) {
- notes.push_back (VerificationNote(VerificationNote::VERIFY_BV21_ERROR, VerificationNote::TOO_MANY_CLOSED_CAPTION_LINES));
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::INVALID_CLOSED_CAPTION_LINE_COUNT});
}
if (result.error_length_exceeded) {
- notes.push_back (VerificationNote(VerificationNote::VERIFY_BV21_ERROR, VerificationNote::CLOSED_CAPTION_LINE_TOO_LONG));
+ 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});
+ 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});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::MISSING_CPL_METADATA_VERSION_NUMBER, cpl->id(), cpl->file().get()});
}
- check_extension_metadata (cpl, notes);
+ verify_extension_metadata (cpl, notes);
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::VERIFY_BV21_ERROR, VerificationNote::CPL_WITH_ENCRYPTED_CONTENT_NOT_SIGNED, cpl->file().get()});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::UNSIGNED_CPL_WITH_ENCRYPTED_CONTENT, cpl->id(), cpl->file().get()});
}
}
}
cxml::Document doc ("PackingList");
doc.read_file (pkl->file().get());
if (!doc.optional_node_child("Signature")) {
- notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::PKL_WITH_ENCRYPTED_CONTENT_NOT_SIGNED, pkl->file().get()});
+ notes.push_back ({VerificationNote::Type::BV21_ERROR, VerificationNote::Code::UNSIGNED_PKL_WITH_ENCRYPTED_CONTENT, pkl->id(), pkl->file().get()});
}
}
}
stage ("Checking ASSETMAP", dcp->asset_map_path().get());
validate_xml (dcp->asset_map_path().get(), xsd_dtd_directory, notes);
} else {
- notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::MISSING_ASSETMAP));
+ notes.push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::MISSING_ASSETMAP});
}
}
return notes;
}
+
string
-dcp::note_to_string (dcp::VerificationNote note)
+dcp::note_to_string (VerificationNote note)
{
+ /** These strings should say what is wrong, incorporating any extra details (ID, filenames etc.).
+ *
+ * e.g. "ClosedCaption asset has no <EntryPoint> tag.",
+ * not "ClosedCaption assets must have an <EntryPoint> tag."
+ *
+ * It's OK to use XML tag names where they are clear.
+ * If both ID and filename are available, use only the ID.
+ * End messages with a full stop.
+ * Messages should not mention whether or not their errors are a part of Bv2.1.
+ */
switch (note.code()) {
- case dcp::VerificationNote::GENERAL_READ:
+ case VerificationNote::Code::FAILED_READ:
return *note.note();
- case dcp::VerificationNote::CPL_HASH_INCORRECT:
- return "The hash of the CPL in the PKL does not agree with the CPL file.";
- case dcp::VerificationNote::INVALID_PICTURE_FRAME_RATE:
- return "The picture in a reel has an invalid frame rate.";
- case dcp::VerificationNote::PICTURE_HASH_INCORRECT:
- return dcp::String::compose("The hash of the picture asset %1 does not agree with the PKL file.", note.file()->filename());
- case dcp::VerificationNote::PKL_CPL_PICTURE_HASHES_DIFFER:
- return dcp::String::compose("The PKL and CPL hashes differ for the picture asset %1.", note.file()->filename());
- case dcp::VerificationNote::SOUND_HASH_INCORRECT:
- return dcp::String::compose("The hash of the sound asset %1 does not agree with the PKL file.", note.file()->filename());
- case dcp::VerificationNote::PKL_CPL_SOUND_HASHES_DIFFER:
- return dcp::String::compose("The PKL and CPL hashes differ for the sound asset %1.", note.file()->filename());
- case dcp::VerificationNote::EMPTY_ASSET_PATH:
+ 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::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());
+ 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());
+ 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:
return "The asset map contains an empty asset path.";
- case dcp::VerificationNote::MISSING_ASSET:
- return String::compose("The file for an asset in the asset map cannot be found; missing file is %1.", note.file()->filename());
- case dcp::VerificationNote::MISMATCHED_STANDARD:
+ 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::Code::MISMATCHED_STANDARD:
return "The DCP contains both SMPTE and Interop parts.";
- case dcp::VerificationNote::XML_VALIDATION_ERROR:
+ 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 dcp::VerificationNote::MISSING_ASSETMAP:
+ case VerificationNote::Code::MISSING_ASSETMAP:
return "No ASSETMAP or ASSETMAP.xml was found.";
- case dcp::VerificationNote::INTRINSIC_DURATION_TOO_SMALL:
- return String::compose("The intrinsic duration of an asset is less than 1 second long: %1", note.note().get());
- case dcp::VerificationNote::DURATION_TOO_SMALL:
- return String::compose("The duration of an asset is less than 1 second long: %1", note.note().get());
- case dcp::VerificationNote::PICTURE_FRAME_TOO_LARGE_IN_BYTES:
+ case VerificationNote::Code::INVALID_INTRINSIC_DURATION:
+ return String::compose("The intrinsic duration of the asset %1 is less than 1 second long.", note.note().get());
+ case VerificationNote::Code::INVALID_DURATION:
+ return String::compose("The duration of the asset %1 is less than 1 second long.", 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 dcp::VerificationNote::PICTURE_FRAME_NEARLY_TOO_LARGE_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 dcp::VerificationNote::EXTERNAL_ASSET:
- return String::compose("An asset that this DCP refers to is not included in the DCP. It may be a VF. Missing asset is %1.", note.note().get());
- case dcp::VerificationNote::NOT_SMPTE:
- return "This DCP does not use the SMPTE standard, which is required for Bv2.1 compliance.";
- case dcp::VerificationNote::BAD_LANGUAGE:
+ 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::INVALID_STANDARD:
+ 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 dcp::VerificationNote::PICTURE_ASSET_INVALID_SIZE_IN_PIXELS:
- return String::compose("A picture asset's size (%1) is not one of those allowed by Bv2.1 (2048x858, 1998x1080, 4096x1716 or 3996x2160)", note.note().get());
- case dcp::VerificationNote::PICTURE_ASSET_INVALID_FRAME_RATE_FOR_2K:
- return String::compose("A picture asset's frame rate (%1) is not one of those allowed for 2K DCPs by Bv2.1 (24, 25 or 48fps)", note.note().get());
- case dcp::VerificationNote::PICTURE_ASSET_INVALID_FRAME_RATE_FOR_4K:
- return String::compose("A picture asset's frame rate (%1) is not 24fps as required for 4K DCPs by Bv2.1", note.note().get());
- case dcp::VerificationNote::PICTURE_ASSET_4K_3D:
- return "3D 4K DCPs are not allowed by Bv2.1";
- case dcp::VerificationNote::CLOSED_CAPTION_XML_TOO_LARGE_IN_BYTES:
- return String::compose("The XML for the closed caption asset %1 is longer than the 256KB maximum required by Bv2.1", note.file()->filename());
- case dcp::VerificationNote::TIMED_TEXT_ASSET_TOO_LARGE_IN_BYTES:
- return String::compose("The total size of the timed text asset %1 is larger than the 115MB maximum required by Bv2.1", note.file()->filename());
- case dcp::VerificationNote::TIMED_TEXT_FONTS_TOO_LARGE_IN_BYTES:
- return String::compose("The total size of the fonts in timed text asset %1 is larger than the 10MB maximum required by Bv2.1", note.file()->filename());
- case dcp::VerificationNote::MISSING_SUBTITLE_LANGUAGE:
- return String::compose("The XML for a SMPTE subtitle asset has no <Language> tag, which is required by Bv2.1", note.file()->filename());
- case dcp::VerificationNote::SUBTITLE_LANGUAGES_DIFFER:
- return String::compose("Some subtitle assets have different <Language> tags than others", note.file()->filename());
- case dcp::VerificationNote::MISSING_SUBTITLE_START_TIME:
- return String::compose("The XML for a SMPTE subtitle asset has no <StartTime> tag, which is required by Bv2.1", note.file()->filename());
- case dcp::VerificationNote::SUBTITLE_START_TIME_NON_ZERO:
- return String::compose("The XML for a SMPTE subtitle asset has a non-zero <StartTime> tag, which is disallowed by Bv2.1", note.file()->filename());
- case dcp::VerificationNote::FIRST_TEXT_TOO_EARLY:
+ 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:
+ 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::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::Code::INVALID_PICTURE_ASSET_RESOLUTION_FOR_3D:
+ return "3D 4K DCPs are not allowed.";
+ 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::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::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::Code::MISSING_SUBTITLE_LANGUAGE:
+ return String::compose("The XML for the SMPTE subtitle asset %1 has no <Language> tag.", note.file()->filename());
+ case VerificationNote::Code::MISMATCHED_SUBTITLE_LANGUAGES:
+ return "Some subtitle assets have different <Language> tags than others";
+ 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::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::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 dcp::VerificationNote::SUBTITLE_TOO_SHORT:
- return "At least one subtitle is less than the minimum of 15 frames suggested by Bv2.1";
- case dcp::VerificationNote::SUBTITLE_TOO_CLOSE:
- return "At least one pair of subtitles are separated by less than the the minimum of 2 frames suggested by Bv2.1";
- case dcp::VerificationNote::TOO_MANY_SUBTITLE_LINES:
- return "There are more than 3 subtitle lines in at least one place in the DCP, which Bv2.1 advises against.";
- case dcp::VerificationNote::SUBTITLE_LINE_LONGER_THAN_RECOMMENDED:
- return "There are more than 52 characters in at least one subtitle line, which Bv2.1 advises against.";
- case dcp::VerificationNote::SUBTITLE_LINE_TOO_LONG:
- return "There are more than 79 characters in at least one subtitle line, which Bv2.1 strongly advises against.";
- case dcp::VerificationNote::TOO_MANY_CLOSED_CAPTION_LINES:
- return "There are more than 3 closed caption lines in at least one place, which is disallowed by Bv2.1";
- case dcp::VerificationNote::CLOSED_CAPTION_LINE_TOO_LONG:
- return "There are more than 32 characters in at least one closed caption line, which is disallowed by Bv2.1";
- case dcp::VerificationNote::INVALID_SOUND_FRAME_RATE:
- return "A sound asset has a sampling rate other than 48kHz, which is disallowed by Bv2.1";
- case dcp::VerificationNote::MISSING_ANNOTATION_TEXT_IN_CPL:
- return "The CPL has no <AnnotationText> tag, which is required by Bv2.1";
- case dcp::VerificationNote::CPL_ANNOTATION_TEXT_DIFFERS_FROM_CONTENT_TITLE_TEXT:
- return "The CPL's <AnnotationText> differs from its <ContentTitleText>, which Bv2.1 advises against.";
- case dcp::VerificationNote::MISMATCHED_ASSET_DURATION:
- return "All assets in a reel do not have the same duration, which is required by Bv2.1";
- case dcp::VerificationNote::MAIN_SUBTITLE_NOT_IN_ALL_REELS:
+ case VerificationNote::Code::INVALID_SUBTITLE_DURATION:
+ return "At least one subtitle lasts less than 15 frames.";
+ case VerificationNote::Code::INVALID_SUBTITLE_SPACING:
+ return "At least one pair of subtitles is separated by less than 2 frames.";
+ 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::Code::NEARLY_INVALID_SUBTITLE_LINE_LENGTH:
+ return "There are more than 52 characters in at least one subtitle line.";
+ case VerificationNote::Code::INVALID_SUBTITLE_LINE_LENGTH:
+ return "There are more than 79 characters in at least one subtitle line.";
+ case VerificationNote::Code::INVALID_CLOSED_CAPTION_LINE_COUNT:
+ return "There are more than 3 closed caption lines in at least one place.";
+ case VerificationNote::Code::INVALID_CLOSED_CAPTION_LINE_LENGTH:
+ return "There are more than 32 characters in at least one closed caption line.";
+ 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());
+ 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::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:
return "At least one reel contains a subtitle asset, but some reel(s) do not";
- case dcp::VerificationNote::CLOSED_CAPTION_ASSET_COUNTS_DIFFER:
+ 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 dcp::VerificationNote::MISSING_SUBTITLE_ENTRY_POINT:
- return "Subtitle assets must have an <EntryPoint> tag.";
- case dcp::VerificationNote::SUBTITLE_ENTRY_POINT_NON_ZERO:
- return "Subtitle assets must have an <EntryPoint> of 0.";
- case dcp::VerificationNote::MISSING_CLOSED_CAPTION_ENTRY_POINT:
- return "Closed caption assets must have an <EntryPoint> tag.";
- case dcp::VerificationNote::CLOSED_CAPTION_ENTRY_POINT_NON_ZERO:
- return "Closed caption assets must have an <EntryPoint> of 0.";
- case dcp::VerificationNote::MISSING_HASH:
- return String::compose("An asset is missing a <Hash> tag: %1", note.note().get());
- case dcp::VerificationNote::MISSING_FFEC_IN_FEATURE:
+ case VerificationNote::Code::MISSING_SUBTITLE_ENTRY_POINT:
+ return String::compose("The subtitle asset %1 has no <EntryPoint> tag.", note.note().get());
+ 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::Code::MISSING_CLOSED_CAPTION_ENTRY_POINT:
+ return String::compose("The closed caption asset %1 has no <EntryPoint> tag.", note.note().get());
+ 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::Code::MISSING_HASH:
+ return String::compose("The asset %1 has no <Hash> tag in the CPL.", note.note().get());
+ 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 dcp::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 dcp::VerificationNote::MISSING_FFOC:
+ case VerificationNote::Code::MISSING_FFOC:
return "There should be a FFOC (first frame of content) marker";
- case dcp::VerificationNote::MISSING_LFOC:
+ case VerificationNote::Code::MISSING_LFOC:
return "There should be a LFOC (last frame of content) marker";
- case dcp::VerificationNote::INCORRECT_FFOC:
- return "The FFOC marker should bet set to 1";
- case dcp::VerificationNote::INCORRECT_LFOC:
- return "The LFOC marker should be set to 1 less than the duration of the last reel";
- case dcp::VerificationNote::MISSING_CPL_METADATA:
- return "There should be a <CompositionMetadataAsset> tag";
- case dcp::VerificationNote::MISSING_CPL_METADATA_VERSION_NUMBER:
- return "The CPL metadata must contain a <VersionNumber>";
- case dcp::VerificationNote::MISSING_EXTENSION_METADATA:
- return "The CPL metadata must contain <ExtensionMetadata>";
- case dcp::VerificationNote::INVALID_EXTENSION_METADATA:
- return String::compose("The <ExtensionMetadata> is malformed in some way: %1", note.note().get());
- case dcp::VerificationNote::CPL_WITH_ENCRYPTED_CONTENT_NOT_SIGNED:
- return String::compose("The CPL %1, which has encrypted content, is not signed", note.file()->filename());
- case dcp::VerificationNote::PKL_WITH_ENCRYPTED_CONTENT_NOT_SIGNED:
- return String::compose("The PKL %1, which has encrypted content, is not signed", note.file()->filename());
- case dcp::VerificationNote::PKL_ANNOTATION_TEXT_DOES_NOT_MATCH_CPL_CONTENT_TITLE_TEXT:
- return String::compose("The PKL %1 has only one CPL but its <AnnotationText> does not match the CPL's <ContentTitleText>", note.file()->filename());
+ case VerificationNote::Code::INCORRECT_FFOC:
+ return String::compose("The FFOC marker is %1 instead of 1", note.note().get());
+ 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());
+ 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::Code::MISSING_EXTENSION_METADATA:
+ return String::compose("The CPL %1 has no <ExtensionMetadata> in its <CompositionMetadataAsset>.", note.note().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());
+ 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::PARTIALLY_ENCRYPTED:
+ return "Some assets are encrypted but some are not";
}
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();
+}
+
+
+std::ostream&
+dcp::operator<< (std::ostream& s, dcp::VerificationNote const& note)
+{
+ s << note_to_string (note);
+ if (note.note()) {
+ s << " [" << note.note().get() << "]";
+ }
+ if (note.file()) {
+ s << " [" << note.file().get() << "]";
+ }
+ if (note.line()) {
+ s << " [" << note.line().get() << "]";
+ }
+ return s;
+}
+