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_position_t
  82 hb_ft_get_glyph_h_advance (hb_font_t *font HB_UNUSED,
  83                            void *font_data,
  84                            hb_codepoint_t glyph,
  85                            void *user_data HB_UNUSED)
  86 {
  87   FT_Face ft_face = (FT_Face) font_data;
  88   int load_flags = FT_LOAD_DEFAULT;
  89
  90   if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
  91     return 0;
  92
  93   return ft_face->glyph->metrics.horiAdvance;
  94 }
  95
  96 static hb_position_t
  97 hb_ft_get_glyph_v_advance (hb_font_t *font HB_UNUSED,
  98                            void *font_data,
  99                            hb_codepoint_t glyph,
 100                            void *user_data HB_UNUSED)
 101 {
 102   FT_Face ft_face = (FT_Face) font_data;
 103   int load_flags = FT_LOAD_DEFAULT;
 104
 105   if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
 106     return 0;
 107
 108   /* Note: FreeType's vertical metrics grows downward while other FreeType coordinates
 109    * have a Y growing upward.  Hence the extra negation. */
 110   return -ft_face->glyph->metrics.vertAdvance;
 111 }
 112
 113 static hb_bool_t
 114 hb_ft_get_glyph_h_origin (hb_font_t *font HB_UNUSED,
 115                           void *font_data HB_UNUSED,
 116                           hb_codepoint_t glyph HB_UNUSED,
 117                           hb_position_t *x HB_UNUSED,
 118                           hb_position_t *y HB_UNUSED,
 119                           void *user_data HB_UNUSED)
 120 {
 121   /* We always work in the horizontal coordinates. */
 122   return TRUE;
 123 }
 124
 125 static hb_bool_t
 126 hb_ft_get_glyph_v_origin (hb_font_t *font HB_UNUSED,
 127                           void *font_data,
 128                           hb_codepoint_t glyph,
 129                           hb_position_t *x,
 130                           hb_position_t *y,
 131                           void *user_data HB_UNUSED)
 132 {
 133   FT_Face ft_face = (FT_Face) font_data;
 134   int load_flags = FT_LOAD_DEFAULT;
 135
 136   if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
 137     return FALSE;
 138
 139   /* Note: FreeType's vertical metrics grows downward while other FreeType coordinates
 140    * have a Y growing upward.  Hence the extra negation. */
 141   *x = ft_face->glyph->metrics.horiBearingX -   ft_face->glyph->metrics.vertBearingX;
 142   *y = ft_face->glyph->metrics.horiBearingY - (-ft_face->glyph->metrics.vertBearingY);
 143
 144   return TRUE;
 145 }
 146
 147 static hb_position_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                            void *user_data HB_UNUSED)
 153 {
 154   FT_Face ft_face = (FT_Face) font_data;
 155   FT_Vector kerningv;
 156
 157   if (FT_Get_Kerning (ft_face, left_glyph, right_glyph, FT_KERNING_DEFAULT, &kerningv))
 158     return 0;
 159
 160   return kerningv.x;
 161 }
 162
 163 static hb_position_t
 164 hb_ft_get_glyph_v_kerning (hb_font_t *font HB_UNUSED,
 165                            void *font_data HB_UNUSED,
 166                            hb_codepoint_t top_glyph HB_UNUSED,
 167                            hb_codepoint_t bottom_glyph HB_UNUSED,
 168                            void *user_data HB_UNUSED)
 169 {
 170   /* FreeType API doesn't support vertical kerning */
 171   return 0;
 172 }
 173
 174 static hb_bool_t
 175 hb_ft_get_glyph_extents (hb_font_t *font HB_UNUSED,
 176                          void *font_data,
 177                          hb_codepoint_t glyph,
 178                          hb_glyph_extents_t *extents,
 179                          void *user_data HB_UNUSED)
 180 {
 181   FT_Face ft_face = (FT_Face) font_data;
 182   int load_flags = FT_LOAD_DEFAULT;
 183
 184   if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
 185     return FALSE;
 186
 187   extents->x_bearing = ft_face->glyph->metrics.horiBearingX;
 188   extents->y_bearing = ft_face->glyph->metrics.horiBearingY;
 189   extents->width = ft_face->glyph->metrics.width;
 190   extents->height = ft_face->glyph->metrics.height;
 191   return TRUE;
 192 }
 193
 194 static hb_bool_t
 195 hb_ft_get_glyph_contour_point (hb_font_t *font HB_UNUSED,
 196                                void *font_data,
 197                                hb_codepoint_t glyph,
 198                                unsigned int point_index,
 199                                hb_position_t *x,
 200                                hb_position_t *y,
 201                                void *user_data HB_UNUSED)
 202 {
 203   FT_Face ft_face = (FT_Face) font_data;
 204   int load_flags = FT_LOAD_DEFAULT;
 205
 206   if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
 207       return FALSE;
 208
 209   if (unlikely (ft_face->glyph->format != FT_GLYPH_FORMAT_OUTLINE))
 210       return FALSE;
 211
 212   if (unlikely (point_index >= (unsigned int) ft_face->glyph->outline.n_points))
 213       return FALSE;
 214
 215   *x = ft_face->glyph->outline.points[point_index].x;
 216   *y = ft_face->glyph->outline.points[point_index].y;
 217
 218   return TRUE;
 219 }
 220
 221 static hb_font_funcs_t ft_ffuncs = {
 222   HB_OBJECT_HEADER_STATIC,
 223
 224   TRUE, /* immutable */
 225
 226   {
 227     hb_ft_get_glyph,
 228     hb_ft_get_glyph_h_advance,
 229     hb_ft_get_glyph_v_advance,
 230     hb_ft_get_glyph_h_origin,
 231     hb_ft_get_glyph_v_origin,
 232     hb_ft_get_glyph_h_kerning,
 233     hb_ft_get_glyph_v_kerning,
 234     hb_ft_get_glyph_extents,
 235     hb_ft_get_glyph_contour_point,
 236   }
 237 };
 238
 239 hb_font_funcs_t *
 240 hb_ft_get_font_funcs (void)
 241 {
 242   return &ft_ffuncs;
 243 }
 244
 245
 246 static hb_blob_t *
 247 get_table  (hb_face_t *face HB_UNUSED, hb_tag_t tag, void *user_data)
 248 {
 249   FT_Face ft_face = (FT_Face) user_data;
 250   FT_Byte *buffer;
 251   FT_ULong  length = 0;
 252   FT_Error error;
 253
 254   if (unlikely (tag == HB_TAG_NONE))
 255     return NULL;
 256
 257   error = FT_Load_Sfnt_Table (ft_face, tag, 0, NULL, &length);
 258   if (error)
 259     return NULL;
 260
 261   buffer = (FT_Byte *) malloc (length);
 262   if (buffer == NULL)
 263     return NULL;
 264
 265   error = FT_Load_Sfnt_Table (ft_face, tag, 0, buffer, &length);
 266   if (error)
 267     return NULL;
 268
 269   return hb_blob_create ((const char *) buffer, length,
 270                          HB_MEMORY_MODE_WRITABLE,
 271                          buffer, free);
 272 }
 273
 274
 275 hb_face_t *
 276 hb_ft_face_create (FT_Face           ft_face,
 277                    hb_destroy_func_t destroy)
 278 {
 279   hb_face_t *face;
 280
 281   if (ft_face->stream->read == NULL) {
 282     hb_blob_t *blob;
 283
 284     blob = hb_blob_create ((const char *) ft_face->stream->base,
 285                            (unsigned int) ft_face->stream->size,
 286                            /* TODO: We assume that it's mmap()'ed, but FreeType code
 287                             * suggests that there are cases we reach here but font is
 288                             * not mmapped.  For example, when mmap() fails.  No idea
 289                             * how to deal with it better here. */
 290                            HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE,
 291                            ft_face, destroy);
 292     face = hb_face_create (blob, ft_face->face_index);
 293     hb_blob_destroy (blob);
 294   } else {
 295     face = hb_face_create_for_tables (get_table, ft_face, destroy);
 296   }
 297
 298   return face;
 299 }
 300
 301 static void
 302 hb_ft_face_finalize (FT_Face ft_face)
 303 {
 304   hb_face_destroy ((hb_face_t *) ft_face->generic.data);
 305 }
 306
 307 hb_face_t *
 308 hb_ft_face_create_cached (FT_Face ft_face)
 309 {
 310   if (unlikely (!ft_face->generic.data || ft_face->generic.finalizer != (FT_Generic_Finalizer) hb_ft_face_finalize))
 311   {
 312     if (ft_face->generic.finalizer)
 313       ft_face->generic.finalizer (ft_face);
 314
 315     ft_face->generic.data = hb_ft_face_create (ft_face, NULL);
 316     ft_face->generic.finalizer = (FT_Generic_Finalizer) hb_ft_face_finalize;
 317   }
 318
 319   return hb_face_reference ((hb_face_t *) ft_face->generic.data);
 320 }
 321
 322
 323 hb_font_t *
 324 hb_ft_font_create (FT_Face           ft_face,
 325                    hb_destroy_func_t destroy)
 326 {
 327   hb_font_t *font;
 328   hb_face_t *face;
 329
 330   face = hb_ft_face_create (ft_face, destroy);
 331   font = hb_font_create (face);
 332   hb_face_destroy (face);
 333   hb_font_set_funcs (font,
 334                      hb_ft_get_font_funcs (),
 335                      ft_face, NULL);
 336   hb_font_set_scale (font,
 337                      ((uint64_t) ft_face->size->metrics.x_scale * (uint64_t) ft_face->units_per_EM) >> 16,
 338                      ((uint64_t) ft_face->size->metrics.y_scale * (uint64_t) ft_face->units_per_EM) >> 16);
 339   hb_font_set_ppem (font,
 340                     ft_face->size->metrics.x_ppem,
 341                     ft_face->size->metrics.y_ppem);
 342
 343   return font;
 344 }
 345
 346
 347 HB_END_DECLS