Adapt for libdcp use of enum class.
[dcpomatic.git] / src / lib / render_text.cc
index 26396173e0e2be0d7df441a55f9520e927b39af3..2272d350625109fb66a0a287694324ee9dffeeb1 100644 (file)
 #include "cross.h"
 #include "font.h"
 #include "dcpomatic_assert.h"
+#include "warnings.h"
+#include "util.h"
 #include <dcp/raw_convert.h>
 #include <fontconfig/fontconfig.h>
 #include <cairomm/cairomm.h>
+DCPOMATIC_DISABLE_WARNINGS
 #include <pangomm.h>
+DCPOMATIC_ENABLE_WARNINGS
+#include <pango/pangocairo.h>
 #ifndef DCPOMATIC_HAVE_SHOW_IN_CAIRO_CONTEXT
 #include <pango/pangocairo.h>
 #endif
-#include <boost/foreach.hpp>
 #include <boost/algorithm/string.hpp>
 #include <iostream>
 
@@ -43,7 +47,7 @@ using std::max;
 using std::pair;
 using std::cerr;
 using std::make_pair;
-using boost::shared_ptr;
+using std::shared_ptr;
 using boost::optional;
 using boost::algorithm::replace_all;
 using namespace dcpomatic;
@@ -56,7 +60,7 @@ marked_up (list<StringText> subtitles, int target_height, float fade_factor)
 {
        string out;
 
-       BOOST_FOREACH (StringText const & i, subtitles) {
+       for (auto const& i: subtitles) {
                out += "<span ";
                if (i.italic()) {
                        out += "style=\"italic\" ";
@@ -90,10 +94,10 @@ set_source_rgba (Cairo::RefPtr<Cairo::Context> context, dcp::Colour colour, floa
 
 
 static shared_ptr<Image>
-create_image (int width, int height)
+create_image (dcp::Size size)
 {
        /* FFmpeg BGRA means first byte blue, second byte green, third byte red, fourth byte alpha */
-       shared_ptr<Image> image (new Image (AV_PIX_FMT_BGRA, dcp::Size (width, height), false));
+       shared_ptr<Image> image (new Image(AV_PIX_FMT_BGRA, size, false));
        image->make_black ();
        return image;
 }
@@ -135,21 +139,9 @@ setup_font (StringText const& subtitle, list<shared_ptr<Font> > const& fonts)
                fc_config = FcInitLoadConfig ();
        }
 
-       optional<boost::filesystem::path> font_file;
-
-       try {
-               font_file = shared_path () / "LiberationSans-Regular.ttf";
-       } catch (boost::filesystem::filesystem_error& e) {
-
-       }
-
-       /* Hack: try the debian/ubuntu locations if getting the shared path failed */
-
-       if (!font_file || !boost::filesystem::exists(*font_file)) {
-               font_file = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
-       }
+       optional<boost::filesystem::path> font_file = default_font_file ();
 
-       BOOST_FOREACH (shared_ptr<Font> i, fonts) {
+       for (auto i: fonts) {
                if (i->id() == subtitle.font() && i->file()) {
                        font_file = i->file ();
                }
@@ -232,15 +224,15 @@ x_position (StringText const& first, int target_width, int layout_width)
 {
        int x = 0;
        switch (first.h_align ()) {
-       case dcp::HALIGN_LEFT:
+       case dcp::HAlign::LEFT:
                /* h_position is distance between left of frame and left of subtitle */
                x = first.h_position() * target_width;
                break;
-       case dcp::HALIGN_CENTER:
+       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;
                break;
-       case dcp::HALIGN_RIGHT:
+       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;
                break;
@@ -256,20 +248,20 @@ y_position (StringText const& first, int target_height, int layout_height)
 {
        int y = 0;
        switch (first.v_align ()) {
-       case dcp::VALIGN_TOP:
+       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
+                  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:
+       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:
+       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;
                break;
@@ -279,6 +271,32 @@ y_position (StringText const& first, int target_height, int layout_height)
 }
 
 
+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);
+}
+
+/** Create a Pango layout using a dummy context which we can use to calculate the size
+ *  of the text we will render.  Then we can transfer the layout over to the real context
+ *  for the actual render.
+ */
+static Glib::RefPtr<Pango::Layout>
+create_layout()
+{
+       PangoFontMap* c_font_map = pango_cairo_font_map_new ();
+       DCPOMATIC_ASSERT (c_font_map);
+       Glib::RefPtr<Pango::FontMap> font_map = Glib::wrap (c_font_map);
+       PangoContext* c_context = pango_font_map_create_context (c_font_map);
+       DCPOMATIC_ASSERT (c_context);
+       Glib::RefPtr<Pango::Context> context = Glib::wrap (c_context);
+       return Pango::Layout::create (context);
+}
+
+
 /** @param subtitles A list of subtitles that are all on the same line,
  *  at the same time and with the same fade in/out.
  */
@@ -290,68 +308,55 @@ render_line (list<StringText> subtitles, list<shared_ptr<Font> > fonts, dcp::Siz
        */
 
        DCPOMATIC_ASSERT (!subtitles.empty ());
-
        StringText const& first = subtitles.front ();
 
+       string const font_name = setup_font (first, fonts);
+       float const fade_factor = calculate_fade_factor (first, time, frame_rate);
+       string const markup = marked_up (subtitles, target.height, fade_factor);
+       Glib::RefPtr<Pango::Layout> layout = create_layout ();
+       setup_layout (layout, font_name, markup);
+       dcp::Size size;
+       layout->get_pixel_size (size.width, size.height);
+
        /* Calculate x and y scale factors.  These are only used to stretch
           the font away from its normal aspect ratio.
        */
-       float xscale = 1;
-       float yscale = 1;
+       float x_scale = 1;
+       float y_scale = 1;
        if (fabs (first.aspect_adjust() - 1.0) > dcp::ASPECT_ADJUST_EPSILON) {
                if (first.aspect_adjust() < 1) {
-                       xscale = max (0.25f, first.aspect_adjust ());
-                       yscale = 1;
+                       x_scale = max (0.25f, first.aspect_adjust ());
+                       y_scale = 1;
                } else {
-                       xscale = 1;
-                       yscale = 1 / min (4.0f, first.aspect_adjust ());
+                       x_scale = 1;
+                       y_scale = 1 / min (4.0f, first.aspect_adjust ());
                }
        }
 
-       /* Make an empty bitmap as wide as target and at
-          least tall enough for this subtitle.
-       */
+       float 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);
 
-       int largest = 0;
-       BOOST_FOREACH (dcp::SubtitleString const & i, subtitles) {
-               largest = max (largest, i.size());
-       }
-       /* Basic guess on height... */
-       int height = largest * target.height / (11 * 72);
-       /* ...scaled... */
-       height *= yscale;
-       /* ...and add a bit more for luck */
-       height += target.height / 11;
-
-       shared_ptr<Image> image = create_image (target.width, height);
-       Cairo::RefPtr<Cairo::Surface> surface = create_surface (image);
-       Cairo::RefPtr<Cairo::Context> context = Cairo::Context::create (surface);
-       string const font_name = setup_font (first, fonts);
-       Glib::RefPtr<Pango::Layout> layout = Pango::Layout::create (context);
-
-       layout->set_alignment (Pango::ALIGN_LEFT);
-
-       context->set_line_width (1);
+       size.width *= x_scale;
+       size.height *= y_scale;
 
-       float const fade_factor = calculate_fade_factor (first, time, frame_rate);
+       /* 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;
 
-       /* Render the subtitle at the top left-hand corner of image */
+       size.width += x_offset;
+       size.height += y_offset;
 
-       Pango::FontDescription font (font_name);
-       layout->set_font_description (font);
-       layout->set_markup (marked_up (subtitles, target.height, fade_factor));
+       shared_ptr<Image> image = create_image (size);
+       Cairo::RefPtr<Cairo::Surface> surface = create_surface (image);
+       Cairo::RefPtr<Cairo::Context> context = Cairo::Context::create (surface);
 
-       context->scale (xscale, yscale);
+       context->set_line_width (1);
+       context->scale (x_scale, y_scale);
        layout->update_from_cairo_context (context);
 
-       /* Shuffle the subtitle over very slightly if it has a border so that the left-hand
-          side of the first character's border is not cut off.
-       */
-       int const x_offset = first.effect() == dcp::BORDER ? (target.width / 600.0) : 0;
-       /* Move down a bit so that accents on capital letters can be seen */
-       int const y_offset = target.height / 100.0;
-
-       if (first.effect() == dcp::SHADOW) {
+       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);
@@ -359,10 +364,10 @@ render_line (list<StringText> subtitles, list<shared_ptr<Font> > fonts, dcp::Siz
                context->fill ();
        }
 
-       if (first.effect() == dcp::BORDER) {
-               /* Border effect; stroke the subtitle with a large (arbitrarily chosen) line width */
+       if (first.effect() == dcp::Effect::BORDER) {
+               /* Border effect */
                set_source_rgba (context, first.effect_colour(), fade_factor);
-               context->set_line_width (first.outline_width * target.width / 2048.0);
+               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);
@@ -371,26 +376,25 @@ render_line (list<StringText> subtitles, list<shared_ptr<Font> > fonts, dcp::Siz
 
        /* The actual subtitle */
 
-       context->set_line_width (0);
+       set_source_rgba (context, first.colour(), fade_factor);
+
        context->move_to (x_offset, y_offset);
-#ifdef DCPOMATIC_HAVE_SHOW_IN_CAIRO_CONTEXT
-       layout->show_in_cairo_context (context);
-#else
-       pango_cairo_show_layout (context->cobj(), layout->gobj());
-#endif
+       layout->add_to_cairo_context (context);
+       context->fill ();
 
-       int layout_width;
-       int layout_height;
-       layout->get_pixel_size (layout_width, layout_height);
-       layout_width *= xscale;
-       layout_height *= yscale;
+       context->set_line_width (0.5);
+       context->move_to (x_offset, y_offset);
+       layout->add_to_cairo_context (context);
+       context->stroke ();
 
-       int const x = x_position (first, target.width, layout_width);
-       int const y = y_position (first, target.height, layout_height);
-       return PositionImage (image, Position<int> (max (0, x), max (0, y)));
+       int const x = x_position (first, target.width, size.width);
+       int const y = y_position (first, target.height, size.height);
+       return PositionImage (image, Position<int>(max (0, x), max(0, y)));
 }
 
+
 /** @param time Time of the frame that these subtitles are going on.
+ *  @param target Size of the container that this subtitle will end up in.
  *  @param frame_rate DCP frame rate.
  */
 list<PositionImage>
@@ -399,7 +403,7 @@ render_text (list<StringText> subtitles, list<shared_ptr<Font> > fonts, dcp::Siz
        list<StringText> pending;
        list<PositionImage> images;
 
-       BOOST_FOREACH (StringText const & i, subtitles) {
+       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)) {
                        images.push_back (render_line (pending, fonts, target, time, frame_rate));
                        pending.clear ();