Missing namespace.

[libdcp.git] / src / types.h

diff --git a/src/types.h b/src/types.h
index 16000daa809c8a58b342461e31e2bbd3169363c8..8297dbcc393d8026892719905b8886bcf2a471ae 100644 (file)
--- a/src/types.h
+++ b/src/types.h
@@ -1,20 +1,34 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
 
-    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 <http://www.gnu.org/licenses/>.
+
+    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,15 @@
 #ifndef LIBDCP_TYPES_H
 #define LIBDCP_TYPES_H
 
+#include <libcxml/cxml.h>
 #include <boost/shared_ptr.hpp>
 #include <boost/function.hpp>
 #include <string>
 
+namespace xmlpp {
+       class Element;
+}
+
 namespace dcp
 {
 
@@ -54,6 +73,10 @@ struct Size
        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
@@ -81,9 +104,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 +142,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 +168,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.
@@ -202,8 +242,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
@@ -214,12 +257,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;
 };
 
@@ -239,6 +283,43 @@ 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);
+
 }
 
 #endif