lib/ta.h

   1 /* ta.h */
   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 #ifndef __TA_H__
  17 #define __TA_H__
  18
  19 #include <config.h>
  20
  21 #include <ft2build.h>
  22 #include FT_FREETYPE_H
  23 #include FT_TRUETYPE_TABLES_H
  24 #include FT_TRUETYPE_TAGS_H
  25
  26 #include "taloader.h"
  27 #include "taglobal.h"
  28 #include "tadummy.h"
  29 #include "talatin.h"
  30
  31 #include <ttfautohint.h>
  32
  33
  34 #define TTFAUTOHINT_GLYPH ".ttfautohint"
  35 #define TTFAUTOHINT_GLYPH_FIRST_BYTE "\x0C" /* first byte is string length */
  36 #define TTFAUTOHINT_GLYPH_LEN 13
  37
  38 /* these macros convert 16bit and 32bit numbers into single bytes */
  39 /* using the byte order needed within SFNT files */
  40
  41 #define HIGH(x) (FT_Byte)(((x) & 0xFF00) >> 8)
  42 #define LOW(x) ((x) & 0x00FF)
  43
  44 #define BYTE1(x) (FT_Byte)(((x) & 0xFF000000UL) >> 24);
  45 #define BYTE2(x) (FT_Byte)(((x) & 0x00FF0000UL) >> 16);
  46 #define BYTE3(x) (FT_Byte)(((x) & 0x0000FF00UL) >> 8);
  47 #define BYTE4(x) ((x) & 0x000000FFUL);
  48
  49
  50 /* the length of a dummy `DSIG' table */
  51 #define DSIG_LEN 8
  52
  53 /* the length of our `gasp' table */
  54 #define GASP_LEN 8
  55
  56 /* an empty slot in the table info array */
  57 #define MISSING (FT_ULong)~0
  58
  59 /* the offset to the loca table format in the `head' table */
  60 #define LOCA_FORMAT_OFFSET 51
  61
  62 /* various offsets within the `maxp' table */
  63 #define MAXP_NUM_GLYPHS 4
  64 #define MAXP_MAX_COMPOSITE_POINTS 10
  65 #define MAXP_MAX_COMPOSITE_CONTOURS 12
  66 #define MAXP_MAX_ZONES_OFFSET 14
  67 #define MAXP_MAX_TWILIGHT_POINTS_OFFSET 16
  68 #define MAXP_MAX_STORAGE_OFFSET 18
  69 #define MAXP_MAX_FUNCTION_DEFS_OFFSET 20
  70 #define MAXP_MAX_INSTRUCTION_DEFS_OFFSET 22
  71 #define MAXP_MAX_STACK_ELEMENTS_OFFSET 24
  72 #define MAXP_MAX_INSTRUCTIONS_OFFSET 26
  73 #define MAXP_MAX_COMPONENTS_OFFSET 28
  74
  75 #define MAXP_LEN 32
  76
  77 /* the offset of the type flags field in the `OS/2' table */
  78 #define OS2_FSTYPE_OFFSET 8
  79
  80
  81 /* flags in composite glyph records */
  82 #define ARGS_ARE_WORDS 0x0001
  83 #define ARGS_ARE_XY_VALUES 0x0002
  84 #define WE_HAVE_A_SCALE 0x0008
  85 #define MORE_COMPONENTS 0x0020
  86 #define WE_HAVE_AN_XY_SCALE 0x0040
  87 #define WE_HAVE_A_2X2 0x0080
  88 #define WE_HAVE_INSTR 0x0100
  89
  90 /* flags in simple glyph records */
  91 #define ON_CURVE 0x01
  92 #define X_SHORT_VECTOR 0x02
  93 #define Y_SHORT_VECTOR 0x04
  94 #define REPEAT 0x08
  95 #define SAME_X 0x10
  96 #define SAME_Y 0x20
  97
  98
  99 /* a single glyph */
 100 typedef struct GLYPH_
 101 {
 102   FT_ULong len1; /* number of bytes before instruction related data */
 103   FT_ULong len2; /* number of bytes after instruction related data; */
 104                  /* if zero, this indicates a composite glyph */
 105   FT_Byte* buf; /* extracted glyph data (without instruction related data) */
 106   FT_ULong flags_offset; /* offset to last flag in a composite glyph */
 107
 108   FT_ULong ins_len; /* number of new instructions */
 109   FT_Byte* ins_buf; /* new instruction data */
 110
 111   FT_Short num_contours; /* >= 0 for simple glyphs */
 112   FT_UShort num_points; /* number of points in a simple glyph */
 113
 114   FT_UShort num_components;
 115   FT_UShort* components; /* the subglyph indices of a composite glyph */
 116
 117   FT_UShort num_pointsums;
 118   FT_UShort* pointsums; /* the pointsums of all composite elements */
 119                         /* (after walking recursively over all subglyphs) */
 120
 121   FT_UShort num_composite_contours; /* after recursion */
 122 } GLYPH;
 123
 124 /* a representation of the data in the `glyf' table */
 125 typedef struct glyf_Data_
 126 {
 127   FT_UShort num_glyphs;
 128   GLYPH* glyphs;
 129 } glyf_Data;
 130
 131 /* an SFNT table */
 132 typedef struct SFNT_Table_
 133 {
 134   FT_ULong tag;
 135   FT_ULong len;
 136   FT_Byte* buf; /* the table data */
 137   FT_ULong offset; /* from beginning of file */
 138   FT_ULong checksum;
 139   void* data; /* used e.g. for `glyf' table data */
 140   FT_Bool processed;
 141 } SFNT_Table;
 142
 143 /* we use indices into the SFNT table array to */
 144 /* represent table info records of the TTF header */
 145 typedef FT_ULong SFNT_Table_Info;
 146
 147 /* this structure is used to model a TTF or a subfont within a TTC */
 148 typedef struct SFNT_
 149 {
 150   FT_Face face;
 151
 152   SFNT_Table_Info* table_infos;
 153   FT_ULong num_table_infos;
 154
 155   /* various SFNT table indices */
 156   FT_ULong glyf_idx;
 157   FT_ULong loca_idx;
 158   FT_ULong head_idx;
 159   FT_ULong hmtx_idx;
 160   FT_ULong maxp_idx;
 161   FT_ULong name_idx;
 162   FT_ULong post_idx;
 163   FT_ULong OS2_idx;
 164   FT_ULong GPOS_idx;
 165
 166   /* values necessary to update the `maxp' table */
 167   FT_UShort max_composite_points;
 168   FT_UShort max_composite_contours;
 169   FT_UShort max_storage;
 170   FT_UShort max_stack_elements;
 171   FT_UShort max_twilight_points;
 172   FT_UShort max_instructions;
 173   FT_UShort max_components;
 174 } SFNT;
 175
 176 /* our font object */
 177 struct FONT_
 178 {
 179   FT_Library lib;
 180
 181   FT_Byte* in_buf;
 182   size_t in_len;
 183
 184   FT_Byte* out_buf;
 185   size_t out_len;
 186
 187   SFNT* sfnts;
 188   FT_Long num_sfnts;
 189
 190   SFNT_Table* tables;
 191   FT_ULong num_tables;
 192
 193   FT_Bool have_DSIG;
 194
 195   TA_LoaderRec loader[1]; /* the interface to the autohinter */
 196
 197   /* configuration options */
 198   TA_Progress_Func progress;
 199   void* progress_data;
 200   TA_Info_Func info;
 201   void* info_data;
 202   FT_UInt hinting_range_min;
 203   FT_UInt hinting_range_max;
 204   FT_UInt hinting_limit;
 205   FT_UInt increase_x_height;
 206   FT_Bool gray_strong_stem_width;
 207   FT_Bool gdi_cleartype_strong_stem_width;
 208   FT_Bool dw_cleartype_strong_stem_width;
 209   FT_Bool pre_hinting;
 210   FT_Bool hint_with_components;
 211   FT_Bool no_x_height_snapping;
 212   FT_Byte* x_height_snapping_exceptions;
 213   FT_Bool ignore_restrictions;
 214   FT_UInt fallback_script;
 215   FT_Bool symbol;
 216   FT_Bool debug;
 217 };
 218
 219
 220 #include "tatables.h"
 221 #include "tabytecode.h"
 222
 223
 224 const char*
 225 TA_get_error_message(FT_Error error);
 226
 227 void
 228 TA_get_current_time(FT_ULong* high,
 229                     FT_ULong* low);
 230
 231 FT_Error
 232 TA_font_init(FONT* font);
 233 void
 234 TA_font_unload(FONT* font,
 235                const char* in_buf,
 236                char** out_bufp);
 237
 238 FT_Error
 239 TA_font_file_read(FONT* font,
 240                   FILE* in_file);
 241 FT_Error
 242 TA_font_file_write(FONT* font,
 243                    FILE* out_file);
 244
 245 FT_Error
 246 TA_sfnt_build_glyph_instructions(SFNT* sfnt,
 247                                  FONT* font,
 248                                  FT_Long idx);
 249
 250 FT_Error
 251 TA_sfnt_split_into_SFNT_tables(SFNT* sfnt,
 252                                FONT* font);
 253
 254 FT_Error
 255 TA_sfnt_build_cvt_table(SFNT* sfnt,
 256                         FONT* font);
 257
 258 FT_Error
 259 TA_table_build_DSIG(FT_Byte** DSIG);
 260
 261 FT_Error
 262 TA_sfnt_build_fpgm_table(SFNT* sfnt,
 263                          FONT* font);
 264
 265 FT_Error
 266 TA_sfnt_build_gasp_table(SFNT* sfnt,
 267                          FONT* font);
 268
 269 FT_Error
 270 TA_sfnt_build_glyf_hints(SFNT* sfnt,
 271                          FONT* font);
 272 FT_Error
 273 TA_sfnt_split_glyf_table(SFNT* sfnt,
 274                          FONT* font);
 275 FT_Error
 276 TA_sfnt_build_glyf_table(SFNT* sfnt,
 277                          FONT* font);
 278 FT_Error
 279 TA_sfnt_create_glyf_data(SFNT* sfnt,
 280                          FONT* font);
 281
 282 FT_Error
 283 TA_sfnt_update_GPOS_table(SFNT* sfnt,
 284                           FONT* font);
 285
 286 FT_Error
 287 TA_sfnt_update_hmtx_table(SFNT* sfnt,
 288                           FONT* font);
 289
 290 FT_Error
 291 TA_sfnt_build_loca_table(SFNT* sfnt,
 292                          FONT* font);
 293
 294 FT_Error
 295 TA_sfnt_update_maxp_table(SFNT* sfnt,
 296                           FONT* font);
 297
 298 FT_Error
 299 TA_sfnt_update_post_table(SFNT* sfnt,
 300                           FONT* font);
 301
 302 FT_Error
 303 TA_sfnt_update_name_table(SFNT* sfnt,
 304                           FONT* font);
 305
 306 FT_Error
 307 TA_sfnt_build_prep_table(SFNT* sfnt,
 308                          FONT* font);
 309
 310 FT_Error
 311 TA_sfnt_build_TTF_header(SFNT* sfnt,
 312                          FONT* font,
 313                          FT_Byte** header_buf,
 314                          FT_ULong* header_len,
 315                          FT_Int do_complete);
 316 FT_Error
 317 TA_font_build_TTF(FONT* font);
 318
 319 FT_Error
 320 TA_font_build_TTC(FONT* font);
 321
 322 #endif /* __TA_H__ */
 323
 324 /* end of ta.h */