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 "font_config.h"
  26 #include "image.h"
  27 #include "render_text.h"
  28 #include "util.h"
  29 #include <dcp/raw_convert.h>
  30 #include <dcp/warnings.h>
  31 #include <cairomm/cairomm.h>
  32 LIBDCP_DISABLE_WARNINGS
  33 #include <pangomm.h>
  34 LIBDCP_ENABLE_WARNINGS
  35 #include <pango/pangocairo.h>
  36 #include <boost/algorithm/string.hpp>
  37 #include <iostream>
  38
  39
  40 using std::cerr;
  41 using std::cout;
  42 using std::make_pair;
  43 using std::make_shared;
  44 using std::max;
  45 using std::min;
  46 using std::pair;
  47 using std::shared_ptr;
  48 using std::string;
  49 using std::vector;
  50 using boost::optional;
  51 using namespace dcpomatic;
  52
  53
  54 /** Create a Pango layout using a dummy context which we can use to calculate the size
  55  *  of the text we will render.  Then we can transfer the layout over to the real context
  56  *  for the actual render.
  57  */
  58 static Glib::RefPtr<Pango::Layout>
  59 create_layout(string font_name, string markup)
  60 {
  61         auto c_font_map = pango_cairo_font_map_new ();
  62         DCPOMATIC_ASSERT (c_font_map);
  63         auto font_map = Glib::wrap (c_font_map);
  64         auto c_context = pango_font_map_create_context (c_font_map);
  65         DCPOMATIC_ASSERT (c_context);
  66         auto context = Glib::wrap (c_context);
  67         auto layout = Pango::Layout::create(context);
  68
  69         layout->set_alignment (Pango::ALIGN_LEFT);
  70         Pango::FontDescription font (font_name);
  71         layout->set_font_description (font);
  72         layout->set_markup (markup);
  73
  74         return layout;
  75 }
  76
  77
  78 string
  79 marked_up(vector<StringText> subtitles, int target_height, float fade_factor, string font_name)
  80 {
  81         auto constexpr pixels_to_1024ths_point = 72 * 1024 / 96;
  82
  83         auto make_span = [target_height, fade_factor](StringText const& subtitle, string text, string extra_attribute) {
  84                 string span;
  85                 span += "<span ";
  86                 if (subtitle.italic()) {
  87                         span += "style=\"italic\" ";
  88                 }
  89                 if (subtitle.bold()) {
  90                         span += "weight=\"bold\" ";
  91                 }
  92                 if (subtitle.underline()) {
  93                         span += "underline=\"single\" ";
  94                 }
  95                 span += "size=\"" + dcp::raw_convert<string>(lrintf(subtitle.size_in_pixels(target_height) * pixels_to_1024ths_point)) + "\" ";
  96                 /* Between 1-65535 inclusive, apparently... */
  97                 span += "alpha=\"" + dcp::raw_convert<string>(int(floor(fade_factor * 65534)) + 1) + "\" ";
  98                 span += "color=\"#" + subtitle.colour().to_rgb_string() + "\"";
  99                 if (!extra_attribute.empty()) {
 100                         span += " " + extra_attribute;
 101                 }
 102                 span += ">";
 103
 104                 boost::algorithm::replace_all(text, "&", "&amp;");
 105                 boost::algorithm::replace_all(text, "<", "&lt;");
 106                 boost::algorithm::replace_all(text, ">", "&gt;");
 107
 108                 span += text;
 109                 span += "</span>";
 110                 return span;
 111         };
 112
 113         string out;
 114         for (auto const& i: subtitles) {
 115                 if (std::abs(i.space_before()) > dcp::SPACE_BEFORE_EPSILON) {
 116                         /* We need to insert some horizontal space into the layout.  The only way I can find to do this
 117                          * is to write a " " with some special letter_spacing.  As far as I can see, such a space will
 118                          * be written with letter_spacing either side.  This means that to get a horizontal space x we
 119                          * need to write a " " with letter spacing (x - s) / 2, where s is the width of the " ".
 120                          */
 121                         auto layout = create_layout(font_name, make_span(i, " ", {}));
 122                         int space_width;
 123                         int dummy;
 124                         layout->get_pixel_size(space_width, dummy);
 125                         auto spacing = ((i.space_before() * i.size_in_pixels(target_height) - space_width) / 2) * pixels_to_1024ths_point;
 126                         out += make_span(i, " ", "letter_spacing=\"" + dcp::raw_convert<string>(spacing) + "\"");
 127                 }
 128
 129                 out += make_span(i, i.text(), {});
 130         }
 131
 132         return out;
 133 }
 134
 135
 136 static void
 137 set_source_rgba (Cairo::RefPtr<Cairo::Context> context, dcp::Colour colour, float fade_factor)
 138 {
 139         context->set_source_rgba (float(colour.r) / 255, float(colour.g) / 255, float(colour.b) / 255, fade_factor);
 140 }
 141
 142
 143 static shared_ptr<Image>
 144 create_image (dcp::Size size)
 145 {
 146         /* FFmpeg BGRA means first byte blue, second byte green, third byte red, fourth byte alpha.
 147          * This must be COMPACT as we're using it with Cairo::ImageSurface::create
 148          */
 149         auto image = make_shared<Image>(AV_PIX_FMT_BGRA, size, Image::Alignment::COMPACT);
 150         image->make_black ();
 151         return image;
 152 }
 153
 154
 155 static Cairo::RefPtr<Cairo::ImageSurface>
 156 create_surface (shared_ptr<Image> image)
 157 {
 158         /* XXX: I don't think it's guaranteed that format_stride_for_width will return a stride without any padding,
 159          * so it's lucky that this works.
 160          */
 161         DCPOMATIC_ASSERT (image->alignment() == Image::Alignment::COMPACT);
 162         DCPOMATIC_ASSERT (image->pixel_format() == AV_PIX_FMT_BGRA);
 163         return Cairo::ImageSurface::create (
 164                 image->data()[0],
 165                 Cairo::FORMAT_ARGB32,
 166                 image->size().width,
 167                 image->size().height,
 168                 /* Cairo ARGB32 means first byte blue, second byte green, third byte red, fourth byte alpha */
 169                 Cairo::ImageSurface::format_stride_for_width (Cairo::FORMAT_ARGB32, image->size().width)
 170                 );
 171 }
 172
 173
 174 static float
 175 calculate_fade_factor (StringText const& first, DCPTime time, int frame_rate)
 176 {
 177         float fade_factor = 1;
 178
 179         /* Round the fade start/end to the nearest frame start.  Otherwise if a subtitle starts just after
 180            the start of a frame it will be faded out.
 181         */
 182         auto const fade_in_start = DCPTime::from_seconds(first.in().as_seconds()).round(frame_rate);
 183         auto const fade_in_end = fade_in_start + DCPTime::from_seconds (first.fade_up_time().as_seconds ());
 184
 185         if (fade_in_start <= time && time <= fade_in_end && fade_in_start != fade_in_end) {
 186                 fade_factor *= DCPTime(time - fade_in_start).seconds() / DCPTime(fade_in_end - fade_in_start).seconds();
 187         }
 188
 189         if (time < fade_in_start) {
 190                 fade_factor = 0;
 191         }
 192
 193         /* first.out() may be zero if we don't know when this subtitle will finish.  We can only think about
 194          * fading out if we _do_ know when it will finish.
 195          */
 196         if (first.out() != dcp::Time()) {
 197                 auto const fade_out_end = DCPTime::from_seconds (first.out().as_seconds()).round(frame_rate);
 198                 auto const fade_out_start = fade_out_end - DCPTime::from_seconds(first.fade_down_time().as_seconds());
 199
 200                 if (fade_out_start <= time && time <= fade_out_end && fade_out_start != fade_out_end) {
 201                         fade_factor *= 1 - DCPTime(time - fade_out_start).seconds() / DCPTime(fade_out_end - fade_out_start).seconds();
 202                 }
 203                 if (time > fade_out_end) {
 204                         fade_factor = 0;
 205                 }
 206         }
 207
 208         return fade_factor;
 209 }
 210
 211
 212 static int
 213 x_position(dcp::HAlign align, float position, int target_width, int layout_width)
 214 {
 215         int x = 0;
 216         switch (align) {
 217         case dcp::HAlign::LEFT:
 218                 /* h_position is distance between left of frame and left of subtitle */
 219                 x = position * target_width;
 220                 break;
 221         case dcp::HAlign::CENTER:
 222                 /* h_position is distance between centre of frame and centre of subtitle */
 223                 x = (0.5 + position) * target_width - layout_width / 2;
 224                 break;
 225         case dcp::HAlign::RIGHT:
 226                 /* h_position is distance between right of frame and right of subtitle */
 227                 x = (1.0 - position) * target_width - layout_width;
 228                 break;
 229         }
 230
 231         return x;
 232 }
 233
 234
 235 /** @param align_standard Standard with which to interpret this subtitle's position.
 236  *  @param align alignment.
 237  *  @param position position (between 0 and 1)
 238  *  @param target_height Height of the target screen (in pixels).
 239  *  @param baseline_to_bottom Distance from text baseline to the bottom of the bounding box (in pixels).
 240  *  @param layout_height Height of the subtitle bounding box (in pixels).
 241  *  @return y position of the top of the subtitle bounding box (in pixels) from the top of the screen.
 242  */
 243 static int
 244 y_position(dcp::SubtitleStandard standard, dcp::VAlign align, float position, int target_height, int baseline_to_bottom, int layout_height)
 245 {
 246         int y = 0;
 247         switch (standard) {
 248         case dcp::SubtitleStandard::INTEROP:
 249         case dcp::SubtitleStandard::SMPTE_2014:
 250                 switch (align) {
 251                 case dcp::VAlign::TOP:
 252                         /* position is distance from top of frame to subtitle baseline */
 253                         y = position * target_height - (layout_height - baseline_to_bottom);
 254                         break;
 255                 case dcp::VAlign::CENTER:
 256                         /* position is distance from centre of frame to subtitle baseline */
 257                         y = (0.5 + position) * target_height - (layout_height - baseline_to_bottom);
 258                         break;
 259                 case dcp::VAlign::BOTTOM:
 260                         /* position is distance from bottom of frame to subtitle baseline */
 261                         y = (1.0 - position) * target_height - (layout_height - baseline_to_bottom);
 262                         break;
 263                 }
 264                 break;
 265         case dcp::SubtitleStandard::SMPTE_2007:
 266         case dcp::SubtitleStandard::SMPTE_2010:
 267                 switch (align) {
 268                 case dcp::VAlign::TOP:
 269                         /* v_position is distance from top of frame to top of subtitle */
 270                         y = position * target_height;
 271                         break;
 272                 case dcp::VAlign::CENTER:
 273                         /* v_position is distance from centre of frame to centre of subtitle */
 274                         y = (0.5 + position) * target_height - layout_height / 2;
 275                         break;
 276                 case dcp::VAlign::BOTTOM:
 277                         /* v_position is distance from bottom of frame to bottom of subtitle */
 278                         y = (1.0 - position) * target_height - layout_height;
 279                         break;
 280                 }
 281         }
 282
 283         return y;
 284 }
 285
 286
 287 struct Layout
 288 {
 289         Position<int> position;
 290         int baseline_position;
 291         dcp::Size size;
 292         Glib::RefPtr<Pango::Layout> pango;
 293
 294         int baseline_to_bottom(int border_width)
 295         {
 296                 return position.y + size.height - baseline_position - border_width;
 297         }
 298 };
 299
 300
 301 /** @param subtitles A list of subtitles that are all on the same line,
 302  *  at the same time and with the same fade in/out.
 303  */
 304 static Layout
 305 setup_layout(vector<StringText> subtitles, dcp::Size target, DCPTime time, int frame_rate)
 306 {
 307         DCPOMATIC_ASSERT(!subtitles.empty());
 308         auto const& first = subtitles.front();
 309
 310         auto const font_name = FontConfig::instance()->make_font_available(first.font);
 311         auto const fade_factor = calculate_fade_factor(first, time, frame_rate);
 312         auto const markup = marked_up(subtitles, target.height, fade_factor, font_name);
 313         auto layout = create_layout(font_name, markup);
 314         auto ink = layout->get_ink_extents();
 315
 316         Layout description;
 317         description.position = { ink.get_x() / Pango::SCALE, ink.get_y() / Pango::SCALE };
 318         description.baseline_position = layout->get_baseline() / Pango::SCALE;
 319         description.size = { ink.get_width() / Pango::SCALE, ink.get_height() / Pango::SCALE };
 320         description.pango = layout;
 321
 322         return description;
 323 }
 324
 325
 326 static
 327 int
 328 border_width_for_subtitle(StringText const& subtitle, dcp::Size target)
 329 {
 330         return subtitle.effect() == dcp::Effect::BORDER ? (subtitle.outline_width * target.width / 2048.0) : 0;
 331 }
 332
 333
 334 /** @param subtitles A list of subtitles that are all on the same line,
 335  *  at the same time and with the same fade in/out.
 336  */
 337 static PositionImage
 338 render_line(vector<StringText> subtitles, dcp::Size target, DCPTime time, int frame_rate)
 339 {
 340         /* XXX: this method can only handle italic / bold changes mid-line,
 341            nothing else yet.
 342         */
 343
 344         DCPOMATIC_ASSERT(!subtitles.empty ());
 345         auto const& first = subtitles.front();
 346         auto const fade_factor = calculate_fade_factor(first, time, frame_rate);
 347
 348         auto layout = setup_layout(subtitles, target, time, frame_rate);
 349
 350         /* Calculate x and y scale factors.  These are only used to stretch
 351            the font away from its normal aspect ratio.
 352         */
 353         float x_scale = 1;
 354         float y_scale = 1;
 355         if (fabs (first.aspect_adjust() - 1.0) > dcp::ASPECT_ADJUST_EPSILON) {
 356                 if (first.aspect_adjust() < 1) {
 357                         x_scale = max (0.25f, first.aspect_adjust ());
 358                         y_scale = 1;
 359                 } else {
 360                         x_scale = 1;
 361                         y_scale = 1 / min (4.0f, first.aspect_adjust ());
 362                 }
 363         }
 364
 365         auto const border_width = border_width_for_subtitle(first, target);
 366         layout.size.width += 2 * ceil (border_width);
 367         layout.size.height += 2 * ceil (border_width);
 368
 369         layout.size.width *= x_scale;
 370         layout.size.height *= y_scale;
 371
 372         /* Shuffle the subtitle over by the border width (if we have any) so it's not cut off */
 373         int const x_offset = -layout.position.x + ceil(border_width);
 374         int const y_offset = -layout.position.y + ceil(border_width);
 375
 376         auto image = create_image(layout.size);
 377         auto surface = create_surface (image);
 378         auto context = Cairo::Context::create (surface);
 379
 380         context->set_line_width (1);
 381         context->scale (x_scale, y_scale);
 382         layout.pango->update_from_cairo_context(context);
 383
 384         if (first.effect() == dcp::Effect::SHADOW) {
 385                 /* Drop-shadow effect */
 386                 set_source_rgba (context, first.effect_colour(), fade_factor);
 387                 context->move_to (x_offset + 4, y_offset + 4);
 388                 layout.pango->add_to_cairo_context(context);
 389                 context->fill ();
 390         }
 391
 392         if (first.effect() == dcp::Effect::BORDER) {
 393                 /* Border effect */
 394                 set_source_rgba (context, first.effect_colour(), fade_factor);
 395                 context->set_line_width (border_width);
 396                 context->set_line_join (Cairo::LINE_JOIN_ROUND);
 397                 context->move_to (x_offset, y_offset);
 398                 layout.pango->add_to_cairo_context (context);
 399                 context->stroke ();
 400         }
 401
 402         /* The actual subtitle */
 403
 404         set_source_rgba (context, first.colour(), fade_factor);
 405
 406         context->move_to (x_offset, y_offset);
 407         layout.pango->add_to_cairo_context (context);
 408         context->fill ();
 409
 410         context->set_line_width (0.5);
 411         context->move_to (x_offset, y_offset);
 412         layout.pango->add_to_cairo_context (context);
 413         context->stroke ();
 414
 415         int const x = x_position(first.h_align(), first.h_position(), target.width, layout.size.width);
 416         int const y = y_position(first.valign_standard, first.v_align(), first.v_position(), target.height, layout.baseline_to_bottom(border_width), layout.size.height);
 417         return PositionImage (image, Position<int>(max (0, x), max(0, y)));
 418 }
 419
 420
 421 /** @param time Time of the frame that these subtitles are going on.
 422  *  @param target Size of the container that this subtitle will end up in.
 423  *  @param frame_rate DCP frame rate.
 424  */
 425 vector<PositionImage>
 426 render_text(vector<StringText> subtitles, dcp::Size target, DCPTime time, int frame_rate)
 427 {
 428         vector<StringText> pending;
 429         vector<PositionImage> images;
 430
 431         for (auto const& i: subtitles) {
 432                 if (!pending.empty()) {
 433                         auto const last = pending.back();
 434                         auto const different_v = i.v_align() != last.v_align() || fabs(i.v_position() - last.v_position()) > 1e-4;
 435                         auto const different_h = i.h_align() != last.h_align() || fabs(i.h_position() - pending.back().h_position()) > 1e-4;
 436                         if (different_v || different_h) {
 437                                 /* We need a new line if any new positioning (horizontal or vertical) changes for this section */
 438                                 images.push_back(render_line(pending, target, time, frame_rate));
 439                                 pending.clear ();
 440                         }
 441                 }
 442                 pending.push_back (i);
 443         }
 444
 445         if (!pending.empty()) {
 446                 images.push_back(render_line(pending, target, time, frame_rate));
 447         }
 448
 449         return images;
 450 }
 451
 452
 453 vector<dcpomatic::Rect<int>>
 454 bounding_box(vector<StringText> subtitles, dcp::Size target, optional<dcp::SubtitleStandard> override_standard)
 455 {
 456         vector<StringText> pending;
 457         vector<dcpomatic::Rect<int>> rects;
 458
 459         auto use_pending = [&pending, &rects, target, override_standard]() {
 460                 auto const& subtitle = pending.front();
 461                 auto standard = override_standard.get_value_or(subtitle.valign_standard);
 462                 /* We can provide dummy values for time and frame rate here as they are only used to calculate fades */
 463                 auto layout = setup_layout(pending, target, DCPTime(), 24);
 464                 int const x = x_position(subtitle.h_align(), subtitle.h_position(), target.width, layout.size.width);
 465                 auto const border_width = border_width_for_subtitle(subtitle, target);
 466                 int const y = y_position(standard, subtitle.v_align(), subtitle.v_position(), target.height, layout.baseline_to_bottom(border_width), layout.size.height);
 467                 rects.push_back({Position<int>(x, y), layout.size.width, layout.size.height});
 468         };
 469
 470         for (auto const& i: subtitles) {
 471                 if (!pending.empty() && (i.v_align() != pending.back().v_align() || fabs(i.v_position() - pending.back().v_position()) > 1e-4)) {
 472                         use_pending();
 473                         pending.clear();
 474                 }
 475                 pending.push_back(i);
 476         }
 477
 478         if (!pending.empty()) {
 479                 use_pending();
 480         }
 481
 482         return rects;
 483 }
 484
 485
 486 float
 487 FontMetrics::height(StringText const& subtitle)
 488 {
 489         return get(subtitle)->second.second;
 490 }
 491
 492
 493 float
 494 FontMetrics::baseline_to_bottom(StringText const& subtitle)
 495 {
 496         return get(subtitle)->second.first;
 497 }
 498
 499
 500 FontMetrics::Cache::iterator
 501 FontMetrics::get(StringText const& subtitle)
 502 {
 503         auto id = Identifier(subtitle);
 504
 505         auto iter = _cache.find(id);
 506         if (iter != _cache.end()) {
 507                 return iter;
 508         }
 509
 510         auto const font_name = FontConfig::instance()->make_font_available(subtitle.font);
 511         auto copy = subtitle;
 512         copy.set_text("Qypjg");
 513         auto layout = create_layout(font_name, marked_up({copy}, _target_height, 1, font_name));
 514         auto ink = layout->get_ink_extents();
 515         auto const scale = float(_target_height * Pango::SCALE);
 516         return _cache.insert({id, { ink.get_y() / scale, ink.get_height() / scale}}).first;
 517 }
 518
 519
 520 FontMetrics::Identifier::Identifier(StringText const& subtitle)
 521         : font(subtitle.font)
 522         , size(subtitle.size())
 523         , aspect_adjust(subtitle.aspect_adjust())
 524 {
 525
 526 }
 527
 528
 529 bool
 530 FontMetrics::Identifier::operator<(FontMetrics::Identifier const& other) const
 531 {
 532         if (font != other.font) {
 533                 return font < other.font;
 534         }
 535
 536         if (size != other.size) {
 537                 return size < other.size;
 538         }
 539
 540         return aspect_adjust < other.aspect_adjust;
 541 }
 542