/*
- Copyright (C) 2012-2014 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
#define LIBDCP_TYPES_H
#include <boost/shared_ptr.hpp>
+#include <boost/function.hpp>
#include <string>
namespace dcp
{
-namespace parse {
- class AssetMap;
-}
+/** @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 {
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
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);
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.
struct EqualityOptions
{
/** Construct an EqualityOptions where nothing at all can differ */
- EqualityOptions ()
+ 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)
+ , reel_annotation_texts_can_differ (false)
, reel_hashes_can_differ (false)
+ , issue_dates_can_differ (false)
+ , keep_going (false)
{}
/** The maximum allowable mean difference 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 */
+ /** 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;
+ /** 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;
+ /** true if IssueDate nodes can differ */
+ bool issue_dates_can_differ;
+ bool keep_going;
};
/* I've been unable to make mingw happy with ERROR as a symbol, so
extern bool operator!= (Colour const & a, Colour const & b);
extern std::ostream & operator<< (std::ostream & s, Colour const & c);
-typedef std::pair<std::string, boost::shared_ptr<const parse::AssetMap> > PathAssetMap;
+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;
}