X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Ftypes.h;h=374dd8b8c1d22741deeafbd252ddae3ffe3340c2;hb=e1e7de8d73bedd0c741e7df0390068c67867e09f;hp=dd2e10a6f4cc29d44d4421d166af2cd0d404dc56;hpb=d927e9b913606f4fc982885c7582ecaf0e3c5a1a;p=libdcp.git diff --git a/src/types.h b/src/types.h index dd2e10a6..374dd8b8 100644 --- a/src/types.h +++ b/src/types.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2015 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington This file is part of libdcp. @@ -31,20 +31,36 @@ 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 + +#include +#include +#include #include #include + +/* MinGW seems to define 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. */ @@ -68,8 +84,13 @@ struct Size int height; }; + +extern bool operator== (Size const & a, Size const & b); +extern bool operator!= (Size const & a, Size const & b); + + /** Identifier for a sound channel */ -enum Channel { +enum class Channel { LEFT = 0, ///< left RIGHT = 1, ///< right CENTRE = 2, ///< centre @@ -78,13 +99,34 @@ enum Channel { RS = 5, ///< right surround HI = 6, VI = 7, - LC = 8, - RC = 9, + /* 8 and 9 are not used */ BSL = 10, - BSR = 11 + BSR = 11, + MOTION_DATA = 12, + SYNC_SIGNAL = 13, + SIGN_LANGUAGE = 14, + /* 15 is not used */ + CHANNEL_COUNT = 16 +}; + + +std::vector used_audio_channels (); + + +enum class MCASoundField +{ + FIVE_POINT_ONE, + SEVEN_POINT_ONE }; -enum ContentKind + +extern std::string channel_to_mca_id (Channel c, MCASoundField field); +extern Channel mca_id_to_channel (std::string); +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 class ContentKind { FEATURE, SHORT, @@ -95,57 +137,73 @@ enum ContentKind TEASER, POLICY, PUBLIC_SERVICE_ANNOUNCEMENT, - ADVERTISEMENT + ADVERTISEMENT, + EPISODE, + PROMO }; -enum Effect + +extern std::string content_kind_to_string (ContentKind kind); +extern ContentKind content_kind_from_string (std::string kind); + + +enum class Effect { NONE, BORDER, SHADOW }; + extern std::string effect_to_string (Effect e); extern Effect string_to_effect (std::string s); -enum HAlign + +enum class 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 + LEFT, ///< horizontal position is distance from left of screen to left of subtitle + CENTER, ///< horizontal position is distance from centre of screen to centre of subtitle + 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 + +enum class 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 + TOP, ///< vertical position is distance from top of screen to top of subtitle + CENTER, ///< vertical position is distance from centre of screen to centre of subtitle + 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). */ @@ -153,7 +211,7 @@ class Fraction { public: /** Construct a fraction of 0/0 */ - Fraction () : numerator (0), denominator (0) {} + Fraction () {} explicit Fraction (std::string s); /** Construct a fraction with a specified numerator and denominator. * @param n Numerator. @@ -167,104 +225,265 @@ 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) - , keep_going (false) - {} + EqualityOptions () {} /** The maximum allowable mean difference in pixel value between two images */ - double max_mean_pixel_error; + double max_mean_pixel_error = 0; /** The maximum standard deviation of the differences in pixel value between two images */ - double max_std_dev_pixel_error; + double max_std_dev_pixel_error = 0; /** The maximum difference in audio sample value between two soundtracks */ - int max_audio_sample_error; + int max_audio_sample_error = 0; /** true if the <AnnotationText> nodes of CPLs are allowed to differ */ - bool cpl_annotation_texts_can_differ; + bool cpl_annotation_texts_can_differ = false; /** true if the <AnnotationText> nodes of Reels are allowed to differ */ - bool reel_annotation_texts_can_differ; + bool reel_annotation_texts_can_differ = false; /** true if es in Reels can differ */ - bool reel_hashes_can_differ; + bool reel_hashes_can_differ = false; /** true if IssueDate nodes can differ */ - bool issue_dates_can_differ; - bool keep_going; + bool issue_dates_can_differ = false; + bool load_font_nodes_can_differ = false; + bool keep_going = false; + /** true to save the first pair of differeng image subtitles to the current working directory */ + bool export_differing_subtitles = false; }; -/* 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 + DCI_SPECIFIC, + /** For testing: adds no AuthorizedDeviceInfo tag */ + MODIFIED_TRANSITIONAL_TEST }; + /** @class Colour - * @brief An RGB colour. + * @brief An RGB colour */ class Colour { public: + /** Construct a Colour, initialising it to black */ Colour (); + + /** 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; + + +enum class Marker { + FFOC, ///< first frame of composition + LFOC, ///< last frame of composition + FFTC, ///< first frame of title credits + LFTC, ///< last frame of title credits + FFOI, ///< first frame of intermission + LFOI, ///< last frame of intermission + FFEC, ///< first frame of end credits + LFEC, ///< last frame of end credits + FFMC, ///< first frame of moving credits + 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); + + +enum class Status +{ + FINAL, ///< final version + TEMP, ///< temporary version (picture/sound unfinished) + PRE ///< pre-release (picture/sound finished) +}; + + +extern std::string status_to_string (Status s); +extern Status string_to_status (std::string s); + + +class ContentVersion +{ +public: + ContentVersion (); + + explicit ContentVersion (cxml::ConstNodePtr node); + + explicit ContentVersion (std::string label_text_); + + ContentVersion (std::string id_, std::string label_text_) + : id (id_) + , label_text (label_text_) + {} + + void as_xml (xmlpp::Element* parent) const; + + std::string id; + std::string label_text; +}; + + +class Luminance +{ +public: + enum class Unit { + CANDELA_PER_SQUARE_METRE, + FOOT_LAMBERT + }; + + Luminance (cxml::ConstNodePtr node); + + Luminance (float value, Unit unit); + + void set_value (float v); + void set_unit (Unit u) { + _unit = u; + } + + float value () const { + return _value; + } + + Unit unit () const { + return _unit; + } + + void as_xml (xmlpp::Element* parent, std::string ns) const; + + static std::string unit_to_string (Unit u); + static Unit string_to_unit (std::string u); + +private: + float _value; + Unit _unit; +}; + + +bool operator== (Luminance const& a, Luminance const& b); + + +class MainSoundConfiguration +{ +public: + MainSoundConfiguration (std::string); + MainSoundConfiguration (MCASoundField field_, int channels); + + MCASoundField field () const { + return _field; + } + + int channels () const { + return _channels.size(); + } + + boost::optional mapping (int index) const; + void set_mapping (int index, Channel channel); + + std::string to_string () const; + +private: + MCASoundField _field; + std::vector > _channels; +}; + } + #endif