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