Optionally allow subtitle issue dates to differ.

[libdcp.git] / src / types.h

diff --git a/src/types.h b/src/types.h
index 133abfd52245a9f3097ea6bfdceaccd0f501e67f..bfcc5a3f6e4fb0ce63b8730c64fa36abd92fb7b9 100644 (file)
--- a/src/types.h
+++ b/src/types.h
@@ -94,11 +94,21 @@ enum Effect
 extern std::string effect_to_string (Effect e);
 extern Effect string_to_effect (std::string s);
 
+enum HAlign
+{
+       HALIGN_LEFT,   ///< horizontal position is distance from left of screen to left of subtitle
+       HALIGN_CENTER, ///< horizontal position is distance from centre of screen to centre of subtitle
+       HALIGN_RIGHT,  ///< horizontal position is distance from right of screen to right of subtitle
+};
+
+extern std::string halign_to_string (HAlign a);
+extern HAlign string_to_halign (std::string s);
+
 enum VAlign
 {
-       TOP,
-       CENTER,
-       BOTTOM
+       VALIGN_TOP,    ///< vertical position is distance from top of screen to top of subtitle
+       VALIGN_CENTER, ///< vertical position is distance from centre of screen to centre of subtitle
+       VALIGN_BOTTOM  ///< vertical position is distance from bottom of screen to bottom of subtitle
 };
 
 extern std::string valign_to_string (VAlign a);
@@ -129,12 +139,15 @@ public:
                return float (numerator) / denominator;
        }
 
+       std::string as_string () const;
+
        int numerator;
        int denominator;
 };
 
 extern bool operator== (Fraction const & a, Fraction const & b);
 extern bool operator!= (Fraction const & a, Fraction const & b);
+extern std::ostream& operator<< (std::ostream& s, Fraction const & f); 
 
 /** @struct EqualityOptions
  *  @brief  A class to describe what "equality" means for a particular test.
@@ -150,8 +163,9 @@ struct EqualityOptions
                , max_std_dev_pixel_error (0)
                , max_audio_sample_error (0)
                , cpl_annotation_texts_can_differ (false)
-               , mxf_filenames_can_differ (false)
+               , reel_annotation_texts_can_differ (false)
                , reel_hashes_can_differ (false)
+               , issue_dates_can_differ (false)
        {}
 
        /** The maximum allowable mean difference in pixel value between two images */
@@ -160,12 +174,14 @@ struct EqualityOptions
        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 */
+       /** true if the &lt;AnnotationText&gt; nodes of CPLs are allowed to differ */
        bool cpl_annotation_texts_can_differ;
-       /** true if MXF file leafnames are allowed to differ */
-       bool mxf_filenames_can_differ;
+       /** true if the &lt;AnnotationText&gt; nodes of Reels are allowed to differ */
+       bool reel_annotation_texts_can_differ;
        /** true if <Hash>es in Reels can differ */
        bool reel_hashes_can_differ;
+       /** true if IssueDate nodes can differ */
+       bool issue_dates_can_differ;
 };
 
 /* I've been unable to make mingw happy with ERROR as a symbol, so
@@ -211,6 +227,15 @@ extern std::ostream & operator<< (std::ostream & s, Colour const & c);
 
 typedef boost::function<void (NoteType, std::string)> NoteHandler;
 
+/** Maximum absolute difference between dcp::SubtitleString::aspect_adjust values that
+ *  are considered equal.
+ */
+const float ASPECT_ADJUST_EPSILON = 1e-3;
+
+/** Maximum absolute difference between dcp::SubtitleString alignment values that
+ *  are considered equal.
+ */
+const float ALIGN_EPSILON = 1e-3;
 
 }