Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Implement text shaping with libraqm #30000

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 17 commits into
base: text-overhaul
Choose a base branch
from

Conversation

QuLogic
Copy link
Member

@QuLogic QuLogic commented May 2, 2025

PR summary

This is based on #29816 but doesn't yet include #29794 and #29695. I'm mostly opening it to see how CI will cope.

PR checklist

@QuLogic
Copy link
Member Author

QuLogic commented May 3, 2025

This was useful in pointing out some cross-platform incompatibilities. I may check cibuildwheel as well later to ensure bundling is working correctly.

The failing test is a relatively recent one; I will have to check if that is from here or the FreeType change.

mdboom and others added 12 commits May 7, 2025 06:27
Namely, `text.hinting` is now `default` instead of `force_autohint` (or
`none` for classic tests) and `text.hinting_factor` is now 1, not 8.
If we've updated an image in the past couple commits, then we can remove
the backwards-compatibility styling so that they're generated as
intended.
The `FontInfo.num` value returned by `TruetypeFonts._get_info` is a
character code, but `FT2Font.get_kerning` takes *glyph indices*, meaning
that kerning was likely off in most cases.
Also add some missing license entries in more places.
@anntzer
Copy link
Contributor

anntzer commented May 17, 2025

Do you envision that raqm will become the sole text layout method, or do you plan to keep the old manual layouting around (perhaps togglable)? I just noticed that the old layouting method appears to be missing handling of lsb_delta and rsb_delta (see note at https://freetype.org/freetype2/docs/reference/ft2-glyph_retrieval.html#ft_glyphslotrec ("If you use strong auto-hinting, you must apply these delta values! Otherwise you will experience far too large inter-glyph spacing at small rendering sizes in most cases.")) but raqm would likely (hopefully?) take care of that for us. If the manual layouting is going to stay then I'll open a separate issue to implement this (perhaps also to be folded into the FreeType update mega-PR); if not, perhaps we can just forget about it.

@QuLogic
Copy link
Member Author

QuLogic commented May 17, 2025

I intend for it to replace everything, I think. I have some in-progress work to apply it to PDF/PS/SVG as well.

I did notice the lsb_delta/rsb_delta note and tried to implement it in #29816, though IIRC not much (or even nothing) changed, but I could be misremembering.

@anntzer
Copy link
Contributor

anntzer commented May 21, 2025

Also, does _text_helpers.layout() also need to be rewritten to use raqm as well? (likely it would need to also include y information now)
I had in fact more or less written that function as a "poor man's raqm", IIRC...

A nice endpoint would be if the new _text_helpers.LayoutItem, by supporting both x and y, was general enough that draw_text and draw_mathtext (and even draw_tex) could ultimately just all pass a list of LayoutItems (+ rects, in the mathtext/tex case) down to a single glyph rendering method.

QuLogic added 2 commits May 23, 2025 07:24
The former may be used even on PS/PDF backend where nothing is rendered.
@QuLogic
Copy link
Member Author

QuLogic commented May 24, 2025

OK, I've figured out why I was running into issues before and pushed the vector implementation up now. The issues aren't fixed, but at least in a position to be discussed.

Specifically, _text_helpers.layout used to use glyph.linearHoriAdvance which is a 16.16 fixed-point value, but libraqm returns advances in 26.6 fixed-point values. For example, the string "center Tj" has 16.16 advances:

[3603200, 4032000, 4153600, 2569600, 4032000, 2694400, 2083200, 4003200, 1820800]

which works out to:

>>> orig / 65536
array([54.98046875, 61.5234375 , 63.37890625, 39.20898438, 61.5234375 ,
       41.11328125, 31.78710938, 61.08398438, 27.78320312])

But the libraqm 26.6 advances are (equivalent to the linear advances divided by 1024 and rounded to integers):

[3519, 3938, 4056, 2509, 3938, 2631, 2034, 3909, 1778]

which works out to:

>>> raqm / 64
array([54.984375, 61.53125 , 63.375   , 39.203125, 61.53125 , 41.109375,
       31.78125 , 61.078125, 27.78125 ])

or the small difference of:

[0.00390625, 0.0078125, -0.00390625, -0.00585938, 0.0078125, -0.00390625, -0.00585938, -0.00585938, -0.00195312]

Unfortunately, this touches almost every single SVG in a way that they all fail, but invisibly.

I'm not sure if we should attempt to work around this (by scaling DPI by 1024, or adding a 1024 scaling FT_Matrix, or something else), or accept this change (but then maybe we'd want to roll that into #29816's big test image update).

@anntzer
Copy link
Contributor

anntzer commented May 24, 2025

[I guess what's really stored in the font file are advances in font design units and then FreeType scales them by (font design units->real space) and then by 2^16 whereas raqm (really, harfbuzz) uses 2^6 for that last scaling, so probably neither of them is really right or wrong?]

If the breakages are only in svg files then I guess this isn't really a problem because it's just a few numbers (the glyph x-positions) that will change and so the diff will not actually be so big? (If you check by git diff rather than the github UI or similar it would just be a few small changes?)

@QuLogic QuLogic changed the base branch from main to text-overhaul June 5, 2025 01:39
@QuLogic QuLogic moved this to Waiting for other PR in Font and text overhaul Jun 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Waiting for other PR
Development

Successfully merging this pull request may close these issues.

3 participants