Basic implementation of <Space> tag in subtitles.

[libdcp.git] / src / subtitle_string.cc

diff --git a/src/subtitle_string.cc b/src/subtitle_string.cc
index 2f6f421b6da09f57f9a06286ee28a2f59438245f..5e2c6251fd75e0da2ef1a1724769ee5a40ee53f4 100644 (file)
--- a/src/subtitle_string.cc
+++ b/src/subtitle_string.cc
@@ -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.
 
@@ -16,22 +16,45 @@
     You should have received a copy of the GNU General Public License
     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/subtitle_string.cc
+ *  @brief SubtitleString class
+ */
+
+
 #include "subtitle_string.h"
 #include "xml.h"
 #include <cmath>
 
-using std::string;
+
+using std::max;
+using std::min;
 using std::ostream;
+using std::string;
 using boost::optional;
 using namespace dcp;
 
-/** @param v_position Vertical position as a fraction of the screen height (between 0 and 1) from v_align */
+
 SubtitleString::SubtitleString (
        optional<string> font,
        bool italic,
        bool bold,
+       bool underline,
        Colour colour,
        int size,
        float aspect_adjust,
@@ -46,30 +69,27 @@ SubtitleString::SubtitleString (
        Effect effect,
        Colour effect_colour,
        Time fade_up_time,
-       Time fade_down_time
+       Time fade_down_time,
+       float space_before
        )
-       : _font (font)
+       : Subtitle (in, out, h_position, h_align, v_position, v_align, fade_up_time, fade_down_time)
+       , _font (font)
        , _italic (italic)
        , _bold (bold)
+       , _underline (underline)
        , _colour (colour)
        , _size (size)
        , _aspect_adjust (aspect_adjust)
-       , _in (in)
-       , _out (out)
-       , _h_position (h_position)
-       , _h_align (h_align)
-       , _v_position (v_position)
-       , _v_align (v_align)
        , _direction (direction)
        , _text (text)
        , _effect (effect)
        , _effect_colour (effect_colour)
-       , _fade_up_time (fade_up_time)
-       , _fade_down_time (fade_down_time)
+       , _space_before (space_before)
 {
-
+       _aspect_adjust = max(min(_aspect_adjust, 4.0f), 0.25f);
 }
 
+
 int
 SubtitleString::size_in_pixels (int screen_height) const
 {
@@ -81,6 +101,7 @@ SubtitleString::size_in_pixels (int screen_height) const
        return _size * screen_height / (11 * 72);
 }
 
+
 bool
 dcp::operator== (SubtitleString const & a, SubtitleString const & b)
 {
@@ -88,6 +109,7 @@ dcp::operator== (SubtitleString const & a, SubtitleString const & b)
                a.font() == b.font() &&
                a.italic() == b.italic() &&
                a.bold() == b.bold() &&
+               a.underline() == b.underline() &&
                a.colour() == b.colour() &&
                a.size() == b.size() &&
                fabs (a.aspect_adjust() - b.aspect_adjust()) < ASPECT_ADJUST_EPSILON &&
@@ -102,10 +124,19 @@ dcp::operator== (SubtitleString const & a, SubtitleString const & b)
                a.effect() == b.effect() &&
                a.effect_colour() == b.effect_colour() &&
                a.fade_up_time() == b.fade_up_time() &&
-               a.fade_down_time() == b.fade_down_time()
+               a.fade_down_time() == b.fade_down_time() &&
+               fabs (a.space_before() - b.space_before()) < SPACE_BEFORE_EPSILON
                );
 }
 
+
+bool
+dcp::operator!= (SubtitleString const & a, SubtitleString const & b)
+{
+       return !(a == b);
+}
+
+
 ostream&
 dcp::operator<< (ostream& s, SubtitleString const & sub)
 {
@@ -125,11 +156,18 @@ dcp::operator<< (ostream& s, SubtitleString const & sub)
                s << "normal, ";
        }
 
-       s << "size " << sub.size() << ", aspect " << sub.aspect_adjust() << ", colour " << sub.colour()
+       if (sub.underline()) {
+               s << "underlined, ";
+       }
+
+       s << "size " << sub.size() << ", aspect " << sub.aspect_adjust()
+         << ", colour (" << sub.colour().r << ", " << sub.colour().g << ", " << sub.colour().b << ")"
          << ", vpos " << sub.v_position() << ", valign " << ((int) sub.v_align())
          << ", hpos " << sub.h_position() << ", halign " << ((int) sub.h_align())
          << ", direction " << ((int) sub.direction())
-         << ", effect " << ((int) sub.effect()) << ", effect colour " << sub.effect_colour();
+         << ", effect " << ((int) sub.effect())
+         << ", effect colour (" << sub.effect_colour().r << ", " << sub.effect_colour().g << ", " << sub.effect_colour().b << ")"
+         << ", space before " << sub.space_before();
 
        return s;
 }