Add AspectAdjust to subtitles.

[libdcp.git] / src / types.h

diff --git a/src/types.h b/src/types.h
index ebcfb838a94ea1444f8197f671b89481e42ece72..52b831f7b864016c25c01327d6f161da70bf8915 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-2015 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,36 @@
 #ifndef LIBDCP_TYPES_H
 #define LIBDCP_TYPES_H
 
+#include <boost/shared_ptr.hpp>
+#include <boost/function.hpp>
 #include <string>
 
-namespace libdcp
+namespace dcp
 {
 
+/** @struct Size
+ *  @brief The integer, two-dimensional size of something.
+ */
+struct Size
+{
+       Size ()
+               : width (0)
+               , height (0)
+       {}
+
+       Size (int w, int h)
+               : width (w)
+               , height (h)
+       {}
+
+       float ratio () const {
+               return float (width) / height;
+       }
+       
+       int width;
+       int height;
+};
+
 /** Identifier for a sound channel */
 enum Channel {
        LEFT = 0,      ///< left
@@ -37,8 +62,12 @@ enum Channel {
        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
+       HI = 6,
+       VI = 7,
+       LC = 8,
+       RC = 9,
+       BSL = 10,
+       BSR = 11
 };
 
 enum ContentKind
@@ -80,42 +109,97 @@ 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) {}
 
+       float as_float () const {
+               return float (numerator) / denominator;
+       }
+
        int numerator;
        int denominator;
 };
 
 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_annotation_texts_can_differ (false)
+               , mxf_filenames_can_differ (false)
+               , reel_annotation_texts_can_differ (false)
+               , reel_hashes_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 file leafnames are allowed to differ */
+       bool mxf_filenames_can_differ;
+       /** true if the <AnnotationText> 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;
 };
 
-/** @class Color
- *  @brief An RGB color (aka colour).
+/* 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
+};
+
+enum Formulation {
+       MODIFIED_TRANSITIONAL_1,
+       DCI_ANY,
+       DCI_SPECIFIC
+};
+
+/** @class Colour
+ *  @brief An RGB colour.
  */
-class Color
+class Colour
 {
 public:
-       Color ();
-       Color (int r_, int g_, int b_);
-       Color (std::string argb_hex);
+       Colour ();
+       Colour (int r_, int g_, int b_);
+       Colour (std::string argb_hex);
 
        int r; ///< red component, from 0 to 255
        int g; ///< green component, from 0 to 255
@@ -124,9 +208,16 @@ public:
        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);
+extern bool operator== (Colour const & a, Colour const & b);
+extern bool operator!= (Colour const & a, Colour const & b);
+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.
+ */
+#define ASPECT_ADJUST_EPSILON (1e-3)
 
 }