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 };
  39
  40 enum ContentKind
  41 {
  42         FEATURE,
  43         SHORT,
  44         TRAILER,
  45         TEST,
  46         TRANSITIONAL,
  47         RATING,
  48         TEASER,
  49         POLICY,
  50         PUBLIC_SERVICE_ANNOUNCEMENT,
  51         ADVERTISEMENT
  52 };
  53
  54 enum Effect
  55 {
  56         NONE,
  57         BORDER,
  58         SHADOW
  59 };
  60
  61 enum VAlign
  62 {
  63         TOP,
  64         CENTER,
  65         BOTTOM
  66 };
  67
  68 enum Eye
  69 {
  70         EYE_LEFT,
  71         EYE_RIGHT
  72 };
  73
  74 class Fraction
  75 {
  76 public:
  77         Fraction () : numerator (0), denominator (0) {}
  78         Fraction (std::string s);
  79         Fraction (int n, int d) : numerator (n), denominator (d) {}
  80
  81         int numerator;
  82         int denominator;
  83 };
  84
  85 extern bool operator== (Fraction const & a, Fraction const & b);
  86 extern bool operator!= (Fraction const & a, Fraction const & b);
  87
  88 struct EqualityOptions {
  89         EqualityOptions ()
  90                 : max_mean_pixel_error (0)
  91                 , max_std_dev_pixel_error (0)
  92                 , max_audio_sample_error (0)
  93         {}
  94
  95         double max_mean_pixel_error;
  96         double max_std_dev_pixel_error;
  97         int max_audio_sample_error;
  98 };
  99
 100 class Color
 101 {
 102 public:
 103         Color ();
 104         Color (int r_, int g_, int b_);
 105         Color (std::string argb_hex);
 106
 107         int r;
 108         int g;
 109         int b;
 110 };
 111
 112 extern bool operator== (Color const & a, Color const & b);
 113 extern std::ostream & operator<< (std::ostream & s, Color const & c);
 114
 115 }
 116
 117 #endif