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 <string>
  29
  30 namespace dcp
  31 {
  32
  33 namespace parse {
  34         class AssetMap;
  35 }
  36
  37 /** Identifier for a sound channel */
  38 enum Channel {
  39         LEFT = 0,      ///< left
  40         RIGHT = 1,     ///< right
  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
  47 };
  48
  49 enum ContentKind
  50 {
  51         FEATURE,
  52         SHORT,
  53         TRAILER,
  54         TEST,
  55         TRANSITIONAL,
  56         RATING,
  57         TEASER,
  58         POLICY,
  59         PUBLIC_SERVICE_ANNOUNCEMENT,
  60         ADVERTISEMENT
  61 };
  62
  63 enum Effect
  64 {
  65         NONE,
  66         BORDER,
  67         SHADOW
  68 };
  69
  70 extern std::string effect_to_string (Effect e);
  71 extern Effect string_to_effect (std::string s);
  72
  73 enum VAlign
  74 {
  75         TOP,
  76         CENTER,
  77         BOTTOM
  78 };
  79
  80 extern std::string valign_to_string (VAlign a);
  81 extern VAlign string_to_valign (std::string s);
  82
  83 enum Eye
  84 {
  85         EYE_LEFT,
  86         EYE_RIGHT
  87 };
  88
  89 /** @class Fraction
  90  *  @brief A fraction (i.e. a thing with an integer numerator and an integer denominator).
  91  */
  92 class Fraction
  93 {
  94 public:
  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.
  99          *  @param n Numerator.
 100          *  @param d Denominator.
 101          */
 102         Fraction (int n, int d) : numerator (n), denominator (d) {}
 103
 104         float as_float () const {
 105                 return float (numerator) / denominator;
 106         }
 107
 108         int numerator;
 109         int denominator;
 110 };
 111
 112 extern bool operator== (Fraction const & a, Fraction const & b);
 113 extern bool operator!= (Fraction const & a, Fraction const & b);
 114
 115 /** @struct EqualityOptions
 116  *  @brief  A class to describe what "equality" means for a particular test.
 117  *
 118  *  When comparing things, we want to be able to ignore some differences;
 119  *  this class expresses those differences.
 120  */
 121 struct EqualityOptions
 122 {
 123         /** Construct an EqualityOptions where nothing at all can differ */
 124         EqualityOptions ()
 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)
 131         {}
 132
 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;
 145 };
 146
 147 /* I've been unable to make mingw happy with ERROR as a symbol, so
 148    I'm using a DCP_ prefix here.
 149 */
 150 enum NoteType {
 151         DCP_PROGRESS,
 152         DCP_ERROR,
 153         DCP_NOTE
 154 };
 155
 156 enum Standard {
 157         INTEROP,
 158         SMPTE
 159 };
 160
 161 enum Formulation {
 162         MODIFIED_TRANSITIONAL_1,
 163         DCI_ANY,
 164         DCI_SPECIFIC
 165 };
 166
 167 /** @class Colour
 168  *  @brief An RGB colour.
 169  */
 170 class Colour
 171 {
 172 public:
 173         Colour ();
 174         Colour (int r_, int g_, int b_);
 175         Colour (std::string argb_hex);
 176
 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
 180
 181         std::string to_argb_string () const;
 182 };
 183
 184 extern bool operator== (Colour const & a, Colour const & b);
 185 extern bool operator!= (Colour const & a, Colour const & b);
 186 extern std::ostream & operator<< (std::ostream & s, Colour const & c);
 187
 188 typedef std::pair<std::string, boost::shared_ptr<const parse::AssetMap> > PathAssetMap;
 189
 190 }
 191
 192 #endif