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_TRUETYPE_TABLES_H
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:
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.
47 * - We don't handle / allow for emboldening / obliqueing.
49 * - In the future, we should add constructors to create fonts in font space.
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. :(
54 * - Always use FT_LOAD_IGNORE_GLOBAL_ADVANCE_WIDTH?
59 hb_ft_get_glyph (hb_font_t *font HB_UNUSED,
61 hb_codepoint_t unicode,
62 hb_codepoint_t variation_selector,
63 hb_codepoint_t *glyph,
64 void *user_data HB_UNUSED)
67 FT_Face ft_face = (FT_Face) font_data;
69 #ifdef HAVE_FT_FACE_GETCHARVARIANTINDEX
70 if (unlikely (variation_selector)) {
71 *glyph = FT_Face_GetCharVariantIndex (ft_face, unicode, variation_selector);
77 *glyph = FT_Get_Char_Index (ft_face, unicode);
82 hb_ft_get_glyph_h_advance (hb_font_t *font HB_UNUSED,
85 hb_position_t *advance,
86 void *user_data HB_UNUSED)
88 FT_Face ft_face = (FT_Face) font_data;
89 int load_flags = FT_LOAD_DEFAULT;
91 if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
94 *advance = ft_face->glyph->metrics.horiAdvance;
98 hb_ft_get_glyph_v_advance (hb_font_t *font HB_UNUSED,
100 hb_codepoint_t glyph,
101 hb_position_t *advance,
102 void *user_data HB_UNUSED)
104 FT_Face ft_face = (FT_Face) font_data;
105 int load_flags = FT_LOAD_DEFAULT;
107 if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
110 /* Note: FreeType's vertical metrics grows downward while other FreeType coordinates
111 * have a Y growing upward. Hence the extra negation. */
112 *advance = -ft_face->glyph->metrics.vertAdvance;
116 hb_ft_get_glyph_h_origin (hb_font_t *font HB_UNUSED,
117 void *font_data HB_UNUSED,
118 hb_codepoint_t glyph HB_UNUSED,
119 hb_position_t *x HB_UNUSED,
120 hb_position_t *y HB_UNUSED,
121 void *user_data HB_UNUSED)
123 /* We always work in the horizontal coordinates. */
128 hb_ft_get_glyph_v_origin (hb_font_t *font HB_UNUSED,
130 hb_codepoint_t glyph,
133 void *user_data HB_UNUSED)
135 FT_Face ft_face = (FT_Face) font_data;
136 int load_flags = FT_LOAD_DEFAULT;
138 if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
141 /* Note: FreeType's vertical metrics grows downward while other FreeType coordinates
142 * have a Y growing upward. Hence the extra negation. */
143 *x = ft_face->glyph->metrics.horiBearingX - ft_face->glyph->metrics.vertBearingX;
144 *y = ft_face->glyph->metrics.horiBearingY - (-ft_face->glyph->metrics.vertBearingY);
150 hb_ft_get_glyph_h_kerning (hb_font_t *font HB_UNUSED,
152 hb_codepoint_t left_glyph,
153 hb_codepoint_t right_glyph,
154 hb_position_t *kerning,
155 void *user_data HB_UNUSED)
157 FT_Face ft_face = (FT_Face) font_data;
160 if (FT_Get_Kerning (ft_face, left_glyph, right_glyph, FT_KERNING_DEFAULT, &kerningv))
163 *kerning = kerningv.x;
167 hb_ft_get_glyph_v_kerning (hb_font_t *font HB_UNUSED,
168 void *font_data HB_UNUSED,
169 hb_codepoint_t top_glyph HB_UNUSED,
170 hb_codepoint_t bottom_glyph HB_UNUSED,
171 hb_position_t *kerning HB_UNUSED,
172 void *user_data HB_UNUSED)
174 /* FreeType API doesn't support vertical kerning */
179 hb_ft_get_glyph_extents (hb_font_t *font HB_UNUSED,
181 hb_codepoint_t glyph,
182 hb_glyph_extents_t *extents,
183 void *user_data HB_UNUSED)
185 FT_Face ft_face = (FT_Face) font_data;
186 int load_flags = FT_LOAD_DEFAULT;
188 if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
191 extents->x_bearing = ft_face->glyph->metrics.horiBearingX;
192 extents->y_bearing = ft_face->glyph->metrics.horiBearingY;
193 extents->width = ft_face->glyph->metrics.width;
194 extents->height = ft_face->glyph->metrics.height;
199 hb_ft_get_glyph_contour_point (hb_font_t *font HB_UNUSED,
201 hb_codepoint_t glyph,
202 unsigned int point_index,
205 void *user_data HB_UNUSED)
207 FT_Face ft_face = (FT_Face) font_data;
208 int load_flags = FT_LOAD_DEFAULT;
210 if (unlikely (FT_Load_Glyph (ft_face, glyph, load_flags)))
213 if (unlikely (ft_face->glyph->format != FT_GLYPH_FORMAT_OUTLINE))
216 if (unlikely (point_index >= (unsigned int) ft_face->glyph->outline.n_points))
219 *x = ft_face->glyph->outline.points[point_index].x;
220 *y = ft_face->glyph->outline.points[point_index].y;
225 static hb_font_funcs_t ft_ffuncs = {
226 HB_OBJECT_HEADER_STATIC,
228 TRUE, /* immutable */
232 hb_ft_get_glyph_h_advance,
233 hb_ft_get_glyph_v_advance,
234 hb_ft_get_glyph_h_origin,
235 hb_ft_get_glyph_v_origin,
236 hb_ft_get_glyph_h_kerning,
237 hb_ft_get_glyph_v_kerning,
238 hb_ft_get_glyph_extents,
239 hb_ft_get_glyph_contour_point,
244 hb_ft_get_font_funcs (void)
251 get_table (hb_face_t *face HB_UNUSED, hb_tag_t tag, void *user_data)
253 FT_Face ft_face = (FT_Face) user_data;
258 if (unlikely (tag == HB_TAG_NONE))
261 error = FT_Load_Sfnt_Table (ft_face, tag, 0, NULL, &length);
265 buffer = (FT_Byte *) malloc (length);
269 error = FT_Load_Sfnt_Table (ft_face, tag, 0, buffer, &length);
273 return hb_blob_create ((const char *) buffer, length,
274 HB_MEMORY_MODE_WRITABLE,
280 hb_ft_face_create (FT_Face ft_face,
281 hb_destroy_func_t destroy)
285 if (ft_face->stream->read == NULL) {
288 blob = hb_blob_create ((const char *) ft_face->stream->base,
289 (unsigned int) ft_face->stream->size,
290 /* TODO: We assume that it's mmap()'ed, but FreeType code
291 * suggests that there are cases we reach here but font is
292 * not mmapped. For example, when mmap() fails. No idea
293 * how to deal with it better here. */
294 HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE,
296 face = hb_face_create (blob, ft_face->face_index);
297 hb_blob_destroy (blob);
299 face = hb_face_create_for_tables (get_table, ft_face, destroy);
306 hb_ft_face_finalize (FT_Face ft_face)
308 hb_face_destroy ((hb_face_t *) ft_face->generic.data);
312 hb_ft_face_create_cached (FT_Face ft_face)
314 if (unlikely (!ft_face->generic.data || ft_face->generic.finalizer != (FT_Generic_Finalizer) hb_ft_face_finalize))
316 if (ft_face->generic.finalizer)
317 ft_face->generic.finalizer (ft_face);
319 ft_face->generic.data = hb_ft_face_create (ft_face, NULL);
320 ft_face->generic.finalizer = (FT_Generic_Finalizer) hb_ft_face_finalize;
323 return hb_face_reference ((hb_face_t *) ft_face->generic.data);
328 hb_ft_font_create (FT_Face ft_face,
329 hb_destroy_func_t destroy)
334 face = hb_ft_face_create (ft_face, destroy);
335 font = hb_font_create (face);
336 hb_face_destroy (face);
337 hb_font_set_funcs (font,
338 hb_ft_get_font_funcs (),
340 hb_font_set_scale (font,
341 ((uint64_t) ft_face->size->metrics.x_scale * (uint64_t) ft_face->units_per_EM) >> 16,
342 ((uint64_t) ft_face->size->metrics.y_scale * (uint64_t) ft_face->units_per_EM) >> 16);
343 hb_font_set_ppem (font,
344 ft_face->size->metrics.x_ppem,
345 ft_face->size->metrics.y_ppem);