Missing install file.

[libdcp.git] / src / types.h

diff --git a/src/types.h b/src/types.h
index c49c5f8f80920589f5d59bc2b555c0b55e637729..edabb9e233b9c9595e704fb5a7831bd003193bc9 100644 (file)
--- a/src/types.h
+++ b/src/types.h
@@ -24,17 +24,21 @@
 #ifndef LIBDCP_TYPES_H
 #define LIBDCP_TYPES_H
 
+#include <string>
+
 namespace libdcp
 {
 
 /** Identifier for a sound channel */
 enum Channel {
-       LEFT = 0,    ///< left
-       RIGHT = 1,   ///< right
-       CENTRE = 2,  ///< centre
-       LFE = 3,     ///< low-frequency effects (sub)
-       LS = 4,      ///< left surround
-       RS = 5       ///< right surround
+       LEFT = 0,      ///< left
+       RIGHT = 1,     ///< right
+       CENTRE = 2,    ///< centre
+       LFE = 3,       ///< low-frequency effects (sub)
+       LS = 4,        ///< left surround
+       RS = 5,        ///< right surround
+       CHANNEL_7 = 6, ///< channel 7; not sure what this should be called
+       CHANNEL_8 = 7  ///< channel 8; not sure what this should be called
 };
 
 enum ContentKind
@@ -57,6 +61,25 @@ enum Effect
        BORDER,
        SHADOW
 };
+
+extern std::string effect_to_string (Effect e);
+extern Effect string_to_effect (std::string s);
+
+enum VAlign
+{
+       TOP,
+       CENTER,
+       BOTTOM
+};
+
+extern std::string valign_to_string (VAlign a);
+extern VAlign string_to_valign (std::string s);
+
+enum Eye
+{
+       EYE_LEFT,
+       EYE_RIGHT
+};
        
 class Fraction
 {
@@ -69,19 +92,37 @@ public:
        int denominator;
 };
 
-enum EqualityFlags {
-       LIBDCP_METADATA = 0x1,
-       MXF_BITWISE = 0x2,
-       MXF_INSPECT = 0x4
-};
-
+extern bool operator== (Fraction const & a, Fraction const & b);
+extern bool operator!= (Fraction const & a, Fraction const & b);
+       
 struct EqualityOptions {
-       EqualityFlags flags;
-       bool verbose;
+       EqualityOptions () 
+               : max_mean_pixel_error (0)
+               , max_std_dev_pixel_error (0)
+               , max_audio_sample_error (0)
+               , cpl_names_can_differ (false)
+               , mxf_names_can_differ (false)
+       {}
+
        double max_mean_pixel_error;
        double max_std_dev_pixel_error;
+       int max_audio_sample_error;
+       bool cpl_names_can_differ;
+       bool mxf_names_can_differ;
 };
 
+/* Win32 defines this */       
+#undef ERROR
+
+enum NoteType {
+       PROGRESS,
+       ERROR,
+       NOTE
+};
+
+/** @class Color
+ *  @brief An RGB color (aka colour).
+ */
 class Color
 {
 public:
@@ -89,12 +130,15 @@ public:
        Color (int r_, int g_, int b_);
        Color (std::string argb_hex);
 
-       int r;
-       int g;
-       int b;
+       int r; ///< red component, from 0 to 255
+       int g; ///< green component, from 0 to 255
+       int b; ///< blue component, from 0 to 255
+
+       std::string to_argb_string () const;
 };
 
 extern bool operator== (Color const & a, Color const & b);
+extern bool operator!= (Color const & a, Color const & b);
 extern std::ostream & operator<< (std::ostream & s, Color const & c);
 
 }