src/hb-ft.cc

   1 /*
   2  * Copyright © 2009  Red Hat, Inc.
   3  * Copyright © 2009  Keith Stribley
   4  *
   5  *  This is part of HarfBuzz, a text shaping library.
   6  *
   7  * Permission is hereby granted, without written agreement and without
   8  * license or royalty fees, to use, copy, modify, and distribute this
   9  * software and its documentation for any purpose, provided that the
  10  * above copyright notice and the following two paragraphs appear in
  11  * all copies of this software.
  12  *
  13  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  15  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  16  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  17  * DAMAGE.
  18  *
  19  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  20  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  21  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  22  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  23  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  24  *
  25  * Red Hat Author(s): Behdad Esfahbod
  26  */
  27
  28 #include "hb-private.hh"
  29
  30 #include "hb-ft.h"
  31
  32 #include "hb-font-private.hh"
  33
  34 #include FT_ADVANCES_H
  35 #include FT_TRUETYPE_TABLES_H
  36
  37
  38
  39 #ifndef HB_DEBUG_FT
  40 #define HB_DEBUG_FT (HB_DEBUG+0)
  41 #endif
  42
  43
  44 /* TODO:
  45  *
  46  * In general, this file does a fine job of what it's supposed to do.
  47  * There are, however, things that need more work:
  48  *
  49  *   - We don't handle any load_flags.  That definitely has API implications. :(
  50  *     I believe hb_ft_font_create() should take load_flags input.
  51  *     In particular, FT_Get_Advance() without the NO_HINTING flag seems to be
  52  *     buggy.
  53  *
  54  *   - We don't handle / allow for emboldening / obliqueing.
  55  *
  56  *   - Rounding, etc?
  57  *
  58  *   - In the future, we should add constructors to create fonts in font space.
  59  *
  60  *   - I believe transforms are not correctly implemented.  FreeType does not
  61  *     provide any API to get to the transform/delta set on the face. :(
  62  *
  63  *   - Always use FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH?
  64  *
  65  *   - FT_Load_Glyph() is exteremely costly.  Do something about it?
  66  */
  67
  68
  69 static hb_bool_t
  70 hb_ft_get_glyph (hb_font_t *font HB_UNUSED,
  71                  void *font_data,
  72                  hb_codepoint_t unicode,
  73                  hb_codepoint_t variation_selector,
  74                  hb_codepoint_t *glyph,
  75                  void *user_data HB_UNUSED)
  76
  77 {
  78   FT_Face ft_face = (FT_Face) font_data;
  79
  80 #ifdef HAVE_FT_FACE_GETCHARVARIANTINDEX
  81   if (unlikely (variation_selector)) {
  82     *glyph = FT_Face_GetCharVariantIndex (ft_face, unicode, variation_selector);
  83     if (*glyph)
  84       return true;
  85   }
  86 #endif
  87
  88   *glyph = FT_Get_Char_Index (ft_face, unicode);
  89   return *glyph != 0;
  90 }
  91
  92 static hb_position_t
  93 hb_ft_get_glyph_h_advance (hb_font_t *font HB_UNUSED,
  94                            void *font_data,
  95                            hb_codepoint_t glyph,
  96                            void *user_data HB_UNUSED)
  97 {
  98   FT_Face ft_face = (FT_Face) font_data;
  99   int load_flags = FT_LOAD_DEFAULT | FT_LOAD_NO_HINTING;
 100   FT_Fixed v;
 101
 102   if (unlikely (FT_Get_Advance (ft_face, glyph, load_flags, &v)))
 103     return 0;
 104
 105   return v >> 10;
 106 }
 107
 108 static hb_position_t
 109 hb_ft_get_glyph_v_advance (hb_font_t *font HB_UNUSED,
 110                            void *font_data,
 111                            hb_codepoint_t glyph,
 112                            void *user_data HB_UNUSED)
 113 {
 114   FT_Face ft_face = (FT_Face) font_data;
 115   int load_flags = FT_LOAD_DEFAULT | FT_LOAD_NO_HINTING | FT_LOAD_VERTICAL_LAYOUT;
 116   FT_Fixed v;
 117
 118   if (unlikely (FT_Get_Advance (ft_face, glyph, load_flags, &v)))
 119     return 0;
 120
 121   /* Note: FreeType's vertical metrics grows downward while other FreeType coordinates
 122    * have a Y growing upward.  Hence the extra negation. */
 123   return -v >> 10;
 124 }
 125
 126 static hb_bool_t
 127 hb_ft_get_glyph_h_origin (hb_font_t *font HB_UNUSED,
 128                           void *font_data HB_UNUSED,
 129                           hb_codepoint_t glyph HB_UNUSED,
 130                           hb_position_t *x HB_UNUSED,
 131                           hb_position_t *y HB_UNUSED,
 132                           void *user_data HB_UNUSED)
 133 {
 134   /* We always work in the horizontal coordinates. */
 135   return true;
 136 }
 137
 138 static hb_bool_t
 139 hb_ft_get_glyph_v_origin (hb_font_t *font HB_UNUSED,
 140                           void *font_data,
 141                           hb_codepoint_t glyph,
 142                           hb_position_t *x,
 143                           hb_position_t *y,
 144                           void *user_data HB_UNUSED)
 145 {
 146   FT_Face ft_face = (FT_Face) font_data;
 147   int load_flags = FT_LOAD_DEFAULT;
 148
 149   if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
 150     return false;
 151
 152   /* Note: FreeType's vertical metrics grows downward while other FreeType coordinates
 153    * have a Y growing upward.  Hence the extra negation. */
 154   *x = ft_face->glyph->metrics.horiBearingX -   ft_face->glyph->metrics.vertBearingX;
 155   *y = ft_face->glyph->metrics.horiBearingY - (-ft_face->glyph->metrics.vertBearingY);
 156
 157   return true;
 158 }
 159
 160 static hb_position_t
 161 hb_ft_get_glyph_h_kerning (hb_font_t *font HB_UNUSED,
 162                            void *font_data,
 163                            hb_codepoint_t left_glyph,
 164                            hb_codepoint_t right_glyph,
 165                            void *user_data HB_UNUSED)
 166 {
 167   FT_Face ft_face = (FT_Face) font_data;
 168   FT_Vector kerningv;
 169
 170   if (FT_Get_Kerning (ft_face, left_glyph, right_glyph, FT_KERNING_DEFAULT, &kerningv))
 171     return 0;
 172
 173   return kerningv.x;
 174 }
 175
 176 static hb_position_t
 177 hb_ft_get_glyph_v_kerning (hb_font_t *font HB_UNUSED,
 178                            void *font_data HB_UNUSED,
 179                            hb_codepoint_t top_glyph HB_UNUSED,
 180                            hb_codepoint_t bottom_glyph HB_UNUSED,
 181                            void *user_data HB_UNUSED)
 182 {
 183   /* FreeType API doesn't support vertical kerning */
 184   return 0;
 185 }
 186
 187 static hb_bool_t
 188 hb_ft_get_glyph_extents (hb_font_t *font HB_UNUSED,
 189                          void *font_data,
 190                          hb_codepoint_t glyph,
 191                          hb_glyph_extents_t *extents,
 192                          void *user_data HB_UNUSED)
 193 {
 194   FT_Face ft_face = (FT_Face) font_data;
 195   int load_flags = FT_LOAD_DEFAULT;
 196
 197   if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
 198     return false;
 199
 200   extents->x_bearing = ft_face->glyph->metrics.horiBearingX;
 201   extents->y_bearing = ft_face->glyph->metrics.horiBearingY;
 202   extents->width = ft_face->glyph->metrics.width;
 203   extents->height = ft_face->glyph->metrics.height;
 204   return true;
 205 }
 206
 207 static hb_bool_t
 208 hb_ft_get_glyph_contour_point (hb_font_t *font HB_UNUSED,
 209                                void *font_data,
 210                                hb_codepoint_t glyph,
 211                                unsigned int point_index,
 212                                hb_position_t *x,
 213                                hb_position_t *y,
 214                                void *user_data HB_UNUSED)
 215 {
 216   FT_Face ft_face = (FT_Face) font_data;
 217   int load_flags = FT_LOAD_DEFAULT;
 218
 219   if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
 220       return false;
 221
 222   if (unlikely (ft_face->glyph->format != FT_GLYPH_FORMAT_OUTLINE))
 223       return false;
 224
 225   if (unlikely (point_index >= (unsigned int) ft_face->glyph->outline.n_points))
 226       return false;
 227
 228   *x = ft_face->glyph->outline.points[point_index].x;
 229   *y = ft_face->glyph->outline.points[point_index].y;
 230
 231   return true;
 232 }
 233
 234 static hb_bool_t
 235 hb_ft_get_glyph_name (hb_font_t *font,
 236                       void *font_data,
 237                       hb_codepoint_t glyph,
 238                       char *name, unsigned int size,
 239                       void *user_data HB_UNUSED)
 240 {
 241   FT_Face ft_face = (FT_Face) font_data;
 242
 243   hb_bool_t ret = !FT_Get_Glyph_Name (ft_face, glyph, name, size);
 244   if (!ret)
 245     snprintf (name, size, "gid%u", glyph);
 246
 247   return ret;
 248 }
 249
 250 static hb_bool_t
 251 hb_ft_get_glyph_from_name (hb_font_t *font,
 252                            void *font_data,
 253                            const char *name, int len, /* -1 means nul-terminated */
 254                            hb_codepoint_t *glyph,
 255                            void *user_data HB_UNUSED)
 256 {
 257   FT_Face ft_face = (FT_Face) font_data;
 258
 259   if (len < 0)
 260     *glyph = FT_Get_Name_Index (ft_face, (FT_String *) name);
 261   else {
 262     /* Make a nul-terminated version. */
 263     char buf[128];
 264     len = MIN (len, (int) sizeof (buf) - 1);
 265     strncpy (buf, name, len);
 266     buf[len] = '\0';
 267     *glyph = FT_Get_Name_Index (ft_face, buf);
 268   }
 269
 270   return *glyph != 0;
 271 }
 272
 273
 274 static hb_font_funcs_t *
 275 _hb_ft_get_font_funcs (void)
 276 {
 277   static const hb_font_funcs_t ft_ffuncs = {
 278     HB_OBJECT_HEADER_STATIC,
 279
 280     true, /* immutable */
 281
 282     {
 283 #define HB_FONT_FUNC_IMPLEMENT(name) hb_ft_get_##name,
 284       HB_FONT_FUNCS_IMPLEMENT_CALLBACKS
 285 #undef HB_FONT_FUNC_IMPLEMENT
 286     }
 287   };
 288
 289   return const_cast<hb_font_funcs_t *> (&ft_ffuncs);
 290 }
 291
 292
 293 static hb_blob_t *
 294 reference_table  (hb_face_t *face HB_UNUSED, hb_tag_t tag, void *user_data)
 295 {
 296   FT_Face ft_face = (FT_Face) user_data;
 297   FT_Byte *buffer;
 298   FT_ULong  length = 0;
 299   FT_Error error;
 300
 301   /* Note: FreeType like HarfBuzz uses the NONE tag for fetching the entire blob */
 302
 303   error = FT_Load_Sfnt_Table (ft_face, tag, 0, NULL, &length);
 304   if (error)
 305     return NULL;
 306
 307   buffer = (FT_Byte *) malloc (length);
 308   if (buffer == NULL)
 309     return NULL;
 310
 311   error = FT_Load_Sfnt_Table (ft_face, tag, 0, buffer, &length);
 312   if (error)
 313     return NULL;
 314
 315   return hb_blob_create ((const char *) buffer, length,
 316                          HB_MEMORY_MODE_WRITABLE,
 317                          buffer, free);
 318 }
 319
 320
 321 hb_face_t *
 322 hb_ft_face_create (FT_Face           ft_face,
 323                    hb_destroy_func_t destroy)
 324 {
 325   hb_face_t *face;
 326
 327   if (ft_face->stream->read == NULL) {
 328     hb_blob_t *blob;
 329
 330     blob = hb_blob_create ((const char *) ft_face->stream->base,
 331                            (unsigned int) ft_face->stream->size,
 332                            /* TODO: We assume that it's mmap()'ed, but FreeType code
 333                             * suggests that there are cases we reach here but font is
 334                             * not mmapped.  For example, when mmap() fails.  No idea
 335                             * how to deal with it better here. */
 336                            HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE,
 337                            ft_face, destroy);
 338     face = hb_face_create (blob, ft_face->face_index);
 339     hb_blob_destroy (blob);
 340   } else {
 341     face = hb_face_create_for_tables (reference_table, ft_face, destroy);
 342   }
 343
 344   hb_face_set_index (face, ft_face->face_index);
 345   hb_face_set_upem (face, ft_face->units_per_EM);
 346
 347   return face;
 348 }
 349
 350 static void
 351 hb_ft_face_finalize (FT_Face ft_face)
 352 {
 353   hb_face_destroy ((hb_face_t *) ft_face->generic.data);
 354 }
 355
 356 hb_face_t *
 357 hb_ft_face_create_cached (FT_Face ft_face)
 358 {
 359   if (unlikely (!ft_face->generic.data || ft_face->generic.finalizer != (FT_Generic_Finalizer) hb_ft_face_finalize))
 360   {
 361     if (ft_face->generic.finalizer)
 362       ft_face->generic.finalizer (ft_face);
 363
 364     ft_face->generic.data = hb_ft_face_create (ft_face, NULL);
 365     ft_face->generic.finalizer = (FT_Generic_Finalizer) hb_ft_face_finalize;
 366   }
 367
 368   return hb_face_reference ((hb_face_t *) ft_face->generic.data);
 369 }
 370
 371 static void
 372 _do_nothing (void)
 373 {
 374 }
 375
 376
 377 hb_font_t *
 378 hb_ft_font_create (FT_Face           ft_face,
 379                    hb_destroy_func_t destroy)
 380 {
 381   hb_font_t *font;
 382   hb_face_t *face;
 383
 384   face = hb_ft_face_create (ft_face, destroy);
 385   font = hb_font_create (face);
 386   hb_face_destroy (face);
 387   hb_font_set_funcs (font,
 388                      _hb_ft_get_font_funcs (),
 389                      ft_face, (hb_destroy_func_t) _do_nothing);
 390   hb_font_set_scale (font,
 391                      ((uint64_t) ft_face->size->metrics.x_scale * (uint64_t) ft_face->units_per_EM) >> 16,
 392                      ((uint64_t) ft_face->size->metrics.y_scale * (uint64_t) ft_face->units_per_EM) >> 16);
 393   hb_font_set_ppem (font,
 394                     ft_face->size->metrics.x_ppem,
 395                     ft_face->size->metrics.y_ppem);
 396
 397   return font;
 398 }
 399
 400
 401 /* Thread-safe, lock-free, FT_Library */
 402
 403 static FT_Library ft_library;
 404
 405 static
 406 void free_ft_library (void)
 407 {
 408   FT_Done_FreeType (ft_library);
 409 }
 410
 411 static FT_Library
 412 get_ft_library (void)
 413 {
 414 retry:
 415   FT_Library library = (FT_Library) hb_atomic_ptr_get (&ft_library);
 416
 417   if (unlikely (!library))
 418   {
 419     /* Not found; allocate one. */
 420     if (FT_Init_FreeType (&library))
 421       return NULL;
 422
 423     if (!hb_atomic_ptr_cmpexch (&ft_library, NULL, library)) {
 424       FT_Done_FreeType (library);
 425       goto retry;
 426     }
 427
 428 #ifdef HAVE_ATEXIT
 429     atexit (free_ft_library); /* First person registers atexit() callback. */
 430 #endif
 431   }
 432
 433   return library;
 434 }
 435
 436 static void
 437 _release_blob (FT_Face ft_face)
 438 {
 439   hb_blob_destroy ((hb_blob_t *) ft_face->generic.data);
 440 }
 441
 442 void
 443 hb_ft_font_set_funcs (hb_font_t *font)
 444 {
 445   hb_blob_t *blob = hb_face_reference_blob (font->face);
 446   unsigned int blob_length;
 447   const char *blob_data = hb_blob_get_data (blob, &blob_length);
 448   if (unlikely (!blob_length))
 449     DEBUG_MSG (FT, font, "Font face has empty blob");
 450
 451   FT_Face ft_face = NULL;
 452   FT_Error err = FT_New_Memory_Face (get_ft_library (),
 453                                      (const FT_Byte *) blob_data,
 454                                      blob_length,
 455                                      hb_face_get_index (font->face),
 456                                      &ft_face);
 457
 458   if (unlikely (err)) {
 459     hb_blob_destroy (blob);
 460     DEBUG_MSG (FT, font, "Font face FT_New_Memory_Face() failed");
 461     return;
 462   }
 463
 464   FT_Select_Charmap (ft_face, FT_ENCODING_UNICODE);
 465
 466   FT_Set_Char_Size (ft_face,
 467                     font->x_scale, font->y_scale,
 468                     font->x_ppem * 72 * 64 / font->x_scale,
 469                     font->y_ppem * 72 * 64 / font->y_scale);
 470
 471   ft_face->generic.data = blob;
 472   ft_face->generic.finalizer = (FT_Generic_Finalizer) _release_blob;
 473
 474   hb_font_set_funcs (font,
 475                      _hb_ft_get_font_funcs (),
 476                      ft_face,
 477                      (hb_destroy_func_t) FT_Done_Face);
 478 }
 479
 480 FT_Face
 481 hb_ft_font_get_face (hb_font_t *font)
 482 {
 483   if (font->destroy == (hb_destroy_func_t) FT_Done_Face ||
 484       font->destroy == (hb_destroy_func_t) _do_nothing)
 485     return (FT_Face) font->user_data;
 486
 487   return NULL;
 488 }