2 Copyright (C) 2018-2021 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.
35 /** @file src/verify.h
36 * @brief dcp::verify() method and associated code
40 #ifndef LIBDCP_VERIFY_H
41 #define LIBDCP_VERIFY_H
44 #include "decrypted_kdm.h"
45 #include <boost/any.hpp>
46 #include <boost/filesystem.hpp>
47 #include <boost/function.hpp>
48 #include <boost/optional.hpp>
54 /* windows.h defines this but we want to use it */
61 class VerificationNote
66 BV21_ERROR, ///< may not always be considered an error, but violates a "shall" requirement of Bv2.1
70 /** Codes for errors or warnings from verifying DCPs.
72 * The names should (in general) answer the question "what is wrong?" with an answer that begins "There is a ..."
73 * e.g. "There is a INCORRECT_CPL_HASH"
74 * "There is a MISSING_ASSET"
76 * In general the pattern should be <negative-adjective> <noun>.
77 * Some <negative-adjective>s are:
79 * - INCORRECT: something, which could have any value, is wrong.
80 * - INVALID: something, which should only be one of a set of values, is not in the set, or some preformatted
81 * quantity (e.g. XML) is in the wrong format.
82 * - MISMATCHED: two things, which should be the same, are not.
83 * - EMPTY: something, which should have a value, has no value.
84 * - MISSING: something, which should be present, is not.
85 * - UNEXPECTED: something, which is present, should not be.
86 * - FAILED: some part of the verification failed in some serious way.
88 * Comments should clarify meaning and also say which of the optional fields (e.g. file)
89 * are filled in when this code is used.
92 // If you change the next line, also look in doc/manual/verifier.py in DCP-o-matic
93 // as it looks for it when compiling the manual. Also, in this enum:
94 // [...] will be taken as a reference to a section of Bv2.1
95 // _foo_ means foo should be written as a piece of code
97 /** A general error when reading the DCP
98 * note contains (probably technical) details
101 /** The hash of the CPL in the PKL does not agree with the CPL file
102 * note contains CPL ID
103 * file contains CPL filename
105 MISMATCHED_CPL_HASHES,
106 /** The frame rate given in a reel for the main picture is not 24, 25, 30, 48, 50 or 60
107 * note contains the invalid frame rate as "<numerator>/<denominator>"
109 INVALID_PICTURE_FRAME_RATE,
110 /** The hash of a main picture asset does not agree with the PKL file
111 * file contains the picture asset filename
113 INCORRECT_PICTURE_HASH,
114 /** The hash of a main picture is different in the CPL and PKL
115 * file contains the picture asset filename
117 MISMATCHED_PICTURE_HASHES,
118 /** The hash of a main sound asset does not agree with the PKL file
119 * file contains the sound asset filename
121 INCORRECT_SOUND_HASH,
122 /** The hash of a main sound is different in the CPL and PKL
123 * file contains the sound asset filename
125 MISMATCHED_SOUND_HASHES,
126 /** An assetmap's _<Path>_ entry is empty */
128 /** A file mentioned in an asset map cannot be found
129 * file contains the filename that is missing
132 /** The DCP contains both SMPTE and Interop-standard components */
134 /** Some XML fails to validate against its XSD/DTD
135 * note contains the (probably technical) details
136 * file contains the invalid filename
137 * line contains the line number
140 /** No _ASSETMAP_ or _ASSETMAP.xml_ was found */
142 /** An asset's _IntrinsicDuration_ is less than 1 second
143 * note contains asset ID
145 INVALID_INTRINSIC_DURATION,
146 /** An asset's _Duration_ is less than 1 second
147 * note contains asset ID
150 /** The JPEG2000 data in at least one picture frame is larger than the equivalent of 250Mbit/s
151 * file contains the picture asset filename
153 INVALID_PICTURE_FRAME_SIZE_IN_BYTES,
154 /** The JPEG2000 data in at least one picture frame is larger than the equivalent of 230Mbit/s
155 * file contains the picture asset filename
157 NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES,
158 /** An asset that the CPL requires is not in this DCP; the DCP may be a VF
159 * note contains the asset ID
162 /** A stereoscopic asset has an MXF which is marked as being monoscopic
163 * file contains the asset filename
165 THREED_ASSET_MARKED_AS_TWOD,
166 /** DCP is Interop, not SMPTE [Bv2.1_6.1] */
168 /** A language or territory does not conform to RFC 5646 [Bv2.1_6.2.1]
169 * note contains the invalid language
172 /** A picture asset does not have one of the required Bv2.1 sizes (in pixels) [Bv2.1_7.1]
173 * note contains the incorrect size as "<width>x<height>"
174 * file contains the asset filename
176 INVALID_PICTURE_SIZE_IN_PIXELS,
177 /** A picture asset is 2K but is not at 24, 25 or 48 fps as required by Bv2.1 [Bv2.1_7.1]
178 * note contains the invalid frame rate as "<numerator>/<denominator>"
179 * file contains the asset filename
181 INVALID_PICTURE_FRAME_RATE_FOR_2K,
182 /** A picture asset is 4K but is not at 24fps as required by Bv2.1 [Bv2.1_7.1]
183 * note contains the invalid frame rate as "<numerator>/<denominator>"
184 * file contains the asset filename
186 INVALID_PICTURE_FRAME_RATE_FOR_4K,
187 /** A picture asset is 4K but is 3D which is not allowed by Bv2.1 [Bv2.1_7.1]
188 * note contains the invalid frame rate as "<numerator>/<denominator>"
189 * file contains the asset filename
191 INVALID_PICTURE_ASSET_RESOLUTION_FOR_3D,
192 /** A closed caption's XML file is larger than 256KB [Bv2.1_7.2.1]
193 * note contains the invalid size in bytes
194 * file contains the asset filename
196 INVALID_CLOSED_CAPTION_XML_SIZE_IN_BYTES,
197 /** Any timed text asset's total files is larger than 115MB [Bv2.1_7.2.1]
198 * note contains the invalid size in bytes
199 * file contains the asset filename
201 INVALID_TIMED_TEXT_SIZE_IN_BYTES,
202 /** The total size of all a timed text asset's fonts is larger than 10MB [Bv2.1_7.2.1]
203 * note contains the invalid size in bytes
204 * file contains the asset filename
206 INVALID_TIMED_TEXT_FONT_SIZE_IN_BYTES,
207 /** Some SMPTE subtitle XML has no _<Language>_ tag [Bv2.1_7.2.2]
208 * file contains the asset filename
210 MISSING_SUBTITLE_LANGUAGE,
211 /** Not all subtitle assets specify the same _<Language>_ tag [Bv2.1_7.2.2] */
212 MISMATCHED_SUBTITLE_LANGUAGES,
213 /** Some SMPTE subtitle XML has no _<StartTime>_ tag [Bv2.1_7.2.3]
214 * file contains the asset filename
216 MISSING_SUBTITLE_START_TIME,
217 /** Some SMPTE subtitle XML has a non-zero _<StartTime>_ tag [Bv2.1_7.2.3]
218 * file contains the asset filename
220 INVALID_SUBTITLE_START_TIME,
221 /** The first subtitle or closed caption happens before 4s into the first reel [Bv2.1_7.2.4] */
222 INVALID_SUBTITLE_FIRST_TEXT_TIME,
223 /** At least one subtitle is less than the minimum of 15 frames suggested by [Bv2.1_7.2.5] */
224 INVALID_SUBTITLE_DURATION,
225 /** At least one pair of subtitles are separated by less than the the minimum of 2 frames suggested by [Bv2.1_7.2.5] */
226 INVALID_SUBTITLE_SPACING,
227 /** A subtitle lasts for longer than the reel which contains it */
228 SUBTITLE_OVERLAPS_REEL_BOUNDARY,
229 /** There are more than 3 subtitle lines in at least one place [Bv2.1_7.2.7] */
230 INVALID_SUBTITLE_LINE_COUNT,
231 /** There are more than 52 characters in at least one subtitle line [Bv2.1_7.2.7] */
232 NEARLY_INVALID_SUBTITLE_LINE_LENGTH,
233 /** There are more than 79 characters in at least one subtitle line [Bv2.1_7.2.7] */
234 INVALID_SUBTITLE_LINE_LENGTH,
235 /** There are more than 3 closed caption lines in at least one place [Bv2.1_7.2.6] */
236 INVALID_CLOSED_CAPTION_LINE_COUNT,
237 /** There are more than 32 characters in at least one closed caption line [Bv2.1_7.2.6] */
238 INVALID_CLOSED_CAPTION_LINE_LENGTH,
239 /** The audio sampling rate must be 48kHz [Bv2.1_7.3]
240 * note contains the invalid frame rate
241 * file contains the asset filename
243 INVALID_SOUND_FRAME_RATE,
244 /** The CPL has no _<AnnotationText>_ tag [Bv2.1_8.1]
245 * note contains the CPL ID
246 * file contains the CPL filename
248 MISSING_CPL_ANNOTATION_TEXT,
249 /** The _<AnnotationText>_ is not the same as the _<ContentTitleText>_ [Bv2.1_8.1]
250 * note contains the CPL ID
251 * file contains the CPL filename
253 MISMATCHED_CPL_ANNOTATION_TEXT,
254 /** At least one asset in a reel does not have the same duration as the others */
255 MISMATCHED_ASSET_DURATION,
256 /** If one reel has a _MainSubtitle_, all must have them */
257 MISSING_MAIN_SUBTITLE_FROM_SOME_REELS,
258 /** If one reel has at least one _ClosedCaption_, all reels must have the same number of _ClosedCaptions_ */
259 MISMATCHED_CLOSED_CAPTION_ASSET_COUNTS,
260 /** MainSubtitle in reels must have _<EntryPoint>_ [Bv2.1_8.3.2]
261 * note contains the asset ID
263 MISSING_SUBTITLE_ENTRY_POINT,
264 /** MainSubtitle _<EntryPoint>_ must be zero [Bv2.1_8.3.2]
265 * note contains the asset ID
267 INCORRECT_SUBTITLE_ENTRY_POINT,
268 /** Closed caption in reels must have _<EntryPoint>_ [Bv2.1_8.3.2]
269 * note contains the asset ID
271 MISSING_CLOSED_CAPTION_ENTRY_POINT,
272 /** Closed caption _MainSubtitle_ _<EntryPoint>_ must be zero [Bv2.1_8.3.2]
273 * note contains the asset ID
275 INCORRECT_CLOSED_CAPTION_ENTRY_POINT,
276 /** _<Hash>_ must be present for assets in CPLs
277 * note contains the asset ID
280 /** If _ContentKind_ is Feature there must be a FFEC marker */
281 MISSING_FFEC_IN_FEATURE,
282 /** If _ContentKind_ is Feature there must be a FFMC marker */
283 MISSING_FFMC_IN_FEATURE,
284 /** There should be a FFOC marker */
286 /** There should be a LFOC marker */
288 /** The FFOC marker should be 1
289 * note contains the incorrect value.
292 /** The LFOC marker should be the last frame in the reel
293 * note contains the incorrect value
296 /** There must be a _<CompositionMetadataAsset>_
297 * note contains the CPL ID
298 * file contains the CPL filename
300 MISSING_CPL_METADATA,
301 /** CPL metadata should contain _<VersionNumber>_ of 1, at least
302 * note contains the CPL ID
303 * file contains the CPL filename
305 MISSING_CPL_METADATA_VERSION_NUMBER,
306 /** There must be an _<ExtensionMetadata>_ in _<CompositionMetadataAsset>_ [Bv2.1_8.6.3]
307 * note contains the CPL ID
308 * file contains the CPL filename
310 MISSING_EXTENSION_METADATA,
311 /** _<ExtensionMetadata>_ does not have the correct form [Bv2.1_8.6.3]
312 * note contains details of what's wrong
313 * file contains the CPL filename
315 INVALID_EXTENSION_METADATA,
316 /** A CPL containing encrypted content is not signed [Bv2.1_8.7]
317 * note contains the CPL ID
318 * file contains the CPL filename
320 UNSIGNED_CPL_WITH_ENCRYPTED_CONTENT,
321 /** A PKL containing encrypted content is not signed [Bv2.1_8.7]
322 * note contains the PKL ID
323 * file contains the PKL filename
325 UNSIGNED_PKL_WITH_ENCRYPTED_CONTENT,
326 /** If a PKL has one CPL its _<ContentTitleText>_ must be the same as the PKL's _<AnnotationText>_
327 * note contains the PKL ID
328 * file contains the PKL filename
330 MISMATCHED_PKL_ANNOTATION_TEXT_WITH_CPL,
331 /** Some, but not all content, is encrypted */
333 /** General error during JPEG2000 codestream verification
334 * note contains details
336 INVALID_JPEG2000_CODESTREAM,
337 /** Invalid number of guard bits in a 2K JPEG2000 stream (should be 1) [Bv2.1_10.2.1]
338 * note contains the number of guard bits
340 INVALID_JPEG2000_GUARD_BITS_FOR_2K,
341 /** Invalid number of guard bits in a 4K JPEG2000 stream (should be 2) [Bv2.1_10.2.1]
342 * note contains the number of guard bits
344 INVALID_JPEG2000_GUARD_BITS_FOR_4K,
345 /** JPEG2000 tile size is not the same as the image size [Bv2.1_10.2.1] */
346 INVALID_JPEG2000_TILE_SIZE,
347 /** JPEG2000 code block width is not 32 [Bv2.1_10.2.1]
348 * note contains the code block width
350 INVALID_JPEG2000_CODE_BLOCK_WIDTH,
351 /** JPEG2000 code block height is not 32 [Bv2.1_10.2.1]
352 * note contains the code block height
354 INVALID_JPEG2000_CODE_BLOCK_HEIGHT,
355 /** There must be no POC markers in a 2K codestream [Bv2.1_10.2.1]
356 * note contains the number of POC markers found
358 INCORRECT_JPEG2000_POC_MARKER_COUNT_FOR_2K,
359 /** There must be exactly one POC marker in a 4K codestream [Bv2.1_10.2.1]
360 * note contains the number of POC markers found
362 INCORRECT_JPEG2000_POC_MARKER_COUNT_FOR_4K,
363 /** A POC marker has incorrect content [Bv2.1_10.2.1]
364 * note contains details
366 INCORRECT_JPEG2000_POC_MARKER,
367 /** A POC marker was found outside the main head [Bv2.1_10.2.1] */
368 INVALID_JPEG2000_POC_MARKER_LOCATION,
369 /** Invalid number of tile parts for 2K JPEG2000 stream (should be 3) [Bv2.1_10.2.1]
370 * note contains the number of tile parts
372 INVALID_JPEG2000_TILE_PARTS_FOR_2K,
373 /** Invalid number of tile parts for 4K JPEG2000 stream (should be 6) [Bv2.1_10.2.1]
374 * note contains the number of tile parts
376 INVALID_JPEG2000_TILE_PARTS_FOR_4K,
377 /** No TLM marker was found [Bv2.1_10.2.1] */
378 MISSING_JPEG200_TLM_MARKER,
379 /** The MXF _ResourceID_ of a timed text resource was not the same as that of the contained XML essence [Bv2.1_10.4.3] */
380 MISMATCHED_TIMED_TEXT_RESOURCE_ID,
381 /** The AssetID of a timed text MXF is the same as its _ResourceID_ or that of the contained XML essence [Bv2.1_10.4.2] */
382 INCORRECT_TIMED_TEXT_ASSET_ID,
383 /** The ContainerDuration of a timed text MXF is not the same as the _Duration_ in its reel [Bv2.1_10.4.3]
384 * note contains the reel duration, followed by a space, followed by the MXF duration
385 * file contains the asset filename
387 MISMATCHED_TIMED_TEXT_DURATION,
388 /** Something could not be verified because content is encrypted and no key is available */
389 MISSED_CHECK_OF_ENCRYPTED,
390 /** Some timed-text XML has an empty <_Text_> node */
392 /** Some closed captions do not have the same vertical alignment within a <_Subtitle_> node */
393 MISMATCHED_CLOSED_CAPTION_VALIGN,
394 /** Some closed captions are not listed in the XML in the order of their vertical position */
395 INCORRECT_CLOSED_CAPTION_ORDERING,
396 /** Some <MainMarkers> asset has an <EntryPoint> that should not be there */
397 UNEXPECTED_ENTRY_POINT,
398 /** Some <MainMarkers> asset has an <Duration> that should not be there */
400 /** A <ContentKind> has been specified with either no scope or the SMPTE 429-7 scope, but which is not one of those allowed */
401 INVALID_CONTENT_KIND,
402 /** Either the width or height of a <MainPictureActiveArea> in a CPL is either not an even number, or bigger than the corresponding asset dimension.
403 * note contains details of what is wrong
404 * file contains the CPL filename
406 INVALID_MAIN_PICTURE_ACTIVE_AREA,
407 /** A PKL has more than one asset with the same ID
408 * note contains the PKL ID
409 * file contains the PKL filename
411 DUPLICATE_ASSET_ID_IN_PKL,
412 /** An ASSETMAP has more than one asset with the same ID
413 * note contains the ASSETMAP ID
414 * file contains the ASSETMAP filename
416 DUPLICATE_ASSET_ID_IN_ASSETMAP,
417 /** An Interop subtitle asset has no subtitles
418 * note contains the asset ID
419 * file contains the asset filename
422 /** A SMPTE subtitle asset as an <IssueDate> which is not of the form yyyy-mm-ddThh:mm:ss
423 * I can find no reference in a standard to this being required, but the Deluxe delivery
424 * specifications require it and their QC will fail DCPs that don't have it.
425 * note contains the incorrect <IssueDate>
427 INVALID_SUBTITLE_ISSUE_DATE,
428 /** The sound assets in the CPL do not have the same audio channel count.
429 * file contains the filename of the first asset to differ
431 MISMATCHED_SOUND_CHANNEL_COUNTS,
432 /** The CPL contains a MainSoundConfiguration tag which does not describe the number of
433 * channels in the audio assets.
434 * note contains details of what is wrong
435 * file contains the CPL filename
437 INVALID_MAIN_SOUND_CONFIGURATION,
438 /** An interop subtitle file has a <LoadFont> node which refers to a font file that is not found.
439 * note contains the <LoadFont> ID
442 /** A tile part in a JPEG2000 frame is too big.
443 * frame contains the frame index (counted from 0)
444 * component contains the component index (0, 1 or 2)
445 * size contains the invalid size in bytes.
447 INVALID_JPEG2000_TILE_PART_SIZE,
448 /** A subtitle XML root node has more than one namespace (xmlns) declaration.
449 * note contains the asset ID
451 INCORRECT_SUBTITLE_NAMESPACE_COUNT,
452 /** A subtitle or closed caption file has a <Font> tag which refers to a font that is not
453 * first introduced with a <LoadFont>.
454 * id contains the ID of the <Font> tag.
456 MISSING_LOAD_FONT_FOR_FONT,
457 /** A SMPTE subtitle asset has at least one <Text> element but no <LoadFont>
458 * id contains the ID of the subtitle asset.
461 /** An ID in an asset map does not match the ID obtained from reading the actual file.
462 * id contains the ID from the asset map.
463 * other_id contains the ID from the file.
465 MISMATCHED_ASSET_MAP_ID,
466 /** The <LabelText> inside a <ContentVersion> is empty
467 * note contains the CPL ID
468 * file contains the CPL filename
470 EMPTY_CONTENT_VERSION_LABEL_TEXT,
473 VerificationNote (Type type, Code code)
478 VerificationNote (Type type, Code code, std::string note)
482 _data[Data::NOTE] = note;
485 VerificationNote (Type type, Code code, boost::filesystem::path file)
489 _data[Data::FILE] = file;
492 VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file)
496 _data[Data::NOTE] = note;
497 _data[Data::FILE] = file;
500 VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file, uint64_t line)
504 _data[Data::NOTE] = note;
505 _data[Data::FILE] = file;
506 _data[Data::LINE] = line;
519 NOTE, ///< further information about the error
520 FILE, ///< path of file containing the error
521 LINE, ///< error line number within the FILE
530 boost::optional<T> data(Data key) const
532 auto iter = _data.find(key);
533 if (iter == _data.end()) {
536 return boost::any_cast<T>(iter->second);
540 boost::optional<std::string> note () const {
541 return data<std::string>(Data::NOTE);
544 boost::optional<boost::filesystem::path> file () const {
545 return data<boost::filesystem::path>(Data::FILE);
548 boost::optional<uint64_t> line () const {
549 return data<uint64_t>(Data::LINE);
552 VerificationNote& set_frame(int frame) {
553 _data[Data::FRAME] = frame;
557 boost::optional<int> frame() const {
558 return data<int>(Data::FRAME);
561 VerificationNote& set_component(int component) {
562 _data[Data::COMPONENT] = component;
566 boost::optional<int> component() const {
567 return data<int>(Data::COMPONENT);
570 VerificationNote& set_size(int size) {
571 _data[Data::SIZE] = size;
575 boost::optional<int> size() const {
576 return data<int>(Data::SIZE);
579 VerificationNote& set_id(std::string id) {
580 _data[Data::ID] = id;
584 boost::optional<std::string> id() const {
585 return data<std::string>(Data::ID);
588 VerificationNote& set_other_id(std::string other_id) {
589 _data[Data::OTHER_ID] = other_id;
593 boost::optional<std::string> other_id() const {
594 return data<std::string>(Data::OTHER_ID);
600 std::map<Data, boost::any> _data;
604 struct VerificationOptions
606 ///< If set, any assets larger than this number of bytes will not have their hashes checked
607 boost::optional<boost::uintmax_t> maximum_asset_size_for_hash_check;
608 ///< true to check asset hashes (except those which match maximum_asset_size_for_hash_check)
609 ///< false to check no asset hashes.
610 bool check_asset_hashes = true;
614 std::vector<VerificationNote> verify (
615 std::vector<boost::filesystem::path> directories,
616 std::vector<dcp::DecryptedKDM> kdms,
617 boost::function<void (std::string, boost::optional<boost::filesystem::path>)> stage,
618 boost::function<void (float)> progress,
619 VerificationOptions options = {},
620 boost::optional<boost::filesystem::path> xsd_dtd_directory = boost::optional<boost::filesystem::path>()
623 std::string note_to_string (dcp::VerificationNote note);
625 bool operator== (dcp::VerificationNote const& a, dcp::VerificationNote const& b);
626 bool operator< (dcp::VerificationNote const& a, dcp::VerificationNote const& b);
628 std::ostream& operator<<(std::ostream& s, dcp::VerificationNote const& note);