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.
34 #ifndef LIBDCP_VERIFY_H
35 #define LIBDCP_VERIFY_H
37 #include <boost/filesystem.hpp>
38 #include <boost/function.hpp>
39 #include <boost/optional.hpp>
45 class VerificationNote
48 /* I've been unable to make mingw happy with ERROR as a symbol, so
49 I'm using a VERIFY_ prefix here.
53 VERIFY_BV21_ERROR, ///< may not always be considered an error, but violates a "shall" requirement of Bv2.1
57 /** Codes for errors or warnings from verifying DCPs.
59 * The names should (in general) answer the question "what is wrong?" with an answer that begins "There is a ..."
60 * e.g. "There is a INCORRECT_CPL_HASH"
61 * "There is a MISSING_ASSET"
63 * In general the pattern should be <negative-adjective> <noun>.
64 * Some <negative-adjective>s are:
66 * - INCORRECT: something, which could have any value, is wrong.
67 * - INVALID: something, which should only be one of a set of values, is not in the set, or some preformatted
68 * quantity (e.g. XML) is in the wrong format.
69 * - MISMATCHED: two things, which should be the same, are not.
70 * - EMPTY: something, which should have a value, has no value.
71 * - MISSING: something, which should be present, is not.
72 * - FAILED: some part of the verification failed in some serious way.
74 * Comments should clarify meaning and also say which of the optional fields (e.g. file)
75 * are filled in when this code is used.
78 /** An error when reading the DCP.
79 * note contains (probably technical) details.
82 /** The hash of the CPL in the PKL does not agree with the CPL file.
83 * note contains CPL ID.
84 * file contains CPL filename.
86 MISMATCHED_CPL_HASHES,
87 /** Frame rate given in a reel for the main picture is not 24, 25, 30, 48, 50 or 60.
88 * note contains the invalid frame rate as "<numerator>/<denominator>"
90 INVALID_PICTURE_FRAME_RATE,
91 /** The hash of a main picture asset does not agree with the PKL file.
92 * file contains the picture asset filename.
94 INCORRECT_PICTURE_HASH,
95 /** The hash of a main picture is different in the CPL and PKL.
96 * file contains the picture asset filename.
98 MISMATCHED_PICTURE_HASHES,
99 /** The hash of a main sound asset does not agree with the PKL file.
100 * file contains the sound asset filename.
102 INCORRECT_SOUND_HASH,
103 /** The hash of a main sound is different in the CPL and PKL.
104 * file contains the sound asset filename.
106 MISMATCHED_SOUND_HASHES,
107 /** An assetmap's <Path> entry is empty. */
109 /** A file mentioned in an asset map cannot be found.
110 * file contains the filename that is missing.
113 /** The DCP contains both SMPTE and Interop-standard components */
115 /** Some XML fails to validate against the XSD/DTD.
116 * note contains the (probably technical) details.
117 * file contains the invalid filename.
118 * line contains the line number.
121 /** No ASSETMAP{.xml} was found */
123 /** An asset's IntrinsicDuration is less than 1 second.
124 * note contains asset ID.
126 INVALID_INTRINSIC_DURATION,
127 /** An asset's Duration is less than 1 second.
128 * note contains asset ID.
131 /** The JPEG2000 data in at least one picture frame is larger than the equivalent of 250Mbit/s.
132 * file contains the picture asset filename.
134 INVALID_PICTURE_FRAME_SIZE_IN_BYTES,
135 /** The JPEG2000 data in at least one picture frame is larger than the equivalent of 230Mbit/s.
136 * file contains the picture asset filename.
138 NEARLY_INVALID_PICTURE_FRAME_SIZE_IN_BYTES,
139 /** An asset that the CPL requires is not in this DCP; the DCP may be a VF.
140 * note contains the asset ID.
143 /** DCP is Interop, not SMPTE [Bv2.1_6.1] */
145 /** A language or territory does not conform to RFC 5646 [Bv2.1_6.2.1].
146 * note contains the invalid language.
149 /** A picture asset does not have one of the required Bv2.1 sizes (in pixels) [Bv2.1_7.1].
150 * note contains the incorrect size as "<width>x<height>"
151 * file contains the asset filename.
153 INVALID_PICTURE_SIZE_IN_PIXELS,
154 /** A picture asset is 2K but is not at 24, 25 or 48 fps as required by Bv2.1 [Bv2.1_7.1].
155 * note contains the invalid frame rate as "<numerator>/<denominator>"
156 * file contains the asset filename.
158 INVALID_PICTURE_FRAME_RATE_FOR_2K,
159 /** A picture asset is 4K but is not at 24fps as required by Bv2.1 [Bv2.1_7.1]
160 * note contains the invalid frame rate as "<numerator>/<denominator>"
161 * file contains the asset filename.
163 INVALID_PICTURE_FRAME_RATE_FOR_4K,
164 /** A picture asset is 4K but is 3D which is not allowed by Bv2.1 [Bv2.1_7.1]
165 * note contains the invalid frame rate as "<numerator>/<denominator>"
166 * file contains the asset filename.
168 INVALID_PICTURE_ASSET_RESOLUTION_FOR_3D,
169 /** A closed caption's XML file is larger than 256KB [Bv2.1_7.2.1].
170 * note contains the invalid size in bytes.
171 * file contains the asset filename.
173 INVALID_CLOSED_CAPTION_XML_SIZE_IN_BYTES,
174 /** Any timed text asset's total files is larger than 115MB [Bv2.1_7.2.1]
175 * note contains the invalid size in bytes.
176 * file contains the asset filename.
178 INVALID_TIMED_TEXT_SIZE_IN_BYTES,
179 /** The total size of all a timed text asset's fonts is larger than 10MB [Bv2.1_7.2.1]
180 * note contains the invalid size in bytes.
181 * file contains the asset filename.
183 INVALID_TIMED_TEXT_FONT_SIZE_IN_BYTES,
184 /** Some SMPTE subtitle XML has no <Language> tag [Bv2.1_7.2.2]
185 * file contains the asset filename.
187 MISSING_SUBTITLE_LANGUAGE,
188 /** Not all subtitle assets specify the same <Language> tag [Bv2.1_7.2.2] */
189 MISMATCHED_SUBTITLE_LANGUAGES,
190 /** Some SMPTE subtitle XML has no <StartTime> tag [Bv2.1_7.2.3]
191 * file contains the asset filename.
193 MISSING_SUBTITLE_START_TIME,
194 /** Some SMPTE subtitle XML has a non-zero <StartTime> tag [Bv2.1_7.2.3]
195 * file contains the asset filename.
197 INVALID_SUBTITLE_START_TIME,
198 /** The first subtitle or closed caption happens before 4s into the first reel [Bv2.1_7.2.4] */
199 INVALID_SUBTITLE_FIRST_TEXT_TIME,
200 /** At least one subtitle is less than the minimum of 15 frames suggested by [Bv2.1_7.2.5] */
201 INVALID_SUBTITLE_DURATION,
202 /** At least one pair of subtitles are separated by less than the the minimum of 2 frames suggested by [Bv2.1_7.2.5] */
203 INVALID_SUBTITLE_SPACING,
204 /** There are more than 3 subtitle lines in at least one place [Bv2.1_7.2.7] */
205 INVALID_SUBTITLE_LINE_COUNT,
206 /** There are more than 52 characters in at least one subtitle line [Bv2.1_7.2.7] */
207 NEARLY_INVALID_SUBTITLE_LINE_LENGTH,
208 /** There are more than 79 characters in at least one subtitle line [Bv2.1_7.2.7] */
209 INVALID_SUBTITLE_LINE_LENGTH,
210 /** There are more than 3 closed caption lines in at least one place [Bv2.1_7.2.6] */
211 INVALID_CLOSED_CAPTION_LINE_COUNT,
212 /** There are more than 32 characters in at least one closed caption line [Bv2.1_7.2.6] */
213 INVALID_CLOSED_CAPTION_LINE_LENGTH,
214 /** The audio sampling rate must be 48kHz [Bv2.1_7.3].
215 * note contains the invalid frame rate.
216 * file contains the asset filename.
218 INVALID_SOUND_FRAME_RATE,
219 /** The CPL has no <AnnotationText> tag [Bv2.1_8.1]
220 * note contains the CPL ID.
221 * file contains the CPL filename.
223 MISSING_CPL_ANNOTATION_TEXT,
224 /** The <AnnotationText> is not the same as the <ContentTitleText> [Bv2.1_8.1]
225 * note contains the CPL ID.
226 * file contains the CPL filename.
228 MISMATCHED_CPL_ANNOTATION_TEXT,
229 /** At least one asset in a reel does not have the same duration as the others */
230 MISMATCHED_ASSET_DURATION,
231 /** If one reel has a MainSubtitle, all must have them */
232 MISSING_MAIN_SUBTITLE_FROM_SOME_REELS,
233 /** If one reel has at least one ClosedCaption, all reels must have the same number of ClosedCaptions */
234 MISMATCHED_CLOSED_CAPTION_ASSET_COUNTS,
235 /** MainSubtitle in reels must have <EntryPoint> Bv2.1_8.3.2
236 * note contains the asset ID
238 MISSING_SUBTITLE_ENTRY_POINT,
239 /** MainSubtitle <EntryPoint> must be zero Bv2.1_8.3.2
240 * note contains the asset ID
242 INCORRECT_SUBTITLE_ENTRY_POINT,
243 /** Closed caption in reels must have <EntryPoint> Bv2.1_8.3.2
244 * note contains the asset ID
246 MISSING_CLOSED_CAPTION_ENTRY_POINT,
247 /** Closed caption MainSubtitle <EntryPoint> must be zero Bv2.1_8.3.2
248 * note contains the asset ID
250 INCORRECT_CLOSED_CAPTION_ENTRY_POINT,
251 /** <Hash> must be present for assets in CPLs.
252 * note contains the asset ID
255 /** If ContentKind is Feature there must be a FFEC marker */
256 MISSING_FFEC_IN_FEATURE,
257 /** If ContentKind is Feature there must be a FFMC marker */
258 MISSING_FFMC_IN_FEATURE,
259 /** There should be a FFOC */
261 /** There should be a LFOC */
263 /** The FFOC should be 1.
264 * note contains the incorrect value.
267 /** The LFOC should be the last frame in the reel
268 * note contains the incorrect value.
271 /** There must be a <CompositionMetadataAsset>
272 * note contains the CPL ID.
273 * file contains the CPL filename.
275 MISSING_CPL_METADATA,
276 /** CPL metadata should contain <VersionNumber> of 1, at least
277 * note contains the CPL ID.
278 * file contains the CPL filename.
280 MISSING_CPL_METADATA_VERSION_NUMBER,
281 /** There must be an <ExtensionMetadata> in <CompositionMetadataAsset> Bv2.1_8.6.3
282 * note contains the CPL ID.
283 * file contains the CPL filename.
285 MISSING_EXTENSION_METADATA,
286 /** <ExtensionMetadata> must have a particular form Bv2.1_8.6.3
287 * note contains details of what's wrong
288 * file contains the CPL filename.
290 INVALID_EXTENSION_METADATA,
291 /** CPLs containing encrypted content must be signed Bv2.1_8.7
292 * note contains the CPL ID.
293 * file contains the CPL filename.
295 UNSIGNED_CPL_WITH_ENCRYPTED_CONTENT,
296 /** PKLs containing encrypted content must be signed Bv2.1_8.7
297 * note contains the PKL ID.
298 * file contains the PKL filename.
300 UNSIGNED_PKL_WITH_ENCRYPTED_CONTENT,
301 /** If a PKL has one CPL its <ContentTitleText> must be the same as the PKL's <AnnotationText>.
302 * note contains the PKL ID.
303 * file contains the PKL filename.
305 MISMATCHED_PKL_ANNOTATION_TEXT_WITH_CPL,
306 /** If any content is encrypted, everything must be encrypted */
310 VerificationNote (Type type, Code code)
315 VerificationNote (Type type, Code code, std::string note)
321 VerificationNote (Type type, Code code, boost::filesystem::path file)
327 VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file)
334 VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file, uint64_t line)
350 boost::optional<std::string> note () const {
354 boost::optional<boost::filesystem::path> file () const {
358 boost::optional<uint64_t> line () const {
365 /** Further information about the error, if applicable */
366 boost::optional<std::string> _note;
367 /** Path of file containing the error, if applicable */
368 boost::optional<boost::filesystem::path> _file;
369 /** Error line number within _file, if applicable */
370 boost::optional<uint64_t> _line;
373 std::vector<VerificationNote> verify (
374 std::vector<boost::filesystem::path> directories,
375 boost::function<void (std::string, boost::optional<boost::filesystem::path>)> stage,
376 boost::function<void (float)> progress,
377 boost::filesystem::path xsd_dtd_directory
380 std::string note_to_string (dcp::VerificationNote note);
382 bool operator== (dcp::VerificationNote const& a, dcp::VerificationNote const& b);
384 std::ostream& operator<<(std::ostream& s, dcp::VerificationNote const& note);