2 Copyright (C) 2018-2020 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
6 libdcp is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 libdcp is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with libdcp. If not, see <http://www.gnu.org/licenses/>.
19 In addition, as a special exception, the copyright holders give
20 permission to link the code of portions of this program with the
21 OpenSSL library under certain conditions as described in each
22 individual source file, and distribute linked combinations
25 You must obey the GNU General Public License in all respects
26 for all of the code used other than OpenSSL. If you modify
27 file(s) with this exception, you may extend this exception to your
28 version of the file(s), but you are not obligated to do so. If you
29 do not wish to do so, delete this exception statement from your
30 version. If you delete this exception statement from all source
31 files in the program, then also delete it here.
38 #include "reel_closed_caption_asset.h"
39 #include "reel_picture_asset.h"
40 #include "reel_sound_asset.h"
41 #include "reel_subtitle_asset.h"
42 #include "interop_subtitle_asset.h"
43 #include "mono_picture_asset.h"
44 #include "mono_picture_frame.h"
45 #include "stereo_picture_asset.h"
46 #include "stereo_picture_frame.h"
47 #include "exceptions.h"
48 #include "compose.hpp"
49 #include "raw_convert.h"
50 #include "smpte_subtitle_asset.h"
51 #include <xercesc/util/PlatformUtils.hpp>
52 #include <xercesc/parsers/XercesDOMParser.hpp>
53 #include <xercesc/parsers/AbstractDOMParser.hpp>
54 #include <xercesc/sax/HandlerBase.hpp>
55 #include <xercesc/dom/DOMImplementation.hpp>
56 #include <xercesc/dom/DOMImplementationLS.hpp>
57 #include <xercesc/dom/DOMImplementationRegistry.hpp>
58 #include <xercesc/dom/DOMLSParser.hpp>
59 #include <xercesc/dom/DOMException.hpp>
60 #include <xercesc/dom/DOMDocument.hpp>
61 #include <xercesc/dom/DOMNodeList.hpp>
62 #include <xercesc/dom/DOMError.hpp>
63 #include <xercesc/dom/DOMLocator.hpp>
64 #include <xercesc/dom/DOMNamedNodeMap.hpp>
65 #include <xercesc/dom/DOMAttr.hpp>
66 #include <xercesc/dom/DOMErrorHandler.hpp>
67 #include <xercesc/framework/LocalFileInputSource.hpp>
68 #include <xercesc/framework/MemBufInputSource.hpp>
69 #include <boost/noncopyable.hpp>
70 #include <boost/foreach.hpp>
71 #include <boost/algorithm/string.hpp>
83 using std::shared_ptr;
84 using boost::optional;
85 using boost::function;
86 using std::dynamic_pointer_cast;
89 using namespace xercesc;
93 xml_ch_to_string (XMLCh const * a)
95 char* x = XMLString::transcode(a);
97 XMLString::release(&x);
101 class XMLValidationError
104 XMLValidationError (SAXParseException const & e)
105 : _message (xml_ch_to_string(e.getMessage()))
106 , _line (e.getLineNumber())
107 , _column (e.getColumnNumber())
108 , _public_id (e.getPublicId() ? xml_ch_to_string(e.getPublicId()) : "")
109 , _system_id (e.getSystemId() ? xml_ch_to_string(e.getSystemId()) : "")
114 string message () const {
118 uint64_t line () const {
122 uint64_t column () const {
126 string public_id () const {
130 string system_id () const {
143 class DCPErrorHandler : public ErrorHandler
146 void warning(const SAXParseException& e)
148 maybe_add (XMLValidationError(e));
151 void error(const SAXParseException& e)
153 maybe_add (XMLValidationError(e));
156 void fatalError(const SAXParseException& e)
158 maybe_add (XMLValidationError(e));
165 list<XMLValidationError> errors () const {
170 void maybe_add (XMLValidationError e)
172 /* XXX: nasty hack */
174 e.message().find("schema document") != string::npos &&
175 e.message().find("has different target namespace from the one specified in instance document") != string::npos
180 _errors.push_back (e);
183 list<XMLValidationError> _errors;
186 class StringToXMLCh : public boost::noncopyable
189 StringToXMLCh (string a)
191 _buffer = XMLString::transcode(a.c_str());
196 XMLString::release (&_buffer);
199 XMLCh const * get () const {
207 class LocalFileResolver : public EntityResolver
210 LocalFileResolver (boost::filesystem::path xsd_dtd_directory)
211 : _xsd_dtd_directory (xsd_dtd_directory)
213 /* XXX: I'm not clear on what things need to be in this list; some XSDs are apparently, magically
214 * found without being here.
216 add("http://www.w3.org/2001/XMLSchema.dtd", "XMLSchema.dtd");
217 add("http://www.w3.org/2001/03/xml.xsd", "xml.xsd");
218 add("http://www.w3.org/TR/2002/REC-xmldsig-core-20020212/xmldsig-core-schema.xsd", "xmldsig-core-schema.xsd");
219 add("http://www.digicine.com/schemas/437-Y/2007/Main-Stereo-Picture-CPL.xsd", "Main-Stereo-Picture-CPL.xsd");
220 add("http://www.digicine.com/PROTO-ASDCP-CPL-20040511.xsd", "PROTO-ASDCP-CPL-20040511.xsd");
221 add("http://www.digicine.com/PROTO-ASDCP-PKL-20040311.xsd", "PROTO-ASDCP-PKL-20040311.xsd");
222 add("http://www.digicine.com/PROTO-ASDCP-AM-20040311.xsd", "PROTO-ASDCP-AM-20040311.xsd");
223 add("http://www.digicine.com/PROTO-ASDCP-CC-CPL-20070926#", "PROTO-ASDCP-CC-CPL-20070926.xsd");
224 add("interop-subs", "DCSubtitle.v1.mattsson.xsd");
225 add("http://www.smpte-ra.org/schemas/428-7/2010/DCST.xsd", "SMPTE-428-7-2010-DCST.xsd");
226 add("http://www.smpte-ra.org/schemas/429-16/2014/CPL-Metadata", "SMPTE-429-16.xsd");
227 add("http://www.dolby.com/schemas/2012/AD", "Dolby-2012-AD.xsd");
228 add("http://www.smpte-ra.org/schemas/429-10/2008/Main-Stereo-Picture-CPL", "SMPTE-429-10-2008.xsd");
231 InputSource* resolveEntity(XMLCh const *, XMLCh const * system_id)
236 string system_id_str = xml_ch_to_string (system_id);
237 boost::filesystem::path p = _xsd_dtd_directory;
238 if (_files.find(system_id_str) == _files.end()) {
241 p /= _files[system_id_str];
243 StringToXMLCh ch (p.string());
244 return new LocalFileInputSource(ch.get());
248 void add (string uri, string file)
253 std::map<string, string> _files;
254 boost::filesystem::path _xsd_dtd_directory;
259 parse (XercesDOMParser& parser, boost::filesystem::path xml)
261 parser.parse(xml.string().c_str());
266 parse (XercesDOMParser& parser, std::string xml)
268 xercesc::MemBufInputSource buf(reinterpret_cast<unsigned char const*>(xml.c_str()), xml.size(), "");
275 validate_xml (T xml, boost::filesystem::path xsd_dtd_directory, list<VerificationNote>& notes)
278 XMLPlatformUtils::Initialize ();
279 } catch (XMLException& e) {
280 throw MiscError ("Failed to initialise xerces library");
283 DCPErrorHandler error_handler;
285 /* All the xerces objects in this scope must be destroyed before XMLPlatformUtils::Terminate() is called */
287 XercesDOMParser parser;
288 parser.setValidationScheme(XercesDOMParser::Val_Always);
289 parser.setDoNamespaces(true);
290 parser.setDoSchema(true);
292 vector<string> schema;
293 schema.push_back("xml.xsd");
294 schema.push_back("xmldsig-core-schema.xsd");
295 schema.push_back("SMPTE-429-7-2006-CPL.xsd");
296 schema.push_back("SMPTE-429-8-2006-PKL.xsd");
297 schema.push_back("SMPTE-429-9-2007-AM.xsd");
298 schema.push_back("Main-Stereo-Picture-CPL.xsd");
299 schema.push_back("PROTO-ASDCP-CPL-20040511.xsd");
300 schema.push_back("PROTO-ASDCP-PKL-20040311.xsd");
301 schema.push_back("PROTO-ASDCP-AM-20040311.xsd");
302 schema.push_back("DCSubtitle.v1.mattsson.xsd");
303 schema.push_back("DCDMSubtitle-2010.xsd");
304 schema.push_back("PROTO-ASDCP-CC-CPL-20070926.xsd");
305 schema.push_back("SMPTE-429-16.xsd");
306 schema.push_back("Dolby-2012-AD.xsd");
307 schema.push_back("SMPTE-429-10-2008.xsd");
308 schema.push_back("xlink.xsd");
309 schema.push_back("SMPTE-335-2012.xsd");
310 schema.push_back("SMPTE-395-2014-13-1-aaf.xsd");
311 schema.push_back("isdcf-mca.xsd");
312 schema.push_back("SMPTE-429-12-2008.xsd");
314 /* XXX: I'm not especially clear what this is for, but it seems to be necessary.
315 * Schemas that are not mentioned in this list are not read, and the things
316 * they describe are not checked.
319 BOOST_FOREACH (string i, schema) {
320 locations += String::compose("%1 %1 ", i, i);
323 parser.setExternalSchemaLocation(locations.c_str());
324 parser.setValidationSchemaFullChecking(true);
325 parser.setErrorHandler(&error_handler);
327 LocalFileResolver resolver (xsd_dtd_directory);
328 parser.setEntityResolver(&resolver);
331 parser.resetDocumentPool();
333 } catch (XMLException& e) {
334 throw MiscError(xml_ch_to_string(e.getMessage()));
335 } catch (DOMException& e) {
336 throw MiscError(xml_ch_to_string(e.getMessage()));
338 throw MiscError("Unknown exception from xerces");
342 XMLPlatformUtils::Terminate ();
344 BOOST_FOREACH (XMLValidationError i, error_handler.errors()) {
347 VerificationNote::VERIFY_ERROR,
348 VerificationNote::XML_VALIDATION_ERROR,
350 boost::trim_copy(i.public_id() + " " + i.system_id()),
358 enum VerifyAssetResult {
359 VERIFY_ASSET_RESULT_GOOD,
360 VERIFY_ASSET_RESULT_CPL_PKL_DIFFER,
361 VERIFY_ASSET_RESULT_BAD
365 static VerifyAssetResult
366 verify_asset (shared_ptr<const DCP> dcp, shared_ptr<const ReelMXF> reel_mxf, function<void (float)> progress)
368 string const actual_hash = reel_mxf->asset_ref()->hash(progress);
370 list<shared_ptr<PKL> > pkls = dcp->pkls();
371 /* We've read this DCP in so it must have at least one PKL */
372 DCP_ASSERT (!pkls.empty());
374 shared_ptr<Asset> asset = reel_mxf->asset_ref().asset();
376 optional<string> pkl_hash;
377 BOOST_FOREACH (shared_ptr<PKL> i, pkls) {
378 pkl_hash = i->hash (reel_mxf->asset_ref()->id());
384 DCP_ASSERT (pkl_hash);
386 optional<string> cpl_hash = reel_mxf->hash();
387 if (cpl_hash && *cpl_hash != *pkl_hash) {
388 return VERIFY_ASSET_RESULT_CPL_PKL_DIFFER;
391 if (actual_hash != *pkl_hash) {
392 return VERIFY_ASSET_RESULT_BAD;
395 return VERIFY_ASSET_RESULT_GOOD;
400 verify_language_tag (string tag, list<VerificationNote>& notes)
403 dcp::LanguageTag test (tag);
404 } catch (dcp::LanguageTagError &) {
405 notes.push_back (VerificationNote(VerificationNote::VERIFY_BV21_ERROR, VerificationNote::BAD_LANGUAGE, tag));
410 enum VerifyPictureAssetResult
412 VERIFY_PICTURE_ASSET_RESULT_GOOD,
413 VERIFY_PICTURE_ASSET_RESULT_FRAME_NEARLY_TOO_LARGE,
414 VERIFY_PICTURE_ASSET_RESULT_BAD,
419 biggest_frame_size (shared_ptr<const MonoPictureFrame> frame)
421 return frame->size ();
425 biggest_frame_size (shared_ptr<const StereoPictureFrame> frame)
427 return max(frame->left()->size(), frame->right()->size());
431 template <class A, class R, class F>
432 optional<VerifyPictureAssetResult>
433 verify_picture_asset_type (shared_ptr<const ReelMXF> reel_mxf, function<void (float)> progress)
435 shared_ptr<A> asset = dynamic_pointer_cast<A>(reel_mxf->asset_ref().asset());
437 return optional<VerifyPictureAssetResult>();
440 int biggest_frame = 0;
441 shared_ptr<R> reader = asset->start_read ();
442 int64_t const duration = asset->intrinsic_duration ();
443 for (int64_t i = 0; i < duration; ++i) {
444 shared_ptr<const F> frame = reader->get_frame (i);
445 biggest_frame = max(biggest_frame, biggest_frame_size(frame));
446 progress (float(i) / duration);
449 static const int max_frame = rint(250 * 1000000 / (8 * asset->edit_rate().as_float()));
450 static const int risky_frame = rint(230 * 1000000 / (8 * asset->edit_rate().as_float()));
451 if (biggest_frame > max_frame) {
452 return VERIFY_PICTURE_ASSET_RESULT_BAD;
453 } else if (biggest_frame > risky_frame) {
454 return VERIFY_PICTURE_ASSET_RESULT_FRAME_NEARLY_TOO_LARGE;
457 return VERIFY_PICTURE_ASSET_RESULT_GOOD;
461 static VerifyPictureAssetResult
462 verify_picture_asset (shared_ptr<const ReelMXF> reel_mxf, function<void (float)> progress)
464 optional<VerifyPictureAssetResult> r = verify_picture_asset_type<MonoPictureAsset, MonoPictureAssetReader, MonoPictureFrame>(reel_mxf, progress);
466 r = verify_picture_asset_type<StereoPictureAsset, StereoPictureAssetReader, StereoPictureFrame>(reel_mxf, progress);
475 verify_main_picture_asset (
476 shared_ptr<const DCP> dcp,
477 shared_ptr<const ReelPictureAsset> reel_asset,
478 function<void (string, optional<boost::filesystem::path>)> stage,
479 function<void (float)> progress,
480 list<VerificationNote>& notes
483 shared_ptr<const PictureAsset> asset = reel_asset->asset();
484 boost::filesystem::path const file = *asset->file();
485 stage ("Checking picture asset hash", file);
486 VerifyAssetResult const r = verify_asset (dcp, reel_asset, progress);
488 case VERIFY_ASSET_RESULT_BAD:
491 VerificationNote::VERIFY_ERROR, VerificationNote::PICTURE_HASH_INCORRECT, file
495 case VERIFY_ASSET_RESULT_CPL_PKL_DIFFER:
498 VerificationNote::VERIFY_ERROR, VerificationNote::PKL_CPL_PICTURE_HASHES_DISAGREE, file
505 stage ("Checking picture frame sizes", asset->file());
506 VerifyPictureAssetResult const pr = verify_picture_asset (reel_asset, progress);
508 case VERIFY_PICTURE_ASSET_RESULT_BAD:
511 VerificationNote::VERIFY_ERROR, VerificationNote::PICTURE_FRAME_TOO_LARGE_IN_BYTES, file
515 case VERIFY_PICTURE_ASSET_RESULT_FRAME_NEARLY_TOO_LARGE:
518 VerificationNote::VERIFY_WARNING, VerificationNote::PICTURE_FRAME_NEARLY_TOO_LARGE_IN_BYTES, file
526 /* Only flat/scope allowed by Bv2.1 */
528 asset->size() != dcp::Size(2048, 858) &&
529 asset->size() != dcp::Size(1998, 1080) &&
530 asset->size() != dcp::Size(4096, 1716) &&
531 asset->size() != dcp::Size(3996, 2160)) {
534 VerificationNote::VERIFY_BV21_ERROR,
535 VerificationNote::PICTURE_ASSET_INVALID_SIZE_IN_PIXELS,
536 String::compose("%1x%2", asset->size().width, asset->size().height),
542 /* Only 24, 25, 48fps allowed for 2K */
544 (asset->size() == dcp::Size(2048, 858) || asset->size() == dcp::Size(1998, 1080)) &&
545 (asset->edit_rate() != dcp::Fraction(24, 1) && asset->edit_rate() != dcp::Fraction(25, 1) && asset->edit_rate() != dcp::Fraction(48, 1))
549 VerificationNote::VERIFY_BV21_ERROR,
550 VerificationNote::PICTURE_ASSET_INVALID_FRAME_RATE_FOR_2K,
551 String::compose("%1/%2", asset->edit_rate().numerator, asset->edit_rate().denominator),
557 if (asset->size() == dcp::Size(4096, 1716) || asset->size() == dcp::Size(3996, 2160)) {
558 /* Only 24fps allowed for 4K */
559 if (asset->edit_rate() != dcp::Fraction(24, 1)) {
562 VerificationNote::VERIFY_BV21_ERROR,
563 VerificationNote::PICTURE_ASSET_INVALID_FRAME_RATE_FOR_4K,
564 String::compose("%1/%2", asset->edit_rate().numerator, asset->edit_rate().denominator),
570 /* Only 2D allowed for 4K */
571 if (dynamic_pointer_cast<const StereoPictureAsset>(asset)) {
574 VerificationNote::VERIFY_BV21_ERROR,
575 VerificationNote::PICTURE_ASSET_4K_3D,
587 verify_main_sound_asset (
588 shared_ptr<const DCP> dcp,
589 shared_ptr<const ReelSoundAsset> reel_asset,
590 function<void (string, optional<boost::filesystem::path>)> stage,
591 function<void (float)> progress,
592 list<VerificationNote>& notes
595 shared_ptr<const dcp::SoundAsset> asset = reel_asset->asset();
596 stage ("Checking sound asset hash", asset->file());
597 VerifyAssetResult const r = verify_asset (dcp, reel_asset, progress);
599 case VERIFY_ASSET_RESULT_BAD:
602 VerificationNote::VERIFY_ERROR, VerificationNote::SOUND_HASH_INCORRECT, *asset->file()
606 case VERIFY_ASSET_RESULT_CPL_PKL_DIFFER:
609 VerificationNote::VERIFY_ERROR, VerificationNote::PKL_CPL_SOUND_HASHES_DISAGREE, *asset->file()
617 stage ("Checking sound asset metadata", asset->file());
619 verify_language_tag (asset->language(), notes);
624 verify_main_subtitle_reel (shared_ptr<const ReelSubtitleAsset> reel_asset, list<VerificationNote>& notes)
626 /* XXX: is Language compulsory? */
627 if (reel_asset->language()) {
628 verify_language_tag (*reel_asset->language(), notes);
634 verify_closed_caption_reel (shared_ptr<const ReelClosedCaptionAsset> reel_asset, list<VerificationNote>& notes)
636 /* XXX: is Language compulsory? */
637 if (reel_asset->language()) {
638 verify_language_tag (*reel_asset->language(), notes);
644 verify_subtitle_asset (
645 shared_ptr<const SubtitleAsset> asset,
646 function<void (string, optional<boost::filesystem::path>)> stage,
647 boost::filesystem::path xsd_dtd_directory,
648 list<VerificationNote>& notes
651 stage ("Checking subtitle XML", asset->file());
652 /* Note: we must not use SubtitleAsset::xml_as_string() here as that will mean the data on disk
653 * gets passed through libdcp which may clean up and therefore hide errors.
655 validate_xml (asset->raw_xml(), xsd_dtd_directory, notes);
657 shared_ptr<const SMPTESubtitleAsset> smpte = dynamic_pointer_cast<const SMPTESubtitleAsset>(asset);
659 if (smpte->language()) {
660 verify_language_tag (*smpte->language(), notes);
666 list<VerificationNote>
668 vector<boost::filesystem::path> directories,
669 function<void (string, optional<boost::filesystem::path>)> stage,
670 function<void (float)> progress,
671 boost::filesystem::path xsd_dtd_directory
674 xsd_dtd_directory = boost::filesystem::canonical (xsd_dtd_directory);
676 list<VerificationNote> notes;
678 list<shared_ptr<DCP> > dcps;
679 BOOST_FOREACH (boost::filesystem::path i, directories) {
680 dcps.push_back (shared_ptr<DCP> (new DCP (i)));
683 BOOST_FOREACH (shared_ptr<DCP> dcp, dcps) {
684 stage ("Checking DCP", dcp->directory());
687 } catch (ReadError& e) {
688 notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::GENERAL_READ, string(e.what())));
689 } catch (XMLError& e) {
690 notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::GENERAL_READ, string(e.what())));
691 } catch (MXFFileError& e) {
692 notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::GENERAL_READ, string(e.what())));
693 } catch (cxml::Error& e) {
694 notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::GENERAL_READ, string(e.what())));
697 if (dcp->standard() != dcp::SMPTE) {
698 notes.push_back (VerificationNote(VerificationNote::VERIFY_BV21_ERROR, VerificationNote::NOT_SMPTE));
701 BOOST_FOREACH (shared_ptr<CPL> cpl, dcp->cpls()) {
702 stage ("Checking CPL", cpl->file());
703 validate_xml (cpl->file().get(), xsd_dtd_directory, notes);
705 BOOST_FOREACH (string const& i, cpl->additional_subtitle_languages()) {
706 verify_language_tag (i, notes);
709 if (cpl->release_territory()) {
710 verify_language_tag (cpl->release_territory().get(), notes);
713 /* Check that the CPL's hash corresponds to the PKL */
714 BOOST_FOREACH (shared_ptr<PKL> i, dcp->pkls()) {
715 optional<string> h = i->hash(cpl->id());
716 if (h && make_digest(ArrayData(*cpl->file())) != *h) {
717 notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::CPL_HASH_INCORRECT));
721 BOOST_FOREACH (shared_ptr<Reel> reel, cpl->reels()) {
722 stage ("Checking reel", optional<boost::filesystem::path>());
724 BOOST_FOREACH (shared_ptr<ReelAsset> i, reel->assets()) {
725 if (i->duration() && (i->duration().get() * i->edit_rate().denominator / i->edit_rate().numerator) < 1) {
726 notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::DURATION_TOO_SMALL, i->id()));
728 if ((i->intrinsic_duration() * i->edit_rate().denominator / i->edit_rate().numerator) < 1) {
729 notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::INTRINSIC_DURATION_TOO_SMALL, i->id()));
733 if (reel->main_picture()) {
734 /* Check reel stuff */
735 Fraction const frame_rate = reel->main_picture()->frame_rate();
736 if (frame_rate.denominator != 1 ||
737 (frame_rate.numerator != 24 &&
738 frame_rate.numerator != 25 &&
739 frame_rate.numerator != 30 &&
740 frame_rate.numerator != 48 &&
741 frame_rate.numerator != 50 &&
742 frame_rate.numerator != 60 &&
743 frame_rate.numerator != 96)) {
744 notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::INVALID_PICTURE_FRAME_RATE));
747 if (reel->main_picture()->asset_ref().resolved()) {
748 verify_main_picture_asset (dcp, reel->main_picture(), stage, progress, notes);
752 if (reel->main_sound() && reel->main_sound()->asset_ref().resolved()) {
753 verify_main_sound_asset (dcp, reel->main_sound(), stage, progress, notes);
756 if (reel->main_subtitle()) {
757 verify_main_subtitle_reel (reel->main_subtitle(), notes);
758 if (reel->main_subtitle()->asset_ref().resolved()) {
759 verify_subtitle_asset (reel->main_subtitle()->asset(), stage, xsd_dtd_directory, notes);
763 BOOST_FOREACH (shared_ptr<dcp::ReelClosedCaptionAsset> i, reel->closed_captions()) {
764 verify_closed_caption_reel (i, notes);
765 if (i->asset_ref().resolved()) {
766 verify_subtitle_asset (i->asset(), stage, xsd_dtd_directory, notes);
772 BOOST_FOREACH (shared_ptr<PKL> pkl, dcp->pkls()) {
773 stage ("Checking PKL", pkl->file());
774 validate_xml (pkl->file().get(), xsd_dtd_directory, notes);
777 if (dcp->asset_map_path()) {
778 stage ("Checking ASSETMAP", dcp->asset_map_path().get());
779 validate_xml (dcp->asset_map_path().get(), xsd_dtd_directory, notes);
781 notes.push_back (VerificationNote(VerificationNote::VERIFY_ERROR, VerificationNote::MISSING_ASSETMAP));
789 dcp::note_to_string (dcp::VerificationNote note)
791 switch (note.code()) {
792 case dcp::VerificationNote::GENERAL_READ:
794 case dcp::VerificationNote::CPL_HASH_INCORRECT:
795 return "The hash of the CPL in the PKL does not agree with the CPL file.";
796 case dcp::VerificationNote::INVALID_PICTURE_FRAME_RATE:
797 return "The picture in a reel has an invalid frame rate.";
798 case dcp::VerificationNote::PICTURE_HASH_INCORRECT:
799 return dcp::String::compose("The hash of the picture asset %1 does not agree with the PKL file.", note.file()->filename());
800 case dcp::VerificationNote::PKL_CPL_PICTURE_HASHES_DISAGREE:
801 return dcp::String::compose("The PKL and CPL hashes disagree for the picture asset %1.", note.file()->filename());
802 case dcp::VerificationNote::SOUND_HASH_INCORRECT:
803 return dcp::String::compose("The hash of the sound asset %1 does not agree with the PKL file.", note.file()->filename());
804 case dcp::VerificationNote::PKL_CPL_SOUND_HASHES_DISAGREE:
805 return dcp::String::compose("The PKL and CPL hashes disagree for the sound asset %1.", note.file()->filename());
806 case dcp::VerificationNote::EMPTY_ASSET_PATH:
807 return "The asset map contains an empty asset path.";
808 case dcp::VerificationNote::MISSING_ASSET:
809 return String::compose("The file for an asset in the asset map cannot be found; missing file is %1.", note.file()->filename());
810 case dcp::VerificationNote::MISMATCHED_STANDARD:
811 return "The DCP contains both SMPTE and Interop parts.";
812 case dcp::VerificationNote::XML_VALIDATION_ERROR:
813 return String::compose("An XML file is badly formed: %1 (%2:%3)", note.note().get(), note.file()->filename(), note.line().get());
814 case dcp::VerificationNote::MISSING_ASSETMAP:
815 return "No ASSETMAP or ASSETMAP.xml was found.";
816 case dcp::VerificationNote::INTRINSIC_DURATION_TOO_SMALL:
817 return String::compose("The intrinsic duration of an asset is less than 1 second long: %1", note.note().get());
818 case dcp::VerificationNote::DURATION_TOO_SMALL:
819 return String::compose("The duration of an asset is less than 1 second long: %1", note.note().get());
820 case dcp::VerificationNote::PICTURE_FRAME_TOO_LARGE_IN_BYTES:
821 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());
822 case dcp::VerificationNote::PICTURE_FRAME_NEARLY_TOO_LARGE_IN_BYTES:
823 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());
824 case dcp::VerificationNote::EXTERNAL_ASSET:
825 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());
826 case dcp::VerificationNote::NOT_SMPTE:
827 return "This DCP does not use the SMPTE standard, which is required for Bv2.1 compliance.";
828 case dcp::VerificationNote::BAD_LANGUAGE:
829 return String::compose("The DCP specifies a language '%1' which does not conform to the RFC 5646 standard.", note.note().get());
830 case dcp::VerificationNote::PICTURE_ASSET_INVALID_SIZE_IN_PIXELS:
831 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());
832 case dcp::VerificationNote::PICTURE_ASSET_INVALID_FRAME_RATE_FOR_2K:
833 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());
834 case dcp::VerificationNote::PICTURE_ASSET_INVALID_FRAME_RATE_FOR_4K:
835 return String::compose("A picture asset's frame rate (%1) is not 24fps as required for 4K DCPs by Bv2.1", note.note().get());
836 case dcp::VerificationNote::PICTURE_ASSET_4K_3D:
837 return "3D 4K DCPs are not allowed by Bv2.1";