1 /***************************************************************************/
5 /* Basic SFNT/TrueType type definitions and interface (specification */
8 /* Copyright 1996-2018 by */
9 /* David Turner, Robert Wilhelm, and Werner Lemberg. */
11 /* This file is part of the FreeType project, and may only be used, */
12 /* modified, and distributed under the terms of the FreeType project */
13 /* license, LICENSE.TXT. By continuing to use, modify, or distribute */
14 /* this file you indicate that you have read the license and */
15 /* understand and accept it fully. */
17 /***************************************************************************/
25 #include FT_TRUETYPE_TABLES_H
26 #include FT_INTERNAL_OBJECTS_H
28 #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT
29 #include FT_MULTIPLE_MASTERS_H
36 /*************************************************************************/
37 /*************************************************************************/
38 /*************************************************************************/
41 /*** REQUIRED TRUETYPE/OPENTYPE TABLES DEFINITIONS ***/
44 /*************************************************************************/
45 /*************************************************************************/
46 /*************************************************************************/
49 /*************************************************************************/
55 /* TrueType collection header. This table contains the offsets of */
56 /* the font headers of each distinct TrueType face in the file. */
59 /* tag :: Must be `ttc ' to indicate a TrueType collection. */
61 /* version :: The version number. */
63 /* count :: The number of faces in the collection. The */
64 /* specification says this should be an unsigned long, but */
65 /* we use a signed long since we need the value -1 for */
66 /* specific purposes. */
68 /* offsets :: The offsets of the font headers, one per face. */
70 typedef struct TTC_HeaderRec_
80 /*************************************************************************/
86 /* SFNT file format header. */
89 /* format_tag :: The font format tag. */
91 /* num_tables :: The number of tables in file. */
93 /* search_range :: Must be `16 * (max power of 2 <= num_tables)'. */
95 /* entry_selector :: Must be log2 of `search_range / 16'. */
97 /* range_shift :: Must be `num_tables * 16 - search_range'. */
99 typedef struct SFNT_HeaderRec_
102 FT_UShort num_tables
;
103 FT_UShort search_range
;
104 FT_UShort entry_selector
;
105 FT_UShort range_shift
;
107 FT_ULong offset
; /* not in file */
109 } SFNT_HeaderRec
, *SFNT_Header
;
112 /*************************************************************************/
118 /* This structure describes a given table of a TrueType font. */
121 /* Tag :: A four-bytes tag describing the table. */
123 /* CheckSum :: The table checksum. This value can be ignored. */
125 /* Offset :: The offset of the table from the start of the TrueType */
126 /* font in its resource. */
128 /* Length :: The table length (in bytes). */
130 typedef struct TT_TableRec_
132 FT_ULong Tag
; /* table type */
133 FT_ULong CheckSum
; /* table checksum */
134 FT_ULong Offset
; /* table file offset */
135 FT_ULong Length
; /* table length */
137 } TT_TableRec
, *TT_Table
;
140 /*************************************************************************/
146 /* WOFF file format header. */
151 /* https://www.w3.org/TR/WOFF/#WOFFHeader */
153 typedef struct WOFF_HeaderRec_
158 FT_UShort num_tables
;
160 FT_ULong totalSfntSize
;
161 FT_UShort majorVersion
;
162 FT_UShort minorVersion
;
165 FT_ULong metaOrigLength
;
169 } WOFF_HeaderRec
, *WOFF_Header
;
172 /*************************************************************************/
178 /* This structure describes a given table of a WOFF font. */
181 /* Tag :: A four-bytes tag describing the table. */
183 /* Offset :: The offset of the table from the start of the WOFF */
184 /* font in its resource. */
186 /* CompLength :: Compressed table length (in bytes). */
188 /* OrigLength :: Uncompressed table length (in bytes). */
190 /* CheckSum :: The table checksum. This value can be ignored. */
192 /* OrigOffset :: The uncompressed table file offset. This value gets */
193 /* computed while constructing the (uncompressed) SFNT */
194 /* header. It is not contained in the WOFF file. */
196 typedef struct WOFF_TableRec_
198 FT_ULong Tag
; /* table ID */
199 FT_ULong Offset
; /* table file offset */
200 FT_ULong CompLength
; /* compressed table length */
201 FT_ULong OrigLength
; /* uncompressed table length */
202 FT_ULong CheckSum
; /* uncompressed checksum */
204 FT_ULong OrigOffset
; /* uncompressed table file offset */
205 /* (not in the WOFF file) */
206 } WOFF_TableRec
, *WOFF_Table
;
209 /*************************************************************************/
212 /* TT_LongMetricsRec */
215 /* A structure modeling the long metrics of the `hmtx' and `vmtx' */
216 /* TrueType tables. The values are expressed in font units. */
219 /* advance :: The advance width or height for the glyph. */
221 /* bearing :: The left-side or top-side bearing for the glyph. */
223 typedef struct TT_LongMetricsRec_
228 } TT_LongMetricsRec
, *TT_LongMetrics
;
231 /*************************************************************************/
234 /* TT_ShortMetrics */
237 /* A simple type to model the short metrics of the `hmtx' and `vmtx' */
240 typedef FT_Short TT_ShortMetrics
;
243 /*************************************************************************/
249 /* A structure modeling TrueType name records. Name records are used */
250 /* to store important strings like family name, style name, */
251 /* copyright, etc. in _localized_ versions (i.e., language, encoding, */
255 /* platformID :: The ID of the name's encoding platform. */
257 /* encodingID :: The platform-specific ID for the name's encoding. */
259 /* languageID :: The platform-specific ID for the name's language. */
261 /* nameID :: The ID specifying what kind of name this is. */
263 /* stringLength :: The length of the string in bytes. */
265 /* stringOffset :: The offset to the string in the `name' table. */
267 /* string :: A pointer to the string's bytes. Note that these */
268 /* are usually UTF-16 encoded characters. */
270 typedef struct TT_NameRec_
272 FT_UShort platformID
;
273 FT_UShort encodingID
;
274 FT_UShort languageID
;
276 FT_UShort stringLength
;
277 FT_ULong stringOffset
;
279 /* this last field is not defined in the spec */
280 /* but used by the FreeType engine */
284 } TT_NameRec
, *TT_Name
;
287 /*************************************************************************/
293 /* A structure modeling language tag records in SFNT `name' tables, */
294 /* introduced in OpenType version 1.6. */
297 /* stringLength :: The length of the string in bytes. */
299 /* stringOffset :: The offset to the string in the `name' table. */
301 /* string :: A pointer to the string's bytes. Note that these */
302 /* are UTF-16BE encoded characters. */
304 typedef struct TT_LangTagRec_
306 FT_UShort stringLength
;
307 FT_ULong stringOffset
;
309 /* this last field is not defined in the spec */
310 /* but used by the FreeType engine */
314 } TT_LangTagRec
, *TT_LangTag
;
317 /*************************************************************************/
320 /* TT_NameTableRec */
323 /* A structure modeling the TrueType name table. */
326 /* format :: The format of the name table. */
328 /* numNameRecords :: The number of names in table. */
330 /* storageOffset :: The offset of the name table in the `name' */
331 /* TrueType table. */
333 /* names :: An array of name records. */
335 /* numLangTagRecords :: The number of language tags in table. */
337 /* langTags :: An array of language tag records. */
339 /* stream :: The file's input stream. */
341 typedef struct TT_NameTableRec_
344 FT_UInt numNameRecords
;
345 FT_UInt storageOffset
;
347 FT_UInt numLangTagRecords
;
348 TT_LangTagRec
* langTags
;
351 } TT_NameTableRec
, *TT_NameTable
;
354 /*************************************************************************/
355 /*************************************************************************/
356 /*************************************************************************/
359 /*** OPTIONAL TRUETYPE/OPENTYPE TABLES DEFINITIONS ***/
362 /*************************************************************************/
363 /*************************************************************************/
364 /*************************************************************************/
367 /*************************************************************************/
370 /* TT_GaspRangeRec */
373 /* A tiny structure used to model a gasp range according to the */
374 /* TrueType specification. */
377 /* maxPPEM :: The maximum ppem value to which `gaspFlag' applies. */
379 /* gaspFlag :: A flag describing the grid-fitting and anti-aliasing */
380 /* modes to be used. */
382 typedef struct TT_GaspRangeRec_
387 } TT_GaspRangeRec
, *TT_GaspRange
;
390 #define TT_GASP_GRIDFIT 0x01
391 #define TT_GASP_DOGRAY 0x02
394 /*************************************************************************/
400 /* A structure modeling the TrueType `gasp' table used to specify */
401 /* grid-fitting and anti-aliasing behaviour. */
404 /* version :: The version number. */
406 /* numRanges :: The number of gasp ranges in table. */
408 /* gaspRanges :: An array of gasp ranges. */
410 typedef struct TT_Gasp_
414 TT_GaspRange gaspRanges
;
419 /*************************************************************************/
420 /*************************************************************************/
421 /*************************************************************************/
424 /*** EMBEDDED BITMAPS SUPPORT ***/
427 /*************************************************************************/
428 /*************************************************************************/
429 /*************************************************************************/
432 /*************************************************************************/
435 /* TT_SBit_MetricsRec */
438 /* A structure used to hold the big metrics of a given glyph bitmap */
439 /* in a TrueType or OpenType font. These are usually found in the */
440 /* `EBDT' (Microsoft) or `bloc' (Apple) table. */
443 /* height :: The glyph height in pixels. */
445 /* width :: The glyph width in pixels. */
447 /* horiBearingX :: The horizontal left bearing. */
449 /* horiBearingY :: The horizontal top bearing. */
451 /* horiAdvance :: The horizontal advance. */
453 /* vertBearingX :: The vertical left bearing. */
455 /* vertBearingY :: The vertical top bearing. */
457 /* vertAdvance :: The vertical advance. */
459 typedef struct TT_SBit_MetricsRec_
464 FT_Short horiBearingX
;
465 FT_Short horiBearingY
;
466 FT_UShort horiAdvance
;
468 FT_Short vertBearingX
;
469 FT_Short vertBearingY
;
470 FT_UShort vertAdvance
;
472 } TT_SBit_MetricsRec
, *TT_SBit_Metrics
;
475 /*************************************************************************/
478 /* TT_SBit_SmallMetricsRec */
481 /* A structure used to hold the small metrics of a given glyph bitmap */
482 /* in a TrueType or OpenType font. These are usually found in the */
483 /* `EBDT' (Microsoft) or the `bdat' (Apple) table. */
486 /* height :: The glyph height in pixels. */
488 /* width :: The glyph width in pixels. */
490 /* bearingX :: The left-side bearing. */
492 /* bearingY :: The top-side bearing. */
494 /* advance :: The advance width or height. */
496 typedef struct TT_SBit_Small_Metrics_
505 } TT_SBit_SmallMetricsRec
, *TT_SBit_SmallMetrics
;
508 /*************************************************************************/
511 /* TT_SBit_LineMetricsRec */
514 /* A structure used to describe the text line metrics of a given */
515 /* bitmap strike, for either a horizontal or vertical layout. */
518 /* ascender :: The ascender in pixels. */
520 /* descender :: The descender in pixels. */
522 /* max_width :: The maximum glyph width in pixels. */
524 /* caret_slope_enumerator :: Rise of the caret slope, typically set */
525 /* to 1 for non-italic fonts. */
527 /* caret_slope_denominator :: Rise of the caret slope, typically set */
528 /* to 0 for non-italic fonts. */
530 /* caret_offset :: Offset in pixels to move the caret for */
531 /* proper positioning. */
533 /* min_origin_SB :: Minimum of horiBearingX (resp. */
535 /* min_advance_SB :: Minimum of */
537 /* horizontal advance - */
538 /* ( horiBearingX + width ) */
542 /* vertical advance - */
543 /* ( vertBearingY + height ) */
545 /* max_before_BL :: Maximum of horiBearingY (resp. */
548 /* min_after_BL :: Minimum of */
550 /* horiBearingY - height */
554 /* vertBearingX - width */
556 /* pads :: Unused (to make the size of the record */
557 /* a multiple of 32 bits. */
559 typedef struct TT_SBit_LineMetricsRec_
564 FT_Char caret_slope_numerator
;
565 FT_Char caret_slope_denominator
;
566 FT_Char caret_offset
;
567 FT_Char min_origin_SB
;
568 FT_Char min_advance_SB
;
569 FT_Char max_before_BL
;
570 FT_Char min_after_BL
;
573 } TT_SBit_LineMetricsRec
, *TT_SBit_LineMetrics
;
576 /*************************************************************************/
579 /* TT_SBit_RangeRec */
582 /* A TrueType/OpenType subIndexTable as defined in the `EBLC' */
583 /* (Microsoft) or `bloc' (Apple) tables. */
586 /* first_glyph :: The first glyph index in the range. */
588 /* last_glyph :: The last glyph index in the range. */
590 /* index_format :: The format of index table. Valid values are 1 */
593 /* image_format :: The format of `EBDT' image data. */
595 /* image_offset :: The offset to image data in `EBDT'. */
597 /* image_size :: For index formats 2 and 5. This is the size in */
598 /* bytes of each glyph bitmap. */
600 /* big_metrics :: For index formats 2 and 5. This is the big */
601 /* metrics for each glyph bitmap. */
603 /* num_glyphs :: For index formats 4 and 5. This is the number of */
604 /* glyphs in the code array. */
606 /* glyph_offsets :: For index formats 1 and 3. */
608 /* glyph_codes :: For index formats 4 and 5. */
610 /* table_offset :: The offset of the index table in the `EBLC' */
611 /* table. Only used during strike loading. */
613 typedef struct TT_SBit_RangeRec_
615 FT_UShort first_glyph
;
616 FT_UShort last_glyph
;
618 FT_UShort index_format
;
619 FT_UShort image_format
;
620 FT_ULong image_offset
;
623 TT_SBit_MetricsRec metrics
;
626 FT_ULong
* glyph_offsets
;
627 FT_UShort
* glyph_codes
;
629 FT_ULong table_offset
;
631 } TT_SBit_RangeRec
, *TT_SBit_Range
;
634 /*************************************************************************/
637 /* TT_SBit_StrikeRec */
640 /* A structure used describe a given bitmap strike in the `EBLC' */
641 /* (Microsoft) or `bloc' (Apple) tables. */
644 /* num_index_ranges :: The number of index ranges. */
646 /* index_ranges :: An array of glyph index ranges. */
648 /* color_ref :: Unused. `color_ref' is put in for future */
649 /* enhancements, but these fields are already */
650 /* in use by other platforms (e.g. Newton). */
651 /* For details, please see */
653 /* https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6bloc.html */
655 /* hori :: The line metrics for horizontal layouts. */
657 /* vert :: The line metrics for vertical layouts. */
659 /* start_glyph :: The lowest glyph index for this strike. */
661 /* end_glyph :: The highest glyph index for this strike. */
663 /* x_ppem :: The number of horizontal pixels per EM. */
665 /* y_ppem :: The number of vertical pixels per EM. */
667 /* bit_depth :: The bit depth. Valid values are 1, 2, 4, */
670 /* flags :: Is this a vertical or horizontal strike? For */
671 /* details, please see */
673 /* https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6bloc.html */
675 typedef struct TT_SBit_StrikeRec_
678 TT_SBit_Range sbit_ranges
;
679 FT_ULong ranges_offset
;
683 TT_SBit_LineMetricsRec hori
;
684 TT_SBit_LineMetricsRec vert
;
686 FT_UShort start_glyph
;
695 } TT_SBit_StrikeRec
, *TT_SBit_Strike
;
698 /*************************************************************************/
701 /* TT_SBit_ComponentRec */
704 /* A simple structure to describe a compound sbit element. */
707 /* glyph_code :: The element's glyph index. */
709 /* x_offset :: The element's left bearing. */
711 /* y_offset :: The element's top bearing. */
713 typedef struct TT_SBit_ComponentRec_
715 FT_UShort glyph_code
;
719 } TT_SBit_ComponentRec
, *TT_SBit_Component
;
722 /*************************************************************************/
725 /* TT_SBit_ScaleRec */
728 /* A structure used describe a given bitmap scaling table, as defined */
729 /* in the `EBSC' table. */
732 /* hori :: The horizontal line metrics. */
734 /* vert :: The vertical line metrics. */
736 /* x_ppem :: The number of horizontal pixels per EM. */
738 /* y_ppem :: The number of vertical pixels per EM. */
740 /* x_ppem_substitute :: Substitution x_ppem value. */
742 /* y_ppem_substitute :: Substitution y_ppem value. */
744 typedef struct TT_SBit_ScaleRec_
746 TT_SBit_LineMetricsRec hori
;
747 TT_SBit_LineMetricsRec vert
;
752 FT_Byte x_ppem_substitute
;
753 FT_Byte y_ppem_substitute
;
755 } TT_SBit_ScaleRec
, *TT_SBit_Scale
;
758 /*************************************************************************/
759 /*************************************************************************/
760 /*************************************************************************/
763 /*** POSTSCRIPT GLYPH NAMES SUPPORT ***/
766 /*************************************************************************/
767 /*************************************************************************/
768 /*************************************************************************/
771 /*************************************************************************/
777 /* Postscript names sub-table, format 2.0. Stores the PS name of */
778 /* each glyph in the font face. */
781 /* num_glyphs :: The number of named glyphs in the table. */
783 /* num_names :: The number of PS names stored in the table. */
785 /* glyph_indices :: The indices of the glyphs in the names arrays. */
787 /* glyph_names :: The PS names not in Mac Encoding. */
789 typedef struct TT_Post_20Rec_
791 FT_UShort num_glyphs
;
793 FT_UShort
* glyph_indices
;
794 FT_Char
** glyph_names
;
796 } TT_Post_20Rec
, *TT_Post_20
;
799 /*************************************************************************/
805 /* Postscript names sub-table, format 2.5. Stores the PS name of */
806 /* each glyph in the font face. */
809 /* num_glyphs :: The number of glyphs in the table. */
811 /* offsets :: An array of signed offsets in a normal Mac */
812 /* Postscript name encoding. */
814 typedef struct TT_Post_25_
816 FT_UShort num_glyphs
;
819 } TT_Post_25Rec
, *TT_Post_25
;
822 /*************************************************************************/
825 /* TT_Post_NamesRec */
828 /* Postscript names table, either format 2.0 or 2.5. */
831 /* loaded :: A flag to indicate whether the PS names are loaded. */
833 /* format_20 :: The sub-table used for format 2.0. */
835 /* format_25 :: The sub-table used for format 2.5. */
837 typedef struct TT_Post_NamesRec_
843 TT_Post_20Rec format_20
;
844 TT_Post_25Rec format_25
;
848 } TT_Post_NamesRec
, *TT_Post_Names
;
851 /*************************************************************************/
852 /*************************************************************************/
853 /*************************************************************************/
856 /*** GX VARIATION TABLE SUPPORT ***/
859 /*************************************************************************/
860 /*************************************************************************/
861 /*************************************************************************/
864 #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT
865 typedef struct GX_BlendRec_
*GX_Blend
;
868 /*************************************************************************/
869 /*************************************************************************/
870 /*************************************************************************/
873 /*** EMBEDDED BDF PROPERTIES TABLE SUPPORT ***/
876 /*************************************************************************/
877 /*************************************************************************/
878 /*************************************************************************/
881 * These types are used to support a `BDF ' table that isn't part of the
882 * official TrueType specification. It is mainly used in SFNT-based
883 * bitmap fonts that were generated from a set of BDF fonts.
885 * The format of the table is as follows.
887 * USHORT version `BDF ' table version number, should be 0x0001.
888 * USHORT strikeCount Number of strikes (bitmap sizes) in this table.
889 * ULONG stringTable Offset (from start of BDF table) to string
892 * This is followed by an array of `strikeCount' descriptors, having the
895 * USHORT ppem Vertical pixels per EM for this strike.
896 * USHORT numItems Number of items for this strike (properties and
897 * atoms). Maximum is 255.
899 * This array in turn is followed by `strikeCount' value sets. Each
900 * `value set' is an array of `numItems' items with the following format.
902 * ULONG item_name Offset in string table to item name.
903 * USHORT item_type The item type. Possible values are
904 * 0 => string (e.g., COMMENT)
905 * 1 => atom (e.g., FONT or even SIZE)
908 * 0x10 => A flag to indicate a properties. This
909 * is ORed with the above values.
910 * ULONG item_value For strings => Offset into string table without
911 * the corresponding double quotes.
912 * For atoms => Offset into string table.
913 * For integers => Direct value.
915 * All strings in the string table consist of bytes and are
920 #ifdef TT_CONFIG_OPTION_BDF
922 typedef struct TT_BDFRec_
927 FT_ULong strings_size
;
931 } TT_BDFRec
, *TT_BDF
;
933 #endif /* TT_CONFIG_OPTION_BDF */
935 /*************************************************************************/
936 /*************************************************************************/
937 /*************************************************************************/
940 /*** ORIGINAL TT_FACE CLASS DEFINITION ***/
943 /*************************************************************************/
944 /*************************************************************************/
945 /*************************************************************************/
948 /*************************************************************************/
950 /* This structure/class is defined here because it is common to the */
951 /* following formats: TTF, OpenType-TT, and OpenType-CFF. */
953 /* Note, however, that the classes TT_Size and TT_GlyphSlot are not */
954 /* shared between font drivers, and are thus defined in `ttobjs.h'. */
956 /*************************************************************************/
959 /*************************************************************************/
965 /* A handle to a TrueType face/font object. A TT_Face encapsulates */
966 /* the resolution and scaling independent parts of a TrueType font */
970 /* The TT_Face structure is also used as a `parent class' for the */
971 /* OpenType-CFF class (T2_Face). */
973 typedef struct TT_FaceRec_
* TT_Face
;
976 /* a function type used for the truetype bytecode interpreter hooks */
978 (*TT_Interpreter
)( void* exec_context
);
980 /* forward declaration */
981 typedef struct TT_LoaderRec_
* TT_Loader
;
984 /*************************************************************************/
987 /* TT_Loader_GotoTableFunc */
990 /* Seeks a stream to the start of a given TrueType table. */
993 /* face :: A handle to the target face object. */
995 /* tag :: A 4-byte tag used to name the table. */
997 /* stream :: The input stream. */
1000 /* length :: The length of the table in bytes. Set to 0 if not */
1004 /* FreeType error code. 0 means success. */
1007 /* The stream cursor must be at the font file's origin. */
1010 (*TT_Loader_GotoTableFunc
)( TT_Face face
,
1016 /*************************************************************************/
1019 /* TT_Loader_StartGlyphFunc */
1022 /* Seeks a stream to the start of a given glyph element, and opens a */
1026 /* loader :: The current TrueType glyph loader object. */
1028 /* glyph index :: The index of the glyph to access. */
1030 /* offset :: The offset of the glyph according to the */
1031 /* `locations' table. */
1033 /* byte_count :: The size of the frame in bytes. */
1036 /* FreeType error code. 0 means success. */
1039 /* This function is normally equivalent to FT_STREAM_SEEK(offset) */
1040 /* followed by FT_FRAME_ENTER(byte_count) with the loader's stream, */
1041 /* but alternative formats (e.g. compressed ones) might use something */
1045 (*TT_Loader_StartGlyphFunc
)( TT_Loader loader
,
1046 FT_UInt glyph_index
,
1048 FT_UInt byte_count
);
1051 /*************************************************************************/
1054 /* TT_Loader_ReadGlyphFunc */
1057 /* Reads one glyph element (its header, a simple glyph, or a */
1058 /* composite) from the loader's current stream frame. */
1061 /* loader :: The current TrueType glyph loader object. */
1064 /* FreeType error code. 0 means success. */
1067 (*TT_Loader_ReadGlyphFunc
)( TT_Loader loader
);
1070 /*************************************************************************/
1073 /* TT_Loader_EndGlyphFunc */
1076 /* Closes the current loader stream frame for the glyph. */
1079 /* loader :: The current TrueType glyph loader object. */
1082 (*TT_Loader_EndGlyphFunc
)( TT_Loader loader
);
1085 typedef enum TT_SbitTableType_
1087 TT_SBIT_TABLE_TYPE_NONE
= 0,
1088 TT_SBIT_TABLE_TYPE_EBLC
, /* `EBLC' (Microsoft), */
1089 /* `bloc' (Apple) */
1090 TT_SBIT_TABLE_TYPE_CBLC
, /* `CBLC' (Google) */
1091 TT_SBIT_TABLE_TYPE_SBIX
, /* `sbix' (Apple) */
1094 TT_SBIT_TABLE_TYPE_MAX
1099 /* OpenType 1.8 brings new tables for variation font support; */
1100 /* to make the old MM and GX fonts still work we need to check */
1101 /* the presence (and validity) of the functionality provided */
1102 /* by those tables. The following flag macros are for the */
1103 /* field `variation_support'. */
1105 /* Note that `fvar' gets checked immediately at font loading, */
1106 /* while the other features are only loaded if MM support is */
1107 /* actually requested. */
1110 #define TT_FACE_FLAG_VAR_FVAR ( 1 << 0 )
1113 #define TT_FACE_FLAG_VAR_HADVANCE ( 1 << 1 )
1114 #define TT_FACE_FLAG_VAR_LSB ( 1 << 2 )
1115 #define TT_FACE_FLAG_VAR_RSB ( 1 << 3 )
1118 #define TT_FACE_FLAG_VAR_VADVANCE ( 1 << 4 )
1119 #define TT_FACE_FLAG_VAR_TSB ( 1 << 5 )
1120 #define TT_FACE_FLAG_VAR_BSB ( 1 << 6 )
1121 #define TT_FACE_FLAG_VAR_VORG ( 1 << 7 )
1124 #define TT_FACE_FLAG_VAR_MVAR ( 1 << 8 )
1127 /*************************************************************************/
1129 /* TrueType Face Type */
1135 /* The TrueType face class. These objects model the resolution and */
1136 /* point-size independent data found in a TrueType font file. */
1139 /* root :: The base FT_Face structure, managed by the */
1142 /* ttc_header :: The TrueType collection header, used when */
1143 /* the file is a `ttc' rather than a `ttf'. */
1144 /* For ordinary font files, the field */
1145 /* `ttc_header.count' is set to 0. */
1147 /* format_tag :: The font format tag. */
1149 /* num_tables :: The number of TrueType tables in this font */
1152 /* dir_tables :: The directory of TrueType tables for this */
1155 /* header :: The font's font header (`head' table). */
1156 /* Read on font opening. */
1158 /* horizontal :: The font's horizontal header (`hhea' */
1159 /* table). This field also contains the */
1160 /* associated horizontal metrics table */
1163 /* max_profile :: The font's maximum profile table. Read on */
1164 /* font opening. Note that some maximum */
1165 /* values cannot be taken directly from this */
1166 /* table. We thus define additional fields */
1167 /* below to hold the computed maxima. */
1169 /* vertical_info :: A boolean which is set when the font file */
1170 /* contains vertical metrics. If not, the */
1171 /* value of the `vertical' field is */
1174 /* vertical :: The font's vertical header (`vhea' table). */
1175 /* This field also contains the associated */
1176 /* vertical metrics table (`vmtx'), if found. */
1177 /* IMPORTANT: The contents of this field is */
1178 /* undefined if the `vertical_info' field is */
1181 /* num_names :: The number of name records within this */
1182 /* TrueType font. */
1184 /* name_table :: The table of name records (`name'). */
1186 /* os2 :: The font's OS/2 table (`OS/2'). */
1188 /* postscript :: The font's PostScript table (`post' */
1189 /* table). The PostScript glyph names are */
1190 /* not loaded by the driver on face opening. */
1191 /* See the `ttpost' module for more details. */
1193 /* cmap_table :: Address of the face's `cmap' SFNT table */
1194 /* in memory (it's an extracted frame). */
1196 /* cmap_size :: The size in bytes of the `cmap_table' */
1197 /* described above. */
1199 /* goto_table :: A function called by each TrueType table */
1200 /* loader to position a stream's cursor to */
1201 /* the start of a given table according to */
1202 /* its tag. It defaults to TT_Goto_Face but */
1203 /* can be different for strange formats (e.g. */
1206 /* access_glyph_frame :: A function used to access the frame of a */
1207 /* given glyph within the face's font file. */
1209 /* forget_glyph_frame :: A function used to forget the frame of a */
1210 /* given glyph when all data has been loaded. */
1212 /* read_glyph_header :: A function used to read a glyph header. */
1213 /* It must be called between an `access' and */
1216 /* read_simple_glyph :: A function used to read a simple glyph. */
1217 /* It must be called after the header was */
1218 /* read, and before the `forget'. */
1220 /* read_composite_glyph :: A function used to read a composite glyph. */
1221 /* It must be called after the header was */
1222 /* read, and before the `forget'. */
1224 /* sfnt :: A pointer to the SFNT service. */
1226 /* psnames :: A pointer to the PostScript names service. */
1228 /* mm :: A pointer to the Multiple Masters service. */
1230 /* var :: A pointer to the Metrics Variations */
1233 /* hdmx :: The face's horizontal device metrics */
1234 /* (`hdmx' table). This table is optional in */
1235 /* TrueType/OpenType fonts. */
1237 /* gasp :: The grid-fitting and scaling properties */
1238 /* table (`gasp'). This table is optional in */
1239 /* TrueType/OpenType fonts. */
1241 /* pclt :: The `pclt' SFNT table. */
1243 /* num_sbit_scales :: The number of sbit scales for this font. */
1245 /* sbit_scales :: Array of sbit scales embedded in this */
1246 /* font. This table is optional in a */
1247 /* TrueType/OpenType font. */
1249 /* postscript_names :: A table used to store the Postscript names */
1250 /* of the glyphs for this font. See the */
1251 /* file `ttconfig.h' for comments on the */
1252 /* TT_CONFIG_OPTION_POSTSCRIPT_NAMES option. */
1254 /* font_program_size :: Size in bytecodes of the face's font */
1255 /* program. 0 if none defined. Ignored for */
1258 /* font_program :: The face's font program (bytecode stream) */
1259 /* executed at load time, also used during */
1260 /* glyph rendering. Comes from the `fpgm' */
1261 /* table. Ignored for Type 2 font fonts. */
1263 /* cvt_program_size :: The size in bytecodes of the face's cvt */
1264 /* program. Ignored for Type 2 fonts. */
1266 /* cvt_program :: The face's cvt program (bytecode stream) */
1267 /* executed each time an instance/size is */
1268 /* changed/reset. Comes from the `prep' */
1269 /* table. Ignored for Type 2 fonts. */
1271 /* cvt_size :: Size of the control value table (in */
1272 /* entries). Ignored for Type 2 fonts. */
1274 /* cvt :: The face's original control value table. */
1275 /* Coordinates are expressed in unscaled font */
1276 /* units. Comes from the `cvt ' table. */
1277 /* Ignored for Type 2 fonts. */
1279 /* interpreter :: A pointer to the TrueType bytecode */
1280 /* interpreters field is also used to hook */
1281 /* the debugger in `ttdebug'. */
1283 /* extra :: Reserved for third-party font drivers. */
1285 /* postscript_name :: The PS name of the font. Used by the */
1286 /* postscript name service. */
1288 /* glyf_len :: The length of the `glyf' table. Needed */
1289 /* for malformed `loca' tables. */
1291 /* glyf_offset :: The file offset of the `glyf' table. */
1293 /* is_cff2 :: Set if the font format is CFF2. */
1295 /* doblend :: A boolean which is set if the font should */
1296 /* be blended (this is for GX var). */
1298 /* blend :: Contains the data needed to control GX */
1299 /* variation tables (rather like Multiple */
1302 /* variation_support :: Flags that indicate which OpenType */
1303 /* functionality related to font variation */
1304 /* support is present, valid, and usable. */
1305 /* For example, TT_FACE_FLAG_VAR_FVAR is only */
1306 /* set if we have at least one design axis. */
1308 /* var_postscript_prefix :: */
1309 /* The PostScript name prefix needed for */
1310 /* constructing a variation font instance's */
1313 /* var_postscript_prefix_len :: */
1314 /* The length of the `var_postscript_prefix' */
1317 /* horz_metrics_size :: The size of the `hmtx' table. */
1319 /* vert_metrics_size :: The size of the `vmtx' table. */
1321 /* num_locations :: The number of glyph locations in this */
1322 /* TrueType file. This should be */
1323 /* identical to the number of glyphs. */
1324 /* Ignored for Type 2 fonts. */
1326 /* glyph_locations :: An array of longs. These are offsets to */
1327 /* glyph data within the `glyf' table. */
1328 /* Ignored for Type 2 font faces. */
1330 /* hdmx_table :: A pointer to the `hdmx' table. */
1332 /* hdmx_table_size :: The size of the `hdmx' table. */
1334 /* hdmx_record_count :: The number of hdmx records. */
1336 /* hdmx_record_size :: The size of a single hdmx record. */
1338 /* hdmx_record_sizes :: An array holding the ppem sizes available */
1339 /* in the `hdmx' table. */
1341 /* sbit_table :: A pointer to the font's embedded bitmap */
1342 /* location table. */
1344 /* sbit_table_size :: The size of `sbit_table'. */
1346 /* sbit_table_type :: The sbit table type (CBLC, sbix, etc.). */
1348 /* sbit_num_strikes :: The number of sbit strikes exposed by */
1349 /* FreeType's API, omitting invalid strikes. */
1351 /* sbit_strike_map :: A mapping between the strike indices */
1352 /* exposed by the API and the indices used in */
1353 /* the font's sbit table. */
1355 /* kern_table :: A pointer to the `kern' table. */
1357 /* kern_table_size :: The size of the `kern' table. */
1359 /* num_kern_tables :: The number of supported kern subtables */
1360 /* (up to 32; FreeType recognizes only */
1361 /* horizontal ones with format 0). */
1363 /* kern_avail_bits :: The availability status of kern subtables; */
1364 /* if bit n is set, table n is available. */
1366 /* kern_order_bits :: The sortedness status of kern subtables; */
1367 /* if bit n is set, table n is sorted. */
1369 /* bdf :: Data related to an SFNT font's `bdf' */
1370 /* table; see `tttypes.h'. */
1372 /* horz_metrics_offset :: The file offset of the `hmtx' table. */
1374 /* vert_metrics_offset :: The file offset of the `vmtx' table. */
1376 /* sph_found_func_flags :: Flags identifying special bytecode */
1377 /* functions (used by the v38 implementation */
1378 /* of the bytecode interpreter). */
1380 /* sph_compatibility_mode :: */
1381 /* This flag is set if we are in ClearType */
1382 /* backward compatibility mode (used by the */
1383 /* v38 implementation of the bytecode */
1386 /* ebdt_start :: The file offset of the sbit data table */
1387 /* (CBDT, bdat, etc.). */
1389 /* ebdt_size :: The size of the sbit data table. */
1391 typedef struct TT_FaceRec_
1395 TTC_HeaderRec ttc_header
;
1397 FT_ULong format_tag
;
1398 FT_UShort num_tables
;
1399 TT_Table dir_tables
;
1401 TT_Header header
; /* TrueType header table */
1402 TT_HoriHeader horizontal
; /* TrueType horizontal header */
1404 TT_MaxProfile max_profile
;
1406 FT_Bool vertical_info
;
1407 TT_VertHeader vertical
; /* TT Vertical header, if present */
1409 FT_UShort num_names
; /* number of name records */
1410 TT_NameTableRec name_table
; /* name table */
1412 TT_OS2 os2
; /* TrueType OS/2 table */
1413 TT_Postscript postscript
; /* TrueType Postscript table */
1415 FT_Byte
* cmap_table
; /* extracted `cmap' table */
1418 TT_Loader_GotoTableFunc goto_table
;
1420 TT_Loader_StartGlyphFunc access_glyph_frame
;
1421 TT_Loader_EndGlyphFunc forget_glyph_frame
;
1422 TT_Loader_ReadGlyphFunc read_glyph_header
;
1423 TT_Loader_ReadGlyphFunc read_simple_glyph
;
1424 TT_Loader_ReadGlyphFunc read_composite_glyph
;
1426 /* a typeless pointer to the SFNT_Interface table used to load */
1427 /* the basic TrueType tables in the face object */
1430 /* a typeless pointer to the FT_Service_PsCMapsRec table used to */
1431 /* handle glyph names <-> unicode & Mac values */
1434 #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT
1435 /* a typeless pointer to the FT_Service_MultiMasters table used to */
1436 /* handle variation fonts */
1439 /* a typeless pointer to the FT_Service_MetricsVariationsRec table */
1440 /* used to handle the HVAR, VVAR, and MVAR OpenType tables */
1444 /* a typeless pointer to the PostScript Aux service */
1448 /***********************************************************************/
1450 /* Optional TrueType/OpenType tables */
1452 /***********************************************************************/
1454 /* grid-fitting and scaling table */
1455 TT_GaspRec gasp
; /* the `gasp' table */
1460 /* embedded bitmaps support */
1461 FT_ULong num_sbit_scales
;
1462 TT_SBit_Scale sbit_scales
;
1464 /* postscript names table */
1465 TT_Post_NamesRec postscript_names
;
1468 /***********************************************************************/
1470 /* TrueType-specific fields (ignored by the CFF driver) */
1472 /***********************************************************************/
1474 /* the font program, if any */
1475 FT_ULong font_program_size
;
1476 FT_Byte
* font_program
;
1478 /* the cvt program, if any */
1479 FT_ULong cvt_program_size
;
1480 FT_Byte
* cvt_program
;
1482 /* the original, unscaled, control value table */
1486 /* A pointer to the bytecode interpreter to use. This is also */
1487 /* used to hook the debugger for the `ttdebug' utility. */
1488 TT_Interpreter interpreter
;
1491 /***********************************************************************/
1493 /* Other tables or fields. This is used by derivative formats like */
1496 /***********************************************************************/
1500 const char* postscript_name
;
1503 FT_ULong glyf_offset
; /* since 2.7.1 */
1505 FT_Bool is_cff2
; /* since 2.7.1 */
1507 #ifdef TT_CONFIG_OPTION_GX_VAR_SUPPORT
1511 FT_UInt32 variation_support
; /* since 2.7.1 */
1513 const char* var_postscript_prefix
; /* since 2.7.2 */
1514 FT_UInt var_postscript_prefix_len
; /* since 2.7.2 */
1518 /* since version 2.2 */
1520 FT_ULong horz_metrics_size
;
1521 FT_ULong vert_metrics_size
;
1523 FT_ULong num_locations
; /* in broken TTF, gid > 0xFFFF */
1524 FT_Byte
* glyph_locations
;
1526 FT_Byte
* hdmx_table
;
1527 FT_ULong hdmx_table_size
;
1528 FT_UInt hdmx_record_count
;
1529 FT_ULong hdmx_record_size
;
1530 FT_Byte
* hdmx_record_sizes
;
1532 FT_Byte
* sbit_table
;
1533 FT_ULong sbit_table_size
;
1534 TT_SbitTableType sbit_table_type
;
1535 FT_UInt sbit_num_strikes
;
1536 FT_UInt
* sbit_strike_map
;
1538 FT_Byte
* kern_table
;
1539 FT_ULong kern_table_size
;
1540 FT_UInt num_kern_tables
;
1541 FT_UInt32 kern_avail_bits
;
1542 FT_UInt32 kern_order_bits
;
1544 #ifdef TT_CONFIG_OPTION_BDF
1546 #endif /* TT_CONFIG_OPTION_BDF */
1549 FT_ULong horz_metrics_offset
;
1550 FT_ULong vert_metrics_offset
;
1552 #ifdef TT_SUPPORT_SUBPIXEL_HINTING_INFINALITY
1554 FT_ULong sph_found_func_flags
; /* special functions found */
1556 FT_Bool sph_compatibility_mode
;
1557 #endif /* TT_SUPPORT_SUBPIXEL_HINTING_INFINALITY */
1559 #ifdef TT_CONFIG_OPTION_EMBEDDED_BITMAPS
1561 FT_ULong ebdt_start
; /* either `CBDT', `EBDT', or `bdat' */
1568 /*************************************************************************/
1571 /* TT_GlyphZoneRec */
1574 /* A glyph zone is used to load, scale and hint glyph outline */
1578 /* memory :: A handle to the memory manager. */
1580 /* max_points :: The maximum size in points of the zone. */
1582 /* max_contours :: Max size in links contours of the zone. */
1584 /* n_points :: The current number of points in the zone. */
1586 /* n_contours :: The current number of contours in the zone. */
1588 /* org :: The original glyph coordinates (font */
1589 /* units/scaled). */
1591 /* cur :: The current glyph coordinates (scaled/hinted). */
1593 /* tags :: The point control tags. */
1595 /* contours :: The contours end points. */
1597 /* first_point :: Offset of the current subglyph's first point. */
1599 typedef struct TT_GlyphZoneRec_
1602 FT_UShort max_points
;
1603 FT_Short max_contours
;
1604 FT_UShort n_points
; /* number of points in zone */
1605 FT_Short n_contours
; /* number of contours */
1607 FT_Vector
* org
; /* original point coordinates */
1608 FT_Vector
* cur
; /* current point coordinates */
1609 FT_Vector
* orus
; /* original (unscaled) point coordinates */
1611 FT_Byte
* tags
; /* current touch flags */
1612 FT_UShort
* contours
; /* contour end points */
1614 FT_UShort first_point
; /* offset of first (#0) point */
1616 } TT_GlyphZoneRec
, *TT_GlyphZone
;
1619 /* handle to execution context */
1620 typedef struct TT_ExecContextRec_
* TT_ExecContext
;
1623 /*************************************************************************/
1629 /* A handle to a TrueType size object. */
1631 typedef struct TT_SizeRec_
* TT_Size
;
1634 /* glyph loader structure */
1635 typedef struct TT_LoaderRec_
1640 FT_GlyphLoader gloader
;
1642 FT_ULong load_flags
;
1643 FT_UInt glyph_index
;
1648 FT_Short n_contours
;
1650 FT_Int left_bearing
;
1657 /* the zone where we load our glyphs */
1658 TT_GlyphZoneRec base
;
1659 TT_GlyphZoneRec zone
;
1661 TT_ExecContext exec
;
1662 FT_Byte
* instructions
;
1665 /* for possible extensibility in other formats */
1668 /* since version 2.1.8 */
1674 /* since version 2.2.1 */
1678 /* since version 2.6.2 */
1679 FT_ListRec composites
;
1686 #endif /* TTTYPES_H_ */