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 edabb9e233b9c9595e704fb5a7831bd003193bc9..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,11 +24,16 @@
 #ifndef LIBDCP_TYPES_H
 #define LIBDCP_TYPES_H
 
+#include <boost/shared_ptr.hpp>
 #include <string>
 
-namespace libdcp
+namespace dcp
 {
 
+namespace parse {
+       class AssetMap;
+}
+
 /** Identifier for a sound channel */
 enum Channel {
        LEFT = 0,      ///< left
@@ -80,12 +85,20 @@ 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;
@@ -94,30 +107,48 @@ public:
 
 extern bool operator== (Fraction const & a, Fraction const & b);
 extern bool operator!= (Fraction const & a, Fraction const & b);
-       
-struct EqualityOptions {
+
+/** @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_names_can_differ (false)
+               , 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;
-       bool cpl_names_can_differ;
+       /** 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;
 };
 
-/* Win32 defines this */       
-#undef ERROR
-
+/* I've been unable to make mingw happy with ERROR as a symbol, so
+   I'm using a DCP_ prefix here.
+*/
 enum NoteType {
-       PROGRESS,
-       ERROR,
-       NOTE
+       DCP_PROGRESS,
+       DCP_ERROR,
+       DCP_NOTE
+};
+
+enum Standard {
+       INTEROP,
+       SMPTE
 };
 
 /** @class Color
@@ -141,6 +172,8 @@ 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