src/types.h

   1 /*
   2     Copyright (C) 2012-2014 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         CHANNEL_7 = 6, ///< channel 7; not sure what this should be called
  66         CHANNEL_8 = 7  ///< channel 8; not sure what this should be called
  67 };
  68
  69 enum ContentKind
  70 {
  71         FEATURE,
  72         SHORT,
  73         TRAILER,
  74         TEST,
  75         TRANSITIONAL,
  76         RATING,
  77         TEASER,
  78         POLICY,
  79         PUBLIC_SERVICE_ANNOUNCEMENT,
  80         ADVERTISEMENT
  81 };
  82
  83 enum Effect
  84 {
  85         NONE,
  86         BORDER,
  87         SHADOW
  88 };
  89
  90 extern std::string effect_to_string (Effect e);
  91 extern Effect string_to_effect (std::string s);
  92
  93 enum VAlign
  94 {
  95         TOP,
  96         CENTER,
  97         BOTTOM
  98 };
  99
 100 extern std::string valign_to_string (VAlign a);
 101 extern VAlign string_to_valign (std::string s);
 102
 103 enum Eye
 104 {
 105         EYE_LEFT,
 106         EYE_RIGHT
 107 };
 108
 109 /** @class Fraction
 110  *  @brief A fraction (i.e. a thing with an integer numerator and an integer denominator).
 111  */
 112 class Fraction
 113 {
 114 public:
 115         /** Construct a fraction of 0/0 */
 116         Fraction () : numerator (0), denominator (0) {}
 117         Fraction (std::string s);
 118         /** Construct a fraction with a specified numerator and denominator.
 119          *  @param n Numerator.
 120          *  @param d Denominator.
 121          */
 122         Fraction (int n, int d) : numerator (n), denominator (d) {}
 123
 124         float as_float () const {
 125                 return float (numerator) / denominator;
 126         }
 127
 128         int numerator;
 129         int denominator;
 130 };
 131
 132 extern bool operator== (Fraction const & a, Fraction const & b);
 133 extern bool operator!= (Fraction const & a, Fraction const & b);
 134
 135 /** @struct EqualityOptions
 136  *  @brief  A class to describe what "equality" means for a particular test.
 137  *
 138  *  When comparing things, we want to be able to ignore some differences;
 139  *  this class expresses those differences.
 140  */
 141 struct EqualityOptions
 142 {
 143         /** Construct an EqualityOptions where nothing at all can differ */
 144         EqualityOptions ()
 145                 : max_mean_pixel_error (0)
 146                 , max_std_dev_pixel_error (0)
 147                 , max_audio_sample_error (0)
 148                 , cpl_annotation_texts_can_differ (false)
 149                 , mxf_filenames_can_differ (false)
 150                 , reel_hashes_can_differ (false)
 151         {}
 152
 153         /** The maximum allowable mean difference in pixel value between two images */
 154         double max_mean_pixel_error;
 155         /** The maximum standard deviation of the differences in pixel value between two images */
 156         double max_std_dev_pixel_error;
 157         /** The maximum difference in audio sample value between two soundtracks */
 158         int max_audio_sample_error;
 159         /** true if the <AnnotationText> nodes of CPLs are allowed to differ */
 160         bool cpl_annotation_texts_can_differ;
 161         /** true if MXF file leafnames are allowed to differ */
 162         bool mxf_filenames_can_differ;
 163         /** true if <Hash>es in Reels can differ */
 164         bool reel_hashes_can_differ;
 165 };
 166
 167 /* I've been unable to make mingw happy with ERROR as a symbol, so
 168    I'm using a DCP_ prefix here.
 169 */
 170 enum NoteType {
 171         DCP_PROGRESS,
 172         DCP_ERROR,
 173         DCP_NOTE
 174 };
 175
 176 enum Standard {
 177         INTEROP,
 178         SMPTE
 179 };
 180
 181 enum Formulation {
 182         MODIFIED_TRANSITIONAL_1,
 183         DCI_ANY,
 184         DCI_SPECIFIC
 185 };
 186
 187 /** @class Colour
 188  *  @brief An RGB colour.
 189  */
 190 class Colour
 191 {
 192 public:
 193         Colour ();
 194         Colour (int r_, int g_, int b_);
 195         Colour (std::string argb_hex);
 196
 197         int r; ///< red component, from 0 to 255
 198         int g; ///< green component, from 0 to 255
 199         int b; ///< blue component, from 0 to 255
 200
 201         std::string to_argb_string () const;
 202 };
 203
 204 extern bool operator== (Colour const & a, Colour const & b);
 205 extern bool operator!= (Colour const & a, Colour const & b);
 206 extern std::ostream & operator<< (std::ostream & s, Colour const & c);
 207
 208 typedef boost::function<void (NoteType, std::string)> NoteHandler;
 209
 210
 211 }
 212
 213 #endif