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