1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/*
Copyright (C) 2018-2020 Carl Hetherington <cth@carlh.net>
This file is part of libdcp.
libdcp is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
libdcp is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with libdcp. If not, see <http://www.gnu.org/licenses/>.
In addition, as a special exception, the copyright holders give
permission to link the code of portions of this program with the
OpenSSL library under certain conditions as described in each
individual source file, and distribute linked combinations
including the two.
You must obey the GNU General Public License in all respects
for all of the code used other than OpenSSL. If you modify
file(s) with this exception, you may extend this exception to your
version of the file(s), but you are not obligated to do so. If you
do not wish to do so, delete this exception statement from your
version. If you delete this exception statement from all source
files in the program, then also delete it here.
*/
#ifndef LIBDCP_VERIFY_H
#define LIBDCP_VERIFY_H
#include <boost/filesystem.hpp>
#include <boost/function.hpp>
#include <boost/optional.hpp>
#include <string>
#include <list>
#include <vector>
namespace dcp {
class VerificationNote
{
public:
/* I've been unable to make mingw happy with ERROR as a symbol, so
I'm using a VERIFY_ prefix here.
*/
enum Type {
VERIFY_ERROR,
VERIFY_WARNING
};
enum Code {
/** An error when reading the DCP. note contains (probably technical) details. */
GENERAL_READ,
/** The hash of the CPL in the PKL does not agree with the CPL file */
CPL_HASH_INCORRECT,
/** Frame rate given in a reel for the main picture is not 24, 25, 30, 48, 50 or 60 */
INVALID_PICTURE_FRAME_RATE,
/** The hash of a main picture asset does not agree with the PKL file. file contains the picture asset filename. */
PICTURE_HASH_INCORRECT,
/** The hash of a main picture is different in the CPL and PKL */
PKL_CPL_PICTURE_HASHES_DISAGREE,
/** The hash of a main sound asset does not agree with the PKL file. file contains the sound asset filename. */
SOUND_HASH_INCORRECT,
/** The hash of a main sound is different in the CPL and PKL */
PKL_CPL_SOUND_HASHES_DISAGREE,
/** An assetmap's <Path> entry is empty */
EMPTY_ASSET_PATH,
/** A file mentioned in an asset map cannot be found */
MISSING_ASSET,
/** The DCP contains both SMPTE and Interop-standard components */
MISMATCHED_STANDARD,
/** Some XML fails to validate against the XSD/DTD */
XML_VALIDATION_ERROR,
/** No ASSETMAP{.xml} was found */
MISSING_ASSETMAP,
/** An asset's IntrinsicDuration is less than 1 second */
INTRINSIC_DURATION_TOO_SMALL,
/** An asset's Duration is less than 1 second */
DURATION_TOO_SMALL,
/** The JPEG2000 data in at least one picture frame is larger than the equivalent of 250Mbit/s */
PICTURE_FRAME_TOO_LARGE,
/** The JPEG2000 data in at least one picture frame is larger than the equivalent of 230Mbit/s */
PICTURE_FRAME_NEARLY_TOO_LARGE,
/** An asset that the CPL requires is not in this DCP; the DCP may be a VF */
EXTERNAL_ASSET,
};
VerificationNote (Type type, Code code)
: _type (type)
, _code (code)
{}
VerificationNote (Type type, Code code, std::string note)
: _type (type)
, _code (code)
, _note (note)
{}
VerificationNote (Type type, Code code, boost::filesystem::path file)
: _type (type)
, _code (code)
, _file (file)
{}
VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file)
: _type (type)
, _code (code)
, _note (note)
, _file (file)
{}
VerificationNote (Type type, Code code, std::string note, boost::filesystem::path file, uint64_t line)
: _type (type)
, _code (code)
, _note (note)
, _file (file)
, _line (line)
{}
Type type () const {
return _type;
}
Code code () const {
return _code;
}
boost::optional<std::string> note () const {
return _note;
}
boost::optional<boost::filesystem::path> file () const {
return _file;
}
boost::optional<uint64_t> line () const {
return _line;
}
private:
Type _type;
Code _code;
/** Further information about the error, if applicable */
boost::optional<std::string> _note;
/** Path of file containing the error, if applicable */
boost::optional<boost::filesystem::path> _file;
/** Error line number within _file, if applicable */
uint64_t _line;
};
std::list<VerificationNote> verify (
std::vector<boost::filesystem::path> directories,
boost::function<void (std::string, boost::optional<boost::filesystem::path>)> stage,
boost::function<void (float)> progress,
boost::filesystem::path xsd_dtd_directory
);
std::string note_to_string (dcp::VerificationNote note);
}
#endif
|
