src/lib/render_text.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_text.h"
  22 #include "types.h"
  23 #include "image.h"
  24 #include "cross.h"
  25 #include "font.h"
  26 #include "dcpomatic_assert.h"
  27 #include "warnings.h"
  28 #include <dcp/raw_convert.h>
  29 #include <fontconfig/fontconfig.h>
  30 #include <cairomm/cairomm.h>
  31 DCPOMATIC_DISABLE_WARNINGS
  32 #include <pangomm.h>
  33 DCPOMATIC_ENABLE_WARNINGS
  34 #include <pango/pangocairo.h>
  35 #ifndef DCPOMATIC_HAVE_SHOW_IN_CAIRO_CONTEXT
  36 #include <pango/pangocairo.h>
  37 #endif
  38 #include <boost/foreach.hpp>
  39 #include <boost/algorithm/string.hpp>
  40 #include <iostream>
  41
  42 using std::list;
  43 using std::cout;
  44 using std::string;
  45 using std::min;
  46 using std::max;
  47 using std::pair;
  48 using std::cerr;
  49 using std::make_pair;
  50 using boost::shared_ptr;
  51 using boost::optional;
  52 using boost::algorithm::replace_all;
  53 using namespace dcpomatic;
  54
  55 static FcConfig* fc_config = 0;
  56 static list<pair<boost::filesystem::path, string> > fc_config_fonts;
  57
  58 string
  59 marked_up (list<StringText> subtitles, int target_height, float fade_factor)
  60 {
  61         string out;
  62
  63         BOOST_FOREACH (StringText const & i, subtitles) {
  64                 out += "<span ";
  65                 if (i.italic()) {
  66                         out += "style=\"italic\" ";
  67                 }
  68                 if (i.bold()) {
  69                         out += "weight=\"bold\" ";
  70                 }
  71                 if (i.underline()) {
  72                         out += "underline=\"single\" ";
  73                 }
  74                 out += "size=\"" + dcp::raw_convert<string>(i.size_in_pixels(target_height) * 72 * 1024 / 96) + "\" ";
  75                 /* Between 1-65535 inclusive, apparently... */
  76                 out += "alpha=\"" + dcp::raw_convert<string>(int(floor(fade_factor * 65534)) + 1) + "\" ";
  77                 out += "color=\"#" + i.colour().to_rgb_string() + "\">";
  78
  79                 string t = i.text();
  80                 replace_all(t, "&", "&amp;");
  81                 out += t;
  82
  83                 out += "</span>";
  84         }
  85
  86         return out;
  87 }
  88
  89 static void
  90 set_source_rgba (Cairo::RefPtr<Cairo::Context> context, dcp::Colour colour, float fade_factor)
  91 {
  92         context->set_source_rgba (float(colour.r) / 255, float(colour.g) / 255, float(colour.b) / 255, fade_factor);
  93 }
  94
  95
  96 static shared_ptr<Image>
  97 create_image (dcp::Size size)
  98 {
  99         /* FFmpeg BGRA means first byte blue, second byte green, third byte red, fourth byte alpha */
 100         shared_ptr<Image> image (new Image(AV_PIX_FMT_BGRA, size, false));
 101         image->make_black ();
 102         return image;
 103 }
 104
 105
 106 static Cairo::RefPtr<Cairo::ImageSurface>
 107 create_surface (shared_ptr<Image> image)
 108 {
 109 #ifdef DCPOMATIC_HAVE_FORMAT_STRIDE_FOR_WIDTH
 110         Cairo::RefPtr<Cairo::ImageSurface> surface = Cairo::ImageSurface::create (
 111                 image->data()[0],
 112                 Cairo::FORMAT_ARGB32,
 113                 image->size().width,
 114                 image->size().height,
 115                 /* Cairo ARGB32 means first byte blue, second byte green, third byte red, fourth byte alpha */
 116                 Cairo::ImageSurface::format_stride_for_width (Cairo::FORMAT_ARGB32, image->size().width)
 117                 );
 118 #else
 119         /* Centos 5 does not have Cairo::ImageSurface::format_stride_for_width, so just use width * 4
 120            which I hope is safe (if slow)
 121         */
 122         Cairo::RefPtr<Cairo::ImageSurface> surface = Cairo::ImageSurface::create (
 123                 image->data()[0],
 124                 Cairo::FORMAT_ARGB32,
 125                 image->size().width,
 126                 image->size().height,
 127                 image->size().width * 4
 128                 );
 129 #endif
 130
 131         return surface;
 132 }
 133
 134
 135 static string
 136 setup_font (StringText const& subtitle, list<shared_ptr<Font> > const& fonts)
 137 {
 138         if (!fc_config) {
 139                 fc_config = FcInitLoadConfig ();
 140         }
 141
 142         optional<boost::filesystem::path> font_file;
 143
 144         try {
 145                 font_file = resources_path() / "LiberationSans-Regular.ttf";
 146         } catch (boost::filesystem::filesystem_error& e) {
 147
 148         }
 149
 150         /* Hack: try the debian/ubuntu locations if getting the shared path failed */
 151
 152         if (!font_file || !boost::filesystem::exists(*font_file)) {
 153                 font_file = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
 154         }
 155
 156         BOOST_FOREACH (shared_ptr<Font> i, fonts) {
 157                 if (i->id() == subtitle.font() && i->file()) {
 158                         font_file = i->file ();
 159                 }
 160         }
 161
 162         list<pair<boost::filesystem::path, string> >::const_iterator existing = fc_config_fonts.begin ();
 163         while (existing != fc_config_fonts.end() && existing->first != *font_file) {
 164                 ++existing;
 165         }
 166
 167         string font_name;
 168         if (existing != fc_config_fonts.end ()) {
 169                 font_name = existing->second;
 170         } else {
 171                 /* Make this font available to DCP-o-matic */
 172                 FcConfigAppFontAddFile (fc_config, reinterpret_cast<FcChar8 const *>(font_file->string().c_str()));
 173                 FcPattern* pattern = FcPatternBuild (
 174                         0, FC_FILE, FcTypeString, font_file->string().c_str(), static_cast<char *> (0)
 175                         );
 176                 FcObjectSet* object_set = FcObjectSetBuild (FC_FAMILY, FC_STYLE, FC_LANG, FC_FILE, static_cast<char *> (0));
 177                 FcFontSet* font_set = FcFontList (fc_config, pattern, object_set);
 178                 if (font_set) {
 179                         for (int i = 0; i < font_set->nfont; ++i) {
 180                                 FcPattern* font = font_set->fonts[i];
 181                                 FcChar8* file;
 182                                 FcChar8* family;
 183                                 FcChar8* style;
 184                                 if (
 185                                         FcPatternGetString (font, FC_FILE, 0, &file) == FcResultMatch &&
 186                                         FcPatternGetString (font, FC_FAMILY, 0, &family) == FcResultMatch &&
 187                                         FcPatternGetString (font, FC_STYLE, 0, &style) == FcResultMatch
 188                                         ) {
 189                                         font_name = reinterpret_cast<char const *> (family);
 190                                 }
 191                         }
 192
 193                         FcFontSetDestroy (font_set);
 194                 }
 195
 196                 FcObjectSetDestroy (object_set);
 197                 FcPatternDestroy (pattern);
 198
 199                 fc_config_fonts.push_back (make_pair(*font_file, font_name));
 200         }
 201
 202         FcConfigSetCurrent (fc_config);
 203         return font_name;
 204 }
 205
 206
 207 static float
 208 calculate_fade_factor (StringText const& first, DCPTime time, int frame_rate)
 209 {
 210         float fade_factor = 1;
 211
 212         /* Round the fade start/end to the nearest frame start.  Otherwise if a subtitle starts just after
 213            the start of a frame it will be faded out.
 214         */
 215         DCPTime const fade_in_start = DCPTime::from_seconds(first.in().as_seconds()).round(frame_rate);
 216         DCPTime const fade_in_end = fade_in_start + DCPTime::from_seconds (first.fade_up_time().as_seconds ());
 217         DCPTime const fade_out_end =  DCPTime::from_seconds (first.out().as_seconds()).round(frame_rate);
 218         DCPTime const fade_out_start = fade_out_end - DCPTime::from_seconds (first.fade_down_time().as_seconds ());
 219
 220         if (fade_in_start <= time && time <= fade_in_end && fade_in_start != fade_in_end) {
 221                 fade_factor *= DCPTime(time - fade_in_start).seconds() / DCPTime(fade_in_end - fade_in_start).seconds();
 222         }
 223         if (fade_out_start <= time && time <= fade_out_end && fade_out_start != fade_out_end) {
 224                 fade_factor *= 1 - DCPTime(time - fade_out_start).seconds() / DCPTime(fade_out_end - fade_out_start).seconds();
 225         }
 226         if (time < fade_in_start || time > fade_out_end) {
 227                 fade_factor = 0;
 228         }
 229
 230         return fade_factor;
 231 }
 232
 233
 234 static int
 235 x_position (StringText const& first, int target_width, int layout_width)
 236 {
 237         int x = 0;
 238         switch (first.h_align ()) {
 239         case dcp::HALIGN_LEFT:
 240                 /* h_position is distance between left of frame and left of subtitle */
 241                 x = first.h_position() * target_width;
 242                 break;
 243         case dcp::HALIGN_CENTER:
 244                 /* h_position is distance between centre of frame and centre of subtitle */
 245                 x = (0.5 + first.h_position()) * target_width - layout_width / 2;
 246                 break;
 247         case dcp::HALIGN_RIGHT:
 248                 /* h_position is distance between right of frame and right of subtitle */
 249                 x = (1.0 - first.h_position()) * target_width - layout_width;
 250                 break;
 251         }
 252
 253         return x;
 254 }
 255
 256
 257
 258 static int
 259 y_position (StringText const& first, int target_height, int layout_height)
 260 {
 261         int y = 0;
 262         switch (first.v_align ()) {
 263         case dcp::VALIGN_TOP:
 264                 /* SMPTE says that v_position is the distance between top
 265                    of frame and top of subtitle, but this doesn't always seem to be
 266                    the case in practice; Gunnar Ásgeirsson's Dolby server appears
 267                    to put VALIGN_TOP subs with v_position as the distance between top
 268                    of frame and bottom of subtitle.
 269                 */
 270                 y = first.v_position() * target_height - layout_height;
 271                 break;
 272         case dcp::VALIGN_CENTER:
 273                 /* v_position is distance between centre of frame and centre of subtitle */
 274                 y = (0.5 + first.v_position()) * target_height - layout_height / 2;
 275                 break;
 276         case dcp::VALIGN_BOTTOM:
 277                 /* v_position is distance between bottom of frame and bottom of subtitle */
 278                 y = (1.0 - first.v_position()) * target_height - layout_height;
 279                 break;
 280         }
 281
 282         return y;
 283 }
 284
 285
 286 static void
 287 setup_layout (Glib::RefPtr<Pango::Layout> layout, string font_name, string markup)
 288 {
 289         layout->set_alignment (Pango::ALIGN_LEFT);
 290         Pango::FontDescription font (font_name);
 291         layout->set_font_description (font);
 292         layout->set_markup (markup);
 293 }
 294
 295 /** Create a Pango layout using a dummy context which we can use to calculate the size
 296  *  of the text we will render.  Then we can transfer the layout over to the real context
 297  *  for the actual render.
 298  */
 299 static Glib::RefPtr<Pango::Layout>
 300 create_layout()
 301 {
 302         PangoFontMap* c_font_map = pango_cairo_font_map_new ();
 303         Glib::RefPtr<Pango::FontMap> font_map = Glib::wrap (c_font_map);
 304         PangoContext* c_context = pango_font_map_create_context (c_font_map);
 305         Glib::RefPtr<Pango::Context> context = Glib::wrap (c_context);
 306         return Pango::Layout::create (context);
 307 }
 308
 309
 310 /** @param subtitles A list of subtitles that are all on the same line,
 311  *  at the same time and with the same fade in/out.
 312  */
 313 static PositionImage
 314 render_line (list<StringText> subtitles, list<shared_ptr<Font> > fonts, dcp::Size target, DCPTime time, int frame_rate)
 315 {
 316         /* XXX: this method can only handle italic / bold changes mid-line,
 317            nothing else yet.
 318         */
 319
 320         DCPOMATIC_ASSERT (!subtitles.empty ());
 321         StringText const& first = subtitles.front ();
 322
 323         string const font_name = setup_font (first, fonts);
 324         float const fade_factor = calculate_fade_factor (first, time, frame_rate);
 325         string const markup = marked_up (subtitles, target.height, fade_factor);
 326         Glib::RefPtr<Pango::Layout> layout = create_layout ();
 327         setup_layout (layout, font_name, markup);
 328         dcp::Size size;
 329         layout->get_pixel_size (size.width, size.height);
 330
 331         /* Calculate x and y scale factors.  These are only used to stretch
 332            the font away from its normal aspect ratio.
 333         */
 334         float x_scale = 1;
 335         float y_scale = 1;
 336         if (fabs (first.aspect_adjust() - 1.0) > dcp::ASPECT_ADJUST_EPSILON) {
 337                 if (first.aspect_adjust() < 1) {
 338                         x_scale = max (0.25f, first.aspect_adjust ());
 339                         y_scale = 1;
 340                 } else {
 341                         x_scale = 1;
 342                         y_scale = 1 / min (4.0f, first.aspect_adjust ());
 343                 }
 344         }
 345
 346         float const border_width = dcp::BORDER ? (first.outline_width * target.width / 2048.0) : 0;
 347         size.width += 2 * ceil (border_width);
 348         size.height += 2 * ceil (border_width);
 349
 350         size.width *= x_scale;
 351         size.height *= y_scale;
 352
 353         /* Shuffle the subtitle over by the border width (if we have any) so it's not cut off */
 354         int const x_offset = ceil (border_width);
 355         /* Move down a bit so that accents on capital letters can be seen */
 356         int const y_offset = target.height / 100.0;
 357
 358         size.width += x_offset;
 359         size.height += y_offset;
 360
 361         shared_ptr<Image> image = create_image (size);
 362         Cairo::RefPtr<Cairo::Surface> surface = create_surface (image);
 363         Cairo::RefPtr<Cairo::Context> context = Cairo::Context::create (surface);
 364
 365         context->set_line_width (1);
 366         context->scale (x_scale, y_scale);
 367         layout->update_from_cairo_context (context);
 368
 369         if (first.effect() == dcp::SHADOW) {
 370                 /* Drop-shadow effect */
 371                 set_source_rgba (context, first.effect_colour(), fade_factor);
 372                 context->move_to (x_offset + 4, y_offset + 4);
 373                 layout->add_to_cairo_context (context);
 374                 context->fill ();
 375         }
 376
 377         if (first.effect() == dcp::BORDER) {
 378                 /* Border effect; stroke the subtitle with a large (arbitrarily chosen) line width */
 379                 set_source_rgba (context, first.effect_colour(), fade_factor);
 380                 context->set_line_width (border_width);
 381                 context->set_line_join (Cairo::LINE_JOIN_ROUND);
 382                 context->move_to (x_offset, y_offset);
 383                 layout->add_to_cairo_context (context);
 384                 context->stroke ();
 385         }
 386
 387         /* The actual subtitle */
 388
 389         context->set_line_width (0);
 390         context->move_to (x_offset, y_offset);
 391 #ifdef DCPOMATIC_HAVE_SHOW_IN_CAIRO_CONTEXT
 392         layout->show_in_cairo_context (context);
 393 #else
 394         pango_cairo_show_layout (context->cobj(), layout->gobj());
 395 #endif
 396
 397         int const x = x_position (first, target.width, size.width);
 398         int const y = y_position (first, target.height, size.height);
 399         return PositionImage (image, Position<int>(max (0, x), max(0, y)));
 400 }
 401
 402
 403 /** @param time Time of the frame that these subtitles are going on.
 404  *  @param target Size of the container that this subtitle will end up in.
 405  *  @param frame_rate DCP frame rate.
 406  */
 407 list<PositionImage>
 408 render_text (list<StringText> subtitles, list<shared_ptr<Font> > fonts, dcp::Size target, DCPTime time, int frame_rate)
 409 {
 410         list<StringText> pending;
 411         list<PositionImage> images;
 412
 413         BOOST_FOREACH (StringText const & i, subtitles) {
 414                 if (!pending.empty() && (i.v_align() != pending.back().v_align() || fabs(i.v_position() - pending.back().v_position()) > 1e-4)) {
 415                         images.push_back (render_line (pending, fonts, target, time, frame_rate));
 416                         pending.clear ();
 417                 }
 418                 pending.push_back (i);
 419         }
 420
 421         if (!pending.empty ()) {
 422                 images.push_back (render_line (pending, fonts, target, time, frame_rate));
 423         }
 424
 425         return images;
 426 }