Work around symbol clash with ERROR on Win32/mingw.

[libdcp.git] / src / types.h

diff --git a/src/types.h b/src/types.h
index 3a50c5d3a140ca0e2ae721b9714634d2a0d61ec3..5ef04bd39caabd45bec65bd1267454b5906e51fc 100644 (file)
--- a/src/types.h
+++ b/src/types.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -24,17 +24,26 @@
 #ifndef LIBDCP_TYPES_H
 #define LIBDCP_TYPES_H
 
-namespace libdcp
+#include <boost/shared_ptr.hpp>
+#include <string>
+
+namespace dcp
 {
 
+namespace parse {
+       class AssetMap;
+}
+
 /** 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
@@ -51,30 +60,100 @@ enum ContentKind
        ADVERTISEMENT
 };
 
+enum Effect
+{
+       NONE,
+       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
+ *  @brief A fraction (i.e. a thing with an integer numerator and an integer denominator).
+ */
 class Fraction
 {
 public:
+       /** Construct a fraction of 0/0 */
        Fraction () : numerator (0), denominator (0) {}
        Fraction (std::string s);
+       /** Construct a fraction with a specified numerator and denominator.
+        *  @param n Numerator.
+        *  @param d Denominator.
+        */
        Fraction (int n, int d) : numerator (n), denominator (d) {}
 
        int numerator;
        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;
+/** @struct EqualityOptions
+ *  @brief  A class to describe what "equality" means for a particular test.
+ *
+ *  When comparing things, we want to be able to ignore some differences;
+ *  this class expresses those differences.
+ */
+struct EqualityOptions
+{
+       /** Construct an EqualityOptions where nothing at all can differ */
+       EqualityOptions () 
+               : max_mean_pixel_error (0)
+               , max_std_dev_pixel_error (0)
+               , max_audio_sample_error (0)
+               , cpl_annotation_texts_can_differ (false)
+               , mxf_names_can_differ (false)
+       {}
+
+       /** The maximum allowable mean difference in pixel value between two images */
        double max_mean_pixel_error;
+       /** The maximum standard deviation of the differences in pixel value between two images */
        double max_std_dev_pixel_error;
+       /** The maximum difference in audio sample value between two soundtracks */
+       int max_audio_sample_error;
+       /** true if the <AnnotationText> nodes of CPLs are allowed to differ */
+       bool cpl_annotation_texts_can_differ;
+       /** true if MXF filenames are allowed to differ */
+       bool mxf_names_can_differ;
 };
 
+/* I've been unable to make mingw happy with ERROR as a symbol, so
+   I'm using a DCP_ prefix here.
+*/
+enum NoteType {
+       DCP_PROGRESS,
+       DCP_ERROR,
+       DCP_NOTE
+};
+
+enum Standard {
+       INTEROP,
+       SMPTE
+};
+
+/** @class Color
+ *  @brief An RGB color (aka colour).
+ */
 class Color
 {
 public:
@@ -82,14 +161,19 @@ 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);
 
+typedef std::pair<std::string, boost::shared_ptr<const parse::AssetMap> > PathAssetMap;
+
 }
 
 #endif