X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Ftypes.h;h=3bd5c2c39b755e3a5ef5c48377ccd2da9083ff8e;hb=3924dd859ad3de1d4a207d04e841f699bd27490a;hp=16908952a58c135d06c0fce3d42c0eec62fa291d;hpb=635c3ae7aee1cad4b871fcf0ddf02a8be1cdce78;p=libdcp.git diff --git a/src/types.h b/src/types.h index 16908952..3bd5c2c3 100644 --- a/src/types.h +++ b/src/types.h @@ -1,20 +1,34 @@ /* - Copyright (C) 2012-2015 Carl Hetherington + Copyright (C) 2012-2019 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of libdcp. + + libdcp is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + libdcp is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - + along with libdcp. If not, see . + + In addition, as a special exception, the copyright holders give + permission to link the code of portions of this program with the + OpenSSL library under certain conditions as described in each + individual source file, and distribute linked combinations + including the two. + + You must obey the GNU General Public License in all respects + for all of the code used other than OpenSSL. If you modify + file(s) with this exception, you may extend this exception to your + version of the file(s), but you are not obligated to do so. If you + do not wish to do so, delete this exception statement from your + version. If you delete this exception statement from all source + files in the program, then also delete it here. */ /** @file src/types.h @@ -24,10 +38,16 @@ #ifndef LIBDCP_TYPES_H #define LIBDCP_TYPES_H -#include +#include +#include +#include #include #include +namespace xmlpp { + class Element; +} + namespace dcp { @@ -49,11 +69,15 @@ struct Size float ratio () const { return float (width) / height; } - + int width; int height; }; +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 { LEFT = 0, ///< left @@ -64,12 +88,32 @@ 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 MCASoundField +{ + FIVE_POINT_ONE, + SEVEN_POINT_ONE }; + +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 ContentKind { FEATURE, @@ -81,9 +125,14 @@ enum ContentKind TEASER, POLICY, PUBLIC_SERVICE_ANNOUNCEMENT, - ADVERTISEMENT + ADVERTISEMENT, + EPISODE, + PROMO }; +extern std::string content_kind_to_string (ContentKind kind); +extern ContentKind content_kind_from_string (std::string kind); + enum Effect { NONE, @@ -114,6 +163,18 @@ enum VAlign extern std::string valign_to_string (VAlign a); extern VAlign string_to_valign (std::string s); +/** Direction for subtitle test */ +enum Direction +{ + DIRECTION_LTR, ///< left-to-right + DIRECTION_RTL, ///< right-to-left + DIRECTION_TTB, ///< top-to-bottom + DIRECTION_BTT ///< bottom-to-top +}; + +extern std::string direction_to_string (Direction a); +extern Direction string_to_direction (std::string s); + enum Eye { EYE_LEFT, @@ -128,7 +189,7 @@ class Fraction public: /** Construct a fraction of 0/0 */ Fraction () : numerator (0), denominator (0) {} - Fraction (std::string s); + explicit Fraction (std::string s); /** Construct a fraction with a specified numerator and denominator. * @param n Numerator. * @param d Denominator. @@ -147,23 +208,30 @@ public: 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 () + 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 */ @@ -178,6 +246,12 @@ struct EqualityOptions 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 @@ -196,8 +270,11 @@ enum Standard { enum 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 @@ -208,12 +285,13 @@ class Colour public: Colour (); Colour (int r_, int g_, int b_); - Colour (std::string argb_hex); + 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 + std::string to_rgb_string () const; std::string to_argb_string () const; }; @@ -233,6 +311,140 @@ const float ASPECT_ADJUST_EPSILON = 1e-3; */ const float ALIGN_EPSILON = 1e-3; +enum 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); +extern std::ostream& operator<< (std::ostream& s, Rating const & r); + + +enum 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 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