Basic and slightly inaccurate support for <Space> in subtitles (#2103).

[dcpomatic.git] / src / lib / text_decoder.cc

diff --git a/src/lib/text_decoder.cc b/src/lib/text_decoder.cc
index a2241c50b4f9f0b630ae1ed623b28b34f60a383d..99b68faba2b8ae570d7a60cc1cf28f4d67565923 100644 (file)
--- a/src/lib/text_decoder.cc
+++ b/src/lib/text_decoder.cc
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2013-2017 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2013-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -18,6 +18,7 @@
 
 */
 
+
 #include "text_decoder.h"
 #include "text_content.h"
 #include "util.h"
@@ -27,6 +28,7 @@
 #include <boost/algorithm/string.hpp>
 #include <iostream>
 
+
 using std::list;
 using std::cout;
 using std::string;
@@ -34,9 +36,9 @@ using std::min;
 using std::max;
 using std::shared_ptr;
 using boost::optional;
-using boost::function;
 using namespace dcpomatic;
 
+
 TextDecoder::TextDecoder (
        Decoder* parent,
        shared_ptr<const TextContent> c,
@@ -49,6 +51,7 @@ TextDecoder::TextDecoder (
 
 }
 
+
 /** Called by subclasses when an image subtitle is starting.
  *  @param from From time of the subtitle.
  *  @param image Subtitle image.
@@ -57,20 +60,22 @@ TextDecoder::TextDecoder (
  *  of the video frame)
  */
 void
-TextDecoder::emit_bitmap_start (ContentTime from, shared_ptr<Image> image, dcpomatic::Rect<double> rect)
+TextDecoder::emit_bitmap_start (ContentTime from, shared_ptr<const Image> image, dcpomatic::Rect<double> rect)
 {
        BitmapStart (ContentBitmapText (from, image, rect));
        _position = from;
 }
 
+
 void
 TextDecoder::emit_plain_start (ContentTime from, list<dcp::SubtitleString> s)
 {
        for (auto& i: s) {
-               /* We must escape < and > in strings, otherwise they might confuse our subtitle
-                  renderer (which uses some HTML-esque markup to do bold/italic etc.)
+               /* We must escape some things, otherwise they might confuse our subtitle
+                  renderer (which uses entities and some HTML-esque markup to do bold/italic etc.)
                */
                string t = i.text ();
+               boost::algorithm::replace_all (t, "&", "&amp;");
                boost::algorithm::replace_all (t, "<", "&lt;");
                boost::algorithm::replace_all (t, ">", "&gt;");
                i.set_text (t);
@@ -97,6 +102,7 @@ TextDecoder::emit_plain_start (ContentTime from, list<dcp::SubtitleString> s)
        _position = from;
 }
 
+
 void
 TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & subtitle)
 {
@@ -147,16 +153,16 @@ TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & subtitle)
                                        v_position = 1.015 -
                                                (1 + bottom_line.get() - i.vertical_position.line.get()) * multiplier;
 
-                                       v_align = dcp::VALIGN_TOP;
+                                       v_align = dcp::VAlign::TOP;
                                        break;
                                case sub::TOP_OF_SCREEN:
                                        /* This 0.1 is another fudge factor to bring the top line away from the top of the screen a little */
                                        v_position = 0.12 + i.vertical_position.line.get() * multiplier;
-                                       v_align = dcp::VALIGN_TOP;
+                                       v_align = dcp::VAlign::TOP;
                                        break;
                                case sub::VERTICAL_CENTRE_OF_SCREEN:
                                        v_position = i.vertical_position.line.get() * multiplier;
-                                       v_align = dcp::VALIGN_CENTER;
+                                       v_align = dcp::VAlign::CENTER;
                                        break;
                                }
                        } else {
@@ -176,16 +182,16 @@ TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & subtitle)
 
                                switch (i.vertical_position.reference.get()) {
                                case sub::TOP_OF_SCREEN:
-                                       v_align = dcp::VALIGN_TOP;
+                                       v_align = dcp::VAlign::TOP;
                                        break;
                                case sub::VERTICAL_CENTRE_OF_SCREEN:
-                                       v_align = dcp::VALIGN_CENTER;
+                                       v_align = dcp::VAlign::CENTER;
                                        break;
                                case sub::BOTTOM_OF_SCREEN:
-                                       v_align = dcp::VALIGN_BOTTOM;
+                                       v_align = dcp::VAlign::BOTTOM;
                                        break;
                                default:
-                                       v_align = dcp::VALIGN_TOP;
+                                       v_align = dcp::VAlign::TOP;
                                        break;
                                }
                        }
