Cleanup: fix more comments/guards (and add check script).

[libdcp.git] / src / subtitle_string.h

diff --git a/src/subtitle_string.h b/src/subtitle_string.h
index 8e798d8ec6fdcb19ebe638efcf7dbba41d2e2ea8..1ef57ff22bf8d80ae693c4c727213a56e671657b 100644 (file)
--- a/src/subtitle_string.h
+++ b/src/subtitle_string.h
@@ -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.
 
@@ -31,27 +31,55 @@
     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 "ruby.h"
+#include "subtitle.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 : 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 z_position Z position as a proportion of the primary picture width between -1 and +1;
+        *  +ve moves the image away from the viewer, -ve moves it toward the viewer, 0 is in the plane of the screen.
+        *  @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
+        *  @param space_before Space to add before this string, in ems (could be negative to remove space).
+        */
        SubtitleString (
                boost::optional<std::string> font,
                bool italic,
@@ -66,12 +94,15 @@ public:
                HAlign h_align,
                float v_position,
                VAlign v_align,
+               float z_position,
                Direction direction,
                std::string text,
                Effect effect,
                Colour effect_colour,
                Time fade_up_time,
-               Time fade_down_time
+               Time fade_down_time,
+               float space_before,
+               std::vector<Ruby> rubies
                );
 
        /** @return font ID */
@@ -115,7 +146,11 @@ public:
                return _size;
        }
 
-       int size_in_pixels (int screen_height) const;
+       float size_in_pixels (int screen_height) const;
+
+       float space_before () const {
+               return _space_before;
+       }
 
        /** @return Aspect ratio `adjustment' of the font size.
         *  Values greater than 1 widen each character, values less than 1 narrow each character,
@@ -125,6 +160,10 @@ public:
                return _aspect_adjust;
        }
 
+       std::vector<Ruby> const& rubies() const {
+               return _rubies;
+       }
+
        void set_font (std::string id) {
                _font = id;
        }
@@ -157,6 +196,12 @@ public:
                _effect_colour = c;
        }
 
+       void set_rubies(std::vector<Ruby> rubies) {
+               _rubies = std::move(rubies);
+       }
+
+       bool equals(std::shared_ptr<const dcp::Subtitle> other_sub, EqualityOptions const& options, NoteHandler node) const override;
+
 private:
        /** font ID */
        boost::optional<std::string> _font;
@@ -177,12 +222,17 @@ private:
        std::string _text;
        Effect _effect;
        Colour _effect_colour;
+       float _space_before;
+       std::vector<Ruby> _rubies;
 };
 
 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
+