Comment tweak.
[dcpomatic.git] / src / lib / render_subtitles.cc
index ed7d131fd7455352d6a49aa695629eb2a9667814..35fcd8b93bc6060173d6473a698eb10da024195c 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/>.
 
 */
 
 #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;
@@ -38,13 +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;
 
-/** @param subtitles A list of subtitles that are all on the same line */
+string
+marked_up (list<SubtitleString> subtitles, int target_height, float fade_factor)
+{
+       string out;
+
+       BOOST_FOREACH (SubtitleString const & i, subtitles) {
+               out += "<span ";
+               if (i.italic()) {
+                       out += "style=\"italic\" ";
+               }
+               if (i.bold()) {
+                       out += "weight=\"bold\" ";
+               }
+               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() + "\">";
+
+               string t = i.text();
+               replace_all(t, "&", "&amp;");
+               out += t;
+
+               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)
+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.
@@ -71,23 +118,42 @@ 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 */
        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
        Cairo::RefPtr<Cairo::ImageSurface> surface = Cairo::ImageSurface::create (
                image->data()[0],
                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
+       /* 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 +208,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) {
@@ -176,67 +244,77 @@ render_line (list<dcp::SubtitleString> subtitles, list<shared_ptr<Font> > fonts,
        layout->set_alignment (Pango::ALIGN_LEFT);
 
        context->set_line_width (1);
+       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);
 
-       /* 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);
+       /* Compute fade factor */
+       float fade_factor = 1;
 
-       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 ();
-               }
+       /* 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()).round(frame_rate);
+       DCPTime const fade_out_start = fade_out_end - DCPTime::from_seconds (subtitles.front().fade_down_time().as_seconds ());
 
-               marked_up += i.text ();
+       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();
        }
-
-       if (italic) {
-               marked_up += "</i>";
+       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;
        }
 
-       layout->set_markup (marked_up);
+       /* Render the subtitle at the top left-hand corner of image */
 
-       /* Compute fade factor */
-       /* XXX */
-       float fade_factor = 1;
+       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);
 
+       /* 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;
+       /* 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 (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 ();
        }
 
-       /* 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 */
-               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);
+               /* Border effect; stroke the subtitle with a large (arbitrarily chosen) line width */
+               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, y_offset);
                layout->add_to_cairo_context (context);
                context->stroke ();
        }
 
+       /* The actual subtitle */
+
+       context->set_line_width (0);
+       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;
        layout->get_pixel_size (layout_width, layout_height);
@@ -283,22 +361,25 @@ 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.
+ *  @param frame_rate DCP frame rate.
+ */
 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, int frame_rate)
 {
-       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, frame_rate));
                        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, frame_rate));
        }
 
        return images;