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
58 /** An error when reading the DCP. note contains (probably technical) details. */
60 /** The hash of the CPL in the PKL does not agree with the CPL file */
62 /** Frame rate given in a reel for the main picture is not 24, 25, 30, 48, 50 or 60 */
63 INVALID_PICTURE_FRAME_RATE,
64 /** The hash of a main picture asset does not agree with the PKL file. file contains the picture asset filename. */
65 PICTURE_HASH_INCORRECT,
66 /** The hash of a main picture is different in the CPL and PKL */
67 PKL_CPL_PICTURE_HASHES_DIFFER,
68 /** The hash of a main sound asset does not agree with the PKL file. file contains the sound asset filename. */
70 /** The hash of a main sound is different in the CPL and PKL */
71 PKL_CPL_SOUND_HASHES_DIFFER,
72 /** An assetmap's <Path> entry is empty */
74 /** A file mentioned in an asset map cannot be found */
76 /** The DCP contains both SMPTE and Interop-standard components */
78 /** Some XML fails to validate against the XSD/DTD */
80 /** No ASSETMAP{.xml} was found */
82 /** An asset's IntrinsicDuration is less than 1 second */
83 INTRINSIC_DURATION_TOO_SMALL,
84 /** An asset's Duration is less than 1 second */
86 /** The JPEG2000 data in at least one picture frame is larger than the equivalent of 250Mbit/s */
87 PICTURE_FRAME_TOO_LARGE_IN_BYTES,
88 /** The JPEG2000 data in at least one picture frame is larger than the equivalent of 230Mbit/s */
89 PICTURE_FRAME_NEARLY_TOO_LARGE_IN_BYTES,
90 /** An asset that the CPL requires is not in this DCP; the DCP may be a VF */
92 /** DCP is Interop, not SMPTE [Bv2.1_6.1] */
94 /** A language or territory does not conform to RFC 5646 [Bv2.1_6.2.1] */
96 /** A picture asset does not have one of the required Bv2.1 sizes (in pixels) [Bv2.1_7.1] */
97 PICTURE_ASSET_INVALID_SIZE_IN_PIXELS,
98 /** A picture asset is 2K but is not at 24, 25 or 48 fps as required by Bv2.1 [Bv2.1_7.1] */
99 PICTURE_ASSET_INVALID_FRAME_RATE_FOR_2K,
100 /** A picture asset is 4K but is not at 24fps as required by Bv2.1 [Bv2.1_7.1] */
101 PICTURE_ASSET_INVALID_FRAME_RATE_FOR_4K,
102 /** A picture asset is 4K but is 3D which is not allowed by Bv2.1 [Bv2.1_7.1] */
104 /** A closed caption's XML file is larger than 256KB [Bv2.1_7.2.1] */
105 CLOSED_CAPTION_XML_TOO_LARGE_IN_BYTES,
106 /** Any timed text asset's total files is larger than 115MB [Bv2.1_7.2.1] */
107 TIMED_TEXT_ASSET_TOO_LARGE_IN_BYTES,
108 /** The total size of all a timed text asset's fonts is larger than 10MB [Bv2.1_7.2.1] */
109 TIMED_TEXT_FONTS_TOO_LARGE_IN_BYTES,
110 /** Some SMPTE subtitle XML has no <Language> tag [Bv2.1_7.2.2] */
111 MISSING_SUBTITLE_LANGUAGE,
112 /** Not all subtitle assets specify the same <Language> tag [Bv2.1_7.2.2] */
113 SUBTITLE_LANGUAGES_DIFFER,
114 /** Some SMPTE subtitle XML has no <StartTime> tag [Bv2.1_7.2.3] */
115 MISSING_SUBTITLE_START_TIME,
116 /** Some SMPTE subtitle XML has a non-zero <StartTime> tag [Bv2.1_7.2.3] */
117 SUBTITLE_START_TIME_NON_ZERO,
118 /** The first subtitle or closed caption happens before 4s into the first reel [Bv2.1_7.2.4] */
119 FIRST_TEXT_TOO_EARLY,
120 /** At least one subtitle is less than the minimum of 15 frames suggested by [Bv2.1_7.2.5] */
122 /** At least one pair of subtitles are separated by less than the the minimum of 2 frames suggested by [Bv2.1_7.2.5] */
124 /** There are more than 3 subtitle lines in at least one place [Bv2.1_7.2.7] */
125 TOO_MANY_SUBTITLE_LINES,
126 /** There are more than 52 characters in at least one subtitle line [Bv2.1_7.2.7] */
127 SUBTITLE_LINE_LONGER_THAN_RECOMMENDED,
128 /** There are more than 79 characters in at least one subtitle line [Bv2.1_7.2.7] */
129 SUBTITLE_LINE_TOO_LONG,
130 /** There are more than 3 closed caption lines in at least one place [Bv2.1_7.2.6] */
131 TOO_MANY_CLOSED_CAPTION_LINES,
132 /** There are more than 32 characters in at least one closed caption line [Bv2.1_7.2.6] */
133 CLOSED_CAPTION_LINE_TOO_LONG,
134 /** The audio sampling rate must be 48kHz [Bv2.1_7.3] */
135 INVALID_SOUND_FRAME_RATE,
136 /** The CPL has no <AnnotationText> tag [Bv2.1_8.1] */
137 MISSING_ANNOTATION_TEXT_IN_CPL,
140 VerificationNote (Type type, Code code)
145 VerificationNote (Type type, Code code, std::string note)
151 VerificationNote (Type type, Code code, boost::filesystem::path file)
157 VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file)
164 VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file, uint64_t line)
180 boost::optional<std::string> note () const {
184 boost::optional<boost::filesystem::path> file () const {
188 boost::optional<uint64_t> line () const {
195 /** Further information about the error, if applicable */
196 boost::optional<std::string> _note;
197 /** Path of file containing the error, if applicable */
198 boost::optional<boost::filesystem::path> _file;
199 /** Error line number within _file, if applicable */
203 std::vector<VerificationNote> verify (
204 std::vector<boost::filesystem::path> directories,
205 boost::function<void (std::string, boost::optional<boost::filesystem::path>)> stage,
206 boost::function<void (float)> progress,
207 boost::filesystem::path xsd_dtd_directory
210 std::string note_to_string (dcp::VerificationNote note);