2 Copyright (C) 2012-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.
36 * @brief Miscellaneous types
40 #ifndef LIBDCP_TYPES_H
41 #define LIBDCP_TYPES_H
45 #include <libcxml/cxml.h>
46 LIBDCP_DISABLE_WARNINGS
47 #include <asdcp/KLV.h>
48 LIBDCP_ENABLE_WARNINGS
50 #include <boost/function.hpp>
54 /* MinGW seems to define this, but we want to use it */
68 * @brief The integer, two-dimensional size of something.
82 float ratio () const {
83 return float (width) / height;
91 extern bool operator== (Size const & a, Size const & b);
92 extern bool operator!= (Size const & a, Size const & b);
95 /** Identifier for a sound channel */
99 CENTRE = 2, ///< centre
100 LFE = 3, ///< low-frequency effects (sub)
101 LS = 4, ///< left surround
102 RS = 5, ///< right surround
105 /* 8 and 9 are not used */
116 std::vector<dcp::Channel> used_audio_channels ();
119 enum class MCASoundField
126 extern std::string channel_to_mca_id (Channel c, MCASoundField field);
127 extern Channel mca_id_to_channel (std::string);
128 extern std::string channel_to_mca_name (Channel c, MCASoundField field);
129 extern ASDCP::UL channel_to_mca_universal_label (Channel c, MCASoundField field, ASDCP::Dictionary const* dict);
132 enum class ContentKind
142 PUBLIC_SERVICE_ANNOUNCEMENT,
149 extern std::string content_kind_to_string (ContentKind kind);
150 extern ContentKind content_kind_from_string (std::string kind);
161 extern std::string effect_to_string (Effect e);
162 extern Effect string_to_effect (std::string s);
167 LEFT, ///< horizontal position is distance from left of screen to left of subtitle
168 CENTER, ///< horizontal position is distance from centre of screen to centre of subtitle
169 RIGHT, ///< horizontal position is distance from right of screen to right of subtitle
173 extern std::string halign_to_string (HAlign a);
174 extern HAlign string_to_halign (std::string s);
179 TOP, ///< vertical position is distance from top of screen to top of subtitle
180 CENTER, ///< vertical position is distance from centre of screen to centre of subtitle
181 BOTTOM ///< vertical position is distance from bottom of screen to bottom of subtitle
185 extern std::string valign_to_string (VAlign a);
186 extern VAlign string_to_valign (std::string s);
189 /** Direction for subtitle test */
192 LTR, ///< left-to-right
193 RTL, ///< right-to-left
194 TTB, ///< top-to-bottom
195 BTT ///< bottom-to-top
199 extern std::string direction_to_string (Direction a);
200 extern Direction string_to_direction (std::string s);
211 * @brief A fraction (i.e. a thing with an integer numerator and an integer denominator).
216 /** Construct a fraction of 0/0 */
218 explicit Fraction (std::string s);
219 /** Construct a fraction with a specified numerator and denominator.
220 * @param n Numerator.
221 * @param d Denominator.
223 Fraction (int n, int d) : numerator (n), denominator (d) {}
225 float as_float () const {
226 return float (numerator) / denominator;
229 std::string as_string () const;
236 extern bool operator== (Fraction const & a, Fraction const & b);
237 extern bool operator!= (Fraction const & a, Fraction const & b);
240 /** @struct EqualityOptions
241 * @brief A class to describe what "equality" means for a particular test.
243 * When comparing things, we want to be able to ignore some differences;
244 * this class expresses those differences.
246 * It also contains some settings for how the comparison should be done.
248 struct EqualityOptions
250 /** Construct an EqualityOptions where nothing at all can differ */
251 EqualityOptions () {}
253 /** The maximum allowable mean difference in pixel value between two images */
254 double max_mean_pixel_error = 0;
255 /** The maximum standard deviation of the differences in pixel value between two images */
256 double max_std_dev_pixel_error = 0;
257 /** The maximum difference in audio sample value between two soundtracks */
258 int max_audio_sample_error = 0;
259 /** true if the <AnnotationText> nodes of CPLs are allowed to differ */
260 bool cpl_annotation_texts_can_differ = false;
261 /** true if the <AnnotationText> nodes of Reels are allowed to differ */
262 bool reel_annotation_texts_can_differ = false;
263 /** true if <Hash>es in Reels can differ */
264 bool reel_hashes_can_differ = false;
265 /** true if IssueDate nodes can differ */
266 bool issue_dates_can_differ = false;
267 bool load_font_nodes_can_differ = false;
268 bool keep_going = false;
269 /** true to save the first pair of differeng image subtitles to the current working directory */
270 bool export_differing_subtitles = false;
274 enum class NoteType {
281 enum class Standard {
287 enum class Formulation {
288 MODIFIED_TRANSITIONAL_1,
289 MULTIPLE_MODIFIED_TRANSITIONAL_1,
296 * @brief An RGB colour
301 /** Construct a Colour, initialising it to black */
304 /** Construct a Colour from R, G and B. The values run between
307 Colour (int r_, int g_, int b_);
309 /** Construct a Colour from an ARGB hex string; the alpha value is ignored.
310 * @param argb_hex A string of the form AARRGGBB, where e.g. RR is a two-character
313 explicit Colour (std::string argb_hex);
315 int r = 0; ///< red component, from 0 to 255
316 int g = 0; ///< green component, from 0 to 255
317 int b = 0; ///< blue component, from 0 to 255
319 /** @return An RGB string of the form RRGGBB, where e.g. RR is a two-character
322 std::string to_rgb_string () const;
324 /** @return An ARGB string of the form AARRGGBB, where e.g. RR is a two-character
325 * hex value. The alpha value will always be FF (ie 255; maximum alpha).
327 std::string to_argb_string () const;
331 extern bool operator== (Colour const & a, Colour const & b);
332 extern bool operator!= (Colour const & a, Colour const & b);
335 typedef boost::function<void (NoteType, std::string)> NoteHandler;
338 /** Maximum absolute difference between dcp::SubtitleString::aspect_adjust values that
339 * are considered equal
341 constexpr float ASPECT_ADJUST_EPSILON = 1e-3;
344 /** Maximum absolute difference between dcp::SubtitleString alignment values that
345 * are considered equal.
347 constexpr float ALIGN_EPSILON = 1e-3;
350 /** Maximum absolute difference between dcp::SubtitleString space_before values that
351 * are considered equal.
353 constexpr float SPACE_BEFORE_EPSILON = 1e-3;
357 FFOC, ///< first frame of composition
358 LFOC, ///< last frame of composition
359 FFTC, ///< first frame of title credits
360 LFTC, ///< last frame of title credits
361 FFOI, ///< first frame of intermission
362 LFOI, ///< last frame of intermission
363 FFEC, ///< first frame of end credits
364 LFEC, ///< last frame of end credits
365 FFMC, ///< first frame of moving credits
366 LFMC ///< last frame of moving credits
370 std::string marker_to_string (Marker);
371 Marker marker_from_string (std::string);
376 FINAL, ///< final version
377 TEMP, ///< temporary version (picture/sound unfinished)
378 PRE ///< pre-release (picture/sound finished)
382 extern std::string status_to_string (Status s);
383 extern Status string_to_status (std::string s);
391 explicit ContentVersion (cxml::ConstNodePtr node);
393 explicit ContentVersion (std::string label_text_);
395 ContentVersion (std::string id_, std::string label_text_)
397 , label_text (label_text_)
400 void as_xml (xmlpp::Element* parent) const;
403 std::string label_text;
411 CANDELA_PER_SQUARE_METRE,
415 Luminance (cxml::ConstNodePtr node);
417 Luminance (float value, Unit unit);
419 void set_value (float v);
420 void set_unit (Unit u) {
424 float value () const {
432 float value_in_foot_lamberts () const;
434 void as_xml (xmlpp::Element* parent, std::string ns) const;
436 static std::string unit_to_string (Unit u);
437 static Unit string_to_unit (std::string u);
445 bool operator== (Luminance const& a, Luminance const& b);
448 class MainSoundConfiguration
451 MainSoundConfiguration (std::string);
452 MainSoundConfiguration (MCASoundField field_, int channels);
454 MCASoundField field () const {
458 int channels () const {
459 return _channels.size();
462 boost::optional<Channel> mapping (int index) const;
463 void set_mapping (int index, Channel channel);
465 std::string to_string () const;
468 MCASoundField _field;
469 std::vector<boost::optional<Channel>> _channels;