src/types.h

   1 /*
   2     Copyright (C) 2012 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 <string>
  28
  29 namespace libdcp
  30 {
  31
  32 namespace parse {
  33         class AssetMap;
  34 }
  35
  36 /** Identifier for a sound channel */
  37 enum Channel {
  38         LEFT = 0,      ///< left
  39         RIGHT = 1,     ///< right
  40         CENTRE = 2,    ///< centre
  41         LFE = 3,       ///< low-frequency effects (sub)
  42         LS = 4,        ///< left surround
  43         RS = 5,        ///< right surround
  44         CHANNEL_7 = 6, ///< channel 7; not sure what this should be called
  45         CHANNEL_8 = 7  ///< channel 8; not sure what this should be called
  46 };
  47
  48 enum ContentKind
  49 {
  50         FEATURE,
  51         SHORT,
  52         TRAILER,
  53         TEST,
  54         TRANSITIONAL,
  55         RATING,
  56         TEASER,
  57         POLICY,
  58         PUBLIC_SERVICE_ANNOUNCEMENT,
  59         ADVERTISEMENT
  60 };
  61
  62 enum Effect
  63 {
  64         NONE,
  65         BORDER,
  66         SHADOW
  67 };
  68
  69 extern std::string effect_to_string (Effect e);
  70 extern Effect string_to_effect (std::string s);
  71
  72 enum VAlign
  73 {
  74         TOP,
  75         CENTER,
  76         BOTTOM
  77 };
  78
  79 extern std::string valign_to_string (VAlign a);
  80 extern VAlign string_to_valign (std::string s);
  81
  82 enum Eye
  83 {
  84         EYE_LEFT,
  85         EYE_RIGHT
  86 };
  87
  88 class Fraction
  89 {
  90 public:
  91         Fraction () : numerator (0), denominator (0) {}
  92         Fraction (std::string s);
  93         Fraction (int n, int d) : numerator (n), denominator (d) {}
  94
  95         int numerator;
  96         int denominator;
  97 };
  98
  99 extern bool operator== (Fraction const & a, Fraction const & b);
 100 extern bool operator!= (Fraction const & a, Fraction const & b);
 101
 102 struct EqualityOptions {
 103         EqualityOptions ()
 104                 : max_mean_pixel_error (0)
 105                 , max_std_dev_pixel_error (0)
 106                 , max_audio_sample_error (0)
 107                 , cpl_names_can_differ (false)
 108                 , mxf_names_can_differ (false)
 109         {}
 110
 111         double max_mean_pixel_error;
 112         double max_std_dev_pixel_error;
 113         int max_audio_sample_error;
 114         bool cpl_names_can_differ;
 115         bool mxf_names_can_differ;
 116 };
 117
 118 /* Win32 defines this */
 119 #undef ERROR
 120
 121 enum NoteType {
 122         PROGRESS,
 123         ERROR,
 124         NOTE
 125 };
 126
 127 /** @class Color
 128  *  @brief An RGB color (aka colour).
 129  */
 130 class Color
 131 {
 132 public:
 133         Color ();
 134         Color (int r_, int g_, int b_);
 135         Color (std::string argb_hex);
 136
 137         int r; ///< red component, from 0 to 255
 138         int g; ///< green component, from 0 to 255
 139         int b; ///< blue component, from 0 to 255
 140
 141         std::string to_argb_string () const;
 142 };
 143
 144 extern bool operator== (Color const & a, Color const & b);
 145 extern bool operator!= (Color const & a, Color const & b);
 146 extern std::ostream & operator<< (std::ostream & s, Color const & c);
 147
 148 typedef std::pair<std::string, boost::shared_ptr<const parse::AssetMap> > PathAssetMap;
 149
 150 }
 151
 152 #endif