lib/taloader.c

   1 /* taloader.c */
   2
   3 /*
   4  * Copyright (C) 2011-2012 by Werner Lemberg.
   5  *
   6  * This file is part of the ttfautohint library, and may only be used,
   7  * modified, and distributed under the terms given in `COPYING'.  By
   8  * continuing to use, modify, or distribute this file you indicate that you
   9  * have read `COPYING' and understand and accept it fully.
  10  *
  11  * The file `COPYING' mentioned in the previous paragraph is distributed
  12  * with the ttfautohint library.
  13  */
  14
  15
  16 /* originally file `afloader.c' (2011-Mar-28) from FreeType */
  17
  18 /* heavily modified 2011 by Werner Lemberg <wl@gnu.org> */
  19
  20 #include <string.h>
  21
  22 #include <ft2build.h>
  23 #include FT_GLYPH_H
  24
  25 #include "ta.h"
  26 #include "tahints.h"
  27 #include "taglobal.h"
  28
  29
  30 /* from file `ftobjs.h' (2011-Mar-28) from FreeType */
  31 typedef struct FT_Slot_InternalRec_
  32 {
  33   TA_GlyphLoader loader;
  34   FT_UInt flags;
  35   FT_Bool glyph_transformed;
  36   FT_Matrix glyph_matrix;
  37   FT_Vector glyph_delta;
  38   void* glyph_hints;
  39 } FT_GlyphSlot_InternalRec;
  40
  41
  42 /* initialize glyph loader */
  43
  44 FT_Error
  45 ta_loader_init(FONT* font)
  46 {
  47   TA_Loader loader = font->loader;
  48
  49
  50   memset(loader, 0, sizeof (TA_LoaderRec));
  51
  52   ta_glyph_hints_init(&loader->hints);
  53 #ifdef TA_DEBUG
  54   _ta_debug_hints = &loader->hints;
  55 #endif
  56   return TA_GlyphLoader_New(&loader->gloader);
  57 }
  58
  59
  60 /* reset glyph loader and compute globals if necessary */
  61
  62 FT_Error
  63 ta_loader_reset(FONT* font,
  64                 FT_Face face)
  65 {
  66   FT_Error error = FT_Err_Ok;
  67   TA_Loader loader = font->loader;
  68
  69
  70   loader->face = face;
  71   loader->globals = (TA_FaceGlobals)face->autohint.data;
  72
  73   TA_GlyphLoader_Rewind(loader->gloader);
  74
  75   if (loader->globals == NULL)
  76   {
  77     error = ta_face_globals_new(face, &loader->globals, font);
  78     if (!error)
  79     {
  80       face->autohint.data = (FT_Pointer)loader->globals;
  81       face->autohint.finalizer = (FT_Generic_Finalizer)ta_face_globals_free;
  82     }
  83   }
  84
  85   return error;
  86 }
  87
  88
  89 /* finalize glyph loader */
  90
  91 void
  92 ta_loader_done(FONT* font)
  93 {
  94   TA_Loader loader = font->loader;
  95
  96
  97   ta_glyph_hints_done(&loader->hints);
  98
  99   loader->face = NULL;
 100   loader->globals = NULL;
 101
 102 #ifdef TA_DEBUG
 103   _ta_debug_hints = NULL;
 104 #endif
 105   TA_GlyphLoader_Done(loader->gloader);
 106   loader->gloader = NULL;
 107 }
 108
 109
 110 /* load a single glyph component; this routine calls itself recursively, */
 111 /* if necessary, and does the main work of `ta_loader_load_glyph' */
 112
 113 static FT_Error
 114 ta_loader_load_g(TA_Loader loader,
 115                  TA_Scaler scaler,
 116                  FT_UInt glyph_index,
 117                  FT_Int32 load_flags,
 118                  FT_UInt depth)
 119 {
 120   FT_Error error;
 121   FT_Face face = loader->face;
 122   TA_GlyphLoader gloader = loader->gloader;
 123   TA_ScriptMetrics metrics = loader->metrics;
 124   TA_GlyphHints hints = &loader->hints;
 125   FT_GlyphSlot slot = face->glyph;
 126 #if 0
 127   FT_Slot_Internal internal = slot->internal;
 128 #endif
 129   FT_Int32 flags;
 130
 131
 132   flags = load_flags | FT_LOAD_LINEAR_DESIGN;
 133   error = FT_Load_Glyph(face, glyph_index, flags);
 134   if (error)
 135     goto Exit;
 136
 137 #if 0
 138   loader->transformed = internal->glyph_transformed;
 139   if (loader->transformed)
 140   {
 141     FT_Matrix inverse;
 142
 143
 144     loader->trans_matrix = internal->glyph_matrix;
 145     loader->trans_delta = internal->glyph_delta;
 146
 147     inverse = loader->trans_matrix;
 148     FT_Matrix_Invert(&inverse);
 149     FT_Vector_Transform(&loader->trans_delta, &inverse);
 150   }
 151 #endif
 152
 153   switch (slot->format)
 154   {
 155   case FT_GLYPH_FORMAT_OUTLINE:
 156     /* translate the loaded glyph when an internal transform is needed */
 157     if (loader->transformed)
 158       FT_Outline_Translate(&slot->outline,
 159                            loader->trans_delta.x,
 160                            loader->trans_delta.y);
 161
 162     /* copy the outline points in the loader's current extra points */
 163     /* which are used to keep original glyph coordinates */
 164     error = TA_GLYPHLOADER_CHECK_POINTS(gloader,
 165                                         slot->outline.n_points + 4,
 166                                         slot->outline.n_contours);
 167     if (error)
 168       goto Exit;
 169
 170     memcpy(gloader->current.outline.points,
 171            slot->outline.points,
 172            slot->outline.n_points * sizeof (FT_Vector));
 173     memcpy(gloader->current.outline.contours,
 174            slot->outline.contours,
 175            slot->outline.n_contours * sizeof (short));
 176     memcpy(gloader->current.outline.tags,
 177            slot->outline.tags,
 178            slot->outline.n_points * sizeof (char));
 179
 180     gloader->current.outline.n_points = slot->outline.n_points;
 181     gloader->current.outline.n_contours = slot->outline.n_contours;
 182
 183     /* compute original horizontal phantom points */
 184     /* (and ignore vertical ones) */
 185     loader->pp1.x = hints->x_delta;
 186     loader->pp1.y = hints->y_delta;
 187     loader->pp2.x = FT_MulFix(slot->metrics.horiAdvance,
 188                               hints->x_scale) + hints->x_delta;
 189     loader->pp2.y = hints->y_delta;
 190
 191     /* be sure to check for spacing glyphs */
 192     if (slot->outline.n_points == 0)
 193       goto Hint_Metrics;
 194
 195     /* now load the slot image into the auto-outline */
 196     /* and run the automatic hinting process */
 197     if (metrics->clazz->script_hints_apply)
 198       metrics->clazz->script_hints_apply(hints,
 199                                          &gloader->current.outline,
 200                                          metrics);
 201
 202     /* we now need to adjust the metrics according to the change in */
 203     /* width/positioning that occurred during the hinting process */
 204     if (scaler->render_mode != FT_RENDER_MODE_LIGHT)
 205     {
 206       FT_Pos old_rsb, old_lsb, new_lsb;
 207       FT_Pos pp1x_uh, pp2x_uh;
 208       TA_AxisHints axis = &hints->axis[TA_DIMENSION_HORZ];
 209
 210       TA_Edge edge1 = axis->edges; /* leftmost edge */
 211       TA_Edge edge2 = edge1 + axis->num_edges - 1; /* rightmost edge */
 212
 213
 214       if (axis->num_edges > 1 && TA_HINTS_DO_ADVANCE(hints))
 215       {
 216         old_rsb = loader->pp2.x - edge2->opos;
 217         old_lsb = edge1->opos;
 218         new_lsb = edge1->pos;
 219
 220         /* remember unhinted values to later account */
 221         /* for rounding errors */
 222         pp1x_uh = new_lsb - old_lsb;
 223         pp2x_uh = edge2->pos + old_rsb;
 224
 225         /* prefer too much space over too little space */
 226         /* for very small sizes */
 227         if (old_lsb < 24)
 228           pp1x_uh -= 8;
 229         if (old_rsb < 24)
 230           pp2x_uh += 8;
 231
 232         loader->pp1.x = TA_PIX_ROUND(pp1x_uh);
 233         loader->pp2.x = TA_PIX_ROUND(pp2x_uh);
 234
 235         if (loader->pp1.x >= new_lsb
 236             && old_lsb > 0)
 237           loader->pp1.x -= 64;
 238         if (loader->pp2.x <= edge2->pos
 239             && old_rsb > 0)
 240           loader->pp2.x += 64;
 241
 242         slot->lsb_delta = loader->pp1.x - pp1x_uh;
 243         slot->rsb_delta = loader->pp2.x - pp2x_uh;
 244       }
 245       else
 246       {
 247         FT_Pos pp1x = loader->pp1.x;
 248         FT_Pos pp2x = loader->pp2.x;
 249
 250
 251         loader->pp1.x = TA_PIX_ROUND(pp1x);
 252         loader->pp2.x = TA_PIX_ROUND(pp2x);
 253
 254         slot->lsb_delta = loader->pp1.x - pp1x;
 255         slot->rsb_delta = loader->pp2.x - pp2x;
 256       }
 257     }
 258     else
 259     {
 260       FT_Pos pp1x = loader->pp1.x;
 261       FT_Pos pp2x = loader->pp2.x;
 262
 263
 264       loader->pp1.x = TA_PIX_ROUND(pp1x + hints->xmin_delta);
 265       loader->pp2.x = TA_PIX_ROUND(pp2x + hints->xmax_delta);
 266
 267       slot->lsb_delta = loader->pp1.x - pp1x;
 268       slot->rsb_delta = loader->pp2.x - pp2x;
 269     }
 270
 271     /* good, we simply add the glyph to our loader's base */
 272     TA_GlyphLoader_Add(gloader);
 273     break;
 274
 275   case FT_GLYPH_FORMAT_COMPOSITE:
 276     {
 277       FT_UInt nn, num_subglyphs = slot->num_subglyphs;
 278       FT_UInt num_base_subgs, start_point;
 279       TA_SubGlyph subglyph;
 280
 281
 282       start_point = gloader->base.outline.n_points;
 283
 284       /* first of all, copy the subglyph descriptors in the glyph loader */
 285       error = TA_GlyphLoader_CheckSubGlyphs(gloader, num_subglyphs);
 286       if (error)
 287         goto Exit;
 288
 289       memcpy(gloader->current.subglyphs,
 290              slot->subglyphs,
 291              num_subglyphs * sizeof (TA_SubGlyphRec));
 292
 293       gloader->current.num_subglyphs = num_subglyphs;
 294       num_base_subgs = gloader->base.num_subglyphs;
 295
 296       /* now read each subglyph independently */
 297       for (nn = 0; nn < num_subglyphs; nn++)
 298       {
 299         FT_Vector pp1, pp2;
 300         FT_Pos x, y;
 301         FT_UInt num_points, num_new_points, num_base_points;
 302
 303
 304         /* gloader.current.subglyphs can change during glyph loading due */
 305         /* to re-allocation -- we must recompute the current subglyph on */
 306         /* each iteration */
 307         subglyph = gloader->base.subglyphs + num_base_subgs + nn;
 308
 309         pp1 = loader->pp1;
 310         pp2 = loader->pp2;
 311
 312         num_base_points = gloader->base.outline.n_points;
 313
 314         error = ta_loader_load_g(loader, scaler, subglyph->index,
 315                                  load_flags, depth + 1);
 316         if (error)
 317           goto Exit;
 318
 319         /* recompute subglyph pointer */
 320         subglyph = gloader->base.subglyphs + num_base_subgs + nn;
 321
 322         if (subglyph->flags & FT_SUBGLYPH_FLAG_USE_MY_METRICS)
 323         {
 324           pp1 = loader->pp1;
 325           pp2 = loader->pp2;
 326         }
 327         else
 328         {
 329           loader->pp1 = pp1;
 330           loader->pp2 = pp2;
 331         }
 332
 333         num_points = gloader->base.outline.n_points;
 334         num_new_points = num_points - num_base_points;
 335
 336         /* now perform the transformation required for this subglyph */
 337         if (subglyph->flags & (FT_SUBGLYPH_FLAG_SCALE
 338                                | FT_SUBGLYPH_FLAG_XY_SCALE
 339                                | FT_SUBGLYPH_FLAG_2X2))
 340         {
 341           FT_Vector* cur = gloader->base.outline.points + num_base_points;
 342           FT_Vector* limit = cur + num_new_points;
 343
 344
 345           for (; cur < limit; cur++)
 346             FT_Vector_Transform(cur, &subglyph->transform);
 347         }
 348
 349         /* apply offset */
 350         if (!(subglyph->flags & FT_SUBGLYPH_FLAG_ARGS_ARE_XY_VALUES))
 351         {
 352           FT_Int k = subglyph->arg1;
 353           FT_UInt l = subglyph->arg2;
 354           FT_Vector* p1;
 355           FT_Vector* p2;
 356
 357
 358           if (start_point + k >= num_base_points
 359               || l >= (FT_UInt)num_new_points)
 360           {
 361             error = FT_Err_Invalid_Composite;
 362             goto Exit;
 363           }
 364
 365           l += num_base_points;
 366
 367           /* for now, only use the current point coordinates; */
 368           /* we eventually may consider another approach */
 369           p1 = gloader->base.outline.points + start_point + k;
 370           p2 = gloader->base.outline.points + start_point + l;
 371
 372           x = p1->x - p2->x;
 373           y = p1->y - p2->y;
 374         }
 375         else
 376         {
 377           x = FT_MulFix(subglyph->arg1, hints->x_scale) + hints->x_delta;
 378           y = FT_MulFix(subglyph->arg2, hints->y_scale) + hints->y_delta;
 379
 380           x = TA_PIX_ROUND(x);
 381           y = TA_PIX_ROUND(y);
 382         }
 383
 384         {
 385           FT_Outline dummy = gloader->base.outline;
 386
 387
 388           dummy.points += num_base_points;
 389           dummy.n_points = (short)num_new_points;
 390
 391           FT_Outline_Translate(&dummy, x, y);
 392         }
 393       }
 394     }
 395     break;
 396
 397   default:
 398     /* we don't support other formats (yet?) */
 399     error = FT_Err_Unimplemented_Feature;
 400   }
 401
 402 Hint_Metrics:
 403   if (depth == 0)
 404   {
 405     FT_BBox bbox;
 406     FT_Vector vvector;
 407
 408
 409     vvector.x = slot->metrics.vertBearingX - slot->metrics.horiBearingX;
 410     vvector.y = slot->metrics.vertBearingY - slot->metrics.horiBearingY;
 411     vvector.x = FT_MulFix(vvector.x, metrics->scaler.x_scale);
 412     vvector.y = FT_MulFix(vvector.y, metrics->scaler.y_scale);
 413
 414     /* transform the hinted outline if needed */
 415     if (loader->transformed)
 416     {
 417       FT_Outline_Transform(&gloader->base.outline, &loader->trans_matrix);
 418       FT_Vector_Transform(&vvector, &loader->trans_matrix);
 419     }
 420 #if 1
 421     /* we must translate our final outline by -pp1.x */
 422     /* and compute the new metrics */
 423     if (loader->pp1.x)
 424       FT_Outline_Translate(&gloader->base.outline, -loader->pp1.x, 0);
 425 #endif
 426     FT_Outline_Get_CBox(&gloader->base.outline, &bbox);
 427
 428     bbox.xMin = TA_PIX_FLOOR(bbox.xMin);
 429     bbox.yMin = TA_PIX_FLOOR(bbox.yMin);
 430     bbox.xMax = TA_PIX_CEIL(bbox.xMax);
 431     bbox.yMax = TA_PIX_CEIL(bbox.yMax);
 432
 433     slot->metrics.width = bbox.xMax - bbox.xMin;
 434     slot->metrics.height = bbox.yMax - bbox.yMin;
 435     slot->metrics.horiBearingX = bbox.xMin;
 436     slot->metrics.horiBearingY = bbox.yMax;
 437
 438     slot->metrics.vertBearingX = TA_PIX_FLOOR(bbox.xMin + vvector.x);
 439     slot->metrics.vertBearingY = TA_PIX_FLOOR(bbox.yMax + vvector.y);
 440
 441     /* for mono-width fonts (like Andale, Courier, etc.) we need */
 442     /* to keep the original rounded advance width; ditto for */
 443     /* digits if all have the same advance width */
 444     if (scaler->render_mode != FT_RENDER_MODE_LIGHT
 445         && (FT_IS_FIXED_WIDTH(slot->face)
 446             || (ta_face_globals_is_digit(loader->globals, glyph_index)
 447                 && metrics->digits_have_same_width)))
 448     {
 449       slot->metrics.horiAdvance = FT_MulFix(slot->metrics.horiAdvance,
 450                                             metrics->scaler.x_scale);
 451
 452       /* set delta values to 0, otherwise code that uses them */
 453       /* is going to ruin the fixed advance width */
 454       slot->lsb_delta = 0;
 455       slot->rsb_delta = 0;
 456     }
 457     else
 458     {
 459       /* non-spacing glyphs must stay as-is */
 460       if (slot->metrics.horiAdvance)
 461         slot->metrics.horiAdvance = loader->pp2.x - loader->pp1.x;
 462     }
 463
 464     slot->metrics.vertAdvance = FT_MulFix(slot->metrics.vertAdvance,
 465                                           metrics->scaler.y_scale);
 466
 467     slot->metrics.horiAdvance = TA_PIX_ROUND(slot->metrics.horiAdvance);
 468     slot->metrics.vertAdvance = TA_PIX_ROUND(slot->metrics.vertAdvance);
 469
 470 #if 0
 471     /* now copy outline into glyph slot */
 472     TA_GlyphLoader_Rewind(internal->loader);
 473     error = TA_GlyphLoader_CopyPoints(internal->loader, gloader);
 474     if (error)
 475       goto Exit;
 476
 477     /* reassign all outline fields except flags to protect them */
 478     slot->outline.n_contours = internal->loader->base.outline.n_contours;
 479     slot->outline.n_points   = internal->loader->base.outline.n_points;
 480     slot->outline.points     = internal->loader->base.outline.points;
 481     slot->outline.tags       = internal->loader->base.outline.tags;
 482     slot->outline.contours   = internal->loader->base.outline.contours;
 483
 484     slot->format = FT_GLYPH_FORMAT_OUTLINE;
 485 #endif
 486   }
 487
 488 Exit:
 489   return error;
 490 }
 491
 492
 493 /* load a glyph */
 494
 495 FT_Error
 496 ta_loader_load_glyph(FONT* font,
 497                      FT_Face face,
 498                      FT_UInt gindex,
 499                      FT_Int32 load_flags)
 500 {
 501   FT_Error error;
 502   FT_Size size = face->size;
 503   TA_Loader loader = font->loader;
 504   TA_ScalerRec scaler;
 505
 506
 507   if (!size)
 508     return FT_Err_Invalid_Argument;
 509
 510   memset(&scaler, 0, sizeof (TA_ScalerRec));
 511
 512   scaler.face = face;
 513   scaler.x_scale = size->metrics.x_scale;
 514   scaler.x_delta = 0; /* XXX: TODO: add support for sub-pixel hinting */
 515   scaler.y_scale = size->metrics.y_scale;
 516   scaler.y_delta = 0; /* XXX: TODO: add support for sub-pixel hinting */
 517
 518   scaler.render_mode = FT_LOAD_TARGET_MODE(load_flags);
 519   scaler.flags = 0; /* XXX: fix this */
 520
 521   /* XXX this is an ugly hack of ttfautohint: */
 522   /* bit 29 triggers vertical hinting only */
 523   if (load_flags & (1 << 29))
 524     scaler.flags |= TA_SCALER_FLAG_NO_HORIZONTAL;
 525
 526   /* note that the fallback script can't be changed anymore */
 527   /* after the first call of `ta_loader_load_glyph' */
 528   error = ta_loader_reset(font, face);
 529   if (!error)
 530   {
 531     TA_ScriptMetrics metrics;
 532     FT_UInt options = 0;
 533
 534
 535 #ifdef FT_OPTION_AUTOFIT2
 536     /* XXX: undocumented hook to activate the latin2 hinter */
 537     if (load_flags & (1UL << 20))
 538       options = 2;
 539 #endif
 540
 541     error = ta_face_globals_get_metrics(loader->globals, gindex,
 542                                         options, &metrics);
 543     if (!error)
 544     {
 545       loader->metrics = metrics;
 546
 547       if (metrics->clazz->script_metrics_scale)
 548         metrics->clazz->script_metrics_scale(metrics, &scaler);
 549       else
 550         metrics->scaler = scaler;
 551
 552       load_flags |= FT_LOAD_NO_SCALE
 553                     | FT_LOAD_IGNORE_TRANSFORM;
 554       load_flags &= ~FT_LOAD_RENDER;
 555
 556       if (metrics->clazz->script_hints_init)
 557       {
 558         error = metrics->clazz->script_hints_init(&loader->hints,
 559                                                   metrics);
 560         if (error)
 561           goto Exit;
 562       }
 563
 564       error = ta_loader_load_g(loader, &scaler, gindex, load_flags, 0);
 565     }
 566   }
 567 Exit:
 568   return error;
 569 }
 570
 571
 572 void
 573 ta_loader_register_hints_recorder(TA_Loader loader,
 574                                   TA_Hints_Recorder hints_recorder,
 575                                   void* user)
 576 {
 577   loader->hints.recorder = hints_recorder;
 578   loader->hints.user = user;
 579 }
 580
 581 /* end of taloader.c */