Add comment.
[dcpomatic.git] / src / lib / text_decoder.cc
index 313fbaa5c669ee3328768257d805525c9d2de20e..6ee6ed079879e014c33df5c2c4bc36e79b336881 100644 (file)
@@ -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.
 
 
 */
 
+
 #include "text_decoder.h"
 #include "text_content.h"
 #include "util.h"
 #include "log.h"
 #include "compose.hpp"
 #include <sub/subtitle.h>
-#include <boost/shared_ptr.hpp>
-#include <boost/foreach.hpp>
 #include <boost/algorithm/string.hpp>
 #include <iostream>
 
+
 using std::list;
 using std::cout;
 using std::string;
 using std::min;
 using std::max;
-using boost::shared_ptr;
+using std::shared_ptr;
 using boost::optional;
-using boost::function;
+using std::function;
 using namespace dcpomatic;
 
+
 TextDecoder::TextDecoder (
        Decoder* parent,
        shared_ptr<const TextContent> c,
@@ -51,6 +52,7 @@ TextDecoder::TextDecoder (
 
 }
 
+
 /** Called by subclasses when an image subtitle is starting.
  *  @param from From time of the subtitle.
  *  @param image Subtitle image.
@@ -65,14 +67,16 @@ TextDecoder::emit_bitmap_start (ContentTime from, shared_ptr<Image> image, dcpom
        _position = from;
 }
 
+
 void
 TextDecoder::emit_plain_start (ContentTime from, list<dcp::SubtitleString> s)
 {
-       BOOST_FOREACH (dcp::SubtitleString& 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.)
+       for (auto& i: s) {
+               /* 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);
@@ -99,16 +103,16 @@ TextDecoder::emit_plain_start (ContentTime from, list<dcp::SubtitleString> s)
        _position = from;
 }
 
+
 void
 TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & subtitle)
 {
        /* See if our next subtitle needs to be vertically placed on screen by us */
        bool needs_placement = false;
        optional<int> bottom_line;
-       BOOST_FOREACH (sub::Line i, subtitle.lines) {
-               if (!i.vertical_position.reference || !i.vertical_position.lines || i.vertical_position.reference.get() == sub::TOP_OF_SUBTITLE) {
+       for (auto i: subtitle.lines) {
+               if (!i.vertical_position.reference || (i.vertical_position.line && !i.vertical_position.lines) || i.vertical_position.reference.get() == sub::TOP_OF_SUBTITLE) {
                        needs_placement = true;
-                       DCPOMATIC_ASSERT (i.vertical_position.line);
                        if (!bottom_line || bottom_line.get() < i.vertical_position.line.get()) {
                                bottom_line = i.vertical_position.line.get();
                        }
@@ -117,7 +121,7 @@ TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & subtitle)
 
        /* Find the lowest proportional position */
        optional<float> lowest_proportional;
-       BOOST_FOREACH (sub::Line i, subtitle.lines) {
+       for (auto i: subtitle.lines) {
                if (i.vertical_position.proportional) {
                        if (!lowest_proportional) {
                                lowest_proportional = i.vertical_position.proportional;
@@ -128,8 +132,8 @@ TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & subtitle)
        }
 
        list<dcp::SubtitleString> out;
-       BOOST_FOREACH (sub::Line i, subtitle.lines) {
-               BOOST_FOREACH (sub::Block j, i.blocks) {
+       for (auto i: subtitle.lines) {
+               for (auto j: i.blocks) {
 
                        if (!j.font_size.specified()) {
                                /* Fallback default font size if no other has been specified */
@@ -140,14 +144,28 @@ TextDecoder::emit_plain_start (ContentTime from, sub::Subtitle const & subtitle)
                        dcp::VAlign v_align;
                        if (needs_placement) {
                                DCPOMATIC_ASSERT (i.vertical_position.line);
-                               /* This 1.015 is an arbitrary value to lift the bottom sub off the bottom
-                                  of the screen a bit to a pleasing degree.
-                               */
-                               v_position = 1.015 -
-                                       (1 + bottom_line.get() - i.vertical_position.line.get())
-                                       * 1.2 * content()->line_spacing() * content()->y_scale() * j.font_size.proportional (72 * 11);
-
-                               v_align = dcp::VALIGN_TOP;
+                               double const multiplier = 1.2 * content()->line_spacing() * content()->y_scale() * j.font_size.proportional (72 * 11);
+                               switch (i.vertical_position.reference.get_value_or(sub::BOTTOM_OF_SCREEN)) {
+                               case sub::BOTTOM_OF_SCREEN:
+                               case sub::TOP_OF_SUBTITLE:
+                                       /* This 1.015 is an arbitrary value to lift the bottom sub off the bottom
+                                          of the screen a bit to a pleasing degree.
+                                          */
+                                       v_position = 1.015 -
+                                               (1 + bottom_line.get() - i.vertical_position.line.get()) * multiplier;
+
+                                       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;
+                                       break;
+                               case sub::VERTICAL_CENTRE_OF_SCREEN:
+                                       v_position = i.vertical_position.line.get() * multiplier;
+                                       v_align = dcp::VAlign::CENTER;
+                                       break;
+                               }
                        } else {
                                DCPOMATIC_ASSERT (i.vertical_position.reference);
                                if (i.vertical_position.proportional) {
@@ -165,16 +183,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;
                                }
                        }
@@ -183,18 +201,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;
                        }
 
@@ -219,9 +237,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
@@ -239,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)
 {
@@ -252,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)
 {
@@ -259,6 +280,7 @@ 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)
@@ -270,6 +292,7 @@ TextDecoder::emit_bitmap (ContentTimePeriod period, shared_ptr<Image> image, dcp
        emit_stop (period.to);
 }
 
+
 void
 TextDecoder::seek ()
 {