src/types.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   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.
  10
  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.
  15
  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/>.
  18
  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
  23     including the two.
  24
  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.
  32 */
  33
  34 /** @file  src/types.h
  35  *  @brief Miscellaneous types.
  36  */
  37
  38 #ifndef LIBDCP_TYPES_H
  39 #define LIBDCP_TYPES_H
  40
  41 #include <boost/shared_ptr.hpp>
  42 #include <boost/function.hpp>
  43 #include <string>
  44
  45 namespace dcp
  46 {
  47
  48 /** @struct Size
  49  *  @brief The integer, two-dimensional size of something.
  50  */
  51 struct Size
  52 {
  53         Size ()
  54                 : width (0)
  55                 , height (0)
  56         {}
  57
  58         Size (int w, int h)
  59                 : width (w)
  60                 , height (h)
  61         {}
  62
  63         float ratio () const {
  64                 return float (width) / height;
  65         }
  66
  67         int width;
  68         int height;
  69 };
  70
  71 extern bool operator== (Size const & a, Size const & b);
  72 extern bool operator!= (Size const & a, Size const & b);
  73 extern std::ostream& operator<< (std::ostream& s, Size const & a);
  74
  75 /** Identifier for a sound channel */
  76 enum Channel {
  77         LEFT = 0,      ///< left
  78         RIGHT = 1,     ///< right
  79         CENTRE = 2,    ///< centre
  80         LFE = 3,       ///< low-frequency effects (sub)
  81         LS = 4,        ///< left surround
  82         RS = 5,        ///< right surround
  83         HI = 6,
  84         VI = 7,
  85         LC = 8,
  86         RC = 9,
  87         BSL = 10,
  88         BSR = 11
  89 };
  90
  91 enum ContentKind
  92 {
  93         FEATURE,
  94         SHORT,
  95         TRAILER,
  96         TEST,
  97         TRANSITIONAL,
  98         RATING,
  99         TEASER,
 100         POLICY,
 101         PUBLIC_SERVICE_ANNOUNCEMENT,
 102         ADVERTISEMENT
 103 };
 104
 105 enum Effect
 106 {
 107         NONE,
 108         BORDER,
 109         SHADOW
 110 };
 111
 112 extern std::string effect_to_string (Effect e);
 113 extern Effect string_to_effect (std::string s);
 114
 115 enum HAlign
 116 {
 117         HALIGN_LEFT,   ///< horizontal position is distance from left of screen to left of subtitle
 118         HALIGN_CENTER, ///< horizontal position is distance from centre of screen to centre of subtitle
 119         HALIGN_RIGHT,  ///< horizontal position is distance from right of screen to right of subtitle
 120 };
 121
 122 extern std::string halign_to_string (HAlign a);
 123 extern HAlign string_to_halign (std::string s);
 124
 125 enum VAlign
 126 {
 127         VALIGN_TOP,    ///< vertical position is distance from top of screen to top of subtitle
 128         VALIGN_CENTER, ///< vertical position is distance from centre of screen to centre of subtitle
 129         VALIGN_BOTTOM  ///< vertical position is distance from bottom of screen to bottom of subtitle
 130 };
 131
 132 extern std::string valign_to_string (VAlign a);
 133 extern VAlign string_to_valign (std::string s);
 134
 135 /** Direction for subtitle test */
 136 enum Direction
 137 {
 138         DIRECTION_LTR, ///< left-to-right
 139         DIRECTION_RTL, ///< right-to-left
 140         DIRECTION_TTB, ///< top-to-bottom
 141         DIRECTION_BTT  ///< bottom-to-top
 142 };
 143
 144 extern std::string direction_to_string (Direction a);
 145 extern Direction string_to_direction (std::string s);
 146
 147 enum Eye
 148 {
 149         EYE_LEFT,
 150         EYE_RIGHT
 151 };
 152
 153 /** @class Fraction
 154  *  @brief A fraction (i.e. a thing with an integer numerator and an integer denominator).
 155  */
 156 class Fraction
 157 {
 158 public:
 159         /** Construct a fraction of 0/0 */
 160         Fraction () : numerator (0), denominator (0) {}
 161         explicit Fraction (std::string s);
 162         /** Construct a fraction with a specified numerator and denominator.
 163          *  @param n Numerator.
 164          *  @param d Denominator.
 165          */
 166         Fraction (int n, int d) : numerator (n), denominator (d) {}
 167
 168         float as_float () const {
 169                 return float (numerator) / denominator;
 170         }
 171
 172         std::string as_string () const;
 173
 174         int numerator;
 175         int denominator;
 176 };
 177
 178 extern bool operator== (Fraction const & a, Fraction const & b);
 179 extern bool operator!= (Fraction const & a, Fraction const & b);
 180 extern std::ostream& operator<< (std::ostream& s, Fraction const & f);
 181
 182 /** @struct EqualityOptions
 183  *  @brief  A class to describe what "equality" means for a particular test.
 184  *
 185  *  When comparing things, we want to be able to ignore some differences;
 186  *  this class expresses those differences.
 187  */
 188 struct EqualityOptions
 189 {
 190         /** Construct an EqualityOptions where nothing at all can differ */
 191         EqualityOptions ()
 192                 : max_mean_pixel_error (0)
 193                 , max_std_dev_pixel_error (0)
 194                 , max_audio_sample_error (0)
 195                 , cpl_annotation_texts_can_differ (false)
 196                 , reel_annotation_texts_can_differ (false)
 197                 , reel_hashes_can_differ (false)
 198                 , issue_dates_can_differ (false)
 199                 , keep_going (false)
 200         {}
 201
 202         /** The maximum allowable mean difference in pixel value between two images */
 203         double max_mean_pixel_error;
 204         /** The maximum standard deviation of the differences in pixel value between two images */
 205         double max_std_dev_pixel_error;
 206         /** The maximum difference in audio sample value between two soundtracks */
 207         int max_audio_sample_error;
 208         /** true if the &lt;AnnotationText&gt; nodes of CPLs are allowed to differ */
 209         bool cpl_annotation_texts_can_differ;
 210         /** true if the &lt;AnnotationText&gt; nodes of Reels are allowed to differ */
 211         bool reel_annotation_texts_can_differ;
 212         /** true if <Hash>es in Reels can differ */
 213         bool reel_hashes_can_differ;
 214         /** true if IssueDate nodes can differ */
 215         bool issue_dates_can_differ;
 216         bool keep_going;
 217 };
 218
 219 /* I've been unable to make mingw happy with ERROR as a symbol, so
 220    I'm using a DCP_ prefix here.
 221 */
 222 enum NoteType {
 223         DCP_PROGRESS,
 224         DCP_ERROR,
 225         DCP_NOTE
 226 };
 227
 228 enum Standard {
 229         INTEROP,
 230         SMPTE
 231 };
 232
 233 enum Formulation {
 234         MODIFIED_TRANSITIONAL_1,
 235         MULTIPLE_MODIFIED_TRANSITIONAL_1,
 236         DCI_ANY,
 237         DCI_SPECIFIC,
 238         /** For testing: adds no AuthorizedDeviceInfo tag */
 239         MODIFIED_TRANSITIONAL_TEST
 240 };
 241
 242 /** @class Colour
 243  *  @brief An RGB colour.
 244  */
 245 class Colour
 246 {
 247 public:
 248         Colour ();
 249         Colour (int r_, int g_, int b_);
 250         explicit Colour (std::string argb_hex);
 251
 252         int r; ///< red component, from 0 to 255
 253         int g; ///< green component, from 0 to 255
 254         int b; ///< blue component, from 0 to 255
 255
 256         std::string to_rgb_string () const;
 257         std::string to_argb_string () const;
 258 };
 259
 260 extern bool operator== (Colour const & a, Colour const & b);
 261 extern bool operator!= (Colour const & a, Colour const & b);
 262 extern std::ostream & operator<< (std::ostream & s, Colour const & c);
 263
 264 typedef boost::function<void (NoteType, std::string)> NoteHandler;
 265
 266 /** Maximum absolute difference between dcp::SubtitleString::aspect_adjust values that
 267  *  are considered equal.
 268  */
 269 const float ASPECT_ADJUST_EPSILON = 1e-3;
 270
 271 /** Maximum absolute difference between dcp::SubtitleString alignment values that
 272  *  are considered equal.
 273  */
 274 const float ALIGN_EPSILON = 1e-3;
 275
 276 }
 277
 278 #endif