granicus.if.org Git - libass/blob - libass/ass_font.c

   1 // -*- c-basic-offset: 8; indent-tabs-mode: t -*-
   2 // vim:ts=8:sw=8:noet:ai:
   3 /*
   4   Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
   5
   6   This program 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.
  10
  11   This program 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.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with this program; if not, write to the Free Software
  18   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  19 */
  20
  21 #include "config.h"
  22
  23 #include <inttypes.h>
  24 #include <ft2build.h>
  25 #include FT_FREETYPE_H
  26 #include FT_SYNTHESIS_H
  27 #include FT_GLYPH_H
  28 #include FT_TRUETYPE_TABLES_H
  29
  30 #include "ass.h"
  31 #include "ass_library.h"
  32 #include "ass_font.h"
  33 #include "ass_bitmap.h"
  34 #include "ass_cache.h"
  35 #include "ass_fontconfig.h"
  36 #include "ass_utils.h"
  37 #include "mputils.h"
  38
  39 /**
  40  * Select Microfost Unicode CharMap, if the font has one.
  41  * Otherwise, let FreeType decide.
  42  */
  43 static void charmap_magic(FT_Face face)
  44 {
  45         int i;
  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*/ && (eid == 1 /*unicode bmp*/ || eid == 10 /*full unicode*/)) {
  51                         FT_Set_Charmap(face, cmap);
  52                         return;
  53                 }
  54         }
  55
  56         if (!face->charmap) {
  57                 if (face->num_charmaps == 0) {
  58                         mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_NoCharmaps);
  59                         return;
  60                 }
  61                 mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_NoCharmapAutodetected);
  62                 FT_Set_Charmap(face, face->charmaps[0]);
  63                 return;
  64         }
  65 }
  66
  67 static void update_transform(ass_font_t* font)
  68 {
  69         int i;
  70         FT_Matrix m;
  71         m.xx = double_to_d16(font->scale_x);
  72         m.yy = double_to_d16(font->scale_y);
  73         m.xy = m.yx = 0;
  74         for (i = 0; i < font->n_faces; ++i)
  75                 FT_Set_Transform(font->faces[i], &m, &font->v);
  76 }
  77
  78 /**
  79  * \brief find a memory font by name
  80  */
  81 static int find_font(ass_library_t* library, char* name)
  82 {
  83         int i;
  84         for (i = 0; i < library->num_fontdata; ++i)
  85                 if (strcasecmp(name, library->fontdata[i].name) == 0)
  86                         return i;
  87         return -1;
  88 }
  89
  90 /**
  91  * \brief Create a new ass_font_t according to "desc" argument
  92  */
  93 ass_font_t* ass_font_new(ass_library_t* library, FT_Library ftlibrary, void* fc_priv, ass_font_desc_t* desc)
  94 {
  95         char* path;
  96         int index;
  97         FT_Face face;
  98         int error;
  99         ass_font_t* fontp;
 100         ass_font_t font;
 101         int mem_idx;
 102
 103         fontp = ass_font_cache_find(desc);
 104         if (fontp)
 105                 return fontp;
 106
 107         path = fontconfig_select(fc_priv, desc->family, desc->bold, desc->italic, &index);
 108
 109         mem_idx = find_font(library, path);
 110         if (mem_idx >= 0) {
 111                 error = FT_New_Memory_Face(ftlibrary, (unsigned char*)library->fontdata[mem_idx].data,
 112                                            library->fontdata[mem_idx].size, 0, &face);
 113                 if (error) {
 114                         mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_ErrorOpeningMemoryFont, path);
 115                         return 0;
 116                 }
 117         } else {
 118                 error = FT_New_Face(ftlibrary, path, index, &face);
 119                 if (error) {
 120                         mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_ErrorOpeningFont, path, index);
 121                         return 0;
 122                 }
 123         }
 124
 125         charmap_magic(face);
 126
 127         font.ftlibrary = ftlibrary;
 128         font.faces[0] = face;
 129         font.n_faces = 1;
 130         font.desc.family = strdup(desc->family);
 131         font.desc.bold = desc->bold;
 132         font.desc.italic = desc->italic;
 133
 134         font.scale_x = font.scale_y = 1.;
 135         font.v.x = font.v.y = 0;
 136         font.size = 0.;
 137
 138 #ifdef HAVE_FONTCONFIG
 139         font.charset = FcCharSetCreate();
 140 #endif
 141
 142         return ass_font_cache_add(&font);
 143 }
 144
 145 /**
 146  * \brief Set font transformation matrix and shift vector
 147  **/
 148 void ass_font_set_transform(ass_font_t* font, double scale_x, double scale_y, FT_Vector* v)
 149 {
 150         font->scale_x = scale_x;
 151         font->scale_y = scale_y;
 152         font->v.x = v->x;
 153         font->v.y = v->y;
 154         update_transform(font);
 155 }
 156
 157 static void face_set_size(FT_Face face, double size)
 158 {
 159 #if (FREETYPE_MAJOR >= 2)
 160         TT_HoriHeader *hori = FT_Get_Sfnt_Table(face, ft_sfnt_hhea);
 161         TT_OS2 *os2 = FT_Get_Sfnt_Table(face, ft_sfnt_os2);
 162         double mscale = 1.;
 163         FT_Size_RequestRec rq;
 164         FT_Size_Metrics *m = &face->size->metrics;
 165         // VSFilter uses metrics from TrueType OS/2 table
 166         // The idea was borrowed from asa (http://asa.diac24.net)
 167         if (hori && os2)
 168                 mscale = ((double)(hori->Ascender - hori->Descender)) / (os2->usWinAscent + os2->usWinDescent);
 169         memset(&rq, 0, sizeof(rq));
 170         rq.type = FT_SIZE_REQUEST_TYPE_REAL_DIM;
 171         rq.width = 0;
 172         rq.height = double_to_d6(size * mscale);
 173         rq.horiResolution = rq.vertResolution = 0;
 174         FT_Request_Size(face, &rq);
 175         m->ascender /= mscale;
 176         m->descender /= mscale;
 177         m->height /= mscale;
 178 #else
 179         FT_Set_Char_Size(face, 0, double_to_d6(size), 0, 0);
 180 #endif
 181 }
 182
 183 /**
 184  * \brief Set font size
 185  **/
 186 void ass_font_set_size(ass_font_t* font, double size)
 187 {
 188         int i;
 189         if (font->size != size) {
 190                 font->size = size;
 191                 for (i = 0; i < font->n_faces; ++i)
 192                         face_set_size(font->faces[i], size);
 193         }
 194 }
 195
 196 #ifdef HAVE_FONTCONFIG
 197 /**
 198  * \brief Select a new FT_Face with the given character
 199  * The new face is added to the end of font->faces.
 200  **/
 201 static void ass_font_reselect(void* fontconfig_priv, ass_font_t* font, uint32_t ch)
 202 {
 203         char* path;
 204         int index;
 205         FT_Face face;
 206         int error;
 207
 208         if (font->n_faces == ASS_FONT_MAX_FACES)
 209                 return;
 210
 211         path = fontconfig_select_with_charset(fontconfig_priv, font->desc.family, font->desc.bold,
 212                                               font->desc.italic, &index, font->charset);
 213
 214         error = FT_New_Face(font->ftlibrary, path, index, &face);
 215         if (error) {
 216                 mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_ErrorOpeningFont, path, index);
 217                 return;
 218         }
 219         charmap_magic(face);
 220
 221         error = FT_Get_Char_Index(face, ch);
 222         if (error == 0) { // the new font face is not better then the old one
 223                 FT_Done_Face(face);
 224                 return;
 225         }
 226
 227         font->faces[font->n_faces++] = face;
 228         update_transform(font);
 229         FT_Set_Pixel_Sizes(face, 0, (int)font->size);
 230 }
 231 #endif
 232
 233 /**
 234  * \brief Get maximal font ascender and descender.
 235  * \param ch character code
 236  * The values are extracted from the font face that provides glyphs for the given character
 237  **/
 238 void ass_font_get_asc_desc(ass_font_t* font, uint32_t ch, int* asc, int* desc)
 239 {
 240         int i;
 241         for (i = 0; i < font->n_faces; ++i) {
 242                 FT_Face face = font->faces[i];
 243                 if (FT_Get_Char_Index(face, ch)) {
 244                         int v, v2;
 245                         v = face->size->metrics.ascender;
 246                         v2 = FT_MulFix(face->bbox.yMax, face->size->metrics.y_scale);
 247                         *asc = (v > v2 * 0.9) ? v : v2;
 248
 249                         v = - face->size->metrics.descender;
 250                         v2 = - FT_MulFix(face->bbox.yMin, face->size->metrics.y_scale);
 251                         *desc = (v > v2 * 0.9) ? v : v2;
 252                         return;
 253                 }
 254         }
 255
 256         *asc = *desc = 0;
 257 }
 258
 259 /**
 260  * \brief Get a glyph
 261  * \param ch character code
 262  **/
 263 FT_Glyph ass_font_get_glyph(void* fontconfig_priv, ass_font_t* font, uint32_t ch, ass_hinting_t hinting)
 264 {
 265         int error;
 266         int index = 0;
 267         int i;
 268         FT_Glyph glyph;
 269         FT_Face face = 0;
 270         int flags = 0;
 271
 272         if (ch < 0x20)
 273                 return 0;
 274         if (font->n_faces == 0)
 275                 return 0;
 276
 277         for (i = 0; i < font->n_faces; ++i) {
 278                 face = font->faces[i];
 279                 index = FT_Get_Char_Index(face, ch);
 280                 if (index)
 281                         break;
 282         }
 283
 284 #ifdef HAVE_FONTCONFIG
 285         FcCharSetAddChar(font->charset, ch);
 286         if (index == 0) {
 287                 mp_msg(MSGT_ASS, MSGL_INFO, MSGTR_LIBASS_GlyphNotFoundReselectingFont,
 288                        ch, font->desc.family, font->desc.bold, font->desc.italic);
 289                 ass_font_reselect(fontconfig_priv, font, ch);
 290                 face = font->faces[font->n_faces - 1];
 291                 index = FT_Get_Char_Index(face, ch);
 292                 if (index == 0) {
 293                         mp_msg(MSGT_ASS, MSGL_ERR, MSGTR_LIBASS_GlyphNotFound,
 294                                ch, font->desc.family, font->desc.bold, font->desc.italic);
 295                 }
 296         }
 297 #endif
 298
 299         switch (hinting) {
 300         case ASS_HINTING_NONE: flags = FT_LOAD_NO_HINTING; break;
 301         case ASS_HINTING_LIGHT: flags = FT_LOAD_FORCE_AUTOHINT | FT_LOAD_TARGET_LIGHT; break;
 302         case ASS_HINTING_NORMAL: flags = FT_LOAD_FORCE_AUTOHINT; break;
 303         case ASS_HINTING_NATIVE: flags = 0; break;
 304         }
 305
 306         error = FT_Load_Glyph(face, index, FT_LOAD_NO_BITMAP | flags);
 307         if (error) {
 308                 mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_ErrorLoadingGlyph);
 309                 return 0;
 310         }
 311
 312 #if (FREETYPE_MAJOR > 2) || \
 313     ((FREETYPE_MAJOR == 2) && (FREETYPE_MINOR >= 2)) || \
 314     ((FREETYPE_MAJOR == 2) && (FREETYPE_MINOR == 1) && (FREETYPE_PATCH >= 10))
 315 // FreeType >= 2.1.10 required
 316         if (!(face->style_flags & FT_STYLE_FLAG_ITALIC) &&
 317                         (font->desc.italic > 55)) {
 318                 FT_GlyphSlot_Oblique(face->glyph);
 319         }
 320 #endif
 321         error = FT_Get_Glyph(face->glyph, &glyph);
 322         if (error) {
 323                 mp_msg(MSGT_ASS, MSGL_WARN, MSGTR_LIBASS_ErrorLoadingGlyph);
 324                 return 0;
 325         }
 326
 327         return glyph;
 328 }
 329
 330 /**
 331  * \brief Get kerning for the pair of glyphs.
 332  **/
 333 FT_Vector ass_font_get_kerning(ass_font_t* font, uint32_t c1, uint32_t c2)
 334 {
 335         FT_Vector v = {0, 0};
 336         int i;
 337
 338         for (i = 0; i < font->n_faces; ++i) {
 339                 FT_Face face = font->faces[i];
 340                 int i1 = FT_Get_Char_Index(face, c1);
 341                 int i2 = FT_Get_Char_Index(face, c2);
 342                 if (i1 && i2) {
 343                         if (FT_HAS_KERNING(face))
 344                                 FT_Get_Kerning(face, i1, i2, FT_KERNING_DEFAULT, &v);
 345                         return v;
 346                 }
 347                 if (i1 || i2) // these glyphs are from different font faces, no kerning information
 348                         return v;
 349         }
 350         return v;
 351 }
 352
 353 /**
 354  * \brief Deallocate ass_font_t
 355  **/
 356 void ass_font_free(ass_font_t* font)
 357 {
 358         int i;
 359         for (i = 0; i < font->n_faces; ++i)
 360                 if (font->faces[i]) FT_Done_Face(font->faces[i]);
 361         if (font->desc.family) free(font->desc.family);
 362 #ifdef HAVE_FONTCONFIG
 363         if (font->charset) FcCharSetDestroy(font->charset);
 364 #endif
 365         free(font);
 366 }