2 Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * @brief Miscellaneous types.
24 #ifndef LIBDCP_TYPES_H
25 #define LIBDCP_TYPES_H
27 #include <boost/shared_ptr.hpp>
37 /** Identifier for a sound channel */
41 CENTRE = 2, ///< centre
42 LFE = 3, ///< low-frequency effects (sub)
43 LS = 4, ///< left surround
44 RS = 5, ///< right surround
45 CHANNEL_7 = 6, ///< channel 7; not sure what this should be called
46 CHANNEL_8 = 7 ///< channel 8; not sure what this should be called
59 PUBLIC_SERVICE_ANNOUNCEMENT,
70 extern std::string effect_to_string (Effect e);
71 extern Effect string_to_effect (std::string s);
80 extern std::string valign_to_string (VAlign a);
81 extern VAlign string_to_valign (std::string s);
90 * @brief A fraction (i.e. a thing with an integer numerator and an integer denominator).
95 /** Construct a fraction of 0/0 */
96 Fraction () : numerator (0), denominator (0) {}
97 Fraction (std::string s);
98 /** Construct a fraction with a specified numerator and denominator.
100 * @param d Denominator.
102 Fraction (int n, int d) : numerator (n), denominator (d) {}
104 float as_float () const {
105 return float (numerator) / denominator;
112 extern bool operator== (Fraction const & a, Fraction const & b);
113 extern bool operator!= (Fraction const & a, Fraction const & b);
115 /** @struct EqualityOptions
116 * @brief A class to describe what "equality" means for a particular test.
118 * When comparing things, we want to be able to ignore some differences;
119 * this class expresses those differences.
121 struct EqualityOptions
123 /** Construct an EqualityOptions where nothing at all can differ */
125 : max_mean_pixel_error (0)
126 , max_std_dev_pixel_error (0)
127 , max_audio_sample_error (0)
128 , cpl_annotation_texts_can_differ (false)
129 , mxf_names_can_differ (false)
130 , reel_hashes_can_differ (false)
133 /** The maximum allowable mean difference in pixel value between two images */
134 double max_mean_pixel_error;
135 /** The maximum standard deviation of the differences in pixel value between two images */
136 double max_std_dev_pixel_error;
137 /** The maximum difference in audio sample value between two soundtracks */
138 int max_audio_sample_error;
139 /** true if the <AnnotationText> nodes of CPLs are allowed to differ */
140 bool cpl_annotation_texts_can_differ;
141 /** true if MXF filenames are allowed to differ */
142 bool mxf_names_can_differ;
143 /** true if <Hash>es in Reels can differ */
144 bool reel_hashes_can_differ;
147 /* I've been unable to make mingw happy with ERROR as a symbol, so
148 I'm using a DCP_ prefix here.
162 MODIFIED_TRANSITIONAL_1,
168 * @brief An RGB color (aka colour).
174 Color (int r_, int g_, int b_);
175 Color (std::string argb_hex);
177 int r; ///< red component, from 0 to 255
178 int g; ///< green component, from 0 to 255
179 int b; ///< blue component, from 0 to 255
181 std::string to_argb_string () const;
184 extern bool operator== (Color const & a, Color const & b);
185 extern bool operator!= (Color const & a, Color const & b);
186 extern std::ostream & operator<< (std::ostream & s, Color const & c);
188 typedef std::pair<std::string, boost::shared_ptr<const parse::AssetMap> > PathAssetMap;