Fix subtitle font handling with in-memory fonts from SMPTE (#2509).
[dcpomatic.git] / src / lib / render_text.cc
index 284e4fa88924ea97b027e5154a99ea159f88f76a..1a06722626d140fdd3b0b32b9a442734a7a3fb5f 100644 (file)
@@ -25,7 +25,6 @@
 #include "font_config.h"
 #include "image.h"
 #include "render_text.h"
-#include "types.h"
 #include "util.h"
 #include <dcp/raw_convert.h>
 #include <dcp/warnings.h>
@@ -48,6 +47,7 @@ using std::min;
 using std::pair;
 using std::shared_ptr;
 using std::string;
+using boost::optional;
 using namespace dcpomatic;
 
 
@@ -56,7 +56,7 @@ using namespace dcpomatic;
  *  for the actual render.
  */
 static Glib::RefPtr<Pango::Layout>
-create_layout()
+create_layout(string font_name, string markup)
 {
        auto c_font_map = pango_cairo_font_map_new ();
        DCPOMATIC_ASSERT (c_font_map);
@@ -64,17 +64,14 @@ create_layout()
        auto c_context = pango_font_map_create_context (c_font_map);
        DCPOMATIC_ASSERT (c_context);
        auto context = Glib::wrap (c_context);
-       return Pango::Layout::create (context);
-}
-
+       auto layout = Pango::Layout::create(context);
 
-static void
-setup_layout (Glib::RefPtr<Pango::Layout> layout, string font_name, string markup)
-{
        layout->set_alignment (Pango::ALIGN_LEFT);
        Pango::FontDescription font (font_name);
        layout->set_font_description (font);
        layout->set_markup (markup);
+
+       return layout;
 }
 
 
@@ -103,6 +100,11 @@ marked_up (list<StringText> subtitles, int target_height, float fade_factor, str
                        span += " " + extra_attribute;
                }
                span += ">";
+
+               boost::algorithm::replace_all(text, "&", "&amp;");
+               boost::algorithm::replace_all(text, "<", "&lt;");
+               boost::algorithm::replace_all(text, ">", "&gt;");
+
                span += text;
                span += "</span>";
                return span;
@@ -116,8 +118,7 @@ marked_up (list<StringText> subtitles, int target_height, float fade_factor, str
                         * be written with letter_spacing either side.  This means that to get a horizontal space x we
                         * need to write a " " with letter spacing (x - s) / 2, where s is the width of the " ".
                         */
-                       auto layout = create_layout();
-                       setup_layout(layout, font_name, make_span(i, " ", {}));
+                       auto layout = create_layout(font_name, make_span(i, " ", {}));
                        int space_width;
                        int dummy;
                        layout->get_pixel_size(space_width, dummy);
@@ -170,19 +171,6 @@ create_surface (shared_ptr<Image> image)
 }
 
 
-static string
-setup_font (StringText const& subtitle)
-{
-       auto font_file = default_font_file ();
-
-       if (subtitle.font && subtitle.font->file()) {
-               font_file = *subtitle.font->file();
-       }
-
-       return FontConfig::instance()->make_font_available(font_file);
-}
-
-
 static float
 calculate_fade_factor (StringText const& first, DCPTime time, int frame_rate)
 {
@@ -222,21 +210,21 @@ calculate_fade_factor (StringText const& first, DCPTime time, int frame_rate)
 
 
 static int
-x_position (StringText const& first, int target_width, int layout_width)
+x_position(dcp::HAlign align, float position, int target_width, int layout_width)
 {
        int x = 0;
-       switch (first.h_align()) {
+       switch (align) {
        case dcp::HAlign::LEFT:
                /* h_position is distance between left of frame and left of subtitle */
-               x = first.h_position() * target_width;
+               x = position * target_width;
                break;
        case dcp::HAlign::CENTER:
                /* h_position is distance between centre of frame and centre of subtitle */
-               x = (0.5 + first.h_position()) * target_width - layout_width / 2;
+               x = (0.5 + position) * target_width - layout_width / 2;
                break;
        case dcp::HAlign::RIGHT:
                /* h_position is distance between right of frame and right of subtitle */
-               x = (1.0 - first.h_position()) * target_width - layout_width;
+               x = (1.0 - position) * target_width - layout_width;
                break;
        }
 
@@ -244,34 +232,84 @@ x_position (StringText const& first, int target_width, int layout_width)
 }
 
 
+/** @param align_standard Standard with which to interpret this subtitle's position.
+ *  @param align alignment.
+ *  @param position position (between 0 and 1)
+ *  @param target_height Height of the target screen (in pixels).
+ *  @param baseline_to_bottom Distance from text baseline to the bottom of the bounding box (in pixels).
+ *  @param layout_height Height of the subtitle bounding box (in pixels).
+ *  @return y position of the top of the subtitle bounding box (in pixels) from the top of the screen.
+ */
 static int
-y_position (StringText const& first, int target_height, int layout_height)
+y_position(dcp::SubtitleStandard standard, dcp::VAlign align, float position, int target_height, int baseline_to_bottom, int layout_height)
 {
        int y = 0;
-       switch (first.v_align()) {
-       case dcp::VAlign::TOP:
-               /* SMPTE says that v_position is the distance between top
-                  of frame and top of subtitle, but this doesn't always seem to be
-                  the case in practice; Gunnar Ásgeirsson's Dolby server appears
-                  to put VAlign::TOP subs with v_position as the distance between top
-                  of frame and bottom of subtitle.
-               */
-               y = first.v_position() * target_height - layout_height;
-               break;
-       case dcp::VAlign::CENTER:
-               /* v_position is distance between centre of frame and centre of subtitle */
-               y = (0.5 + first.v_position()) * target_height - layout_height / 2;
-               break;
-       case dcp::VAlign::BOTTOM:
-               /* v_position is distance between bottom of frame and bottom of subtitle */
-               y = (1.0 - first.v_position()) * target_height - layout_height;
+       switch (standard) {
+       case dcp::SubtitleStandard::INTEROP:
+       case dcp::SubtitleStandard::SMPTE_2014:
+               switch (align) {
+               case dcp::VAlign::TOP:
+                       /* position is distance from top of frame to subtitle baseline */
+                       y = position * target_height - (layout_height - baseline_to_bottom);
+                       break;
+               case dcp::VAlign::CENTER:
+                       /* position is distance from centre of frame to subtitle baseline */
+                       y = (0.5 + position) * target_height - (layout_height - baseline_to_bottom);
+                       break;
+               case dcp::VAlign::BOTTOM:
+                       /* position is distance from bottom of frame to subtitle baseline */
+                       y = (1.0 - position) * target_height - (layout_height - baseline_to_bottom);
+                       break;
+               }
                break;
+       case dcp::SubtitleStandard::SMPTE_2007:
+       case dcp::SubtitleStandard::SMPTE_2010:
+               switch (align) {
+               case dcp::VAlign::TOP:
+                       /* v_position is distance from top of frame to top of subtitle */
+                       y = position * target_height;
+                       break;
+               case dcp::VAlign::CENTER:
+                       /* v_position is distance from centre of frame to centre of subtitle */
+                       y = (0.5 + position) * target_height - layout_height / 2;
+                       break;
+               case dcp::VAlign::BOTTOM:
+                       /* v_position is distance from bottom of frame to bottom of subtitle */
+                       y = (1.0 - position) * target_height - layout_height;
+                       break;
+               }
        }
 
        return y;
 }
 
 
+struct Layout
+{
+       Position<int> position;
+       dcp::Size size;
+       Glib::RefPtr<Pango::Layout> pango;
+};
+
+
+/** @param subtitles A list of subtitles that are all on the same line,
+ *  at the same time and with the same fade in/out.
+ */
+static Layout
+setup_layout(list<StringText> subtitles, dcp::Size target, DCPTime time, int frame_rate)
+{
+       DCPOMATIC_ASSERT(!subtitles.empty());
+       auto const& first = subtitles.front();
+
+       auto const font_name = FontConfig::instance()->make_font_available(first.font);
+       auto const fade_factor = calculate_fade_factor(first, time, frame_rate);
+       auto const markup = marked_up(subtitles, target.height, fade_factor, font_name);
+       auto layout = create_layout(font_name, markup);
+       auto ink = layout->get_ink_extents();
+       return { { ink.get_x() / Pango::SCALE, ink.get_y() / Pango::SCALE }, { ink.get_width() / Pango::SCALE, ink.get_height() / Pango::SCALE }, layout };
+}
+
+
 /** @param subtitles A list of subtitles that are all on the same line,
  *  at the same time and with the same fade in/out.
  */
@@ -282,16 +320,11 @@ render_line (list<StringText> subtitles, dcp::Size target, DCPTime time, int fra
           nothing else yet.
        */
 
-       DCPOMATIC_ASSERT (!subtitles.empty ());
-       auto const& first = subtitles.front ();
+       DCPOMATIC_ASSERT(!subtitles.empty ());
+       auto const& first = subtitles.front();
+       auto const fade_factor = calculate_fade_factor(first, time, frame_rate);
 
-       auto const font_name = setup_font (first);
-       auto const fade_factor = calculate_fade_factor (first, time, frame_rate);
-       auto const markup = marked_up (subtitles, target.height, fade_factor, font_name);
-       auto layout = create_layout ();
-       setup_layout (layout, font_name, markup);
-       dcp::Size size;
-       layout->get_pixel_size (size.width, size.height);
+       auto layout = setup_layout(subtitles, target, time, frame_rate);
 
        /* Calculate x and y scale factors.  These are only used to stretch
           the font away from its normal aspect ratio.
@@ -309,33 +342,29 @@ render_line (list<StringText> subtitles, dcp::Size target, DCPTime time, int fra
        }
 
        auto const border_width = first.effect() == dcp::Effect::BORDER ? (first.outline_width * target.width / 2048.0) : 0;
-       size.width += 2 * ceil (border_width);
-       size.height += 2 * ceil (border_width);
+       layout.size.width += 2 * ceil (border_width);
+       layout.size.height += 2 * ceil (border_width);
 
-       size.width *= x_scale;
-       size.height *= y_scale;
+       layout.size.width *= x_scale;
+       layout.size.height *= y_scale;
 
        /* Shuffle the subtitle over by the border width (if we have any) so it's not cut off */
-       int const x_offset = ceil (border_width);
-       /* Move down a bit so that accents on capital letters can be seen */
-       int const y_offset = target.height / 100.0;
-
-       size.width += x_offset;
-       size.height += y_offset;
+       int const x_offset = -layout.position.x + ceil(border_width);
+       int const y_offset = -layout.position.y + ceil(border_width);
 
-       auto image = create_image (size);
+       auto image = create_image(layout.size);
        auto surface = create_surface (image);
        auto context = Cairo::Context::create (surface);
 
        context->set_line_width (1);
        context->scale (x_scale, y_scale);
-       layout->update_from_cairo_context (context);
+       layout.pango->update_from_cairo_context(context);
 
        if (first.effect() == dcp::Effect::SHADOW) {
                /* Drop-shadow effect */
                set_source_rgba (context, first.effect_colour(), fade_factor);
                context->move_to (x_offset + 4, y_offset + 4);
-               layout->add_to_cairo_context (context);
+               layout.pango->add_to_cairo_context(context);
                context->fill ();
        }
 
@@ -345,7 +374,7 @@ render_line (list<StringText> subtitles, dcp::Size target, DCPTime time, int fra
                context->set_line_width (border_width);
                context->set_line_join (Cairo::LINE_JOIN_ROUND);
                context->move_to (x_offset, y_offset);
-               layout->add_to_cairo_context (context);
+               layout.pango->add_to_cairo_context (context);
                context->stroke ();
        }
 
@@ -354,16 +383,16 @@ render_line (list<StringText> subtitles, dcp::Size target, DCPTime time, int fra
        set_source_rgba (context, first.colour(), fade_factor);
 
        context->move_to (x_offset, y_offset);
-       layout->add_to_cairo_context (context);
+       layout.pango->add_to_cairo_context (context);
        context->fill ();
 
        context->set_line_width (0.5);
        context->move_to (x_offset, y_offset);
-       layout->add_to_cairo_context (context);
+       layout.pango->add_to_cairo_context (context);
        context->stroke ();
 
-       int const x = x_position (first, target.width, size.width);
-       int const y = y_position (first, target.height, size.height);
+       int const x = x_position(first.h_align(), first.h_position(), target.width, layout.size.width);
+       int const y = y_position(first.valign_standard, first.v_align(), first.v_position(), target.height, layout.position.y, layout.size.height);
        return PositionImage (image, Position<int>(max (0, x), max(0, y)));
 }
 
@@ -387,8 +416,99 @@ render_text (list<StringText> subtitles, dcp::Size target, DCPTime time, int fra
        }
 
        if (!pending.empty()) {
-               images.push_back(render_line(pending,  target, time, frame_rate));
+               images.push_back(render_line(pending, target, time, frame_rate));
        }
 
        return images;
 }
+
+
+list<dcpomatic::Rect<int>>
+bounding_box(list<StringText> subtitles, dcp::Size target, optional<dcp::SubtitleStandard> override_standard)
+{
+       list<StringText> pending;
+       list<dcpomatic::Rect<int>> rects;
+
+       auto use_pending = [&pending, &rects, target, override_standard]() {
+               auto const& subtitle = pending.front();
+               auto standard = override_standard.get_value_or(subtitle.valign_standard);
+               /* We can provide dummy values for time and frame rate here as they are only used to calculate fades */
+               auto layout = setup_layout(pending, target, DCPTime(), 24);
+               int const x = x_position(subtitle.h_align(), subtitle.h_position(), target.width, layout.size.width);
+               int const y = y_position(standard, subtitle.v_align(), subtitle.v_position(), target.height, layout.position.y, layout.size.height);
+               rects.push_back({Position<int>(x, y), layout.size.width, layout.size.height});
+       };
+
+       for (auto const& i: subtitles) {
+               if (!pending.empty() && (i.v_align() != pending.back().v_align() || fabs(i.v_position() - pending.back().v_position()) > 1e-4)) {
+                       use_pending();
+                       pending.clear();
+               }
+               pending.push_back(i);
+       }
+
+       if (!pending.empty()) {
+               use_pending();
+       }
+
+       return rects;
+}
+
+
+float
+FontMetrics::height(StringText const& subtitle)
+{
+       return get(subtitle)->second.second;
+}
+
+
+float
+FontMetrics::baseline_to_bottom(StringText const& subtitle)
+{
+       return get(subtitle)->second.first;
+}
+
+
+FontMetrics::Cache::iterator
+FontMetrics::get(StringText const& subtitle)
+{
+       auto id = Identifier(subtitle);
+
+       auto iter = _cache.find(id);
+       if (iter != _cache.end()) {
+               return iter;
+       }
+
+       auto const font_name = FontConfig::instance()->make_font_available(subtitle.font);
+       auto copy = subtitle;
+       copy.set_text("Qypjg");
+       auto layout = create_layout(font_name, marked_up({copy}, _target_height, 1, font_name));
+       auto ink = layout->get_ink_extents();
+       auto const scale = float(_target_height * Pango::SCALE);
+       return _cache.insert({id, { ink.get_y() / scale, ink.get_height() / scale}}).first;
+}
+
+
+FontMetrics::Identifier::Identifier(StringText const& subtitle)
+       : font(subtitle.font)
+       , size(subtitle.size())
+       , aspect_adjust(subtitle.aspect_adjust())
+{
+
+}
+
+
+bool
+FontMetrics::Identifier::operator<(FontMetrics::Identifier const& other) const
+{
+       if (font != other.font) {
+               return font < other.font;
+       }
+
+       if (size != other.size) {
+           return size < other.size;
+       }
+
+       return aspect_adjust < other.aspect_adjust;
+}
+