2 * Copyright © 2009 Red Hat, Inc.
3 * Copyright © 2009 Keith Stribley
5 * This is part of HarfBuzz, a text shaping library.
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.
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
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.
25 * Red Hat Author(s): Behdad Esfahbod
28 #include "hb-private.hh"
32 #include "hb-font-private.hh"
34 #include FT_ADVANCES_H
35 #include FT_TRUETYPE_TABLES_H
40 #define HB_DEBUG_FT (HB_DEBUG+0)
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:
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
54 * - We don't handle / allow for emboldening / obliqueing.
56 * - In the future, we should add constructors to create fonts in font space?
58 * - FT_Load_Glyph() is exteremely costly. Do something about it?
63 hb_ft_get_glyph (hb_font_t *font HB_UNUSED,
65 hb_codepoint_t unicode,
66 hb_codepoint_t variation_selector,
67 hb_codepoint_t *glyph,
68 void *user_data HB_UNUSED)
71 FT_Face ft_face = (FT_Face) font_data;
73 #ifdef HAVE_FT_FACE_GETCHARVARIANTINDEX
74 if (unlikely (variation_selector)) {
75 *glyph = FT_Face_GetCharVariantIndex (ft_face, unicode, variation_selector);
80 *glyph = FT_Get_Char_Index (ft_face, unicode);
85 hb_ft_get_glyph_h_advance (hb_font_t *font HB_UNUSED,
88 void *user_data HB_UNUSED)
90 FT_Face ft_face = (FT_Face) font_data;
91 int load_flags = FT_LOAD_DEFAULT | FT_LOAD_NO_HINTING;
94 if (unlikely (FT_Get_Advance (ft_face, glyph, load_flags, &v)))
97 return (v + (1<<9)) >> 10;
101 hb_ft_get_glyph_v_advance (hb_font_t *font HB_UNUSED,
103 hb_codepoint_t glyph,
104 void *user_data HB_UNUSED)
106 FT_Face ft_face = (FT_Face) font_data;
107 int load_flags = FT_LOAD_DEFAULT | FT_LOAD_NO_HINTING | FT_LOAD_VERTICAL_LAYOUT;
110 if (unlikely (FT_Get_Advance (ft_face, glyph, load_flags, &v)))
113 /* Note: FreeType's vertical metrics grows downward while other FreeType coordinates
114 * have a Y growing upward. Hence the extra negation. */
115 return (-v + (1<<9)) >> 10;
119 hb_ft_get_glyph_h_origin (hb_font_t *font HB_UNUSED,
120 void *font_data HB_UNUSED,
121 hb_codepoint_t glyph HB_UNUSED,
122 hb_position_t *x HB_UNUSED,
123 hb_position_t *y HB_UNUSED,
124 void *user_data HB_UNUSED)
126 /* We always work in the horizontal coordinates. */
131 hb_ft_get_glyph_v_origin (hb_font_t *font HB_UNUSED,
133 hb_codepoint_t glyph,
136 void *user_data HB_UNUSED)
138 FT_Face ft_face = (FT_Face) font_data;
139 int load_flags = FT_LOAD_DEFAULT;
141 if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
144 /* Note: FreeType's vertical metrics grows downward while other FreeType coordinates
145 * have a Y growing upward. Hence the extra negation. */
146 *x = ft_face->glyph->metrics.horiBearingX - ft_face->glyph->metrics.vertBearingX;
147 *y = ft_face->glyph->metrics.horiBearingY - (-ft_face->glyph->metrics.vertBearingY);
153 hb_ft_get_glyph_h_kerning (hb_font_t *font,
155 hb_codepoint_t left_glyph,
156 hb_codepoint_t right_glyph,
157 void *user_data HB_UNUSED)
159 FT_Face ft_face = (FT_Face) font_data;
162 FT_Kerning_Mode mode = font->x_ppem ? FT_KERNING_DEFAULT : FT_KERNING_UNFITTED;
163 if (FT_Get_Kerning (ft_face, left_glyph, right_glyph, mode, &kerningv))
170 hb_ft_get_glyph_v_kerning (hb_font_t *font HB_UNUSED,
171 void *font_data HB_UNUSED,
172 hb_codepoint_t top_glyph HB_UNUSED,
173 hb_codepoint_t bottom_glyph HB_UNUSED,
174 void *user_data HB_UNUSED)
176 /* FreeType API doesn't support vertical kerning */
181 hb_ft_get_glyph_extents (hb_font_t *font HB_UNUSED,
183 hb_codepoint_t glyph,
184 hb_glyph_extents_t *extents,
185 void *user_data HB_UNUSED)
187 FT_Face ft_face = (FT_Face) font_data;
188 int load_flags = FT_LOAD_DEFAULT;
190 if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
193 extents->x_bearing = ft_face->glyph->metrics.horiBearingX;
194 extents->y_bearing = ft_face->glyph->metrics.horiBearingY;
195 extents->width = ft_face->glyph->metrics.width;
196 extents->height = -ft_face->glyph->metrics.height;
201 hb_ft_get_glyph_contour_point (hb_font_t *font HB_UNUSED,
203 hb_codepoint_t glyph,
204 unsigned int point_index,
207 void *user_data HB_UNUSED)
209 FT_Face ft_face = (FT_Face) font_data;
210 int load_flags = FT_LOAD_DEFAULT;
212 if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
215 if (unlikely (ft_face->glyph->format != FT_GLYPH_FORMAT_OUTLINE))
218 if (unlikely (point_index >= (unsigned int) ft_face->glyph->outline.n_points))
221 *x = ft_face->glyph->outline.points[point_index].x;
222 *y = ft_face->glyph->outline.points[point_index].y;
228 hb_ft_get_glyph_name (hb_font_t *font HB_UNUSED,
230 hb_codepoint_t glyph,
231 char *name, unsigned int size,
232 void *user_data HB_UNUSED)
234 FT_Face ft_face = (FT_Face) font_data;
236 hb_bool_t ret = !FT_Get_Glyph_Name (ft_face, glyph, name, size);
237 if (ret && (size && !*name))
244 hb_ft_get_glyph_from_name (hb_font_t *font HB_UNUSED,
246 const char *name, int len, /* -1 means nul-terminated */
247 hb_codepoint_t *glyph,
248 void *user_data HB_UNUSED)
250 FT_Face ft_face = (FT_Face) font_data;
253 *glyph = FT_Get_Name_Index (ft_face, (FT_String *) name);
255 /* Make a nul-terminated version. */
257 len = MIN (len, (int) sizeof (buf) - 1);
258 strncpy (buf, name, len);
260 *glyph = FT_Get_Name_Index (ft_face, buf);
265 /* Check whether the given name was actually the name of glyph 0. */
267 if (!FT_Get_Glyph_Name(ft_face, 0, buf, sizeof (buf)) &&
268 len < 0 ? !strcmp (buf, name) : !strncmp (buf, name, len))
276 static hb_font_funcs_t *
277 _hb_ft_get_font_funcs (void)
279 static const hb_font_funcs_t ft_ffuncs = {
280 HB_OBJECT_HEADER_STATIC,
282 true, /* immutable */
285 #define HB_FONT_FUNC_IMPLEMENT(name) hb_ft_get_##name,
286 HB_FONT_FUNCS_IMPLEMENT_CALLBACKS
287 #undef HB_FONT_FUNC_IMPLEMENT
291 return const_cast<hb_font_funcs_t *> (&ft_ffuncs);
296 reference_table (hb_face_t *face HB_UNUSED, hb_tag_t tag, void *user_data)
298 FT_Face ft_face = (FT_Face) user_data;
303 /* Note: FreeType like HarfBuzz uses the NONE tag for fetching the entire blob */
305 error = FT_Load_Sfnt_Table (ft_face, tag, 0, NULL, &length);
309 buffer = (FT_Byte *) malloc (length);
313 error = FT_Load_Sfnt_Table (ft_face, tag, 0, buffer, &length);
317 return hb_blob_create ((const char *) buffer, length,
318 HB_MEMORY_MODE_WRITABLE,
324 * @ft_face: (destroy destroy) (scope notified):
329 * Return value: (transfer full):
333 hb_ft_face_create (FT_Face ft_face,
334 hb_destroy_func_t destroy)
338 if (ft_face->stream->read == NULL) {
341 blob = hb_blob_create ((const char *) ft_face->stream->base,
342 (unsigned int) ft_face->stream->size,
343 /* TODO: We assume that it's mmap()'ed, but FreeType code
344 * suggests that there are cases we reach here but font is
345 * not mmapped. For example, when mmap() fails. No idea
346 * how to deal with it better here. */
347 HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE,
349 face = hb_face_create (blob, ft_face->face_index);
350 hb_blob_destroy (blob);
352 face = hb_face_create_for_tables (reference_table, ft_face, destroy);
355 hb_face_set_index (face, ft_face->face_index);
356 hb_face_set_upem (face, ft_face->units_per_EM);
362 hb_ft_face_finalize (FT_Face ft_face)
364 hb_face_destroy ((hb_face_t *) ft_face->generic.data);
368 * hb_ft_face_create_cached:
373 * Return value: (transfer full):
377 hb_ft_face_create_cached (FT_Face ft_face)
379 if (unlikely (!ft_face->generic.data || ft_face->generic.finalizer != (FT_Generic_Finalizer) hb_ft_face_finalize))
381 if (ft_face->generic.finalizer)
382 ft_face->generic.finalizer (ft_face);
384 ft_face->generic.data = hb_ft_face_create (ft_face, NULL);
385 ft_face->generic.finalizer = (FT_Generic_Finalizer) hb_ft_face_finalize;
388 return hb_face_reference ((hb_face_t *) ft_face->generic.data);
399 * @ft_face: (destroy destroy) (scope notified):
404 * Return value: (transfer full):
408 hb_ft_font_create (FT_Face ft_face,
409 hb_destroy_func_t destroy)
414 face = hb_ft_face_create (ft_face, destroy);
415 font = hb_font_create (face);
416 hb_face_destroy (face);
417 hb_font_set_funcs (font,
418 _hb_ft_get_font_funcs (),
419 ft_face, (hb_destroy_func_t) _do_nothing);
420 hb_font_set_scale (font,
421 (int) (((uint64_t) ft_face->size->metrics.x_scale * (uint64_t) ft_face->units_per_EM + (1<<15)) >> 16),
422 (int) (((uint64_t) ft_face->size->metrics.y_scale * (uint64_t) ft_face->units_per_EM + (1<<15)) >> 16));
423 hb_font_set_ppem (font,
424 ft_face->size->metrics.x_ppem,
425 ft_face->size->metrics.y_ppem);
431 /* Thread-safe, lock-free, FT_Library */
433 static FT_Library ft_library;
436 void free_ft_library (void)
438 FT_Done_FreeType (ft_library);
442 get_ft_library (void)
445 FT_Library library = (FT_Library) hb_atomic_ptr_get (&ft_library);
447 if (unlikely (!library))
449 /* Not found; allocate one. */
450 if (FT_Init_FreeType (&library))
453 if (!hb_atomic_ptr_cmpexch (&ft_library, NULL, library)) {
454 FT_Done_FreeType (library);
459 atexit (free_ft_library); /* First person registers atexit() callback. */
467 _release_blob (FT_Face ft_face)
469 hb_blob_destroy ((hb_blob_t *) ft_face->generic.data);
473 hb_ft_font_set_funcs (hb_font_t *font)
475 hb_blob_t *blob = hb_face_reference_blob (font->face);
476 unsigned int blob_length;
477 const char *blob_data = hb_blob_get_data (blob, &blob_length);
478 if (unlikely (!blob_length))
479 DEBUG_MSG (FT, font, "Font face has empty blob");
481 FT_Face ft_face = NULL;
482 FT_Error err = FT_New_Memory_Face (get_ft_library (),
483 (const FT_Byte *) blob_data,
485 hb_face_get_index (font->face),
488 if (unlikely (err)) {
489 hb_blob_destroy (blob);
490 DEBUG_MSG (FT, font, "Font face FT_New_Memory_Face() failed");
494 FT_Select_Charmap (ft_face, FT_ENCODING_UNICODE);
496 assert (font->y_scale >= 0);
497 FT_Set_Char_Size (ft_face,
498 font->x_scale, font->y_scale,
501 font->x_ppem * 72 * 64 / font->x_scale,
502 font->y_ppem * 72 * 64 / font->y_scale);
505 ft_face->generic.data = blob;
506 ft_face->generic.finalizer = (FT_Generic_Finalizer) _release_blob;
508 hb_font_set_funcs (font,
509 _hb_ft_get_font_funcs (),
511 (hb_destroy_func_t) FT_Done_Face);
515 hb_ft_font_get_face (hb_font_t *font)
517 if (font->destroy == (hb_destroy_func_t) FT_Done_Face ||
518 font->destroy == (hb_destroy_func_t) _do_nothing)
519 return (FT_Face) font->user_data;