src/lib/render_subtitles.cc

   1 /*
   2     Copyright (C) 2014-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #include "render_subtitles.h"
  22 #include "types.h"
  23 #include "image.h"
  24 #include "cross.h"
  25 #include "font.h"
  26 #include "dcpomatic_assert.h"
  27 #include <dcp/raw_convert.h>
  28 #include <fontconfig/fontconfig.h>
  29 #include <cairomm/cairomm.h>
  30 #include <pangomm.h>
  31 #ifndef DCPOMATIC_HAVE_SHOW_IN_CAIRO_CONTEXT
  32 #include <pango/pangocairo.h>
  33 #endif
  34 #include <boost/foreach.hpp>
  35 #include <iostream>
  36
  37 using std::list;
  38 using std::cout;
  39 using std::string;
  40 using std::min;
  41 using std::max;
  42 using std::pair;
  43 using std::cerr;
  44 using std::make_pair;
  45 using boost::shared_ptr;
  46 using boost::optional;
  47
  48 static FcConfig* fc_config = 0;
  49 static list<pair<FontFiles, string> > fc_config_fonts;
  50
  51 string
  52 marked_up (list<SubtitleString> subtitles, int target_height, float fade_factor)
  53 {
  54         string out;
  55
  56         BOOST_FOREACH (SubtitleString const & i, subtitles) {
  57                 out += "<span ";
  58                 if (i.italic()) {
  59                         out += "style=\"italic\" ";
  60                 }
  61                 if (i.bold()) {
  62                         out += "weight=\"bold\" ";
  63                 }
  64                 if (i.underline()) {
  65                         out += "underline=\"single\" ";
  66                 }
  67                 out += "size=\"" + dcp::raw_convert<string>(i.size_in_pixels(target_height) * 72 * 1024 / 96) + "\" ";
  68                 /* Between 1-65535 inclusive, apparently... */
  69                 out += "alpha=\"" + dcp::raw_convert<string>(int(floor(fade_factor * 65534)) + 1) + "\" ";
  70                 out += "color=\"#" + i.colour().to_rgb_string() + "\">";
  71                 out += i.text ();
  72                 out += "</span>";
  73         }
  74
  75         return out;
  76 }
  77
  78 static void
  79 set_source_rgba (Cairo::RefPtr<Cairo::Context> context, dcp::Colour colour, float fade_factor)
  80 {
  81         context->set_source_rgba (float(colour.r) / 255, float(colour.g) / 255, float(colour.b) / 255, fade_factor);
  82 }
  83
  84 /** @param subtitles A list of subtitles that are all on the same line,
  85  *  at the same time and with the same fade in/out.
  86  */
  87 static PositionImage
  88 render_line (list<SubtitleString> subtitles, list<shared_ptr<Font> > fonts, dcp::Size target, DCPTime time)
  89 {
  90         /* XXX: this method can only handle italic / bold changes mid-line,
  91            nothing else yet.
  92         */
  93
  94         DCPOMATIC_ASSERT (!subtitles.empty ());
  95
  96         /* Calculate x and y scale factors.  These are only used to stretch
  97            the font away from its normal aspect ratio.
  98         */
  99         float xscale = 1;
 100         float yscale = 1;
 101         if (fabs (subtitles.front().aspect_adjust() - 1.0) > dcp::ASPECT_ADJUST_EPSILON) {
 102                 if (subtitles.front().aspect_adjust() < 1) {
 103                         xscale = max (0.25f, subtitles.front().aspect_adjust ());
 104                         yscale = 1;
 105                 } else {
 106                         xscale = 1;
 107                         yscale = 1 / min (4.0f, subtitles.front().aspect_adjust ());
 108                 }
 109         }
 110
 111         /* Make an empty bitmap as wide as target and at
 112            least tall enough for this subtitle.
 113         */
 114
 115         int largest = 0;
 116         BOOST_FOREACH (dcp::SubtitleString const & i, subtitles) {
 117                 largest = max (largest, i.size());
 118         }
 119         /* Basic guess on height... */
 120         int height = largest * target.height / (11 * 72);
 121         /* ...scaled... */
 122         height *= yscale;
 123         /* ...and add a bit more for luck */
 124         height += target.height / 11;
 125
 126         /* FFmpeg BGRA means first byte blue, second byte green, third byte red, fourth byte alpha */
 127         shared_ptr<Image> image (new Image (AV_PIX_FMT_BGRA, dcp::Size (target.width, height), false));
 128         image->make_black ();
 129
 130 #ifdef DCPOMATIC_HAVE_FORMAT_STRIDE_FOR_WIDTH
 131         Cairo::RefPtr<Cairo::ImageSurface> surface = Cairo::ImageSurface::create (
 132                 image->data()[0],
 133                 Cairo::FORMAT_ARGB32,
 134                 image->size().width,
 135                 image->size().height,
 136                 /* Cairo ARGB32 means first byte blue, second byte green, third byte red, fourth byte alpha */
 137                 Cairo::ImageSurface::format_stride_for_width (Cairo::FORMAT_ARGB32, image->size().width)
 138                 );
 139 #else
 140         /* Centos 5 does not have Cairo::ImageSurface::format_stride_for_width, so just use width * 4
 141            which I hope is safe (if slow)
 142         */
 143         Cairo::RefPtr<Cairo::ImageSurface> surface = Cairo::ImageSurface::create (
 144                 image->data()[0],
 145                 Cairo::FORMAT_ARGB32,
 146                 image->size().width,
 147                 image->size().height,
 148                 image->size().width * 4
 149                 );
 150 #endif
 151
 152         Cairo::RefPtr<Cairo::Context> context = Cairo::Context::create (surface);
 153
 154         if (!fc_config) {
 155                 fc_config = FcConfigCreate ();
 156         }
 157
 158         FontFiles font_files;
 159
 160         try {
 161                 font_files.set (FontFiles::NORMAL, shared_path () / "LiberationSans-Regular.ttf");
 162                 font_files.set (FontFiles::ITALIC, shared_path () / "LiberationSans-Italic.ttf");
 163                 font_files.set (FontFiles::BOLD, shared_path () / "LiberationSans-Bold.ttf");
 164         } catch (boost::filesystem::filesystem_error& e) {
 165
 166         }
 167
 168         /* Hack: try the debian/ubuntu locations if getting the shared path failed */
 169
 170         if (!font_files.get(FontFiles::NORMAL) || !boost::filesystem::exists(font_files.get(FontFiles::NORMAL).get())) {
 171                 font_files.set (FontFiles::NORMAL, "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf");
 172         }
 173         if (!font_files.get(FontFiles::ITALIC) || !boost::filesystem::exists(font_files.get(FontFiles::ITALIC).get())) {
 174                 font_files.set (FontFiles::ITALIC, "/usr/share/fonts/truetype/liberation/LiberationSans-Italic.ttf");
 175         }
 176         if (!font_files.get(FontFiles::BOLD) || !boost::filesystem::exists(font_files.get(FontFiles::BOLD).get())) {
 177                 font_files.set (FontFiles::BOLD, "/usr/share/fonts/truetype/liberation/LiberationSans-Bold.ttf");
 178         }
 179
 180         BOOST_FOREACH (shared_ptr<Font> i, fonts) {
 181                 if (i->id() == subtitles.front().font() && i->file(FontFiles::NORMAL)) {
 182                         font_files = i->files ();
 183                 }
 184         }
 185
 186         list<pair<FontFiles, string> >::const_iterator existing = fc_config_fonts.begin ();
 187         while (existing != fc_config_fonts.end() && existing->first != font_files) {
 188                 ++existing;
 189         }
 190
 191         string font_name;
 192         if (existing != fc_config_fonts.end ()) {
 193                 font_name = existing->second;
 194         } else {
 195                 /* Make this font available to DCP-o-matic */
 196                 for (int i = 0; i < FontFiles::VARIANTS; ++i) {
 197                         if (font_files.get(static_cast<FontFiles::Variant>(i))) {
 198                                 FcConfigAppFontAddFile (
 199                                         fc_config,
 200                                         reinterpret_cast<FcChar8 const *> (font_files.get(static_cast<FontFiles::Variant>(i)).get().string().c_str())
 201                                         );
 202                         }
 203                 }
 204
 205                 FcPattern* pattern = FcPatternBuild (
 206                         0, FC_FILE, FcTypeString, font_files.get(FontFiles::NORMAL).get().string().c_str(), static_cast<char *> (0)
 207                         );
 208                 FcObjectSet* object_set = FcObjectSetBuild (FC_FAMILY, FC_STYLE, FC_LANG, FC_FILE, static_cast<char *> (0));
 209                 FcFontSet* font_set = FcFontList (fc_config, pattern, object_set);
 210                 if (font_set) {
 211                         for (int i = 0; i < font_set->nfont; ++i) {
 212                                 FcPattern* font = font_set->fonts[i];
 213                                 FcChar8* file;
 214                                 FcChar8* family;
 215                                 FcChar8* style;
 216                                 if (
 217                                         FcPatternGetString (font, FC_FILE, 0, &file) == FcResultMatch &&
 218                                         FcPatternGetString (font, FC_FAMILY, 0, &family) == FcResultMatch &&
 219                                         FcPatternGetString (font, FC_STYLE, 0, &style) == FcResultMatch
 220                                         ) {
 221                                         font_name = reinterpret_cast<char const *> (family);
 222                                 }
 223                         }
 224
 225                         FcFontSetDestroy (font_set);
 226                 }
 227
 228                 FcObjectSetDestroy (object_set);
 229                 FcPatternDestroy (pattern);
 230
 231                 fc_config_fonts.push_back (make_pair (font_files, font_name));
 232         }
 233
 234         FcConfigSetCurrent (fc_config);
 235
 236         Glib::RefPtr<Pango::Layout> layout = Pango::Layout::create (context);
 237
 238         layout->set_alignment (Pango::ALIGN_LEFT);
 239
 240         context->set_line_width (1);
 241
 242         /* Compute fade factor */
 243         float fade_factor = 1;
 244
 245         DCPTime const fade_in_start = DCPTime::from_seconds (subtitles.front().in().as_seconds ());
 246         DCPTime const fade_in_end = fade_in_start + DCPTime::from_seconds (subtitles.front().fade_up_time().as_seconds ());
 247         DCPTime const fade_out_end =  DCPTime::from_seconds (subtitles.front().out().as_seconds ());
 248         DCPTime const fade_out_start = fade_out_end - DCPTime::from_seconds (subtitles.front().fade_down_time().as_seconds ());
 249
 250         if (fade_in_start <= time && time <= fade_in_end && fade_in_start != fade_in_end) {
 251                 fade_factor *= DCPTime(time - fade_in_start).seconds() / DCPTime(fade_in_end - fade_in_start).seconds();
 252         }
 253         if (fade_out_start <= time && time <= fade_out_end && fade_out_start != fade_out_end) {
 254                 fade_factor *= 1 - DCPTime(time - fade_out_start).seconds() / DCPTime(fade_out_end - fade_out_start).seconds();
 255         }
 256         if (time < fade_in_start || time > fade_out_end) {
 257                 fade_factor = 0;
 258         }
 259
 260         /* Render the subtitle at the top left-hand corner of image */
 261
 262         Pango::FontDescription font (font_name);
 263         layout->set_font_description (font);
 264         layout->set_markup (marked_up (subtitles, target.height, fade_factor));
 265
 266         context->scale (xscale, yscale);
 267         layout->update_from_cairo_context (context);
 268
 269         /* Shuffle the subtitle over very slightly if it has a border so that the left-hand
 270            side of the first character's border is not cut off.
 271         */
 272         int const x_offset = subtitles.front().effect() == dcp::BORDER ? (target.width / 600.0) : 0;
 273         /* Move down a bit so that accents on capital letters can be seen */
 274         int const y_offset = target.height / 100.0;
 275
 276         if (subtitles.front().effect() == dcp::SHADOW) {
 277                 /* Drop-shadow effect */
 278                 set_source_rgba (context, subtitles.front().effect_colour(), fade_factor);
 279                 context->move_to (x_offset + 4, y_offset + 4);
 280                 layout->add_to_cairo_context (context);
 281                 context->fill ();
 282         }
 283
 284         if (subtitles.front().effect() == dcp::BORDER) {
 285                 /* Border effect; stroke the subtitle with a large (arbitrarily chosen) line width */
 286                 set_source_rgba (context, subtitles.front().effect_colour(), fade_factor);
 287                 context->set_line_width (subtitles.front().outline_width * target.width / 2048.0);
 288                 context->set_line_join (Cairo::LINE_JOIN_ROUND);
 289                 context->move_to (x_offset, y_offset);
 290                 layout->add_to_cairo_context (context);
 291                 context->stroke ();
 292         }
 293
 294         /* The actual subtitle */
 295
 296         context->set_line_width (0);
 297         context->move_to (x_offset, y_offset);
 298 #ifdef DCPOMATIC_HAVE_SHOW_IN_CAIRO_CONTEXT
 299         layout->show_in_cairo_context (context);
 300 #else
 301         pango_cairo_show_layout (context->cobj(), layout->gobj());
 302 #endif
 303
 304         int layout_width;
 305         int layout_height;
 306         layout->get_pixel_size (layout_width, layout_height);
 307         layout_width *= xscale;
 308         layout_height *= yscale;
 309
 310         int x = 0;
 311         switch (subtitles.front().h_align ()) {
 312         case dcp::HALIGN_LEFT:
 313                 /* h_position is distance between left of frame and left of subtitle */
 314                 x = subtitles.front().h_position() * target.width;
 315                 break;
 316         case dcp::HALIGN_CENTER:
 317                 /* h_position is distance between centre of frame and centre of subtitle */
 318                 x = (0.5 + subtitles.front().h_position()) * target.width - layout_width / 2;
 319                 break;
 320         case dcp::HALIGN_RIGHT:
 321                 /* h_position is distance between right of frame and right of subtitle */
 322                 x = (1.0 - subtitles.front().h_position()) * target.width - layout_width;
 323                 break;
 324         }
 325
 326         int y = 0;
 327         switch (subtitles.front().v_align ()) {
 328         case dcp::VALIGN_TOP:
 329                 /* SMPTE says that v_position is the distance between top
 330                    of frame and top of subtitle, but this doesn't always seem to be
 331                    the case in practice; Gunnar Ásgeirsson's Dolby server appears
 332                    to put VALIGN_TOP subs with v_position as the distance between top
 333                    of frame and bottom of subtitle.
 334                 */
 335                 y = subtitles.front().v_position() * target.height - layout_height;
 336                 break;
 337         case dcp::VALIGN_CENTER:
 338                 /* v_position is distance between centre of frame and centre of subtitle */
 339                 y = (0.5 + subtitles.front().v_position()) * target.height - layout_height / 2;
 340                 break;
 341         case dcp::VALIGN_BOTTOM:
 342                 /* v_position is distance between bottom of frame and bottom of subtitle */
 343                 y = (1.0 - subtitles.front().v_position()) * target.height - layout_height;
 344                 break;
 345         }
 346
 347         return PositionImage (image, Position<int> (max (0, x), max (0, y)));
 348 }
 349
 350 /** @param time Time of the frame that these subtitles are going on */
 351 list<PositionImage>
 352 render_subtitles (list<SubtitleString> subtitles, list<shared_ptr<Font> > fonts, dcp::Size target, DCPTime time)
 353 {
 354         list<SubtitleString> pending;
 355         list<PositionImage> images;
 356
 357         BOOST_FOREACH (SubtitleString const & i, subtitles) {
 358                 if (!pending.empty() && fabs (i.v_position() - pending.back().v_position()) > 1e-4) {
 359                         images.push_back (render_line (pending, fonts, target, time));
 360                         pending.clear ();
 361                 }
 362                 pending.push_back (i);
 363         }
 364
 365         if (!pending.empty ()) {
 366                 images.push_back (render_line (pending, fonts, target, time));
 367         }
 368
 369         return images;
 370 }