/*
- Copyright (C) 2018-2020 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2018-2021 Carl Hetherington <cth@carlh.net>
This file is part of libdcp.
#include "dcp.h"
#include "cpl.h"
#include "reel.h"
+#include "reel_closed_caption_asset.h"
#include "reel_picture_asset.h"
#include "reel_sound_asset.h"
#include "reel_subtitle_asset.h"
#include "exceptions.h"
#include "compose.hpp"
#include "raw_convert.h"
+#include "reel_markers_asset.h"
#include "smpte_subtitle_asset.h"
#include <xercesc/util/PlatformUtils.hpp>
#include <xercesc/parsers/XercesDOMParser.hpp>
#include <xercesc/framework/LocalFileInputSource.hpp>
#include <xercesc/framework/MemBufInputSource.hpp>
#include <boost/noncopyable.hpp>
-#include <boost/foreach.hpp>
#include <boost/algorithm/string.hpp>
#include <map>
-#include <list>
#include <vector>
#include <iostream>
using std::cout;
using std::map;
using std::max;
+using std::set;
using std::shared_ptr;
+using std::make_shared;
using boost::optional;
using boost::function;
using std::dynamic_pointer_cast;
if (!system_id) {
return 0;
}
- string system_id_str = xml_ch_to_string (system_id);
- boost::filesystem::path p = _xsd_dtd_directory;
+ auto system_id_str = xml_ch_to_string (system_id);
+ auto p = _xsd_dtd_directory;
if (_files.find(system_id_str) == _files.end()) {
p /= system_id_str;
} else {
static void
-parse (XercesDOMParser& parser, std::string xml)
+parse (XercesDOMParser& parser, string xml)
{
xercesc::MemBufInputSource buf(reinterpret_cast<unsigned char const*>(xml.c_str()), xml.size(), "");
parser.parse(buf);
template <class T>
void
-validate_xml (T xml, boost::filesystem::path xsd_dtd_directory, list<VerificationNote>& notes)
+validate_xml (T xml, boost::filesystem::path xsd_dtd_directory, vector<VerificationNote>& notes)
{
try {
XMLPlatformUtils::Initialize ();
* they describe are not checked.
*/
string locations;
- BOOST_FOREACH (string i, schema) {
+ for (auto i: schema) {
locations += String::compose("%1 %1 ", i, i);
}
XMLPlatformUtils::Terminate ();
- BOOST_FOREACH (XMLValidationError i, error_handler.errors()) {
+ for (auto i: error_handler.errors()) {
notes.push_back (
VerificationNote(
VerificationNote::VERIFY_ERROR,
static VerifyAssetResult
verify_asset (shared_ptr<const DCP> dcp, shared_ptr<const ReelMXF> reel_mxf, function<void (float)> progress)
{
- string const actual_hash = reel_mxf->asset_ref()->hash(progress);
+ auto const actual_hash = reel_mxf->asset_ref()->hash(progress);
- list<shared_ptr<PKL> > pkls = dcp->pkls();
+ auto pkls = dcp->pkls();
/* We've read this DCP in so it must have at least one PKL */
DCP_ASSERT (!pkls.empty());
- shared_ptr<Asset> asset = reel_mxf->asset_ref().asset();
+ auto asset = reel_mxf->asset_ref().asset();
optional<string> pkl_hash;
- BOOST_FOREACH (shared_ptr<PKL> i, pkls) {
+ for (auto i: pkls) {
pkl_hash = i->hash (reel_mxf->asset_ref()->id());
if (pkl_hash) {
break;
DCP_ASSERT (pkl_hash);
- optional<string> cpl_hash = reel_mxf->hash();
+ auto cpl_hash = reel_mxf->hash();
if (cpl_hash && *cpl_hash != *pkl_hash) {
return VERIFY_ASSET_RESULT_CPL_PKL_DIFFER;
}
void
-verify_language_tag (string tag, list<VerificationNote>& notes)
+verify_language_tag (string tag, vector<VerificationNote>& notes)
{
try {
dcp::LanguageTag test (tag);
template <class A, class R, class F>
optional<VerifyPictureAssetResult>
-verify_picture_asset_type (shared_ptr<ReelMXF> reel_mxf, function<void (float)> progress)
+verify_picture_asset_type (shared_ptr<const ReelMXF> reel_mxf, function<void (float)> progress)
{
-
shared_ptr<A> asset = dynamic_pointer_cast<A>(reel_mxf->asset_ref().asset());
+
auto asset = dynamic_pointer_cast<A>(reel_mxf->asset_ref().asset());
if (!asset) {
return optional<VerifyPictureAssetResult>();
}
int biggest_frame = 0;
- shared_ptr<R> reader = asset->start_read ();
- int64_t const duration = asset->intrinsic_duration ();
+ auto reader = asset->start_read ();
+ auto const duration = asset->intrinsic_duration ();
for (int64_t i = 0; i < duration; ++i) {
shared_ptr<const F> frame = reader->get_frame (i);
biggest_frame = max(biggest_frame, biggest_frame_size(frame));
static VerifyPictureAssetResult
-verify_picture_asset (shared_ptr<ReelMXF> reel_mxf, function<void (float)> progress)
+verify_picture_asset (shared_ptr<const ReelMXF> reel_mxf, function<void (float)> progress)
{
- optional<VerifyPictureAssetResult> r = verify_picture_asset_type<MonoPictureAsset, MonoPictureAssetReader, MonoPictureFrame>(reel_mxf, progress);
+ auto r = verify_picture_asset_type<MonoPictureAsset, MonoPictureAssetReader, MonoPictureFrame>(reel_mxf, progress);
if (!r) {
r = verify_picture_asset_type<StereoPictureAsset, StereoPictureAssetReader, StereoPictureFrame>(reel_mxf, progress);
}
static void
verify_main_picture_asset (
shared_ptr<const DCP> dcp,
- shared_ptr<const Reel> reel,
+ shared_ptr<const ReelPictureAsset> reel_asset,
function<void (string, optional<boost::filesystem::path>)> stage,
function<void (float)> progress,
- list<VerificationNote>& notes
+ vector<VerificationNote>& notes
)
{
- boost::filesystem::path const file = *reel->main_picture()->asset()->file();
+ auto asset = reel_asset->asset();
+ auto const file = *asset->file();
stage ("Checking picture asset hash", file);
- VerifyAssetResult const r = verify_asset (dcp, reel->main_picture(), progress);
+ auto const r = verify_asset (dcp, reel_asset, progress);
switch (r) {
case VERIFY_ASSET_RESULT_BAD:
notes.push_back (
case VERIFY_ASSET_RESULT_CPL_PKL_DIFFER:
notes.push_back (
VerificationNote(
- VerificationNote::VERIFY_ERROR, VerificationNote::PKL_CPL_PICTURE_HASHES_DISAGREE, file
+ VerificationNote::VERIFY_ERROR, VerificationNote::PKL_CPL_PICTURE_HASHES_DIFFER, file
)
);
break;
default:
break;
}
- stage ("Checking picture frame sizes", reel->main_picture()->asset()->file());
- VerifyPictureAssetResult const pr = verify_picture_asset (reel->main_picture(), progress);
+ 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, file
+ VerificationNote::VERIFY_ERROR, VerificationNote::PICTURE_FRAME_TOO_LARGE_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, file
+ VerificationNote::VERIFY_WARNING, VerificationNote::PICTURE_FRAME_NEARLY_TOO_LARGE_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
+ )
+ );
+ }
+
+ /* 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))
+ ) {
+ 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
+ )
+ );
+ }
+
+ if (asset->size() == dcp::Size(4096, 1716) || asset->size() == dcp::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
+ )
+ );
+ }
+
+ /* 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
+ )
+ );
+
+ }
+ }
+
}
static void
verify_main_sound_asset (
shared_ptr<const DCP> dcp,
- shared_ptr<const Reel> reel,
+ shared_ptr<const ReelSoundAsset> reel_asset,
function<void (string, optional<boost::filesystem::path>)> stage,
function<void (float)> progress,
- list<VerificationNote>& notes
+ vector<VerificationNote>& notes
)
{
- shared_ptr<dcp::SoundAsset> asset = reel->main_sound()->asset();
+ auto asset = reel_asset->asset();
stage ("Checking sound asset hash", asset->file());
- VerifyAssetResult const r = verify_asset (dcp, reel->main_sound(), progress);
+ auto const r = verify_asset (dcp, reel_asset, progress);
switch (r) {
case VERIFY_ASSET_RESULT_BAD:
notes.push_back (
case VERIFY_ASSET_RESULT_CPL_PKL_DIFFER:
notes.push_back (
VerificationNote(
- VerificationNote::VERIFY_ERROR, VerificationNote::PKL_CPL_SOUND_HASHES_DISAGREE, *asset->file()
+ VerificationNote::VERIFY_ERROR, VerificationNote::PKL_CPL_SOUND_HASHES_DIFFER, *asset->file()
)
);
break;
stage ("Checking sound asset metadata", asset->file());
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()
+ )
+ );
+ }
}
static void
-verify_main_subtitle_reel (shared_ptr<const ReelSubtitleAsset> reel_asset, list<VerificationNote>& notes)
+verify_main_subtitle_reel (shared_ptr<const ReelSubtitleAsset> reel_asset, vector<VerificationNote>& notes)
{
/* XXX: is Language compulsory? */
if (reel_asset->language()) {
verify_language_tag (*reel_asset->language(), notes);
}
+
+ if (!reel_asset->entry_point()) {
+ notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_SUBTITLE_ENTRY_POINT });
+ } else if (reel_asset->entry_point().get()) {
+ notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::SUBTITLE_ENTRY_POINT_NON_ZERO });
+ }
}
static void
-verify_main_subtitle_asset (
- shared_ptr<const Reel> reel,
+verify_closed_caption_reel (shared_ptr<const ReelClosedCaptionAsset> reel_asset, vector<VerificationNote>& notes)
+{
+ /* XXX: is Language compulsory? */
+ if (reel_asset->language()) {
+ verify_language_tag (*reel_asset->language(), notes);
+ }
+
+ if (!reel_asset->entry_point()) {
+ notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_CLOSED_CAPTION_ENTRY_POINT });
+ } else if (reel_asset->entry_point().get()) {
+ notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::CLOSED_CAPTION_ENTRY_POINT_NON_ZERO });
+ }
+}
+
+
+struct State
+{
+ boost::optional<string> subtitle_language;
+};
+
+
+
+void
+verify_smpte_subtitle_asset (
+ shared_ptr<const dcp::SMPTESubtitleAsset> asset,
+ vector<VerificationNote>& notes,
+ State& state
+ )
+{
+ if (asset->language()) {
+ auto const language = *asset->language();
+ verify_language_tag (language, notes);
+ if (!state.subtitle_language) {
+ state.subtitle_language = language;
+ } else if (state.subtitle_language != language) {
+ notes.push_back (
+ VerificationNote(
+ VerificationNote::VERIFY_BV21_ERROR, VerificationNote::SUBTITLE_LANGUAGES_DIFFER, *asset->file()
+ )
+ );
+ }
+ } else {
+ notes.push_back (
+ VerificationNote(
+ VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_SUBTITLE_LANGUAGE, *asset->file()
+ )
+ );
+ }
+ if (boost::filesystem::file_size(*asset->file()) > 115 * 1024 * 1024) {
+ notes.push_back (
+ VerificationNote(
+ VerificationNote::VERIFY_BV21_ERROR, VerificationNote::TIMED_TEXT_ASSET_TOO_LARGE_IN_BYTES, *asset->file()
+ )
+ );
+ }
+ /* XXX: I'm not sure what Bv2.1_7.2.1 means when it says "the font resource shall not be larger than 10MB"
+ * but I'm hoping that checking for the total size of all fonts being <= 10MB will do.
+ */
+ auto fonts = asset->font_data ();
+ int total_size = 0;
+ for (auto i: fonts) {
+ 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()
+ )
+ );
+ }
+
+ 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())
+ );
+ }
+}
+
+
+static void
+verify_subtitle_asset (
+ shared_ptr<const SubtitleAsset> asset,
function<void (string, optional<boost::filesystem::path>)> stage,
boost::filesystem::path xsd_dtd_directory,
- list<VerificationNote>& notes
+ vector<VerificationNote>& notes,
+ State& state
)
{
- shared_ptr<SubtitleAsset> asset = reel->main_subtitle()->asset();
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.
*/
validate_xml (asset->raw_xml(), xsd_dtd_directory, notes);
- shared_ptr<SMPTESubtitleAsset> smpte = dynamic_pointer_cast<SMPTESubtitleAsset>(asset);
+ auto smpte = dynamic_pointer_cast<const SMPTESubtitleAsset>(asset);
if (smpte) {
- if (smpte->language()) {
- verify_language_tag (*smpte->language(), notes);
+ verify_smpte_subtitle_asset (smpte, notes, state);
+ }
+}
+
+
+static void
+verify_closed_caption_asset (
+ shared_ptr<const SubtitleAsset> asset,
+ function<void (string, optional<boost::filesystem::path>)> stage,
+ boost::filesystem::path xsd_dtd_directory,
+ vector<VerificationNote>& notes,
+ State& state
+ )
+{
+ 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()
+ )
+ );
+ }
+}
+
+
+static
+void
+check_text_timing (
+ vector<shared_ptr<dcp::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
+ )
+{
+ /* end of last subtitle (in editable units) */
+ optional<int64_t> last_out;
+ auto too_short = false;
+ auto too_close = false;
+ auto too_early = false;
+ /* current reel start time (in editable units) */
+ int64_t reel_offset = 0;
+
+ std::function<void (cxml::ConstNodePtr, int, int, bool)> parse;
+ parse = [&parse, &last_out, &too_short, &too_close, &too_early, &reel_offset](cxml::ConstNodePtr node, int tcr, int pfr, bool first_reel) {
+ 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)) {
+ too_early = true;
+ }
+ auto length = out - in;
+ if (length.as_editable_units(pfr) < 15) {
+ too_short = true;
+ }
+ if (last_out) {
+ /* XXX: this feels dubious - is it really what Bv2.1 means? */
+ auto distance = reel_offset + in.as_editable_units(pfr) - *last_out;
+ if (distance >= 0 && distance < 2) {
+ too_close = true;
+ }
+ }
+ last_out = reel_offset + out.as_editable_units(pfr);
+ } else {
+ for (auto i: node->node_children()) {
+ parse(i, tcr, pfr, first_reel);
+ }
}
+ };
+
+ for (auto i = 0U; i < reels.size(); ++i) {
+ if (!check(reels[i])) {
+ continue;
+ }
+
+ /* We need to look at <Subtitle> instances in the XML being checked, so we can't use the subtitles
+ * read in by libdcp's parser.
+ */
+
+ auto doc = make_shared<cxml::Document>("SubtitleReel");
+ doc->read_string (xml(reels[i]));
+ auto const tcr = doc->number_child<int>("TimeCodeRate");
+ parse (doc, tcr, picture_frame_rate.get_value_or(24), i == 0);
+ reel_offset += duration(reels[i]);
+ }
+
+ if (too_early) {
+ notes.push_back(
+ VerificationNote(
+ VerificationNote::VERIFY_WARNING, VerificationNote::FIRST_TEXT_TOO_EARLY
+ )
+ );
+ }
+
+ if (too_short) {
+ notes.push_back (
+ VerificationNote(
+ VerificationNote::VERIFY_WARNING, VerificationNote::SUBTITLE_TOO_SHORT
+ )
+ );
+ }
+
+ if (too_close) {
+ notes.push_back (
+ VerificationNote(
+ VerificationNote::VERIFY_WARNING, VerificationNote::SUBTITLE_TOO_CLOSE
+ )
+ );
+ }
+}
+
+
+struct LinesCharactersResult
+{
+ bool warning_length_exceeded = false;
+ bool error_length_exceeded = false;
+ bool line_count_exceeded = false;
+};
+
+
+static
+void
+check_text_lines_and_characters (
+ shared_ptr<SubtitleAsset> asset,
+ int warning_length,
+ int error_length,
+ LinesCharactersResult* result
+ )
+{
+ class Event
+ {
+ public:
+ Event (dcp::Time time_, float position_, int characters_)
+ : time (time_)
+ , position (position_)
+ , characters (characters_)
+ {}
+
+ Event (dcp::Time time_, shared_ptr<Event> start_)
+ : time (time_)
+ , start (start_)
+ {}
+
+ dcp::Time time;
+ int position; //< position from 0 at top of screen to 100 at bottom
+ int characters;
+ shared_ptr<Event> start;
+ };
+
+ vector<shared_ptr<Event>> events;
+
+ auto position = [](shared_ptr<const SubtitleString> sub) {
+ switch (sub->v_align()) {
+ case VALIGN_TOP:
+ return lrintf(sub->v_position() * 100);
+ case VALIGN_CENTER:
+ return lrintf((0.5f + sub->v_position()) * 100);
+ case VALIGN_BOTTOM:
+ return lrintf((1.0f - sub->v_position()) * 100);
+ }
+
+ return 0L;
+ };
+
+ for (auto j: asset->subtitles()) {
+ auto text = dynamic_pointer_cast<const SubtitleString>(j);
+ if (text) {
+ auto in = make_shared<Event>(text->in(), position(text), text->text().length());
+ events.push_back(in);
+ events.push_back(make_shared<Event>(text->out(), in));
+ }
+ }
+
+ std::sort(events.begin(), events.end(), [](shared_ptr<Event> const& a, shared_ptr<Event>const& b) {
+ return a->time < b->time;
+ });
+
+ map<int, int> current;
+ for (auto i: events) {
+ if (current.size() > 3) {
+ result->line_count_exceeded = true;
+ }
+ for (auto j: current) {
+ if (j.second >= warning_length) {
+ result->warning_length_exceeded = true;
+ }
+ if (j.second >= error_length) {
+ result->error_length_exceeded = true;
+ }
+ }
+
+ if (i->start) {
+ /* end of a subtitle */
+ DCP_ASSERT (current.find(i->start->position) != current.end());
+ if (current[i->start->position] == i->start->characters) {
+ current.erase(i->start->position);
+ } else {
+ current[i->start->position] -= i->start->characters;
+ }
+ } else {
+ /* start of a subtitle */
+ if (current.find(i->position) == current.end()) {
+ current[i->position] = i->characters;
+ } else {
+ current[i->position] += i->characters;
+ }
+ }
+ }
+}
+
+
+static
+void
+check_text_timing (vector<shared_ptr<dcp::Reel>> reels, vector<VerificationNote>& notes)
+{
+ if (reels.empty()) {
+ return;
+ }
+
+ optional<int> picture_frame_rate;
+ if (reels[0]->main_picture()) {
+ picture_frame_rate = reels[0]->main_picture()->frame_rate().numerator;
+ }
+
+ if (reels[0]->main_subtitle()) {
+ check_text_timing (reels, picture_frame_rate, notes,
+ [](shared_ptr<dcp::Reel> reel) {
+ return static_cast<bool>(reel->main_subtitle());
+ },
+ [](shared_ptr<dcp::Reel> reel) {
+ return reel->main_subtitle()->asset()->raw_xml();
+ },
+ [](shared_ptr<dcp::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) {
+ return i < reel->closed_captions().size();
+ },
+ [i](shared_ptr<dcp::Reel> reel) {
+ return reel->closed_captions()[i]->asset()->raw_xml();
+ },
+ [i](shared_ptr<dcp::Reel> reel) {
+ return reel->closed_captions()[i]->actual_duration();
+ }
+ );
+ }
+}
+
+
+void
+check_extension_metadata (shared_ptr<dcp::CPL> cpl, vector<VerificationNote>& notes)
+{
+ DCP_ASSERT (cpl->file());
+ cxml::Document doc ("CompositionPlaylist");
+ doc.read_file (cpl->file().get());
+
+ auto missing = false;
+ string malformed;
+
+ if (auto reel_list = doc.node_child("ReelList")) {
+ auto reels = reel_list->node_children("Reel");
+ if (!reels.empty()) {
+ if (auto asset_list = reels[0]->optional_node_child("AssetList")) {
+ if (auto metadata = asset_list->optional_node_child("CompositionMetadataAsset")) {
+ if (auto extension_list = metadata->optional_node_child("ExtensionMetadataList")) {
+ missing = true;
+ for (auto extension: extension_list->node_children("ExtensionMetadata")) {
+ if (extension->optional_string_attribute("scope").get_value_or("") != "http://isdcf.com/ns/cplmd/app") {
+ continue;
+ }
+ missing = false;
+ if (auto name = extension->optional_node_child("Name")) {
+ if (name->content() != "Application") {
+ malformed = "<Name> should be 'Application'";
+ }
+ }
+ if (auto property_list = extension->optional_node_child("PropertyList")) {
+ if (auto property = property_list->optional_node_child("Property")) {
+ if (auto name = property->optional_node_child("Name")) {
+ if (name->content() != "DCP Constraints Profile") {
+ malformed = "<Name> property should be 'DCP Constraints Profile'";
+ }
+ }
+ if (auto value = property->optional_node_child("Value")) {
+ if (value->content() != "SMPTE-RDD-52:2020-Bv2.1") {
+ malformed = "<Value> property should be 'SMPTE-RDD-52:2020-Bv2.1'";
+ }
+ }
+ }
+ }
+ }
+ } else {
+ missing = true;
+ }
+ }
+ }
+ }
+ }
+
+ if (missing) {
+ notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_EXTENSION_METADATA});
+ } else if (!malformed.empty()) {
+ notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::INVALID_EXTENSION_METADATA, malformed});
}
}
-list<VerificationNote>
+vector<VerificationNote>
dcp::verify (
vector<boost::filesystem::path> directories,
function<void (string, optional<boost::filesystem::path>)> stage,
{
xsd_dtd_directory = boost::filesystem::canonical (xsd_dtd_directory);
- list<VerificationNote> notes;
+ vector<VerificationNote> notes;
+ State state;
- list<shared_ptr<DCP> > dcps;
- BOOST_FOREACH (boost::filesystem::path i, directories) {
+ vector<shared_ptr<DCP>> dcps;
+ for (auto i: directories) {
dcps.push_back (shared_ptr<DCP> (new DCP (i)));
}
- BOOST_FOREACH (shared_ptr<DCP> dcp, dcps) {
+ for (auto dcp: dcps) {
stage ("Checking DCP", dcp->directory());
try {
dcp->read (¬es);
notes.push_back (VerificationNote(VerificationNote::VERIFY_BV21_ERROR, VerificationNote::NOT_SMPTE));
}
- BOOST_FOREACH (shared_ptr<CPL> cpl, dcp->cpls()) {
+ for (auto cpl: dcp->cpls()) {
stage ("Checking CPL", cpl->file());
validate_xml (cpl->file().get(), xsd_dtd_directory, notes);
+ for (auto const& i: cpl->additional_subtitle_languages()) {
+ verify_language_tag (i, notes);
+ }
+
+ 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::VERIFY_BV21_ERROR, VerificationNote::BAD_LANGUAGE, terr});
+ }
+ }
+ }
+ }
+
+ if (dcp->standard() == dcp::SMPTE) {
+ if (!cpl->annotation_text()) {
+ notes.push_back (VerificationNote(VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_ANNOTATION_TEXT_IN_CPL));
+ } 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));
+ }
+ }
+
/* Check that the CPL's hash corresponds to the PKL */
- BOOST_FOREACH (shared_ptr<PKL> i, dcp->pkls()) {
+ for (auto i: dcp->pkls()) {
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));
}
}
- BOOST_FOREACH (shared_ptr<Reel> reel, cpl->reels()) {
+ /* 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>());
- BOOST_FOREACH (shared_ptr<ReelAsset> i, reel->assets()) {
+ 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()));
}
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()));
}
+ auto mxf = dynamic_pointer_cast<ReelMXF>(i);
+ if (mxf && !mxf->hash()) {
+ notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_HASH, i->id()});
+ }
+ }
+
+ if (dcp->standard() == dcp::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()));
+ break;
+ }
+ }
}
if (reel->main_picture()) {
/* Check reel stuff */
- Fraction const frame_rate = reel->main_picture()->frame_rate();
+ auto const frame_rate = reel->main_picture()->frame_rate();
if (frame_rate.denominator != 1 ||
(frame_rate.numerator != 24 &&
frame_rate.numerator != 25 &&
}
/* Check asset */
if (reel->main_picture()->asset_ref().resolved()) {
- verify_main_picture_asset (dcp, reel, stage, progress, notes);
+ verify_main_picture_asset (dcp, reel->main_picture(), stage, progress, notes);
}
}
if (reel->main_sound() && reel->main_sound()->asset_ref().resolved()) {
- verify_main_sound_asset (dcp, reel, stage, progress, notes);
+ verify_main_sound_asset (dcp, reel->main_sound(), stage, progress, notes);
}
if (reel->main_subtitle()) {
verify_main_subtitle_reel (reel->main_subtitle(), notes);
if (reel->main_subtitle()->asset_ref().resolved()) {
- verify_main_subtitle_asset (reel, stage, xsd_dtd_directory, notes);
+ verify_subtitle_asset (reel->main_subtitle()->asset(), stage, xsd_dtd_directory, notes, state);
+ }
+ have_main_subtitle = true;
+ } else {
+ have_no_main_subtitle = true;
+ }
+
+ for (auto i: reel->closed_captions()) {
+ verify_closed_caption_reel (i, notes);
+ if (i->asset_ref().resolved()) {
+ verify_closed_caption_asset (i->asset(), stage, xsd_dtd_directory, notes, state);
+ }
+ }
+
+ if (reel->main_markers()) {
+ for (auto const& i: reel->main_markers()->get()) {
+ markers_seen.insert (i);
+ }
+ }
+
+ 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 (dcp->standard() == dcp::SMPTE) {
+
+ if (have_main_subtitle && have_no_main_subtitle) {
+ notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MAIN_SUBTITLE_NOT_IN_ALL_REELS});
+ }
+
+ if (fewest_closed_captions != most_closed_captions) {
+ notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::CLOSED_CAPTION_ASSET_COUNTS_DIFFER});
+ }
+
+ 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 (markers_seen.find(dcp::Marker::FFMC) == markers_seen.end()) {
+ notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_FFMC_IN_FEATURE});
+ }
+ }
+
+ auto ffoc = markers_seen.find(dcp::Marker::FFOC);
+ if (ffoc == markers_seen.end()) {
+ notes.push_back ({VerificationNote::VERIFY_WARNING, VerificationNote::MISSING_FFOC});
+ } else if (ffoc->second.e != 1) {
+ notes.push_back ({VerificationNote::VERIFY_WARNING, VerificationNote::INCORRECT_FFOC});
+ }
+
+ auto lfoc = markers_seen.find(dcp::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});
+ }
+
+ check_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);
+ }
+ }
+
+ if (result.line_count_exceeded) {
+ notes.push_back (VerificationNote(VerificationNote::VERIFY_WARNING, VerificationNote::TOO_MANY_SUBTITLE_LINES));
+ }
+ if (result.error_length_exceeded) {
+ notes.push_back (VerificationNote(VerificationNote::VERIFY_WARNING, VerificationNote::SUBTITLE_LINE_TOO_LONG));
+ } else if (result.warning_length_exceeded) {
+ notes.push_back (VerificationNote(VerificationNote::VERIFY_WARNING, VerificationNote::SUBTITLE_LINE_LONGER_THAN_RECOMMENDED));
+ }
+
+ 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);
+ }
+ }
+ }
+
+ if (result.line_count_exceeded) {
+ notes.push_back (VerificationNote(VerificationNote::VERIFY_BV21_ERROR, VerificationNote::TOO_MANY_CLOSED_CAPTION_LINES));
+ }
+ if (result.error_length_exceeded) {
+ notes.push_back (VerificationNote(VerificationNote::VERIFY_BV21_ERROR, VerificationNote::CLOSED_CAPTION_LINE_TOO_LONG));
+ }
+
+ 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});
+ } else if (!cpl->version_number()) {
+ notes.push_back ({VerificationNote::VERIFY_BV21_ERROR, VerificationNote::MISSING_CPL_METADATA_VERSION_NUMBER});
+ }
+
+ check_extension_metadata (cpl, notes);
+
+ if (cpl->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()});
}
}
}
}
- BOOST_FOREACH (shared_ptr<PKL> pkl, dcp->pkls()) {
+ for (auto pkl: dcp->pkls()) {
stage ("Checking PKL", pkl->file());
validate_xml (pkl->file().get(), xsd_dtd_directory, notes);
}
return "The picture in a reel has an invalid frame rate.";
case dcp::VerificationNote::PICTURE_HASH_INCORRECT:
return dcp::String::compose("The hash of the picture asset %1 does not agree with the PKL file.", note.file()->filename());
- case dcp::VerificationNote::PKL_CPL_PICTURE_HASHES_DISAGREE:
- return dcp::String::compose("The PKL and CPL hashes disagree for the picture asset %1.", note.file()->filename());
+ case dcp::VerificationNote::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_DISAGREE:
- return dcp::String::compose("The PKL and CPL hashes disagree for the sound asset %1.", 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:
return "The asset map contains an empty asset path.";
case dcp::VerificationNote::MISSING_ASSET:
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:
+ case dcp::VerificationNote::PICTURE_FRAME_TOO_LARGE_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:
+ case dcp::VerificationNote::PICTURE_FRAME_NEARLY_TOO_LARGE_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());
return "This DCP does not use the SMPTE standard, which is required for Bv2.1 compliance.";
case dcp::VerificationNote::BAD_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:
+ 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:
+ return "At least one reel contains a subtitle asset, but some reel(s) do not";
+ case dcp::VerificationNote::CLOSED_CAPTION_ASSET_COUNTS_DIFFER:
+ 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:
+ 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:
+ return "The DCP is marked as a Feature but there is no FFMC (first frame of moving credits) marker";
+ case dcp::VerificationNote::MISSING_FFOC:
+ return "There should be a FFOC (first frame of content) marker";
+ case dcp::VerificationNote::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());
}
return "";
projects / libdcp.git / blobdiff