Give a slightly better error whn trying to add a KDM using add-file (#1035).
[dcpomatic.git] / src / lib / render_subtitles.cc
index 6e4dcf46ad4958d899eb55eccaacf8690041a06b..9426427fd507385a12973e0b02823af4c15b19da 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 <iostream>
 
@@ -45,58 +49,43 @@ static FcConfig* fc_config = 0;
 static list<pair<FontFiles, string> > fc_config_fonts;
 
 string
-marked_up (list<dcp::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 (dcp::SubtitleString const & i, subtitles) {
 
-               if (i.italic() && !italic) {
-                       out += "<i>";
-               }
-               if (i.bold() && !bold) {
-                       out += "<b>";
-               }
-               if (i.underline() && !underline) {
-                       out += "<u>";
+       BOOST_FOREACH (SubtitleString const & i, subtitles) {
+               out += "<span ";
+               if (i.italic()) {
+                       out += "style=\"italic\" ";
                }
-               if (!i.underline() && underline) {
-                       out += "</u>";
+               if (i.bold()) {
+                       out += "weight=\"bold\" ";
                }
-               if (!i.bold() && bold) {
-                       out += "</b>";
+               if (i.underline()) {
+                       out += "underline=\"single\" ";
                }
-               if (!i.italic() && italic) {
-                       out += "</i>";
-               }
-
-               italic = i.italic ();
-               bold = i.bold ();
-               underline = i.underline ();
-
+               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() + "\">";
                out += i.text ();
-       }
-
-       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<dcp::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)
 {
        /* XXX: this method can only handle italic / bold changes mid-line,
           nothing else yet.
@@ -123,8 +112,12 @@ render_line (list<dcp::SubtitleString> subtitles, list<shared_ptr<Font> > fonts,
           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 */
@@ -244,13 +237,6 @@ render_line (list<dcp::SubtitleString> subtitles, list<shared_ptr<Font> > fonts,
 
        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));
-
        /* Compute fade factor */
        float fade_factor = 1;
 
@@ -262,8 +248,16 @@ render_line (list<dcp::SubtitleString> subtitles, list<shared_ptr<Font> > fonts,
                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();
+       } else 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,36 +265,36 @@ render_line (list<dcp::SubtitleString> subtitles, list<shared_ptr<Font> > fonts,
           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);
-               /* This 300.0 is a magic number chosen to make the outline look good */
-               context->set_line_width (target.width / 300.0);
+               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;
@@ -350,12 +344,12 @@ render_line (list<dcp::SubtitleString> subtitles, list<shared_ptr<Font> > fonts,
 
 /** @param time Time of the frame that these subtitles are going on */
 list<PositionImage>
-render_subtitles (list<dcp::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)
 {
-       list<dcp::SubtitleString> pending;
+       list<SubtitleString> pending;
        list<PositionImage> images;
 
-       BOOST_FOREACH (dcp::SubtitleString const & i, subtitles) {
+       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));
                        pending.clear ();