4 * Copyright (C) 2011-2014 by Werner Lemberg.
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.
11 * The file `COPYING' mentioned in the previous paragraph is distributed
12 * with the ttfautohint library.
19 #define PREP(snippet_name) prep_ ## snippet_name
22 unsigned char PREP(hinting_limit_a
) [] =
25 /* all our measurements are taken along the y axis, */
26 /* including the ppem and CVT values */
29 /* first of all, check whether we do hinting at all */
35 /* %d, hinting size limit */
37 unsigned char PREP(hinting_limit_b
) [] =
43 1, /* switch off hinting */
50 /* we store 0x10000 in CVT index `cvtl_funits_to_pixels' as a scaled value */
51 /* to have a conversion factor from FUnits to pixels */
53 unsigned char PREP(store_funits_to_pixels
) [] =
57 cvtl_funits_to_pixels
,
66 WCVTF
, /* store value 1 in 16.16 format, scaled */
70 /* if the current ppem value is an exception, don't apply scaling */
72 unsigned char PREP(test_exception_a
) [] =
83 /* provide scaling factors for all styles */
85 unsigned char PREP(align_top_a
) [] =
90 CVT_SCALING_VALUE_OFFSET(0),
95 /* PUSHB (num_used_styles + 2) */
97 /* %c, style 1's x height blue zone idx */
98 /* %c, style 0's x height blue zone idx */
99 /* %c, num_used_styles */
101 unsigned char PREP(align_top_b
) [] =
109 unsigned char PREP(loop_cvt_a
) [] =
112 /* loop over (almost all) vertical CVT entries of all styles, part 1 */
115 CVT_SCALING_VALUE_OFFSET(0),
120 /* PUSHB (2*num_used_styles + 2) */
122 /* %c, style 1's first vertical index */
123 /* %c, style 1's number of vertical indices */
124 /* (std. width, widths, flat blues zones without artifical ones) */
125 /* %c, style 0's first vertical index */
126 /* %c, style 0's number of vertical indices */
127 /* (std. width, widths, flat blues zones without artifical ones) */
128 /* %c, num_used_styles */
130 unsigned char PREP(loop_cvt_b
) [] =
133 bci_cvt_rescale_range
,
136 /* loop over (almost all) vertical CVT entries of all styles, part 2 */
139 CVT_SCALING_VALUE_OFFSET(0),
144 /* PUSHB (2*num_used_styles + 2) */
146 /* %c, style 1's first round blue zone index */
147 /* %c, style 1's number of round blue zones (without artificial ones) */
148 /* %c, style 0's first round blue zone index */
149 /* %c, style 0's number of round blue zones (without artificial ones) */
150 /* %c, num_used_styles */
152 unsigned char PREP(loop_cvt_c
) [] =
155 bci_cvt_rescale_range
,
160 unsigned char PREP(test_exception_b
) [] =
167 unsigned char PREP(store_vwidth_data_a
) [] =
175 /* %c, offset to vertical width offset data in CVT */
177 unsigned char PREP(store_vwidth_data_b
) [] =
184 /*PUSHW (num_used_styles + 2) */
186 /* %d, style 1's first vertical width index (in multiples of 64) */
187 /* %d, style 0's first vertical width index (in multiples of 64) */
188 /* %d, num_used_styles */
190 unsigned char PREP(store_vwidth_data_c
) [] =
193 0x00, /* high byte */
194 bci_vwidth_data_store
, /* low byte */
202 /* %c, offset to vertical width size data in CVT */
204 unsigned char PREP(store_vwidth_data_d
) [] =
211 /*PUSHW (num_used_styles + 2) */
213 /* %d, style 1's number of vertical widths (in multiples of 64) */
214 /* %d, style 0's number of vertical widths (in multiples of 64) */
215 /* %d, num_used_styles */
217 unsigned char PREP(store_vwidth_data_e
) [] =
220 0x00, /* high byte */
221 bci_vwidth_data_store
, /* low byte */
226 unsigned char PREP(set_smooth_or_strong_a
) [] =
230 * There are two ClearType flavours available on Windows: The older GDI
231 * ClearType, introduced in 2000, and the recent DW ClearType, introduced
232 * in 2008. The main difference is that the older incarnation behaves
233 * like a B/W renderer along the y axis, while the newer version does
234 * vertical smoothing also.
236 * The only possibility to differentiate between GDI and DW ClearType is
237 * testing bit 10 in the GETINFO instruction (with return value in bit 17;
238 * this works for TrueType version >= 38), checking whether sub-pixel
239 * positioning is available.
241 * If GDI ClearType is active, we use different functions for stem width
242 * computation and blue zone rounding that snap to integer pixels as much
246 /* set default value */
248 cvtl_use_strong_functions
,
252 /* %c, either 0 or 100 */
254 unsigned char PREP(set_smooth_or_strong_b
) [] =
259 /* get rasterizer version (bit 0) */
265 /* `GDI ClearType': */
266 /* version >= 36 and version < 38, ClearType enabled */
269 /* check whether ClearType is enabled (bit 6) */
275 cvtl_use_strong_functions
,
278 /* %c, either 0 or 100 */
280 unsigned char PREP(set_smooth_or_strong_c
) [] =
285 /* get rasterizer version (bit 0) */
291 /* `DW ClearType': */
292 /* version >= 38, sub-pixel positioning is enabled */
295 /* check whether sub-pixel positioning is enabled (bit 10) -- */
296 /* due to a bug in FreeType 2.5.0 and earlier, */
297 /* bit 6 must be set also to get the correct information, */
298 /* so we test that both return values (in bits 13 and 17) are set */
300 0x08, /* bits 13 and 17 shifted by 6 bits */
302 0x00, /* we do `MUL' with value 1, */
303 0x01, /* which is essentially a division by 64 */
304 0x04, /* bits 6 and 10 */
311 cvtl_use_strong_functions
,
315 /* %c, either 0 or 100 */
317 unsigned char PREP(set_smooth_or_strong_d
) [] =
328 /*PUSHB (2*num_used_styles + 2) */
330 /* %c, style 1's first blue ref index */
331 /* %c, style 1's number of blue ref indices */
332 /* %c, style 0's first blue ref index */
333 /* %c, style 0's number of blue ref indices */
334 /* %c, num_used_styles */
336 unsigned char PREP(round_blues
) [] =
339 bci_blue_round_range
,
344 unsigned char PREP(set_dropout_mode
) [] =
348 0x01, /* 0x01FF, activate dropout handling unconditionally */
352 4, /* smart dropout include stubs */
357 unsigned char PREP(reset_component_counter
) [] =
360 /* In case an application tries to render `.ttfautohint' */
361 /* (which it should never do), */
362 /* hinting of all glyphs rendered afterwards is disabled */
363 /* because the `cvtl_is_subglyph' counter gets incremented, */
364 /* but there is no counterpart to decrement it. */
365 /* Font inspection tools like the FreeType demo programs */
366 /* are an exception to that rule, however, */
367 /* since they can directly access a font by glyph indices. */
368 /* The following guard alleviates the problem a bit: */
369 /* Any change of the graphics state */
370 /* (for example, rendering at a different size or with a different mode) */
371 /* resets the counter to zero. */
380 /* this function allocates `buf', parsing `number_set' to create bytecode */
381 /* which eventually sets CVT index `cvtl_is_element' */
382 /* (in functions `bci_number_set_is_element' and */
383 /* `bci_number_set_is_element2') */
386 TA_sfnt_build_number_set(SFNT
* sfnt
,
388 number_range
* number_set
)
390 FT_Byte
* bufp
= NULL
;
393 FT_UInt num_singles2
= 0;
394 FT_UInt
* single2_args
;
395 FT_UInt
* single2_arg
;
396 FT_UInt num_singles
= 0;
397 FT_UInt
* single_args
;
400 FT_UInt num_ranges2
= 0;
401 FT_UInt
* range2_args
;
403 FT_UInt num_ranges
= 0;
407 FT_UInt have_single
= 0;
408 FT_UInt have_range
= 0;
410 FT_UShort num_stack_elements
;
413 /* build up four stacks to stay as compact as possible */
417 if (nr
->start
== nr
->end
)
426 if (nr
->start
< 256 && nr
->end
< 256)
434 /* collect all arguments temporarily in arrays (in reverse order) */
435 /* so that we can easily split into chunks of 255 args */
436 /* as needed by NPUSHB and friends; */
437 /* for simplicity, always allocate an extra slot */
438 single2_args
= (FT_UInt
*)malloc((num_singles2
+ 1) * sizeof (FT_UInt
));
439 single_args
= (FT_UInt
*)malloc((num_singles
+ 1) * sizeof (FT_UInt
));
440 range2_args
= (FT_UInt
*)malloc((2 * num_ranges2
+ 1) * sizeof (FT_UInt
));
441 range_args
= (FT_UInt
*)malloc((2 * num_ranges
+ 1) * sizeof (FT_UInt
));
442 if (!single2_args
|| !single_args
443 || !range2_args
|| !range_args
)
446 /* check whether we need the extra slot for the argument to CALL */
447 if (num_singles
|| num_singles2
)
449 if (num_ranges
|| num_ranges2
)
452 /* set function indices outside of argument loop (using the extra slot) */
454 single_args
[num_singles
] = bci_number_set_is_element
;
456 range_args
[2 * num_ranges
] = bci_number_set_is_element2
;
458 single2_arg
= single2_args
+ num_singles2
- 1;
459 single_arg
= single_args
+ num_singles
- 1;
460 range2_arg
= range2_args
+ 2 * num_ranges2
- 1;
461 range_arg
= range_args
+ 2 * num_ranges
- 1;
466 if (nr
->start
== nr
->end
)
469 *(single_arg
--) = nr
->start
;
471 *(single2_arg
--) = nr
->start
;
475 if (nr
->start
< 256 && nr
->end
< 256)
477 *(range_arg
--) = nr
->start
;
478 *(range_arg
--) = nr
->end
;
482 *(range2_arg
--) = nr
->start
;
483 *(range2_arg
--) = nr
->end
;
489 /* this rough estimate of the buffer size gets adjusted later on */
490 *buf
= (FT_Byte
*)malloc((2 + 1) * num_singles2
491 + (1 + 1) * num_singles
492 + (4 + 1) * num_ranges2
493 + (2 + 1) * num_ranges
500 BCI(cvtl_is_element
);
504 bufp
= TA_build_push(bufp
, single2_args
, num_singles2
, 1, 1);
505 bufp
= TA_build_push(bufp
, single_args
, num_singles
+ have_single
, 0, 1);
509 bufp
= TA_build_push(bufp
, range2_args
, 2 * num_ranges2
, 1, 1);
510 bufp
= TA_build_push(bufp
, range_args
, 2 * num_ranges
+ have_range
, 0, 1);
514 num_stack_elements
= num_singles
+ num_singles2
;
515 if (num_stack_elements
> num_ranges
+ num_ranges2
)
516 num_stack_elements
= num_ranges
+ num_ranges2
;
517 num_stack_elements
+= ADDITIONAL_STACK_ELEMENTS
;
518 if (num_stack_elements
> sfnt
->max_stack_elements
)
519 sfnt
->max_stack_elements
= num_stack_elements
;
531 #define COPY_PREP(snippet_name) \
534 memcpy(bufp, prep_ ## snippet_name, \
535 sizeof (prep_ ## snippet_name)); \
536 bufp += sizeof (prep_ ## snippet_name); \
540 TA_table_build_prep(FT_Byte
** prep
,
545 SFNT_Table
* glyf_table
= &font
->tables
[sfnt
->glyf_idx
];
546 glyf_Data
* data
= (glyf_Data
*)glyf_table
->data
;
556 FT_Byte
* bufp
= NULL
;
559 if (font
->x_height_snapping_exceptions
)
561 bufp
= TA_sfnt_build_number_set(sfnt
, &buf
,
562 font
->x_height_snapping_exceptions
);
564 return FT_Err_Out_Of_Memory
;
567 buf_len
= bufp
- buf
;
568 buf_new_len
= buf_len
;
570 if (font
->hinting_limit
)
571 buf_new_len
+= sizeof (PREP(hinting_limit_a
))
573 + sizeof (PREP(hinting_limit_b
));
575 buf_new_len
+= sizeof (PREP(store_funits_to_pixels
));
577 if (font
->x_height_snapping_exceptions
)
578 buf_new_len
+= sizeof (PREP(test_exception_a
));
580 buf_new_len
+= sizeof (PREP(align_top_a
))
581 + (data
->num_used_styles
> 6
582 ? data
->num_used_styles
+ 3
583 : data
->num_used_styles
+ 2)
584 + sizeof (PREP(align_top_b
));
585 buf_new_len
+= sizeof (PREP(loop_cvt_a
))
586 + (data
->num_used_styles
> 3
587 ? 2 * data
->num_used_styles
+ 3
588 : 2 * data
->num_used_styles
+ 2)
589 + sizeof (PREP(loop_cvt_b
))
590 + (data
->num_used_styles
> 3
591 ? 2 * data
->num_used_styles
+ 3
592 : 2 * data
->num_used_styles
+ 2)
593 + sizeof (PREP(loop_cvt_c
));
595 if (font
->x_height_snapping_exceptions
)
596 buf_new_len
+= sizeof (PREP(test_exception_b
));
598 buf_new_len
+= sizeof (PREP(store_vwidth_data_a
))
600 + sizeof (PREP(store_vwidth_data_b
))
601 + (data
->num_used_styles
> 6
602 ? 2 * (data
->num_used_styles
+ 1) + 2
603 : 2 * (data
->num_used_styles
+ 1) + 1)
604 + sizeof (PREP(store_vwidth_data_c
))
606 + sizeof (PREP(store_vwidth_data_d
))
607 + (data
->num_used_styles
> 6
608 ? 2 * (data
->num_used_styles
+ 1) + 2
609 : 2 * (data
->num_used_styles
+ 1) + 1)
610 + sizeof (PREP(store_vwidth_data_e
));
611 buf_new_len
+= sizeof (PREP(set_smooth_or_strong_a
))
613 + sizeof (PREP(set_smooth_or_strong_b
))
615 + sizeof (PREP(set_smooth_or_strong_c
))
617 + sizeof (PREP(set_smooth_or_strong_d
));
618 buf_new_len
+= (data
->num_used_styles
> 3
619 ? 2 * data
->num_used_styles
+ 3
620 : 2 * data
->num_used_styles
+ 2)
621 + sizeof (PREP(round_blues
));
622 buf_new_len
+= sizeof (PREP(set_dropout_mode
));
623 buf_new_len
+= sizeof (PREP(reset_component_counter
));
625 /* buffer length must be a multiple of four */
626 len
= (buf_new_len
+ 3) & ~3;
627 buf_new
= (FT_Byte
*)realloc(buf
, len
);
631 return FT_Err_Out_Of_Memory
;
635 /* pad end of buffer with zeros */
640 /* copy remaining cvt program into buffer */
641 /* and fill in the missing variables */
642 bufp
= buf
+ buf_len
;
644 if (font
->hinting_limit
)
646 COPY_PREP(hinting_limit_a
);
647 *(bufp
++) = HIGH(font
->hinting_limit
);
648 *(bufp
++) = LOW(font
->hinting_limit
);
649 COPY_PREP(hinting_limit_b
);
652 COPY_PREP(store_funits_to_pixels
);
654 if (font
->x_height_snapping_exceptions
)
655 COPY_PREP(test_exception_a
);
657 COPY_PREP(align_top_a
);
658 if (data
->num_used_styles
> 6)
661 BCI(data
->num_used_styles
+ 2);
664 BCI(PUSHB_1
- 1 + data
->num_used_styles
+ 2);
665 /* XXX: make this work for offsets > 255 */
666 for (i
= TA_STYLE_MAX
- 1; i
>= 0; i
--)
668 if (data
->style_ids
[i
] == 0xFFFFU
)
671 *(bufp
++) = CVT_X_HEIGHT_BLUE_OFFSET(i
) >= 0xFFFFU
673 : (unsigned char)CVT_X_HEIGHT_BLUE_OFFSET(i
);
675 *(bufp
++) = data
->num_used_styles
;
676 COPY_PREP(align_top_b
);
678 COPY_PREP(loop_cvt_a
);
679 if (data
->num_used_styles
> 3)
682 BCI(2 * data
->num_used_styles
+ 2);
685 BCI(PUSHB_1
- 1 + 2 * data
->num_used_styles
+ 2);
686 /* XXX: make this work for offsets > 255 */
687 for (i
= TA_STYLE_MAX
- 1; i
>= 0; i
--)
689 if (data
->style_ids
[i
] == 0xFFFFU
)
692 /* don't loop over artificial blue zones */
693 *(bufp
++) = (unsigned char)CVT_VERT_STANDARD_WIDTH_OFFSET(i
);
694 *(bufp
++) = (unsigned char)(
696 + CVT_VERT_WIDTHS_SIZE(i
)
697 + (CVT_BLUES_SIZE(i
) > 1 ? CVT_BLUES_SIZE(i
) - 2 : 0));
699 *(bufp
++) = data
->num_used_styles
;
700 COPY_PREP(loop_cvt_b
);
701 if (data
->num_used_styles
> 3)
704 BCI(2 * data
->num_used_styles
+ 2);
707 BCI(PUSHB_1
- 1 + 2 * data
->num_used_styles
+ 2);
708 /* XXX: make this work for offsets > 255 */
709 for (i
= TA_STYLE_MAX
- 1; i
>= 0; i
--)
711 if (data
->style_ids
[i
] == 0xFFFFU
)
714 /* don't loop over artificial blue zones */
715 *(bufp
++) = (unsigned char)CVT_BLUE_SHOOTS_OFFSET(i
);
716 *(bufp
++) = (unsigned char)(
717 CVT_BLUES_SIZE(i
) > 1 ? CVT_BLUES_SIZE(i
) - 2 : 0);
719 *(bufp
++) = data
->num_used_styles
;
720 COPY_PREP(loop_cvt_c
);
722 if (font
->x_height_snapping_exceptions
)
723 COPY_PREP(test_exception_b
);
725 COPY_PREP(store_vwidth_data_a
);
726 *(bufp
++) = (unsigned char)CVT_VWIDTH_OFFSET_DATA(0);
727 COPY_PREP(store_vwidth_data_b
);
728 if (data
->num_used_styles
> 6)
731 BCI(data
->num_used_styles
+ 2);
734 BCI(PUSHW_1
- 1 + data
->num_used_styles
+ 2);
735 for (i
= TA_STYLE_MAX
- 1; i
>= 0; i
--)
737 if (data
->style_ids
[i
] == 0xFFFFU
)
740 *(bufp
++) = HIGH(CVT_VERT_WIDTHS_OFFSET(i
) * 64);
741 *(bufp
++) = LOW(CVT_VERT_WIDTHS_OFFSET(i
) * 64);
743 *(bufp
++) = HIGH(data
->num_used_styles
);
744 *(bufp
++) = LOW(data
->num_used_styles
);
745 COPY_PREP(store_vwidth_data_c
);
746 *(bufp
++) = (unsigned char)CVT_VWIDTH_SIZE_DATA(0);
747 COPY_PREP(store_vwidth_data_d
);
748 if (data
->num_used_styles
> 6)
751 BCI(data
->num_used_styles
+ 2);
754 BCI(PUSHW_1
- 1 + data
->num_used_styles
+ 2);
755 for (i
= TA_STYLE_MAX
- 1; i
>= 0; i
--)
757 if (data
->style_ids
[i
] == 0xFFFFU
)
760 *(bufp
++) = HIGH(CVT_VERT_WIDTHS_SIZE(i
) * 64);
761 *(bufp
++) = LOW(CVT_VERT_WIDTHS_SIZE(i
) * 64);
763 *(bufp
++) = HIGH(data
->num_used_styles
);
764 *(bufp
++) = LOW(data
->num_used_styles
);
765 COPY_PREP(store_vwidth_data_e
);
767 COPY_PREP(set_smooth_or_strong_a
);
768 *(bufp
++) = font
->gray_strong_stem_width
? 100 : 0;
769 COPY_PREP(set_smooth_or_strong_b
);
770 *(bufp
++) = font
->gdi_cleartype_strong_stem_width
? 100 : 0;
771 COPY_PREP(set_smooth_or_strong_c
);
772 *(bufp
++) = font
->dw_cleartype_strong_stem_width
? 100 : 0;
773 COPY_PREP(set_smooth_or_strong_d
);
775 if (data
->num_used_styles
> 3)
778 BCI(2 * data
->num_used_styles
+ 2);
781 BCI(PUSHB_1
- 1 + 2 * data
->num_used_styles
+ 2);
782 /* XXX: make this work for offsets > 255 */
783 for (i
= TA_STYLE_MAX
- 1; i
>= 0; i
--)
785 if (data
->style_ids
[i
] == 0xFFFFU
)
788 *(bufp
++) = (unsigned char)CVT_BLUE_REFS_OFFSET(i
);
789 *(bufp
++) = (unsigned char)CVT_BLUES_SIZE(i
);
791 *(bufp
++) = data
->num_used_styles
;
792 COPY_PREP(round_blues
);
794 COPY_PREP(set_dropout_mode
);
795 COPY_PREP(reset_component_counter
);
798 *prep_len
= buf_new_len
;
805 TA_sfnt_build_prep_table(SFNT
* sfnt
,
810 SFNT_Table
* glyf_table
= &font
->tables
[sfnt
->glyf_idx
];
811 glyf_Data
* data
= (glyf_Data
*)glyf_table
->data
;
817 error
= TA_sfnt_add_table_info(sfnt
);
821 /* `glyf', `cvt', `fpgm', and `prep' are always used in parallel */
822 if (glyf_table
->processed
)
824 sfnt
->table_infos
[sfnt
->num_table_infos
- 1] = data
->prep_idx
;
828 error
= TA_table_build_prep(&prep_buf
, &prep_len
, sfnt
, font
);
833 /* ttfautohint's bytecode in `fpgm' is larger */
834 /* than the bytecode in `prep'; */
835 /* this commented out code here is just for completeness */
836 if (prep_len
> sfnt
->max_instructions
)
837 sfnt
->max_instructions
= prep_len
;
840 /* in case of success, `prep_buf' gets linked */
841 /* and is eventually freed in `TA_font_unload' */
842 error
= TA_font_add_table(font
,
843 &sfnt
->table_infos
[sfnt
->num_table_infos
- 1],
844 TTAG_prep
, prep_len
, prep_buf
);
848 data
->prep_idx
= sfnt
->table_infos
[sfnt
->num_table_infos
- 1];
854 /* end of taprep.c */