src/types.h

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