Make burnt-in subtitle outline width configurable (#940).
[dcpomatic.git] / src / lib / render_subtitles.cc
index dd8e8870b780df70363acda41518870ef5f7b05c..c99827d108da8421faa7a65b8b278283a932d089 100644 (file)
@@ -1,19 +1,20 @@
 /*
-    Copyright (C) 2014-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
@@ -23,6 +24,7 @@
 #include "cross.h"
 #include "font.h"
 #include "dcpomatic_assert.h"
+#include <fontconfig/fontconfig.h>
 #include <cairomm/cairomm.h>
 #include <pangomm.h>
 #include <boost/foreach.hpp>
@@ -42,9 +44,59 @@ using boost::optional;
 static FcConfig* fc_config = 0;
 static list<pair<FontFiles, string> > fc_config_fonts;
 
-/** @param subtitles A list of subtitles that are all on the same line */
+string
+marked_up (list<SubtitleString> subtitles)
+{
+       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>";
+               }
+               if (!i.bold() && bold) {
+                       out += "</b>";
+               }
+               if (!i.italic() && italic) {
+                       out += "</i>";
+               }
+
+               italic = i.italic ();
+               bold = i.bold ();
+               underline = i.underline ();
+
+               out += i.text ();
+       }
+
+       if (underline) {
+               out += "</u>";
+       }
+       if (bold) {
+               out += "</b>";
+       }
+       if (italic) {
+               out += "</i>";
+       }
+
+       return out;
+}
+
+/** @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)
+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.
@@ -81,6 +133,7 @@ render_line (list<dcp::SubtitleString> subtitles, list<shared_ptr<Font> > fonts,
        shared_ptr<Image> image (new Image (AV_PIX_FMT_RGBA, dcp::Size (target.width, height), false));
        image->make_black ();
 
+#ifdef DCPOMATIC_HAVE_FORMAT_STRIDE_FOR_WIDTH
        Cairo::RefPtr<Cairo::ImageSurface> surface = Cairo::ImageSurface::create (
                image->data()[0],
                Cairo::FORMAT_ARGB32,
@@ -88,6 +141,18 @@ render_line (list<dcp::SubtitleString> subtitles, list<shared_ptr<Font> > fonts,
                image->size().height,
                Cairo::ImageSurface::format_stride_for_width (Cairo::FORMAT_ARGB32, image->size().width)
                );
+#else
+       /* Centos 5 does not have Cairo::ImageSurface::format_stride_for_width, so just use width * 4
+          which I hope is safe (if slow)
+       */
+       Cairo::RefPtr<Cairo::ImageSurface> surface = Cairo::ImageSurface::create (
+               image->data()[0],
+               Cairo::FORMAT_ARGB32,
+               image->size().width,
+               image->size().height,
+               image->size().width * 4
+               );
+#endif
 
        Cairo::RefPtr<Cairo::Context> context = Cairo::Context::create (surface);
 
@@ -142,7 +207,9 @@ render_line (list<dcp::SubtitleString> subtitles, list<shared_ptr<Font> > fonts,
                        }
                }
 
-               FcPattern* pattern = FcPatternBuild (0, FC_FILE, FcTypeString, font_files.get(FontFiles::NORMAL).get().string().c_str(), static_cast<char *> (0));
+               FcPattern* pattern = FcPatternBuild (
+                       0, FC_FILE, FcTypeString, font_files.get(FontFiles::NORMAL).get().string().c_str(), static_cast<char *> (0)
+                       );
                FcObjectSet* object_set = FcObjectSetBuild (FC_FAMILY, FC_STYLE, FC_LANG, FC_FILE, static_cast<char *> (0));
                FcFontSet* font_set = FcFontList (fc_config, pattern, object_set);
                if (font_set) {
@@ -182,65 +249,63 @@ render_line (list<dcp::SubtitleString> subtitles, list<shared_ptr<Font> > fonts,
        Pango::FontDescription font (font_name);
        font.set_absolute_size (subtitles.front().size_in_pixels (target.height) * PANGO_SCALE);
        layout->set_font_description (font);
-
-       string marked_up;
-       bool italic = false;
-       BOOST_FOREACH (dcp::SubtitleString const & i, subtitles) {
-               if (i.italic() != italic) {
-                       if (i.italic()) {
-                               marked_up += "<i>";
-                       } else {
-                               marked_up += "</i>";
-                       }
-                       italic = i.italic ();
-               }
-
-               marked_up += i.text ();
-       }
-
-       if (italic) {
-               marked_up += "</i>";
-       }
-
-       layout->set_markup (marked_up);
+       layout->set_markup (marked_up (subtitles));
 
        /* Compute fade factor */
-       /* XXX */
        float fade_factor = 1;
 
-       layout->update_from_cairo_context (context);
+       DCPTime const fade_in_start = DCPTime::from_seconds (subtitles.front().in().as_seconds ());
+       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_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();
+       }
 
        context->scale (xscale, yscale);
+       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 = subtitles.front().effect() == dcp::BORDER ? (target.width / 600.0) : 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 (4, 4);
+               context->move_to (x_offset + 4, 4);
                layout->add_to_cairo_context (context);
                context->fill ();
        }
 
-       /* 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->move_to (0, 0);
-       layout->add_to_cairo_context (context);
-       context->fill ();
-
        if (subtitles.front().effect() == dcp::BORDER) {
-               /* Border effect */
+               /* 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);
-               context->move_to (0, 0);
+               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);
                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 ();
+
        int layout_width;
        int layout_height;
        layout->get_pixel_size (layout_width, layout_height);
+       layout_width *= xscale;
+       layout_height *= yscale;
 
        int x = 0;
        switch (subtitles.front().h_align ()) {
@@ -282,22 +347,23 @@ render_line (list<dcp::SubtitleString> subtitles, list<shared_ptr<Font> > fonts,
        return PositionImage (image, Position<int> (max (0, x), max (0, y)));
 }
 
+/** @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)
+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));
+                       images.push_back (render_line (pending, fonts, target, time));
                        pending.clear ();
                }
                pending.push_back (i);
        }
 
        if (!pending.empty ()) {
-               images.push_back (render_line (pending, fonts, target));
+               images.push_back (render_line (pending, fonts, target, time));
        }
 
        return images;