@@ -194,18 +200,18 @@ TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & subtitle)
                        float h_position = i.horizontal_position.proportional;
                        switch (i.horizontal_position.reference) {
                        case sub::LEFT_OF_SCREEN:
-                               h_align = dcp::HALIGN_LEFT;
+                               h_align = dcp::HAlign::LEFT;
                                h_position = max(h_position, 0.05f);
                                break;
                        case sub::HORIZONTAL_CENTRE_OF_SCREEN:
-                               h_align = dcp::HALIGN_CENTER;
+                               h_align = dcp::HAlign::CENTER;
                                break;
                        case sub::RIGHT_OF_SCREEN:
-                               h_align = dcp::HALIGN_RIGHT;
+                               h_align = dcp::HAlign::RIGHT;
                                h_position = max(h_position, 0.05f);
                                break;
                        default:
-                               h_align = dcp::HALIGN_CENTER;
+                               h_align = dcp::HAlign::CENTER;
                                break;
                        }
 
@@ -230,9 +236,9 @@ TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & subtitle)
                                        h_align,
                                        v_position,
                                        v_align,
-                                       dcp::DIRECTION_LTR,
+                                       dcp::Direction::LTR,
                                        j.text,
-                                       dcp::NONE,
+                                       dcp::Effect::NONE,
                                        j.effect_colour.get_value_or(sub::Colour(0, 0, 0)).dcp(),
                                        /* Hack: we should use subtitle.fade_up and subtitle.fade_down here
                                           but the times of these often don't have a frame rate associated
@@ -241,7 +247,8 @@ TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & subtitle)
                                           use libsub for DCP subs) we can cheat by just putting 0 in here.
                                        */
                                        dcp::Time (),
-                                       dcp::Time ()
+                                       dcp::Time (),
+                                       0
                                        )
                                );
                }
@@ -250,12 +257,14 @@ TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & subtitle)
        emit_plain_start (from, out);
 }
 
+
 void
 TextDecoder::emit_stop (ContentTime to)
 {
        Stop (to);
 }
 
+
 void
 TextDecoder::emit_plain (ContentTimePeriod period, list<dcp::SubtitleString> s)
 {
@@ -263,6 +272,7 @@ TextDecoder::emit_plain (ContentTimePeriod period, list<dcp::SubtitleString> s)
        emit_stop (period.to);
 }
 
+
 void
 TextDecoder::emit_plain (ContentTimePeriod period, sub::Subtitle const & s)
 {
@@ -270,17 +280,19 @@ TextDecoder::emit_plain (ContentTimePeriod period, sub::Subtitle const & s)
        emit_stop (period.to);
 }
 
+
 /*  @param rect Area expressed as a fraction of the video frame that this subtitle
  *  is for (e.g. a width of 0.5 means the width of the subtitle is half the width
  *  of the video frame)
  */
 void
-TextDecoder::emit_bitmap (ContentTimePeriod period, shared_ptr<Image> image, dcpomatic::Rect<double> rect)
+TextDecoder::emit_bitmap (ContentTimePeriod period, shared_ptr<const Image> image, dcpomatic::Rect<double> rect)
 {
        emit_bitmap_start (period.from, image, rect);
        emit_stop (period.to);
 }
 
+
 void
 TextDecoder::seek ()
 {