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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/*
Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
This program 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.
This program 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 this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
/** @file src/types.h
* @brief Miscellaneous types.
*/
#ifndef LIBDCP_TYPES_H
#define LIBDCP_TYPES_H
#include <boost/shared_ptr.hpp>
#include <boost/function.hpp>
#include <string>
namespace dcp
{
/** @struct Size
* @brief The integer, two-dimensional size of something.
*/
struct Size
{
Size ()
: width (0)
, height (0)
{}
Size (int w, int h)
: width (w)
, height (h)
{}
float ratio () const {
return float (width) / height;
}
int width;
int height;
};
/** Identifier for a sound channel */
enum Channel {
LEFT = 0, ///< left
RIGHT = 1, ///< right
CENTRE = 2, ///< centre
LFE = 3, ///< low-frequency effects (sub)
LS = 4, ///< left surround
RS = 5, ///< right surround
HI = 6,
VI = 7,
LC = 8,
RC = 9,
BSL = 10,
BSR = 11
};
enum ContentKind
{
FEATURE,
SHORT,
TRAILER,
TEST,
TRANSITIONAL,
RATING,
TEASER,
POLICY,
PUBLIC_SERVICE_ANNOUNCEMENT,
ADVERTISEMENT
};
enum Effect
{
NONE,
BORDER,
SHADOW
};
extern std::string effect_to_string (Effect e);
extern Effect string_to_effect (std::string s);
enum VAlign
{
TOP,
CENTER,
BOTTOM
};
extern std::string valign_to_string (VAlign a);
extern VAlign string_to_valign (std::string s);
enum Eye
{
EYE_LEFT,
EYE_RIGHT
};
/** @class Fraction
* @brief A fraction (i.e. a thing with an integer numerator and an integer denominator).
*/
class Fraction
{
public:
/** Construct a fraction of 0/0 */
Fraction () : numerator (0), denominator (0) {}
Fraction (std::string s);
/** Construct a fraction with a specified numerator and denominator.
* @param n Numerator.
* @param d Denominator.
*/
Fraction (int n, int d) : numerator (n), denominator (d) {}
float as_float () const {
return float (numerator) / denominator;
}
int numerator;
int denominator;
};
extern bool operator== (Fraction const & a, Fraction const & b);
extern bool operator!= (Fraction const & a, Fraction const & b);
/** @struct EqualityOptions
* @brief A class to describe what "equality" means for a particular test.
*
* When comparing things, we want to be able to ignore some differences;
* this class expresses those differences.
*/
struct EqualityOptions
{
/** Construct an EqualityOptions where nothing at all can differ */
EqualityOptions ()
: max_mean_pixel_error (0)
, max_std_dev_pixel_error (0)
, max_audio_sample_error (0)
, cpl_annotation_texts_can_differ (false)
, mxf_filenames_can_differ (false)
, reel_hashes_can_differ (false)
{}
/** The maximum allowable mean difference in pixel value between two images */
double max_mean_pixel_error;
/** The maximum standard deviation of the differences in pixel value between two images */
double max_std_dev_pixel_error;
/** The maximum difference in audio sample value between two soundtracks */
int max_audio_sample_error;
/** true if the <AnnotationText> nodes of CPLs are allowed to differ */
bool cpl_annotation_texts_can_differ;
/** true if MXF file leafnames are allowed to differ */
bool mxf_filenames_can_differ;
/** true if <Hash>es in Reels can differ */
bool reel_hashes_can_differ;
};
/* I've been unable to make mingw happy with ERROR as a symbol, so
I'm using a DCP_ prefix here.
*/
enum NoteType {
DCP_PROGRESS,
DCP_ERROR,
DCP_NOTE
};
enum Standard {
INTEROP,
SMPTE
};
enum Formulation {
MODIFIED_TRANSITIONAL_1,
DCI_ANY,
DCI_SPECIFIC
};
/** @class Colour
* @brief An RGB colour.
*/
class Colour
{
public:
Colour ();
Colour (int r_, int g_, int b_);
Colour (std::string argb_hex);
int r; ///< red component, from 0 to 255
int g; ///< green component, from 0 to 255
int b; ///< blue component, from 0 to 255
std::string to_argb_string () const;
};
extern bool operator== (Colour const & a, Colour const & b);
extern bool operator!= (Colour const & a, Colour const & b);
extern std::ostream & operator<< (std::ostream & s, Colour const & c);
typedef boost::function<void (NoteType, std::string)> NoteHandler;
}
#endif
|
