X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Ftypes.h;h=183ce6383e6cc0f440977bf8e61e180c2a369b99;hb=0d31c86d6dfad9f437f5613d41cace9cc5928474;hp=7f9c3e8b43275e9776627d61c6c6fb7f43bdad58;hpb=8d56ea4bbff391dd72981f86001245a595fa9c62;p=libdcp.git diff --git a/src/types.h b/src/types.h index 7f9c3e8b..183ce638 100644 --- a/src/types.h +++ b/src/types.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2019 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington This file is part of libdcp. @@ -31,35 +31,45 @@ files in the program, then also delete it here. */ + /** @file src/types.h - * @brief Miscellaneous types. + * @brief Miscellaneous types */ + #ifndef LIBDCP_TYPES_H #define LIBDCP_TYPES_H + +#include "warnings.h" #include +LIBDCP_DISABLE_WARNINGS #include +LIBDCP_ENABLE_WARNINGS #include #include #include + +/* windows.h defines this but we want to use it */ +#undef ERROR + + namespace xmlpp { class Element; } + namespace dcp { + /** @struct Size * @brief The integer, two-dimensional size of something. */ struct Size { - Size () - : width (0) - , height (0) - {} + Size() = default; Size (int w, int h) : width (w) @@ -70,16 +80,17 @@ struct Size return float (width) / height; } - int width; - int height; + int width = 0; + int height = 0; }; + extern bool operator== (Size const & a, Size const & b); extern bool operator!= (Size const & a, Size const & b); -extern std::ostream& operator<< (std::ostream& s, Size const & a); + /** Identifier for a sound channel */ -enum Channel { +enum class Channel { LEFT = 0, ///< left RIGHT = 1, ///< right CENTRE = 2, ///< centre @@ -98,13 +109,15 @@ enum Channel { CHANNEL_COUNT = 16 }; + std::vector used_audio_channels (); -enum MCASoundField +enum class MCASoundField { FIVE_POINT_ONE, - SEVEN_POINT_ONE + SEVEN_POINT_ONE, + OTHER }; @@ -114,73 +127,39 @@ extern std::string channel_to_mca_name (Channel c, MCASoundField field); extern ASDCP::UL channel_to_mca_universal_label (Channel c, MCASoundField field, ASDCP::Dictionary const* dict); -enum ContentKind -{ - FEATURE, - SHORT, - TRAILER, - TEST, - TRANSITIONAL, - RATING, - TEASER, - POLICY, - PUBLIC_SERVICE_ANNOUNCEMENT, - ADVERTISEMENT, - EPISODE, - PROMO -}; - -extern std::string content_kind_to_string (ContentKind kind); -extern ContentKind content_kind_from_string (std::string kind); - -enum Effect +enum class Effect { NONE, BORDER, SHADOW }; + 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 -{ - 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); -extern VAlign string_to_valign (std::string s); /** Direction for subtitle test */ -enum Direction +enum class Direction { - DIRECTION_LTR, ///< left-to-right - DIRECTION_RTL, ///< right-to-left - DIRECTION_TTB, ///< top-to-bottom - DIRECTION_BTT ///< bottom-to-top + LTR, ///< left-to-right + RTL, ///< right-to-left + TTB, ///< top-to-bottom + BTT ///< bottom-to-top }; + extern std::string direction_to_string (Direction a); extern Direction string_to_direction (std::string s); -enum Eye + +enum class Eye { - EYE_LEFT, - EYE_RIGHT + LEFT, + RIGHT }; + /** @class Fraction * @brief A fraction (i.e. a thing with an integer numerator and an integer denominator). */ @@ -188,7 +167,8 @@ class Fraction { public: /** Construct a fraction of 0/0 */ - Fraction () : numerator (0), denominator (0) {} + Fraction() = default; + explicit Fraction (std::string s); /** Construct a fraction with a specified numerator and denominator. * @param n Numerator. @@ -202,114 +182,105 @@ public: std::string as_string () const; - int numerator; - int denominator; + int numerator = 0; + int denominator = 0; }; + 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. - * - * When comparing things, we want to be able to ignore some differences; - * this class expresses those differences. - * - * It also contains some settings for how the comparison should be done. - */ -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) - , reel_annotation_texts_can_differ (false) - , reel_hashes_can_differ (false) - , issue_dates_can_differ (false) - , load_font_nodes_can_differ (false) - , keep_going (false) - , export_differing_subtitles (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 the <AnnotationText> nodes of Reels are allowed to differ */ - bool reel_annotation_texts_can_differ; - /** true if es in Reels can differ */ - bool reel_hashes_can_differ; - /** true if IssueDate nodes can differ */ - bool issue_dates_can_differ; - bool load_font_nodes_can_differ; - bool keep_going; - /** true to save the first pair of differeng image subtitles to the current working directory */ - bool export_differing_subtitles; -}; -/* 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 class NoteType { + PROGRESS, + ERROR, + NOTE }; -enum Standard { + +enum class Standard { INTEROP, SMPTE }; -enum Formulation { + +enum class Formulation { MODIFIED_TRANSITIONAL_1, MULTIPLE_MODIFIED_TRANSITIONAL_1, DCI_ANY, DCI_SPECIFIC, - /** For testing: adds no AuthorizedDeviceInfo tag */ - MODIFIED_TRANSITIONAL_TEST }; + +std::string formulation_to_string (dcp::Formulation formulation); +dcp::Formulation string_to_formulation (std::string forumulation); + + /** @class Colour - * @brief An RGB colour. + * @brief An RGB colour */ class Colour { public: - Colour (); + /** Construct a Colour, initialising it to black */ + Colour() = default; + + /** Construct a Colour from R, G and B. The values run between + * 0 and 255. + */ Colour (int r_, int g_, int b_); + + /** Construct a Colour from an ARGB hex string; the alpha value is ignored. + * @param argb_hex A string of the form AARRGGBB, where e.g. RR is a two-character + * hex value. + */ explicit Colour (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 + int r = 0; ///< red component, from 0 to 255 + int g = 0; ///< green component, from 0 to 255 + int b = 0; ///< blue component, from 0 to 255 + /** @return An RGB string of the form RRGGBB, where e.g. RR is a two-character + * hex value. + */ std::string to_rgb_string () const; + + /** @return An ARGB string of the form AARRGGBB, where e.g. RR is a two-character + * hex value. The alpha value will always be FF (ie 255; maximum alpha). + */ std::string to_argb_string () const; }; + 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 NoteHandler; + /** Maximum absolute difference between dcp::SubtitleString::aspect_adjust values that - * are considered equal. + * are considered equal */ -const float ASPECT_ADJUST_EPSILON = 1e-3; +constexpr float ASPECT_ADJUST_EPSILON = 1e-3; + /** Maximum absolute difference between dcp::SubtitleString alignment values that * are considered equal. */ -const float ALIGN_EPSILON = 1e-3; +constexpr float ALIGN_EPSILON = 1e-3; + + +/** Maximum absolute difference between dcp::SubtitleString space_before values that + * are considered equal. + */ +constexpr float SPACE_BEFORE_EPSILON = 1e-3; + + +constexpr float SIZE_EPSILON = 1e-3; +constexpr float OFFSET_EPSILON = 1e-3; +constexpr float SPACING_EPSILON = 1e-3; + enum class Marker { FFOC, ///< first frame of composition @@ -324,32 +295,12 @@ enum class Marker { LFMC ///< last frame of moving credits }; + std::string marker_to_string (Marker); Marker marker_from_string (std::string); -class Rating -{ -public: - Rating (std::string agency_, std::string label_) - : agency (agency_) - , label (label_) - {} - - explicit Rating (cxml::ConstNodePtr node); - void as_xml (xmlpp::Element* parent) const; - - /** URI of the agency issuing the rating */ - std::string agency; - /** Rating (e.g. PG, PG-13, 12A etc) */ - std::string label; -}; - -extern bool operator== (Rating const & a, Rating const & b); -extern std::ostream& operator<< (std::ostream& s, Rating const & r); - - -enum Status +enum class Status { FINAL, ///< final version TEMP, ///< temporary version (picture/sound unfinished) @@ -385,7 +336,7 @@ public: class Luminance { public: - enum Unit { + enum class Unit { CANDELA_PER_SQUARE_METRE, FOOT_LAMBERT }; @@ -407,6 +358,8 @@ public: return _unit; } + float value_in_foot_lamberts () const; + void as_xml (xmlpp::Element* parent, std::string ns) const; static std::string unit_to_string (Unit u); @@ -417,13 +370,14 @@ private: Unit _unit; }; + bool operator== (Luminance const& a, Luminance const& b); class MainSoundConfiguration { public: - MainSoundConfiguration (std::string); + explicit MainSoundConfiguration(std::string); MainSoundConfiguration (MCASoundField field_, int channels); MCASoundField field () const { @@ -441,10 +395,11 @@ public: private: MCASoundField _field; - std::vector > _channels; + std::vector> _channels; }; } + #endif