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