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 /*PUSHB (2*num_used_styles + 2) */
228 /* %c, style 1's first blue ref index */
229 /* %c, style 1's number of blue ref indices */
230 /* %c, style 0's first blue ref index */
231 /* %c, style 0's number of blue ref indices */
232 /* %c, num_used_styles */
234 unsigned char PREP(round_blues
) [] =
237 bci_blue_round_range
,
242 unsigned char PREP(set_stem_width_handling_a
) [] =
246 * There are two ClearType flavours available on Windows: The older GDI
247 * ClearType, introduced in 2000, and the recent DW ClearType, introduced
248 * in 2008. The main difference is that the older incarnation behaves
249 * like a B/W renderer along the y axis, while the newer version does
250 * vertical smoothing also.
252 * The only possibility to differentiate between GDI and DW ClearType is
253 * testing bit 10 in the GETINFO instruction (with return value in bit 17;
254 * this works for TrueType version >= 38), checking whether sub-pixel
255 * positioning is available.
257 * If GDI ClearType is active, we use a different stem width function
258 * which snaps to integer pixels as much as possible.
261 /* set default positioning */
263 cvtl_use_strong_stem_width_function
,
267 /* %c, either 0 or 100 */
269 unsigned char PREP(set_stem_width_handling_b
) [] =
274 /* get rasterizer version (bit 0) */
280 /* `GDI ClearType': */
281 /* version >= 36 and version < 38, ClearType enabled */
284 /* check whether ClearType is enabled (bit 6) */
290 cvtl_use_strong_stem_width_function
,
293 /* %c, either 0 or 100 */
295 unsigned char PREP(set_stem_width_handling_c
) [] =
300 /* get rasterizer version (bit 0) */
306 /* `DW ClearType': */
307 /* version >= 38, sub-pixel positioning is enabled */
310 /* check whether sub-pixel positioning is enabled (bit 10) -- */
311 /* due to a bug in FreeType 2.5.0 and earlier, */
312 /* bit 6 must be set also to get the correct information, */
313 /* so we test that both return values (in bits 13 and 17) are set */
315 0x08, /* bits 13 and 17 shifted by 6 bits */
317 0x00, /* we do `MUL' with value 1, */
318 0x01, /* which is essentially a division by 64 */
319 0x04, /* bits 6 and 10 */
326 cvtl_use_strong_stem_width_function
,
330 /* %c, either 0 or 100 */
332 unsigned char PREP(set_stem_width_handling_d
) [] =
343 unsigned char PREP(set_dropout_mode
) [] =
347 0x01, /* 0x01FF, activate dropout handling unconditionally */
351 4, /* smart dropout include stubs */
356 unsigned char PREP(reset_component_counter
) [] =
359 /* In case an application tries to render `.ttfautohint' */
360 /* (which it should never do), */
361 /* hinting of all glyphs rendered afterwards is disabled */
362 /* because the `cvtl_is_subglyph' counter gets incremented, */
363 /* but there is no counterpart to decrement it. */
364 /* Font inspection tools like the FreeType demo programs */
365 /* are an exception to that rule, however, */
366 /* since they can directly access a font by glyph indices. */
367 /* The following guard alleviates the problem a bit: */
368 /* Any change of the graphics state */
369 /* (for example, rendering at a different size or with a different mode) */
370 /* resets the counter to zero. */
379 /* this function allocates `buf', parsing `number_set' to create bytecode */
380 /* which eventually sets CVT index `cvtl_is_element' */
381 /* (in functions `bci_number_set_is_element' and */
382 /* `bci_number_set_is_element2') */
385 TA_sfnt_build_number_set(SFNT
* sfnt
,
387 number_range
* number_set
)
389 FT_Byte
* bufp
= NULL
;
392 FT_UInt num_singles2
= 0;
393 FT_UInt
* single2_args
;
394 FT_UInt
* single2_arg
;
395 FT_UInt num_singles
= 0;
396 FT_UInt
* single_args
;
399 FT_UInt num_ranges2
= 0;
400 FT_UInt
* range2_args
;
402 FT_UInt num_ranges
= 0;
406 FT_UInt have_single
= 0;
407 FT_UInt have_range
= 0;
409 FT_UShort num_stack_elements
;
412 /* build up four stacks to stay as compact as possible */
416 if (nr
->start
== nr
->end
)
425 if (nr
->start
< 256 && nr
->end
< 256)
433 /* collect all arguments temporarily in arrays (in reverse order) */
434 /* so that we can easily split into chunks of 255 args */
435 /* as needed by NPUSHB and friends; */
436 /* for simplicity, always allocate an extra slot */
437 single2_args
= (FT_UInt
*)malloc((num_singles2
+ 1) * sizeof (FT_UInt
));
438 single_args
= (FT_UInt
*)malloc((num_singles
+ 1) * sizeof (FT_UInt
));
439 range2_args
= (FT_UInt
*)malloc((2 * num_ranges2
+ 1) * sizeof (FT_UInt
));
440 range_args
= (FT_UInt
*)malloc((2 * num_ranges
+ 1) * sizeof (FT_UInt
));
441 if (!single2_args
|| !single_args
442 || !range2_args
|| !range_args
)
445 /* check whether we need the extra slot for the argument to CALL */
446 if (num_singles
|| num_singles2
)
448 if (num_ranges
|| num_ranges2
)
451 /* set function indices outside of argument loop (using the extra slot) */
453 single_args
[num_singles
] = bci_number_set_is_element
;
455 range_args
[2 * num_ranges
] = bci_number_set_is_element2
;
457 single2_arg
= single2_args
+ num_singles2
- 1;
458 single_arg
= single_args
+ num_singles
- 1;
459 range2_arg
= range2_args
+ 2 * num_ranges2
- 1;
460 range_arg
= range_args
+ 2 * num_ranges
- 1;
465 if (nr
->start
== nr
->end
)
468 *(single_arg
--) = nr
->start
;
470 *(single2_arg
--) = nr
->start
;
474 if (nr
->start
< 256 && nr
->end
< 256)
476 *(range_arg
--) = nr
->start
;
477 *(range_arg
--) = nr
->end
;
481 *(range2_arg
--) = nr
->start
;
482 *(range2_arg
--) = nr
->end
;
488 /* this rough estimate of the buffer size gets adjusted later on */
489 *buf
= (FT_Byte
*)malloc((2 + 1) * num_singles2
490 + (1 + 1) * num_singles
491 + (4 + 1) * num_ranges2
492 + (2 + 1) * num_ranges
499 BCI(cvtl_is_element
);
503 bufp
= TA_build_push(bufp
, single2_args
, num_singles2
, 1, 1);
504 bufp
= TA_build_push(bufp
, single_args
, num_singles
+ have_single
, 0, 1);
508 bufp
= TA_build_push(bufp
, range2_args
, 2 * num_ranges2
, 1, 1);
509 bufp
= TA_build_push(bufp
, range_args
, 2 * num_ranges
+ have_range
, 0, 1);
513 num_stack_elements
= num_singles
+ num_singles2
;
514 if (num_stack_elements
> num_ranges
+ num_ranges2
)
515 num_stack_elements
= num_ranges
+ num_ranges2
;
516 num_stack_elements
+= ADDITIONAL_STACK_ELEMENTS
;
517 if (num_stack_elements
> sfnt
->max_stack_elements
)
518 sfnt
->max_stack_elements
= num_stack_elements
;
530 #define COPY_PREP(snippet_name) \
533 memcpy(bufp, prep_ ## snippet_name, \
534 sizeof (prep_ ## snippet_name)); \
535 bufp += sizeof (prep_ ## snippet_name); \
539 TA_table_build_prep(FT_Byte
** prep
,
544 SFNT_Table
* glyf_table
= &font
->tables
[sfnt
->glyf_idx
];
545 glyf_Data
* data
= (glyf_Data
*)glyf_table
->data
;
555 FT_Byte
* bufp
= NULL
;
558 if (font
->x_height_snapping_exceptions
)
560 bufp
= TA_sfnt_build_number_set(sfnt
, &buf
,
561 font
->x_height_snapping_exceptions
);
563 return FT_Err_Out_Of_Memory
;
566 buf_len
= bufp
- buf
;
567 buf_new_len
= buf_len
;
569 if (font
->hinting_limit
)
570 buf_new_len
+= sizeof (PREP(hinting_limit_a
))
572 + sizeof (PREP(hinting_limit_b
));
574 buf_new_len
+= sizeof (PREP(store_funits_to_pixels
));
576 if (font
->x_height_snapping_exceptions
)
577 buf_new_len
+= sizeof (PREP(test_exception_a
));
579 buf_new_len
+= sizeof (PREP(align_top_a
))
580 + (data
->num_used_styles
> 6
581 ? data
->num_used_styles
+ 3
582 : data
->num_used_styles
+ 2)
583 + sizeof (PREP(align_top_b
));
584 buf_new_len
+= sizeof (PREP(loop_cvt_a
))
585 + (data
->num_used_styles
> 3
586 ? 2 * data
->num_used_styles
+ 3
587 : 2 * data
->num_used_styles
+ 2)
588 + sizeof (PREP(loop_cvt_b
))
589 + (data
->num_used_styles
> 3
590 ? 2 * data
->num_used_styles
+ 3
591 : 2 * data
->num_used_styles
+ 2)
592 + sizeof (PREP(loop_cvt_c
));
594 if (font
->x_height_snapping_exceptions
)
595 buf_new_len
+= sizeof (PREP(test_exception_b
));
597 buf_new_len
+= sizeof (PREP(store_vwidth_data_a
))
599 + sizeof (PREP(store_vwidth_data_b
))
600 + (data
->num_used_styles
> 6
601 ? 2 * (data
->num_used_styles
+ 1) + 2
602 : 2 * (data
->num_used_styles
+ 1) + 1)
603 + sizeof (PREP(store_vwidth_data_c
))
605 + sizeof (PREP(store_vwidth_data_d
))
606 + (data
->num_used_styles
> 6
607 ? 2 * (data
->num_used_styles
+ 1) + 2
608 : 2 * (data
->num_used_styles
+ 1) + 1)
609 + sizeof (PREP(store_vwidth_data_e
));
610 buf_new_len
+= (data
->num_used_styles
> 3
611 ? 2 * data
->num_used_styles
+ 3
612 : 2 * data
->num_used_styles
+ 2)
613 + sizeof (PREP(round_blues
));
614 buf_new_len
+= sizeof (PREP(set_stem_width_handling_a
))
616 + sizeof (PREP(set_stem_width_handling_b
))
618 + sizeof (PREP(set_stem_width_handling_c
))
620 + sizeof (PREP(set_stem_width_handling_d
));
621 buf_new_len
+= sizeof (PREP(set_dropout_mode
));
622 buf_new_len
+= sizeof (PREP(reset_component_counter
));
624 /* buffer length must be a multiple of four */
625 len
= (buf_new_len
+ 3) & ~3;
626 buf_new
= (FT_Byte
*)realloc(buf
, len
);
630 return FT_Err_Out_Of_Memory
;
634 /* pad end of buffer with zeros */
639 /* copy remaining cvt program into buffer */
640 /* and fill in the missing variables */
641 bufp
= buf
+ buf_len
;
643 if (font
->hinting_limit
)
645 COPY_PREP(hinting_limit_a
);
646 *(bufp
++) = HIGH(font
->hinting_limit
);
647 *(bufp
++) = LOW(font
->hinting_limit
);
648 COPY_PREP(hinting_limit_b
);
651 COPY_PREP(store_funits_to_pixels
);
653 if (font
->x_height_snapping_exceptions
)
654 COPY_PREP(test_exception_a
);
656 COPY_PREP(align_top_a
);
657 if (data
->num_used_styles
> 6)
660 BCI(data
->num_used_styles
+ 2);
663 BCI(PUSHB_1
- 1 + data
->num_used_styles
+ 2);
664 /* XXX: make this work for offsets > 255 */
665 for (i
= TA_STYLE_MAX
- 1; i
>= 0; i
--)
667 if (data
->style_ids
[i
] == 0xFFFFU
)
670 *(bufp
++) = CVT_X_HEIGHT_BLUE_OFFSET(i
) >= 0xFFFFU
672 : (unsigned char)CVT_X_HEIGHT_BLUE_OFFSET(i
);
674 *(bufp
++) = data
->num_used_styles
;
675 COPY_PREP(align_top_b
);
677 COPY_PREP(loop_cvt_a
);
678 if (data
->num_used_styles
> 3)
681 BCI(2 * data
->num_used_styles
+ 2);
684 BCI(PUSHB_1
- 1 + 2 * data
->num_used_styles
+ 2);
685 /* XXX: make this work for offsets > 255 */
686 for (i
= TA_STYLE_MAX
- 1; i
>= 0; i
--)
688 if (data
->style_ids
[i
] == 0xFFFFU
)
691 /* don't loop over artificial blue zones */
692 *(bufp
++) = (unsigned char)CVT_VERT_STANDARD_WIDTH_OFFSET(i
);
693 *(bufp
++) = (unsigned char)(
695 + CVT_VERT_WIDTHS_SIZE(i
)
696 + (CVT_BLUES_SIZE(i
) > 1 ? CVT_BLUES_SIZE(i
) - 2 : 0));
698 *(bufp
++) = data
->num_used_styles
;
699 COPY_PREP(loop_cvt_b
);
700 if (data
->num_used_styles
> 3)
703 BCI(2 * data
->num_used_styles
+ 2);
706 BCI(PUSHB_1
- 1 + 2 * data
->num_used_styles
+ 2);
707 /* XXX: make this work for offsets > 255 */
708 for (i
= TA_STYLE_MAX
- 1; i
>= 0; i
--)
710 if (data
->style_ids
[i
] == 0xFFFFU
)
713 /* don't loop over artificial blue zones */
714 *(bufp
++) = (unsigned char)CVT_BLUE_SHOOTS_OFFSET(i
);
715 *(bufp
++) = (unsigned char)(
716 CVT_BLUES_SIZE(i
) > 1 ? CVT_BLUES_SIZE(i
) - 2 : 0);
718 *(bufp
++) = data
->num_used_styles
;
719 COPY_PREP(loop_cvt_c
);
721 if (font
->x_height_snapping_exceptions
)
722 COPY_PREP(test_exception_b
);
724 COPY_PREP(store_vwidth_data_a
);
725 *(bufp
++) = (unsigned char)CVT_VWIDTH_OFFSET_DATA(0);
726 COPY_PREP(store_vwidth_data_b
);
727 if (data
->num_used_styles
> 6)
730 BCI(data
->num_used_styles
+ 2);
733 BCI(PUSHW_1
- 1 + data
->num_used_styles
+ 2);
734 for (i
= TA_STYLE_MAX
- 1; i
>= 0; i
--)
736 if (data
->style_ids
[i
] == 0xFFFFU
)
739 *(bufp
++) = HIGH(CVT_VERT_WIDTHS_OFFSET(i
) * 64);
740 *(bufp
++) = LOW(CVT_VERT_WIDTHS_OFFSET(i
) * 64);
742 *(bufp
++) = HIGH(data
->num_used_styles
);
743 *(bufp
++) = LOW(data
->num_used_styles
);
744 COPY_PREP(store_vwidth_data_c
);
745 *(bufp
++) = (unsigned char)CVT_VWIDTH_SIZE_DATA(0);
746 COPY_PREP(store_vwidth_data_d
);
747 if (data
->num_used_styles
> 6)
750 BCI(data
->num_used_styles
+ 2);
753 BCI(PUSHW_1
- 1 + data
->num_used_styles
+ 2);
754 for (i
= TA_STYLE_MAX
- 1; i
>= 0; i
--)
756 if (data
->style_ids
[i
] == 0xFFFFU
)
759 *(bufp
++) = HIGH(CVT_VERT_WIDTHS_SIZE(i
) * 64);
760 *(bufp
++) = LOW(CVT_VERT_WIDTHS_SIZE(i
) * 64);
762 *(bufp
++) = HIGH(data
->num_used_styles
);
763 *(bufp
++) = LOW(data
->num_used_styles
);
764 COPY_PREP(store_vwidth_data_e
);
766 if (data
->num_used_styles
> 3)
769 BCI(2 * data
->num_used_styles
+ 2);
772 BCI(PUSHB_1
- 1 + 2 * data
->num_used_styles
+ 2);
773 /* XXX: make this work for offsets > 255 */
774 for (i
= TA_STYLE_MAX
- 1; i
>= 0; i
--)
776 if (data
->style_ids
[i
] == 0xFFFFU
)
779 *(bufp
++) = (unsigned char)CVT_BLUE_REFS_OFFSET(i
);
780 *(bufp
++) = (unsigned char)CVT_BLUES_SIZE(i
);
782 *(bufp
++) = data
->num_used_styles
;
783 COPY_PREP(round_blues
);
785 COPY_PREP(set_stem_width_handling_a
);
786 *(bufp
++) = font
->gray_strong_stem_width
? 100 : 0;
787 COPY_PREP(set_stem_width_handling_b
);
788 *(bufp
++) = font
->gdi_cleartype_strong_stem_width
? 100 : 0;
789 COPY_PREP(set_stem_width_handling_c
);
790 *(bufp
++) = font
->dw_cleartype_strong_stem_width
? 100 : 0;
791 COPY_PREP(set_stem_width_handling_d
);
792 COPY_PREP(set_dropout_mode
);
793 COPY_PREP(reset_component_counter
);
796 *prep_len
= buf_new_len
;
803 TA_sfnt_build_prep_table(SFNT
* sfnt
,
808 SFNT_Table
* glyf_table
= &font
->tables
[sfnt
->glyf_idx
];
809 glyf_Data
* data
= (glyf_Data
*)glyf_table
->data
;
815 error
= TA_sfnt_add_table_info(sfnt
);
819 /* `glyf', `cvt', `fpgm', and `prep' are always used in parallel */
820 if (glyf_table
->processed
)
822 sfnt
->table_infos
[sfnt
->num_table_infos
- 1] = data
->prep_idx
;
826 error
= TA_table_build_prep(&prep_buf
, &prep_len
, sfnt
, font
);
831 /* ttfautohint's bytecode in `fpgm' is larger */
832 /* than the bytecode in `prep'; */
833 /* this commented out code here is just for completeness */
834 if (prep_len
> sfnt
->max_instructions
)
835 sfnt
->max_instructions
= prep_len
;
838 /* in case of success, `prep_buf' gets linked */
839 /* and is eventually freed in `TA_font_unload' */
840 error
= TA_font_add_table(font
,
841 &sfnt
->table_infos
[sfnt
->num_table_infos
- 1],
842 TTAG_prep
, prep_len
, prep_buf
);
846 data
->prep_idx
= sfnt
->table_infos
[sfnt
->num_table_infos
- 1];
852 /* end of taprep.c */