Basic implementation of <Space> tag in subtitles.
[libdcp.git] / src / subtitle_string.cc
index 66869fd59329db90e04343f98b44a633ce8dd921..5e2c6251fd75e0da2ef1a1724769ee5a40ee53f4 100644 (file)
@@ -1,61 +1,95 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 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/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;
 
+
 SubtitleString::SubtitleString (
-       string font,
+       optional<string> font,
        bool italic,
-       Color color,
+       bool bold,
+       bool underline,
+       Colour colour,
        int size,
+       float aspect_adjust,
        Time in,
        Time out,
+       float h_position,
+       HAlign h_align,
        float v_position,
        VAlign v_align,
+       Direction direction,
        string text,
        Effect effect,
-       Color effect_color,
+       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)
-       , _color (color)
+       , _bold (bold)
+       , _underline (underline)
+       , _colour (colour)
        , _size (size)
-       , _in (in)
-       , _out (out)
-       , _v_position (v_position)
-       , _v_align (v_align)
+       , _aspect_adjust (aspect_adjust)
+       , _direction (direction)
        , _text (text)
        , _effect (effect)
-       , _effect_color (effect_color)
-       , _fade_up_time (fade_up_time)
-       , _fade_down_time (fade_down_time)
+       , _effect_colour (effect_colour)
+       , _space_before (space_before)
 {
-
+       _aspect_adjust = max(min(_aspect_adjust, 4.0f), 0.25f);
 }
 
+
 int
 SubtitleString::size_in_pixels (int screen_height) const
 {
@@ -63,45 +97,77 @@ SubtitleString::size_in_pixels (int screen_height) const
           height is 11 inches, so a 72pt font would be 1/11th of the screen
           height.
        */
-       
+
        return _size * screen_height / (11 * 72);
 }
 
+
 bool
 dcp::operator== (SubtitleString const & a, SubtitleString const & b)
 {
        return (
                a.font() == b.font() &&
                a.italic() == b.italic() &&
-               a.color() == b.color() &&
+               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 &&
                a.in() == b.in() &&
                a.out() == b.out() &&
+               a.h_position() == b.h_position() &&
+               a.h_align() == b.h_align() &&
                a.v_position() == b.v_position() &&
                a.v_align() == b.v_align() &&
+               a.direction() == b.direction() &&
                a.text() == b.text() &&
                a.effect() == b.effect() &&
-               a.effect_color() == b.effect_color() &&
+               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)
 {
        s << "\n`" << sub.text() << "' from " << sub.in() << " to " << sub.out() << ";\n"
          << "fade up " << sub.fade_up_time() << ", fade down " << sub.fade_down_time() << ";\n"
-         << "font " << sub.font() << ", ";
+         << "font " << sub.font().get_value_or ("[default]") << ", ";
 
        if (sub.italic()) {
-               s << "italic";
+               s << "italic";
        } else {
-               s << "non-italic";
+               s << "non-italic";
        }
-       
-       s << ", size " << sub.size() << ", color " << sub.color() << ", vpos " << sub.v_position() << ", valign " << ((int) sub.v_align()) << ";\n"
-         << "effect " << ((int) sub.effect()) << ", effect color " << sub.effect_color();
+
+       if (sub.bold()) {
+               s << "bold, ";
+       } else {
+               s << "normal, ";
+       }
+
+       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().r << ", " << sub.effect_colour().g << ", " << sub.effect_colour().b << ")"
+         << ", space before " << sub.space_before();
 
        return s;
 }