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