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 VAlign
  98 {
  99         TOP,
 100         CENTER,
 101         BOTTOM
 102 };
 103
 104 extern std::string valign_to_string (VAlign a);
 105 extern VAlign string_to_valign (std::string s);
 106
 107 enum Eye
 108 {
 109         EYE_LEFT,
 110         EYE_RIGHT
 111 };
 112
 113 /** @class Fraction
 114  *  @brief A fraction (i.e. a thing with an integer numerator and an integer denominator).
 115  */
 116 class Fraction
 117 {
 118 public:
 119         /** Construct a fraction of 0/0 */
 120         Fraction () : numerator (0), denominator (0) {}
 121         Fraction (std::string s);
 122         /** Construct a fraction with a specified numerator and denominator.
 123          *  @param n Numerator.
 124          *  @param d Denominator.
 125          */
 126         Fraction (int n, int d) : numerator (n), denominator (d) {}
 127
 128         float as_float () const {
 129                 return float (numerator) / denominator;
 130         }
 131
 132         int numerator;
 133         int denominator;
 134 };
 135
 136 extern bool operator== (Fraction const & a, Fraction const & b);
 137 extern bool operator!= (Fraction const & a, Fraction const & b);
 138
 139 /** @struct EqualityOptions
 140  *  @brief  A class to describe what "equality" means for a particular test.
 141  *
 142  *  When comparing things, we want to be able to ignore some differences;
 143  *  this class expresses those differences.
 144  */
 145 struct EqualityOptions
 146 {
 147         /** Construct an EqualityOptions where nothing at all can differ */
 148         EqualityOptions ()
 149                 : max_mean_pixel_error (0)
 150                 , max_std_dev_pixel_error (0)
 151                 , max_audio_sample_error (0)
 152                 , cpl_annotation_texts_can_differ (false)
 153                 , mxf_filenames_can_differ (false)
 154                 , reel_annotation_texts_can_differ (false)
 155                 , reel_hashes_can_differ (false)
 156         {}
 157
 158         /** The maximum allowable mean difference in pixel value between two images */
 159         double max_mean_pixel_error;
 160         /** The maximum standard deviation of the differences in pixel value between two images */
 161         double max_std_dev_pixel_error;
 162         /** The maximum difference in audio sample value between two soundtracks */
 163         int max_audio_sample_error;
 164         /** true if the <AnnotationText> nodes of CPLs are allowed to differ */
 165         bool cpl_annotation_texts_can_differ;
 166         /** true if MXF file leafnames are allowed to differ */
 167         bool mxf_filenames_can_differ;
 168         /** true if the <AnnotationText> nodes of Reels are allowed to differ */
 169         bool reel_annotation_texts_can_differ;
 170         /** true if <Hash>es in Reels can differ */
 171         bool reel_hashes_can_differ;
 172 };
 173
 174 /* I've been unable to make mingw happy with ERROR as a symbol, so
 175    I'm using a DCP_ prefix here.
 176 */
 177 enum NoteType {
 178         DCP_PROGRESS,
 179         DCP_ERROR,
 180         DCP_NOTE
 181 };
 182
 183 enum Standard {
 184         INTEROP,
 185         SMPTE
 186 };
 187
 188 enum Formulation {
 189         MODIFIED_TRANSITIONAL_1,
 190         DCI_ANY,
 191         DCI_SPECIFIC
 192 };
 193
 194 /** @class Colour
 195  *  @brief An RGB colour.
 196  */
 197 class Colour
 198 {
 199 public:
 200         Colour ();
 201         Colour (int r_, int g_, int b_);
 202         Colour (std::string argb_hex);
 203
 204         int r; ///< red component, from 0 to 255
 205         int g; ///< green component, from 0 to 255
 206         int b; ///< blue component, from 0 to 255
 207
 208         std::string to_argb_string () const;
 209 };
 210
 211 extern bool operator== (Colour const & a, Colour const & b);
 212 extern bool operator!= (Colour const & a, Colour const & b);
 213 extern std::ostream & operator<< (std::ostream & s, Colour const & c);
 214
 215 typedef boost::function<void (NoteType, std::string)> NoteHandler;
 216
 217 /** Maximum absolute difference between dcp::SubtitleString::aspect_adjust values that
 218  *  are considered equal.
 219  */
 220 #define ASPECT_ADJUST_EPSILON (1e-3)
 221
 222 }
 223
 224 #endif