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 /* windows.h defines this but we want to use it */
68 * @brief The integer, two-dimensional size of something.
79 float ratio () const {
80 return float (width) / height;
88 extern bool operator== (Size const & a, Size const & b);
89 extern bool operator!= (Size const & a, Size const & b);
92 /** Identifier for a sound channel */
96 CENTRE = 2, ///< centre
97 LFE = 3, ///< low-frequency effects (sub)
98 LS = 4, ///< left surround
99 RS = 5, ///< right surround
102 /* 8 and 9 are not used */
113 std::vector<dcp::Channel> used_audio_channels ();
116 enum class MCASoundField
124 extern std::string channel_to_mca_id (Channel c, MCASoundField field);
125 extern Channel mca_id_to_channel (std::string);
126 extern std::string channel_to_mca_name (Channel c, MCASoundField field);
127 extern ASDCP::UL channel_to_mca_universal_label (Channel c, MCASoundField field, ASDCP::Dictionary const* dict);
138 extern std::string effect_to_string (Effect e);
139 extern Effect string_to_effect (std::string s);
142 /** Direction for subtitle test */
145 LTR, ///< left-to-right
146 RTL, ///< right-to-left
147 TTB, ///< top-to-bottom
148 BTT ///< bottom-to-top
152 extern std::string direction_to_string (Direction a);
153 extern Direction string_to_direction (std::string s);
164 * @brief A fraction (i.e. a thing with an integer numerator and an integer denominator).
169 /** Construct a fraction of 0/0 */
170 Fraction() = default;
172 explicit Fraction (std::string s);
173 /** Construct a fraction with a specified numerator and denominator.
174 * @param n Numerator.
175 * @param d Denominator.
177 Fraction (int n, int d) : numerator (n), denominator (d) {}
179 float as_float () const {
180 return float (numerator) / denominator;
183 std::string as_string () const;
190 extern bool operator== (Fraction const & a, Fraction const & b);
191 extern bool operator!= (Fraction const & a, Fraction const & b);
194 enum class NoteType {
201 enum class Standard {
207 enum class Formulation {
208 MODIFIED_TRANSITIONAL_1,
209 MULTIPLE_MODIFIED_TRANSITIONAL_1,
215 std::string formulation_to_string (dcp::Formulation formulation);
216 dcp::Formulation string_to_formulation (std::string forumulation);
220 * @brief An RGB colour
225 /** Construct a Colour, initialising it to black */
228 /** Construct a Colour from R, G and B. The values run between
231 Colour (int r_, int g_, int b_);
233 /** Construct a Colour from an ARGB hex string; the alpha value is ignored.
234 * @param argb_hex A string of the form AARRGGBB, where e.g. RR is a two-character
237 explicit Colour (std::string argb_hex);
239 int r = 0; ///< red component, from 0 to 255
240 int g = 0; ///< green component, from 0 to 255
241 int b = 0; ///< blue component, from 0 to 255
243 /** @return An RGB string of the form RRGGBB, where e.g. RR is a two-character
246 std::string to_rgb_string () const;
248 /** @return An ARGB string of the form AARRGGBB, where e.g. RR is a two-character
249 * hex value. The alpha value will always be FF (ie 255; maximum alpha).
251 std::string to_argb_string () const;
255 extern bool operator== (Colour const & a, Colour const & b);
256 extern bool operator!= (Colour const & a, Colour const & b);
259 typedef boost::function<void (NoteType, std::string)> NoteHandler;
262 /** Maximum absolute difference between dcp::SubtitleString::aspect_adjust values that
263 * are considered equal
265 constexpr float ASPECT_ADJUST_EPSILON = 1e-3;
268 /** Maximum absolute difference between dcp::SubtitleString alignment values that
269 * are considered equal.
271 constexpr float ALIGN_EPSILON = 1e-3;
274 /** Maximum absolute difference between dcp::SubtitleString space_before values that
275 * are considered equal.
277 constexpr float SPACE_BEFORE_EPSILON = 1e-3;
280 constexpr float SIZE_EPSILON = 1e-3;
281 constexpr float OFFSET_EPSILON = 1e-3;
282 constexpr float SPACING_EPSILON = 1e-3;
286 FFOC, ///< first frame of composition
287 LFOC, ///< last frame of composition
288 FFTC, ///< first frame of title credits
289 LFTC, ///< last frame of title credits
290 FFOI, ///< first frame of intermission
291 LFOI, ///< last frame of intermission
292 FFEC, ///< first frame of end credits
293 LFEC, ///< last frame of end credits
294 FFMC, ///< first frame of moving credits
295 LFMC ///< last frame of moving credits
299 std::string marker_to_string (Marker);
300 Marker marker_from_string (std::string);
305 FINAL, ///< final version
306 TEMP, ///< temporary version (picture/sound unfinished)
307 PRE ///< pre-release (picture/sound finished)
311 extern std::string status_to_string (Status s);
312 extern Status string_to_status (std::string s);
320 explicit ContentVersion (cxml::ConstNodePtr node);
322 explicit ContentVersion (std::string label_text_);
324 ContentVersion (std::string id_, std::string label_text_)
326 , label_text (label_text_)
329 void as_xml (xmlpp::Element* parent) const;
332 std::string label_text;
340 CANDELA_PER_SQUARE_METRE,
344 Luminance (cxml::ConstNodePtr node);
346 Luminance (float value, Unit unit);
348 void set_value (float v);
349 void set_unit (Unit u) {
353 float value () const {
361 float value_in_foot_lamberts () const;
363 void as_xml (xmlpp::Element* parent, std::string ns) const;
365 static std::string unit_to_string (Unit u);
366 static Unit string_to_unit (std::string u);
374 bool operator== (Luminance const& a, Luminance const& b);
377 class MainSoundConfiguration
380 explicit MainSoundConfiguration(std::string);
381 MainSoundConfiguration (MCASoundField field_, int channels);
383 MCASoundField field () const {
387 int channels () const {
388 return _channels.size();
391 boost::optional<Channel> mapping (int index) const;
392 void set_mapping (int index, Channel channel);
394 std::string to_string () const;
397 MCASoundField _field;
398 std::vector<boost::optional<Channel>> _channels;