src/lib/render_text.cc

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