/*
- 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
#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
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;
};
+extern bool operator== (Fraction const & a, Fraction const & b);
+extern bool operator!= (Fraction const & a, Fraction const & b);
+
+/** @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;
+};
+
+/* Win32 defines this */
+#undef ERROR
+
+enum NoteType {
+ PROGRESS,
+ ERROR,
+ NOTE
+};
+
+enum Standard {
+ INTEROP,
+ SMPTE
+};
+
+/** @class Color
+ * @brief An RGB color (aka colour).
+ */
+class Color
+{
+public:
+ Color ();
+ Color (int r_, int g_, int b_);
+ Color (std::string argb_hex);
+
+ 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