2 * Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
4 * This file is part of libass.
6 * libass is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * libass is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with libass; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include FT_FREETYPE_H
26 #include FT_SYNTHESIS_H
28 #include FT_TRUETYPE_TABLES_H
32 #include "ass_library.h"
34 #include "ass_bitmap.h"
35 #include "ass_cache.h"
36 #include "ass_fontconfig.h"
37 #include "ass_utils.h"
40 * Select Microfost Unicode CharMap, if the font has one.
41 * Otherwise, let FreeType decide.
43 static void charmap_magic(ASS_Library
*library
, FT_Face face
)
46 for (i
= 0; i
< face
->num_charmaps
; ++i
) {
47 FT_CharMap cmap
= face
->charmaps
[i
];
48 unsigned pid
= cmap
->platform_id
;
49 unsigned eid
= cmap
->encoding_id
;
50 if (pid
== 3 /*microsoft */
51 && (eid
== 1 /*unicode bmp */
52 || eid
== 10 /*full unicode */ )) {
53 FT_Set_Charmap(face
, cmap
);
59 if (face
->num_charmaps
== 0) {
60 ass_msg(library
, MSGL_WARN
, "Font face with no charmaps");
63 ass_msg(library
, MSGL_WARN
,
64 "No charmap autodetected, trying the first one");
65 FT_Set_Charmap(face
, face
->charmaps
[0]);
70 static void update_transform(ASS_Font
*font
)
74 m
.xx
= double_to_d16(font
->scale_x
);
75 m
.yy
= double_to_d16(font
->scale_y
);
77 for (i
= 0; i
< font
->n_faces
; ++i
)
78 FT_Set_Transform(font
->faces
[i
], &m
, &font
->v
);
82 * \brief find a memory font by name
84 static int find_font(ASS_Library
*library
, char *name
)
87 for (i
= 0; i
< library
->num_fontdata
; ++i
)
88 if (strcasecmp(name
, library
->fontdata
[i
].name
) == 0)
93 static void face_set_size(FT_Face face
, double size
);
95 static void buggy_font_workaround(FT_Face face
)
97 // Some fonts have zero Ascender/Descender fields in 'hhea' table.
98 // In this case, get the information from 'os2' table or, as
99 // a last resort, from face.bbox.
100 if (face
->ascender
+ face
->descender
== 0 || face
->height
== 0) {
101 TT_OS2
*os2
= FT_Get_Sfnt_Table(face
, ft_sfnt_os2
);
103 face
->ascender
= os2
->sTypoAscender
;
104 face
->descender
= os2
->sTypoDescender
;
105 face
->height
= face
->ascender
- face
->descender
;
107 face
->ascender
= face
->bbox
.yMax
;
108 face
->descender
= face
->bbox
.yMin
;
109 face
->height
= face
->ascender
- face
->descender
;
115 * \brief Select a face with the given charcode and add it to ASS_Font
116 * \return index of the new face in font->faces, -1 if failed
118 static int add_face(void *fc_priv
, ASS_Font
*font
, uint32_t ch
)
126 if (font
->n_faces
== ASS_FONT_MAX_FACES
)
130 fontconfig_select(font
->library
, fc_priv
, font
->desc
.family
,
131 font
->desc
.treat_family_as_pattern
,
132 font
->desc
.bold
, font
->desc
.italic
, &index
, ch
);
136 mem_idx
= find_font(font
->library
, path
);
139 FT_New_Memory_Face(font
->ftlibrary
,
140 (unsigned char *) font
->library
->
141 fontdata
[mem_idx
].data
,
142 font
->library
->fontdata
[mem_idx
].size
, 0,
145 ass_msg(font
->library
, MSGL_WARN
,
146 "Error opening memory font: '%s'", path
);
151 error
= FT_New_Face(font
->ftlibrary
, path
, index
, &face
);
153 ass_msg(font
->library
, MSGL_WARN
,
154 "Error opening font: '%s', %d", path
, index
);
159 charmap_magic(font
->library
, face
);
160 buggy_font_workaround(face
);
162 font
->faces
[font
->n_faces
++] = face
;
163 update_transform(font
);
164 face_set_size(face
, font
->size
);
166 return font
->n_faces
- 1;
170 * \brief Create a new ASS_Font according to "desc" argument
172 ASS_Font
*ass_font_new(void *font_cache
, ASS_Library
*library
,
173 FT_Library ftlibrary
, void *fc_priv
,
180 fontp
= ass_font_cache_find((Hashmap
*) font_cache
, desc
);
184 font
.library
= library
;
185 font
.ftlibrary
= ftlibrary
;
187 font
.desc
.family
= strdup(desc
->family
);
188 font
.desc
.treat_family_as_pattern
= desc
->treat_family_as_pattern
;
189 font
.desc
.bold
= desc
->bold
;
190 font
.desc
.italic
= desc
->italic
;
192 font
.scale_x
= font
.scale_y
= 1.;
193 font
.v
.x
= font
.v
.y
= 0;
196 error
= add_face(fc_priv
, &font
, 0);
198 free(font
.desc
.family
);
201 return ass_font_cache_add((Hashmap
*) font_cache
, &font
);
205 * \brief Set font transformation matrix and shift vector
207 void ass_font_set_transform(ASS_Font
*font
, double scale_x
,
208 double scale_y
, FT_Vector
*v
)
210 font
->scale_x
= scale_x
;
211 font
->scale_y
= scale_y
;
216 update_transform(font
);
219 static void face_set_size(FT_Face face
, double size
)
221 #if (FREETYPE_MAJOR > 2) || ((FREETYPE_MAJOR == 2) && (FREETYPE_MINOR > 1))
222 TT_HoriHeader
*hori
= FT_Get_Sfnt_Table(face
, ft_sfnt_hhea
);
223 TT_OS2
*os2
= FT_Get_Sfnt_Table(face
, ft_sfnt_os2
);
225 FT_Size_RequestRec rq
;
226 FT_Size_Metrics
*m
= &face
->size
->metrics
;
227 // VSFilter uses metrics from TrueType OS/2 table
228 // The idea was borrowed from asa (http://asa.diac24.net)
230 int hori_height
= hori
->Ascender
- hori
->Descender
;
231 int os2_height
= os2
->usWinAscent
+ os2
->usWinDescent
;
232 if (hori_height
&& os2_height
)
233 mscale
= (double) hori_height
/ os2_height
;
235 memset(&rq
, 0, sizeof(rq
));
236 rq
.type
= FT_SIZE_REQUEST_TYPE_REAL_DIM
;
238 rq
.height
= double_to_d6(size
* mscale
);
239 rq
.horiResolution
= rq
.vertResolution
= 0;
240 FT_Request_Size(face
, &rq
);
241 m
->ascender
/= mscale
;
242 m
->descender
/= mscale
;
245 FT_Set_Char_Size(face
, 0, double_to_d6(size
), 0, 0);
250 * \brief Set font size
252 void ass_font_set_size(ASS_Font
*font
, double size
)
255 if (font
->size
!= size
) {
257 for (i
= 0; i
< font
->n_faces
; ++i
)
258 face_set_size(font
->faces
[i
], size
);
263 * \brief Get maximal font ascender and descender.
264 * \param ch character code
265 * The values are extracted from the font face that provides glyphs for the given character
267 void ass_font_get_asc_desc(ASS_Font
*font
, uint32_t ch
, int *asc
,
271 for (i
= 0; i
< font
->n_faces
; ++i
) {
272 FT_Face face
= font
->faces
[i
];
273 TT_OS2
*os2
= FT_Get_Sfnt_Table(face
, ft_sfnt_os2
);
274 if (FT_Get_Char_Index(face
, ch
)) {
275 int y_scale
= face
->size
->metrics
.y_scale
;
277 *asc
= FT_MulFix(os2
->usWinAscent
, y_scale
);
278 *desc
= FT_MulFix(os2
->usWinDescent
, y_scale
);
280 *asc
= FT_MulFix(face
->ascender
, y_scale
);
281 *desc
= FT_MulFix(-face
->descender
, y_scale
);
291 * Strike a glyph with a horizontal line; it's possible to underline it
292 * and/or strike through it. For the line's position and size, truetype
293 * tables are consulted. Obviously this relies on the data in the tables
297 static int ass_strike_outline_glyph(FT_Face face
, ASS_Font
*font
,
298 FT_Glyph glyph
, int under
, int through
)
300 TT_OS2
*os2
= FT_Get_Sfnt_Table(face
, ft_sfnt_os2
);
301 TT_Postscript
*ps
= FT_Get_Sfnt_Table(face
, ft_sfnt_post
);
302 FT_Outline
*ol
= &((FT_OutlineGlyph
) glyph
)->outline
;
303 int bear
, advance
, y_scale
, i
, dir
;
305 if (!under
&& !through
)
309 i
= (under
? 4 : 0) + (through
? 4 : 0);
310 ol
->points
= realloc(ol
->points
, sizeof(FT_Vector
) *
312 ol
->tags
= realloc(ol
->tags
, ol
->n_points
+ i
);
313 i
= !!under
+ !!through
;
314 ol
->contours
= realloc(ol
->contours
, sizeof(short) *
315 (ol
->n_contours
+ i
));
317 // If the bearing is negative, the glyph starts left of the current
319 bear
= FFMIN(face
->glyph
->metrics
.horiBearingX
, 0);
320 // We're adding half a pixel to avoid small gaps
321 advance
= d16_to_d6(glyph
->advance
.x
) + 32;
322 y_scale
= face
->size
->metrics
.y_scale
;
324 // Reverse drawing direction for non-truetype fonts
325 dir
= FT_Outline_Get_Orientation(ol
);
327 // Add points to the outline
330 pos
= FT_MulFix(ps
->underlinePosition
, y_scale
* font
->scale_y
);
331 size
= FT_MulFix(ps
->underlineThickness
,
332 y_scale
* font
->scale_y
/ 2);
334 if (pos
> 0 || size
<= 0)
337 FT_Vector points
[4] = {
338 {.x
= bear
, .y
= pos
+ size
},
339 {.x
= advance
, .y
= pos
+ size
},
340 {.x
= advance
, .y
= pos
- size
},
341 {.x
= bear
, .y
= pos
- size
},
344 if (dir
== FT_ORIENTATION_TRUETYPE
) {
345 for (i
= 0; i
< 4; i
++) {
346 ol
->points
[ol
->n_points
] = points
[i
];
347 ol
->tags
[ol
->n_points
++] = 1;
350 for (i
= 3; i
>= 0; i
--) {
351 ol
->points
[ol
->n_points
] = points
[i
];
352 ol
->tags
[ol
->n_points
++] = 1;
356 ol
->contours
[ol
->n_contours
++] = ol
->n_points
- 1;
359 if (through
&& os2
) {
361 pos
= FT_MulFix(os2
->yStrikeoutPosition
, y_scale
* font
->scale_y
);
362 size
= FT_MulFix(os2
->yStrikeoutSize
, y_scale
* font
->scale_y
/ 2);
364 if (pos
< 0 || size
<= 0)
367 FT_Vector points
[4] = {
368 {.x
= bear
, .y
= pos
+ size
},
369 {.x
= advance
, .y
= pos
+ size
},
370 {.x
= advance
, .y
= pos
- size
},
371 {.x
= bear
, .y
= pos
- size
},
374 if (dir
== FT_ORIENTATION_TRUETYPE
) {
375 for (i
= 0; i
< 4; i
++) {
376 ol
->points
[ol
->n_points
] = points
[i
];
377 ol
->tags
[ol
->n_points
++] = 1;
380 for (i
= 3; i
>= 0; i
--) {
381 ol
->points
[ol
->n_points
] = points
[i
];
382 ol
->tags
[ol
->n_points
++] = 1;
386 ol
->contours
[ol
->n_contours
++] = ol
->n_points
- 1;
393 * Slightly embold a glyph without touching its metrics
395 static void ass_glyph_embolden(FT_GlyphSlot slot
)
399 if (slot
->format
!= FT_GLYPH_FORMAT_OUTLINE
)
402 str
= FT_MulFix(slot
->face
->units_per_EM
,
403 slot
->face
->size
->metrics
.y_scale
) / 64;
405 FT_Outline_Embolden(&slot
->outline
, str
);
410 * \param ch character code
412 FT_Glyph
ass_font_get_glyph(void *fontconfig_priv
, ASS_Font
*font
,
413 uint32_t ch
, ASS_Hinting hinting
, int deco
)
424 if (font
->n_faces
== 0)
427 for (i
= 0; i
< font
->n_faces
; ++i
) {
428 face
= font
->faces
[i
];
429 index
= FT_Get_Char_Index(face
, ch
);
434 #ifdef CONFIG_FONTCONFIG
437 ass_msg(font
->library
, MSGL_INFO
,
438 "Glyph 0x%X not found, selecting one more "
439 "font for (%s, %d, %d)", ch
, font
->desc
.family
,
440 font
->desc
.bold
, font
->desc
.italic
);
441 face_idx
= add_face(fontconfig_priv
, font
, ch
);
443 face
= font
->faces
[face_idx
];
444 index
= FT_Get_Char_Index(face
, ch
);
446 ass_msg(font
->library
, MSGL_ERR
,
447 "Glyph 0x%X not found in font for (%s, %d, %d)",
448 ch
, font
->desc
.family
, font
->desc
.bold
,
456 case ASS_HINTING_NONE
:
457 flags
= FT_LOAD_NO_HINTING
;
459 case ASS_HINTING_LIGHT
:
460 flags
= FT_LOAD_FORCE_AUTOHINT
| FT_LOAD_TARGET_LIGHT
;
462 case ASS_HINTING_NORMAL
:
463 flags
= FT_LOAD_FORCE_AUTOHINT
;
465 case ASS_HINTING_NATIVE
:
470 error
= FT_Load_Glyph(face
, index
, FT_LOAD_NO_BITMAP
| flags
);
472 ass_msg(font
->library
, MSGL_WARN
, "Error loading glyph, index %d",
476 #if (FREETYPE_MAJOR > 2) || \
477 ((FREETYPE_MAJOR == 2) && (FREETYPE_MINOR >= 2)) || \
478 ((FREETYPE_MAJOR == 2) && (FREETYPE_MINOR == 1) && (FREETYPE_PATCH >= 10))
479 // FreeType >= 2.1.10 required
480 if (!(face
->style_flags
& FT_STYLE_FLAG_ITALIC
) &&
481 (font
->desc
.italic
> 55)) {
482 FT_GlyphSlot_Oblique(face
->glyph
);
485 if (!(face
->style_flags
& FT_STYLE_FLAG_BOLD
) &&
486 (font
->desc
.bold
> 80)) {
487 ass_glyph_embolden(face
->glyph
);
490 error
= FT_Get_Glyph(face
->glyph
, &glyph
);
492 ass_msg(font
->library
, MSGL_WARN
, "Error loading glyph, index %d",
497 ass_strike_outline_glyph(face
, font
, glyph
, deco
& DECO_UNDERLINE
,
498 deco
& DECO_STRIKETHROUGH
);
504 * \brief Get kerning for the pair of glyphs.
506 FT_Vector
ass_font_get_kerning(ASS_Font
*font
, uint32_t c1
, uint32_t c2
)
508 FT_Vector v
= { 0, 0 };
511 for (i
= 0; i
< font
->n_faces
; ++i
) {
512 FT_Face face
= font
->faces
[i
];
513 int i1
= FT_Get_Char_Index(face
, c1
);
514 int i2
= FT_Get_Char_Index(face
, c2
);
516 if (FT_HAS_KERNING(face
))
517 FT_Get_Kerning(face
, i1
, i2
, FT_KERNING_DEFAULT
, &v
);
520 if (i1
|| i2
) // these glyphs are from different font faces, no kerning information
527 * \brief Deallocate ASS_Font
529 void ass_font_free(ASS_Font
*font
)
532 for (i
= 0; i
< font
->n_faces
; ++i
)
534 FT_Done_Face(font
->faces
[i
]);
535 if (font
->desc
.family
)
536 free(font
->desc
.family
);