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 extern std::string effect_to_string (Effect e);
  62 extern Effect string_to_effect (std::string s);
  63
  64 enum VAlign
  65 {
  66         TOP,
  67         CENTER,
  68         BOTTOM
  69 };
  70
  71 extern std::string valign_to_string (VAlign a);
  72 extern VAlign string_to_valign (std::string s);
  73
  74 enum Eye
  75 {
  76         EYE_LEFT,
  77         EYE_RIGHT
  78 };
  79
  80 class Fraction
  81 {
  82 public:
  83         Fraction () : numerator (0), denominator (0) {}
  84         Fraction (std::string s);
  85         Fraction (int n, int d) : numerator (n), denominator (d) {}
  86
  87         int numerator;
  88         int denominator;
  89 };
  90
  91 extern bool operator== (Fraction const & a, Fraction const & b);
  92 extern bool operator!= (Fraction const & a, Fraction const & b);
  93
  94 struct EqualityOptions {
  95         EqualityOptions ()
  96                 : max_mean_pixel_error (0)
  97                 , max_std_dev_pixel_error (0)
  98                 , max_audio_sample_error (0)
  99         {}
 100
 101         double max_mean_pixel_error;
 102         double max_std_dev_pixel_error;
 103         int max_audio_sample_error;
 104 };
 105
 106 class Color
 107 {
 108 public:
 109         Color ();
 110         Color (int r_, int g_, int b_);
 111         Color (std::string argb_hex);
 112
 113         int r;
 114         int g;
 115         int b;
 116
 117         std::string to_argb_string () const;
 118 };
 119
 120 extern bool operator== (Color const & a, Color const & b);
 121 extern bool operator!= (Color const & a, Color const & b);
 122 extern std::ostream & operator<< (std::ostream & s, Color const & c);
 123
 124 }
 125
 126 #endif