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_TRUETYPE_TABLES_H
  35
  36 HB_BEGIN_DECLS
  37
  38
  39 /* TODO:
  40  *
  41  * In general, this file does a fine job of what it's supposed to do.
  42  * There are, however, things that need more work:
  43  *
  44  *   - We don't handle any load_flags.  That definitely has API implications. :(
  45  *     I believe hb_ft_font_create() should take load_flags input.
  46  *
  47  *   - We don't handle / allow for emboldening / obliqueing.
  48  *
  49  *   - In the future, we should add constructors to create fonts in font space.
  50  *
  51  *   - I believe transforms are not correctly implemented.  FreeType does not
  52  *     provide any API to get to the transform/delta set on the face. :(
  53  *
  54  *   - Always use FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH?
  55  */
  56
  57
  58 static hb_bool_t
  59 hb_ft_get_glyph (hb_font_t *font HB_UNUSED,
  60                  void *font_data,
  61                  hb_codepoint_t unicode,
  62                  hb_codepoint_t variation_selector,
  63                  hb_codepoint_t *glyph,
  64                  void *user_data HB_UNUSED)
  65
  66 {
  67   FT_Face ft_face = (FT_Face) font_data;
  68
  69 #ifdef HAVE_FT_FACE_GETCHARVARIANTINDEX
  70   if (unlikely (variation_selector)) {
  71     *glyph = FT_Face_GetCharVariantIndex (ft_face, unicode, variation_selector);
  72     if (*glyph)
  73       return TRUE;
  74   }
  75 #endif
  76
  77   *glyph = FT_Get_Char_Index (ft_face, unicode);
  78   return *glyph != 0;
  79 }
  80
  81 static hb_bool_t
  82 hb_ft_get_glyph_h_advance (hb_font_t *font HB_UNUSED,
  83                            void *font_data,
  84                            hb_codepoint_t glyph,
  85                            hb_position_t *x,
  86                            hb_position_t *y,
  87                            void *user_data HB_UNUSED)
  88 {
  89   FT_Face ft_face = (FT_Face) font_data;
  90   int load_flags = FT_LOAD_DEFAULT;
  91
  92   if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
  93     return FALSE;
  94
  95   *x = ft_face->glyph->metrics.horiAdvance;
  96   return TRUE;
  97 }
  98
  99 static hb_bool_t
 100 hb_ft_get_glyph_v_advance (hb_font_t *font HB_UNUSED,
 101                            void *font_data,
 102                            hb_codepoint_t glyph,
 103                            hb_position_t *x,
 104                            hb_position_t *y,
 105                            void *user_data HB_UNUSED)
 106 {
 107   FT_Face ft_face = (FT_Face) font_data;
 108   int load_flags = FT_LOAD_DEFAULT;
 109
 110   if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
 111     return FALSE;
 112
 113   *y = -ft_face->glyph->metrics.vertAdvance;
 114   return TRUE;
 115 }
 116
 117 static hb_bool_t
 118 hb_ft_get_glyph_h_origin (hb_font_t *font HB_UNUSED,
 119                           void *font_data HB_UNUSED,
 120                           hb_codepoint_t glyph HB_UNUSED,
 121                           hb_position_t *x HB_UNUSED,
 122                           hb_position_t *y HB_UNUSED,
 123                           void *user_data HB_UNUSED)
 124 {
 125   /* We always work in the horizontal coordinates. */
 126   return TRUE;
 127 }
 128
 129 static hb_bool_t
 130 hb_ft_get_glyph_v_origin (hb_font_t *font HB_UNUSED,
 131                           void *font_data,
 132                           hb_codepoint_t glyph,
 133                           hb_position_t *x,
 134                           hb_position_t *y,
 135                           void *user_data HB_UNUSED)
 136 {
 137   FT_Face ft_face = (FT_Face) font_data;
 138   int load_flags = FT_LOAD_DEFAULT;
 139
 140   if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
 141     return FALSE;
 142
 143   /* XXX */*y = ft_face->glyph->metrics.vertAdvance;
 144   return TRUE;
 145 }
 146
 147 static hb_bool_t
 148 hb_ft_get_glyph_h_kerning (hb_font_t *font HB_UNUSED,
 149                            void *font_data,
 150                            hb_codepoint_t left_glyph,
 151                            hb_codepoint_t right_glyph,
 152                            hb_position_t *x,
 153                            hb_position_t *y,
 154                            void *user_data HB_UNUSED)
 155 {
 156   FT_Face ft_face = (FT_Face) font_data;
 157   FT_Vector kerning;
 158
 159   if (FT_Get_Kerning (ft_face, left_glyph, right_glyph, FT_KERNING_DEFAULT, &kerning))
 160     return FALSE;
 161
 162   *x = kerning.x;
 163   *y = kerning.y;
 164   return TRUE;
 165 }
 166
 167 static hb_bool_t
 168 hb_ft_get_glyph_v_kerning (hb_font_t *font HB_UNUSED,
 169                            void *font_data HB_UNUSED,
 170                            hb_codepoint_t top_glyph HB_UNUSED,
 171                            hb_codepoint_t bottom_glyph HB_UNUSED,
 172                            hb_position_t *x HB_UNUSED,
 173                            hb_position_t *y HB_UNUSED,
 174                            void *user_data HB_UNUSED)
 175 {
 176   /* FreeType API doesn't support vertical kerning */
 177   return FALSE;
 178 }
 179
 180 static hb_bool_t
 181 hb_ft_get_glyph_extents (hb_font_t *font HB_UNUSED,
 182                          void *font_data,
 183                          hb_codepoint_t glyph,
 184                          hb_glyph_extents_t *extents,
 185                          void *user_data HB_UNUSED)
 186 {
 187   FT_Face ft_face = (FT_Face) font_data;
 188   int load_flags = FT_LOAD_DEFAULT;
 189
 190   if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
 191     return FALSE;
 192
 193   /* XXX: A few negations should be in order here, not sure. */
 194   extents->x_bearing = ft_face->glyph->metrics.horiBearingX;
 195   extents->y_bearing = ft_face->glyph->metrics.horiBearingY;
 196   extents->width = ft_face->glyph->metrics.width;
 197   extents->height = ft_face->glyph->metrics.height;
 198   return TRUE;
 199 }
 200
 201 static hb_bool_t
 202 hb_ft_get_glyph_contour_point (hb_font_t *font HB_UNUSED,
 203                                void *font_data,
 204                                hb_codepoint_t glyph,
 205                                unsigned int point_index,
 206                                hb_position_t *x,
 207                                hb_position_t *y,
 208                                void *user_data HB_UNUSED)
 209 {
 210   FT_Face ft_face = (FT_Face) font_data;
 211   int load_flags = FT_LOAD_DEFAULT;
 212
 213   if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
 214       return FALSE;
 215
 216   if (unlikely (ft_face->glyph->format != FT_GLYPH_FORMAT_OUTLINE))
 217       return FALSE;
 218
 219   if (unlikely (point_index >= (unsigned int) ft_face->glyph->outline.n_points))
 220       return FALSE;
 221
 222   *x = ft_face->glyph->outline.points[point_index].x;
 223   *y = ft_face->glyph->outline.points[point_index].y;
 224
 225   return TRUE;
 226 }
 227
 228 static hb_font_funcs_t ft_ffuncs = {
 229   HB_OBJECT_HEADER_STATIC,
 230
 231   TRUE, /* immutable */
 232
 233   {
 234     hb_ft_get_glyph,
 235     hb_ft_get_glyph_h_advance,
 236     hb_ft_get_glyph_v_advance,
 237     hb_ft_get_glyph_h_origin,
 238     hb_ft_get_glyph_v_origin,
 239     hb_ft_get_glyph_h_kerning,
 240     hb_ft_get_glyph_v_kerning,
 241     hb_ft_get_glyph_extents,
 242     hb_ft_get_glyph_contour_point,
 243   }
 244 };
 245
 246 hb_font_funcs_t *
 247 hb_ft_get_font_funcs (void)
 248 {
 249   return &ft_ffuncs;
 250 }
 251
 252
 253 static hb_blob_t *
 254 get_table  (hb_face_t *face HB_UNUSED, hb_tag_t tag, void *user_data)
 255 {
 256   FT_Face ft_face = (FT_Face) user_data;
 257   FT_Byte *buffer;
 258   FT_ULong  length = 0;
 259   FT_Error error;
 260
 261   if (unlikely (tag == HB_TAG_NONE))
 262     return NULL;
 263
 264   error = FT_Load_Sfnt_Table (ft_face, tag, 0, NULL, &length);
 265   if (error)
 266     return NULL;
 267
 268   buffer = (FT_Byte *) malloc (length);
 269   if (buffer == NULL)
 270     return NULL;
 271
 272   error = FT_Load_Sfnt_Table (ft_face, tag, 0, buffer, &length);
 273   if (error)
 274     return NULL;
 275
 276   return hb_blob_create ((const char *) buffer, length,
 277                          HB_MEMORY_MODE_WRITABLE,
 278                          buffer, free);
 279 }
 280
 281
 282 hb_face_t *
 283 hb_ft_face_create (FT_Face           ft_face,
 284                    hb_destroy_func_t destroy)
 285 {
 286   hb_face_t *face;
 287
 288   if (ft_face->stream->read == NULL) {
 289     hb_blob_t *blob;
 290
 291     blob = hb_blob_create ((const char *) ft_face->stream->base,
 292                            (unsigned int) ft_face->stream->size,
 293                            /* TODO: We assume that it's mmap()'ed, but FreeType code
 294                             * suggests that there are cases we reach here but font is
 295                             * not mmapped.  For example, when mmap() fails.  No idea
 296                             * how to deal with it better here. */
 297                            HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE,
 298                            ft_face, destroy);
 299     face = hb_face_create (blob, ft_face->face_index);
 300     hb_blob_destroy (blob);
 301   } else {
 302     face = hb_face_create_for_tables (get_table, ft_face, destroy);
 303   }
 304
 305   return face;
 306 }
 307
 308 static void
 309 hb_ft_face_finalize (FT_Face ft_face)
 310 {
 311   hb_face_destroy ((hb_face_t *) ft_face->generic.data);
 312 }
 313
 314 hb_face_t *
 315 hb_ft_face_create_cached (FT_Face ft_face)
 316 {
 317   if (unlikely (!ft_face->generic.data || ft_face->generic.finalizer != (FT_Generic_Finalizer) hb_ft_face_finalize))
 318   {
 319     if (ft_face->generic.finalizer)
 320       ft_face->generic.finalizer (ft_face);
 321
 322     ft_face->generic.data = hb_ft_face_create (ft_face, NULL);
 323     ft_face->generic.finalizer = (FT_Generic_Finalizer) hb_ft_face_finalize;
 324   }
 325
 326   return hb_face_reference ((hb_face_t *) ft_face->generic.data);
 327 }
 328
 329
 330 hb_font_t *
 331 hb_ft_font_create (FT_Face           ft_face,
 332                    hb_destroy_func_t destroy)
 333 {
 334   hb_font_t *font;
 335   hb_face_t *face;
 336
 337   face = hb_ft_face_create (ft_face, destroy);
 338   font = hb_font_create (face);
 339   hb_face_destroy (face);
 340   hb_font_set_funcs (font,
 341                      hb_ft_get_font_funcs (),
 342                      ft_face, NULL);
 343   hb_font_set_scale (font,
 344                      ((uint64_t) ft_face->size->metrics.x_scale * (uint64_t) ft_face->units_per_EM) >> 16,
 345                      ((uint64_t) ft_face->size->metrics.y_scale * (uint64_t) ft_face->units_per_EM) >> 16);
 346   hb_font_set_ppem (font,
 347                     ft_face->size->metrics.x_ppem,
 348                     ft_face->size->metrics.y_ppem);
 349
 350   return font;
 351 }
 352
 353
 354 HB_END_DECLS