Some compilers don't like x = {} where x is a boost::optional<string>
[libdcp.git] / src / subtitle_string.h
index 47e4fed15593880473817fa6d5c1d25af51a6124..bf9c87d9036cf32f1919872d773c2dc22afc07a8 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
     files in the program, then also delete it here.
 */
 
+
 /** @file  src/subtitle_string.h
- *  @brief SubtitleString class.
+ *  @brief SubtitleString class
  */
 
+
 #ifndef LIBDCP_SUBTITLE_STRING_H
 #define LIBDCP_SUBTITLE_STRING_H
 
+
 #include "types.h"
+#include "subtitle.h"
 #include "dcp_time.h"
 #include <boost/optional.hpp>
 #include <string>
 
+
 namespace dcp {
 
+
 /** @class SubtitleString
  *  @brief A single line of subtitle text with all the associated attributes.
  */
-class SubtitleString
+class SubtitleString : public Subtitle
 {
 public:
+       /** @param font Font ID, or empty to use the default
+        *  @param italic true for italic text
+        *  @param bold true for bold text
+        *  @param underline true for underlined text
+        *  @param colour Colour of the text
+        *  @param size Size in points as if the screen height is 11 inches, so a 72pt font would be 1/11th of the screen height
+        *  @param aspect_adjust greater than 1 to stretch text to be wider, less than 1 to shrink text to be narrower (must be between 0.25 and 4)
+        *  @param in start time
+        *  @param out finish time
+        *  @param h_position Horizontal position as a fraction of the screen width (between 0 and 1) from h_align
+        *  @param h_align Horizontal alignment point
+        *  @param v_position Vertical position as a fraction of the screen height (between 0 and 1) from v_align
+        *  @param v_align Vertical alignment point
+        *  @param direction Direction of text
+        *  @param text The text to display
+        *  @param effect Effect to use
+        *  @param effect_colour Colour of the effect
+        *  @param fade_up_time Time to fade the text in
+        *  @param fade_down_time Time to fade the text out
+        */
        SubtitleString (
                boost::optional<std::string> font,
                bool italic,
@@ -94,38 +120,10 @@ public:
                return _colour;
        }
 
-       Time in () const {
-               return _in;
-       }
-
-       Time out () const {
-               return _out;
-       }
-
        std::string text () const {
                return _text;
        }
 
-       float h_position () const {
-               return _h_position;
-       }
-
-       HAlign h_align () const {
-               return _h_align;
-       }
-
-       /** @return vertical position as a proportion of the screen height from the
-        *  vertical alignment point.
-        *  (between 0 and 1)
-        */
-       float v_position () const {
-               return _v_position;
-       }
-
-       VAlign v_align () const {
-               return _v_align;
-       }
-
        Direction direction () const {
                return _direction;
        }
@@ -138,14 +136,6 @@ public:
                return _effect_colour;
        }
 
-       Time fade_up_time () const {
-               return _fade_up_time;
-       }
-
-       Time fade_down_time () const {
-               return _fade_down_time;
-       }
-
        int size () const {
                return _size;
        }
@@ -160,23 +150,12 @@ public:
                return _aspect_adjust;
        }
 
-       void set_in (Time i) {
-               _in = i;
-       }
-
-       void set_out (Time o) {
-               _out = o;
-       }
-
-       void set_h_position (float p) {
-               _h_position = p;
+       void set_font (std::string id) {
+               _font = id;
        }
 
-       /** @param p New vertical position as a proportion of the screen height
-        *  from the top (between 0 and 1)
-        */
-       void set_v_position (float p) {
-               _v_position = p;
+       void unset_font () {
+               _font = boost::optional<std::string>();
        }
 
        void set_size (int s) {
@@ -191,7 +170,7 @@ public:
                _text = t;
        }
 
-       void set_colour (dcp::Colour c) {
+       void set_colour (Colour c) {
                _colour = c;
        }
 
@@ -199,18 +178,10 @@ public:
                _effect = e;
        }
 
-       void set_effect_colour (dcp::Colour c) {
+       void set_effect_colour (Colour c) {
                _effect_colour = c;
        }
 
-       void set_fade_up_time (dcp::Time t) {
-               _fade_up_time = t;
-       }
-
-       void set_fade_down_time (dcp::Time t) {
-               _fade_down_time = t;
-       }
-
 private:
        /** font ID */
        boost::optional<std::string> _font;
@@ -227,29 +198,18 @@ private:
         */
        int _size;
        float _aspect_adjust;
-       Time _in;
-       Time _out;
-       /** Horizontal position as a proportion of the screen width from the _h_align
-        *  (between 0 and 1)
-        */
-       float _h_position;
-       HAlign _h_align;
-       /** Vertical position as a proportion of the screen height from the _v_align
-        *  (between 0 and 1)
-        */
-       float _v_position;
-       VAlign _v_align;
        Direction _direction;
        std::string _text;
        Effect _effect;
        Colour _effect_colour;
-       Time _fade_up_time;
-       Time _fade_down_time;
 };
 
 bool operator== (SubtitleString const & a, SubtitleString const & b);
+bool operator!= (SubtitleString const & a, SubtitleString const & b);
 std::ostream& operator<< (std::ostream& s, SubtitleString const & sub);
 
+
 }
 
+
 #endif