Comment tweak.
[dcpomatic.git] / src / lib / render_subtitles.cc
index c99827d108da8421faa7a65b8b278283a932d089..35fcd8b93bc6060173d6473a698eb10da024195c 100644 (file)
 #include "cross.h"
 #include "font.h"
 #include "dcpomatic_assert.h"
+#include <dcp/raw_convert.h>
 #include <fontconfig/fontconfig.h>
 #include <cairomm/cairomm.h>
 #include <pangomm.h>
+#ifndef DCPOMATIC_HAVE_SHOW_IN_CAIRO_CONTEXT
+#include <pango/pangocairo.h>
+#endif
 #include <boost/foreach.hpp>
+#include <boost/algorithm/string.hpp>
 #include <iostream>
 
 using std::list;
@@ -40,63 +45,53 @@ using std::cerr;
 using std::make_pair;
 using boost::shared_ptr;
 using boost::optional;
+using boost::algorithm::replace_all;
 
 static FcConfig* fc_config = 0;
 static list<pair<FontFiles, string> > fc_config_fonts;
 
 string
-marked_up (list<SubtitleString> subtitles)
+marked_up (list<SubtitleString> subtitles, int target_height, float fade_factor)
 {
        string out;
-       bool italic = false;
-       bool bold = false;
-       bool underline = false;
-       BOOST_FOREACH (SubtitleString const & i, subtitles) {
 
-               if (i.italic() && !italic) {
-                       out += "<i>";
-               }
-               if (i.bold() && !bold) {
-                       out += "<b>";
-               }
-               if (i.underline() && !underline) {
-                       out += "<u>";
-               }
-               if (!i.underline() && underline) {
-                       out += "</u>";
+       BOOST_FOREACH (SubtitleString const & i, subtitles) {
+               out += "<span ";
+               if (i.italic()) {
+                       out += "style=\"italic\" ";
                }
-               if (!i.bold() && bold) {
-                       out += "</b>";
+               if (i.bold()) {
+                       out += "weight=\"bold\" ";
                }
-               if (!i.italic() && italic) {
-                       out += "</i>";
+               if (i.underline()) {
+                       out += "underline=\"single\" ";
                }
+               out += "size=\"" + dcp::raw_convert<string>(i.size_in_pixels(target_height) * 72 * 1024 / 96) + "\" ";
+               /* Between 1-65535 inclusive, apparently... */
+               out += "alpha=\"" + dcp::raw_convert<string>(int(floor(fade_factor * 65534)) + 1) + "\" ";
+               out += "color=\"#" + i.colour().to_rgb_string() + "\">";
 
-               italic = i.italic ();
-               bold = i.bold ();
-               underline = i.underline ();
-
-               out += i.text ();
-       }
+               string t = i.text();
+               replace_all(t, "&", "&amp;");
+               out += t;
 
-       if (underline) {
-               out += "</u>";
-       }
-       if (bold) {
-               out += "</b>";
-       }
-       if (italic) {
-               out += "</i>";
+               out += "</span>";
        }
 
        return out;
 }
 
+static void
+set_source_rgba (Cairo::RefPtr<Cairo::Context> context, dcp::Colour colour, float fade_factor)
+{
+       context->set_source_rgba (float(colour.r) / 255, float(colour.g) / 255, float(colour.b) / 255, fade_factor);
+}
+
 /** @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 PositionImage
-render_line (list<SubtitleString> subtitles, list<shared_ptr<Font> > fonts, dcp::Size target, DCPTime time)
+render_line (list<SubtitleString> subtitles, list<shared_ptr<Font> > fonts, dcp::Size target, DCPTime time, int frame_rate)
 {
        /* XXX: this method can only handle italic / bold changes mid-line,
           nothing else yet.
@@ -123,14 +118,19 @@ render_line (list<SubtitleString> subtitles, list<shared_ptr<Font> > fonts, dcp:
           least tall enough for this subtitle.
        */
 
+       int largest = 0;
+       BOOST_FOREACH (dcp::SubtitleString const & i, subtitles) {
+               largest = max (largest, i.size());
+       }
        /* Basic guess on height... */
-       int height = subtitles.front().size() * target.height / (11 * 72);
+       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 (new Image (AV_PIX_FMT_RGBA, dcp::Size (target.width, height), false));
+       /* 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 (target.width, height), false));
        image->make_black ();
 
 #ifdef DCPOMATIC_HAVE_FORMAT_STRIDE_FOR_WIDTH
@@ -139,6 +139,7 @@ render_line (list<SubtitleString> subtitles, list<shared_ptr<Font> > fonts, dcp:
                Cairo::FORMAT_ARGB32,
                image->size().width,
                image->size().height,
+               /* Cairo ARGB32 means first byte blue, second byte green, third byte red, fourth byte alpha */
                Cairo::ImageSurface::format_stride_for_width (Cairo::FORMAT_ARGB32, image->size().width)
                );
 #else
@@ -243,27 +244,39 @@ render_line (list<SubtitleString> subtitles, list<shared_ptr<Font> > fonts, dcp:
        layout->set_alignment (Pango::ALIGN_LEFT);
 
        context->set_line_width (1);
-
-       /* Render the subtitle at the top left-hand corner of image */
-
-       Pango::FontDescription font (font_name);
-       font.set_absolute_size (subtitles.front().size_in_pixels (target.height) * PANGO_SCALE);
-       layout->set_font_description (font);
-       layout->set_markup (marked_up (subtitles));
+       context->set_antialias (Cairo::ANTIALIAS_GRAY);
+       Cairo::FontOptions fo;
+       context->get_font_options (fo);
+       fo.set_antialias (Cairo::ANTIALIAS_GRAY);
+       context->set_font_options (fo);
 
        /* Compute fade factor */
        float fade_factor = 1;
 
-       DCPTime const fade_in_start = DCPTime::from_seconds (subtitles.front().in().as_seconds ());
+       /* Round the fade start/end to the nearest frame start.  Otherwise if a subtitle starts just after
+          the start of a frame it will be faded out.
+       */
+       DCPTime const fade_in_start = DCPTime::from_seconds(subtitles.front().in().as_seconds()).round(frame_rate);
        DCPTime const fade_in_end = fade_in_start + DCPTime::from_seconds (subtitles.front().fade_up_time().as_seconds ());
-       DCPTime const fade_out_end =  DCPTime::from_seconds (subtitles.front().out().as_seconds ());
+       DCPTime const fade_out_end =  DCPTime::from_seconds (subtitles.front().out().as_seconds()).round(frame_rate);
        DCPTime const fade_out_start = fade_out_end - DCPTime::from_seconds (subtitles.front().fade_down_time().as_seconds ());
+
        if (fade_in_start <= time && time <= fade_in_end && fade_in_start != fade_in_end) {
-               fade_factor = DCPTime(time - fade_in_start).seconds() / DCPTime(fade_in_end - fade_in_start).seconds();
-       } else if (fade_out_start <= time && time <= fade_out_end && fade_out_start != fade_out_end) {
-               fade_factor = 1 - DCPTime(time - fade_out_start).seconds() / DCPTime(fade_out_end - fade_out_start).seconds();
+               fade_factor *= DCPTime(time - fade_in_start).seconds() / DCPTime(fade_in_end - fade_in_start).seconds();
+       }
+       if (fade_out_start <= time && time <= fade_out_end && fade_out_start != fade_out_end) {
+               fade_factor *= 1 - DCPTime(time - fade_out_start).seconds() / DCPTime(fade_out_end - fade_out_start).seconds();
+       }
+       if (time < fade_in_start || time > fade_out_end) {
+               fade_factor = 0;
        }
 
+       /* Render the subtitle at the top left-hand corner of image */
+
+       Pango::FontDescription font (font_name);
+       layout->set_font_description (font);
+       layout->set_markup (marked_up (subtitles, target.height, fade_factor));
+
        context->scale (xscale, yscale);
        layout->update_from_cairo_context (context);
 
@@ -271,35 +284,36 @@ render_line (list<SubtitleString> subtitles, list<shared_ptr<Font> > fonts, dcp:
           side of the first character's border is not cut off.
        */
        int const x_offset = subtitles.front().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 (subtitles.front().effect() == dcp::SHADOW) {
                /* Drop-shadow effect */
-               dcp::Colour const ec = subtitles.front().effect_colour ();
-               context->set_source_rgba (float(ec.r) / 255, float(ec.g) / 255, float(ec.b) / 255, fade_factor);
-               context->move_to (x_offset + 4, 4);
+               set_source_rgba (context, subtitles.front().effect_colour(), fade_factor);
+               context->move_to (x_offset + 4, y_offset + 4);
                layout->add_to_cairo_context (context);
                context->fill ();
        }
 
        if (subtitles.front().effect() == dcp::BORDER) {
                /* Border effect; stroke the subtitle with a large (arbitrarily chosen) line width */
-               dcp::Colour ec = subtitles.front().effect_colour ();
-               context->set_source_rgba (float(ec.r) / 255, float(ec.g) / 255, float(ec.b) / 255, fade_factor);
+               set_source_rgba (context, subtitles.front().effect_colour(), fade_factor);
                context->set_line_width (subtitles.front().outline_width * target.width / 2048.0);
                context->set_line_join (Cairo::LINE_JOIN_ROUND);
-               context->move_to (x_offset, 0);
+               context->move_to (x_offset, y_offset);
                layout->add_to_cairo_context (context);
                context->stroke ();
        }
 
        /* The actual subtitle */
 
-       dcp::Colour const c = subtitles.front().colour ();
-       context->set_source_rgba (float(c.r) / 255, float(c.g) / 255, float(c.b) / 255, fade_factor);
        context->set_line_width (0);
-       context->move_to (x_offset, 0);
-       layout->add_to_cairo_context (context);
-       context->fill ();
+       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
 
        int layout_width;
        int layout_height;
@@ -347,23 +361,25 @@ render_line (list<SubtitleString> subtitles, list<shared_ptr<Font> > fonts, dcp:
        return PositionImage (image, Position<int> (max (0, x), max (0, y)));
 }
 
-/** @param time Time of the frame that these subtitles are going on */
+/** @param time Time of the frame that these subtitles are going on.
+ *  @param frame_rate DCP frame rate.
+ */
 list<PositionImage>
-render_subtitles (list<SubtitleString> subtitles, list<shared_ptr<Font> > fonts, dcp::Size target, DCPTime time)
+render_subtitles (list<SubtitleString> subtitles, list<shared_ptr<Font> > fonts, dcp::Size target, DCPTime time, int frame_rate)
 {
        list<SubtitleString> pending;
        list<PositionImage> images;
 
        BOOST_FOREACH (SubtitleString const & i, subtitles) {
                if (!pending.empty() && fabs (i.v_position() - pending.back().v_position()) > 1e-4) {
-                       images.push_back (render_line (pending, fonts, target, time));
+                       images.push_back (render_line (pending, fonts, target, time, frame_rate));
                        pending.clear ();
                }
                pending.push_back (i);
        }
 
        if (!pending.empty ()) {
-               images.push_back (render_line (pending, fonts, target, time));
+               images.push_back (render_line (pending, fonts, target, time, frame_rate));
        }
 
        return images;