Merge pull request #2552 from qxliu76/add_hb_repack
Use Harfbuzz Repacker for packing GSUB/GPOS tables
This commit is contained in:
Cosimo Lupo
GitHub
commit
e92dd05101
@ -8,6 +8,13 @@ from typing import Iterator, NamedTuple, Optional
|
||||
|
||||
log = logging.getLogger(__name__)
|
||||
|
||||
have_uharfbuzz = False
|
||||
try:
|
||||
import uharfbuzz as hb
|
||||
have_uharfbuzz = True
|
||||
except ImportError:
|
||||
pass
|
||||
|
||||
class OverflowErrorRecord(object):
|
||||
def __init__(self, overflowTuple):
|
||||
self.tableType = overflowTuple[0]
|
||||
@ -71,6 +78,12 @@ class BaseTTXConverter(DefaultTable):
|
||||
try:
|
||||
writer = OTTableWriter(tableTag=self.tableTag)
|
||||
self.table.compile(writer, font)
|
||||
if have_uharfbuzz and self.tableTag in ("GSUB", "GPOS"):
|
||||
try:
|
||||
return writer.getAllDataUsingHarfbuzz()
|
||||
except (ValueError, MemoryError, hb.RepackerError) as e:
|
||||
log.error("hb.repack failed, reverting to pure-python serializer; the error message was: %s", e)
|
||||
return writer.getAllData(remove_duplicate=False)
|
||||
return writer.getAllData()
|
||||
|
||||
except OTLOffsetOverflowError as e:
|
||||
@ -298,6 +311,20 @@ class OTTableWriter(object):
|
||||
|
||||
return bytesjoin(items)
|
||||
|
||||
def getDataForHarfbuzz(self):
|
||||
"""Assemble the data for this writer/table with all offset field set to 0"""
|
||||
items = list(self.items)
|
||||
packFuncs = {2: packUShort, 3: packUInt24, 4: packULong}
|
||||
for i, item in enumerate(items):
|
||||
if hasattr(item, "getData"):
|
||||
# Offset value is not needed in harfbuzz repacker, so setting offset to 0 to avoid overflow here
|
||||
if item.offsetSize in packFuncs:
|
||||
items[i] = packFuncs[item.offsetSize](0)
|
||||
else:
|
||||
raise ValueError(item.offsetSize)
|
||||
|
||||
return bytesjoin(items)
|
||||
|
||||
def __hash__(self):
|
||||
# only works after self._doneWriting() has been called
|
||||
return hash(self.items)
|
||||
@ -402,11 +429,95 @@ class OTTableWriter(object):
|
||||
|
||||
selfTables.append(self)
|
||||
|
||||
def getAllData(self):
|
||||
"""Assemble all data, including all subtables."""
|
||||
def _gatherGraphForHarfbuzz(self, tables, obj_list, done, objidx, virtual_edges):
|
||||
real_links = []
|
||||
virtual_links = []
|
||||
item_idx = objidx
|
||||
|
||||
# Merge virtual_links from parent
|
||||
for idx in virtual_edges:
|
||||
virtual_links.append((0, 0, idx))
|
||||
|
||||
sortCoverageLast = False
|
||||
coverage_idx = 0
|
||||
if hasattr(self, "sortCoverageLast"):
|
||||
# Find coverage table
|
||||
for i, item in enumerate(self.items):
|
||||
if getattr(item, 'name', None) == "Coverage":
|
||||
sortCoverageLast = True
|
||||
if id(item) not in done:
|
||||
coverage_idx = item_idx = item._gatherGraphForHarfbuzz(tables, obj_list, done, item_idx, virtual_edges)
|
||||
else:
|
||||
coverage_idx = done[id(item)]
|
||||
virtual_edges.append(coverage_idx)
|
||||
break
|
||||
|
||||
child_idx = 0
|
||||
offset_pos = 0
|
||||
for i, item in enumerate(self.items):
|
||||
if hasattr(item, "getData"):
|
||||
pos = offset_pos
|
||||
elif hasattr(item, "getCountData"):
|
||||
offset_pos += item.size
|
||||
continue
|
||||
else:
|
||||
offset_pos = offset_pos + len(item)
|
||||
continue
|
||||
|
||||
if id(item) not in done:
|
||||
child_idx = item_idx = item._gatherGraphForHarfbuzz(tables, obj_list, done, item_idx, virtual_edges)
|
||||
else:
|
||||
child_idx = done[id(item)]
|
||||
|
||||
real_edge = (pos, item.offsetSize, child_idx)
|
||||
real_links.append(real_edge)
|
||||
offset_pos += item.offsetSize
|
||||
|
||||
tables.append(self)
|
||||
obj_list.append((real_links,virtual_links))
|
||||
item_idx += 1
|
||||
done[id(self)] = item_idx
|
||||
if sortCoverageLast:
|
||||
virtual_edges.pop()
|
||||
|
||||
return item_idx
|
||||
|
||||
def getAllDataUsingHarfbuzz(self):
|
||||
"""The Whole table is represented as a Graph.
|
||||
Assemble graph data and call Harfbuzz repacker to pack the table.
|
||||
Harfbuzz repacker is faster and retain as much sub-table sharing as possible, see also:
|
||||
https://github.com/harfbuzz/harfbuzz/blob/main/docs/repacker.md
|
||||
The input format for hb.repack() method is explained here:
|
||||
https://github.com/harfbuzz/uharfbuzz/blob/main/src/uharfbuzz/_harfbuzz.pyx#L1149
|
||||
"""
|
||||
internedTables = {}
|
||||
self._doneWriting(internedTables)
|
||||
tables = []
|
||||
obj_list = []
|
||||
done = {}
|
||||
objidx = 0
|
||||
virtual_edges = []
|
||||
self._gatherGraphForHarfbuzz(tables, obj_list, done, objidx, virtual_edges)
|
||||
# Gather all data in two passes: the absolute positions of all
|
||||
# subtable are needed before the actual data can be assembled.
|
||||
pos = 0
|
||||
for table in tables:
|
||||
table.pos = pos
|
||||
pos = pos + table.getDataLength()
|
||||
|
||||
data = []
|
||||
for table in tables:
|
||||
tableData = table.getDataForHarfbuzz()
|
||||
data.append(tableData)
|
||||
|
||||
return hb.repack(data, obj_list)
|
||||
|
||||
def getAllData(self, remove_duplicate=True):
|
||||
"""Assemble all data, including all subtables."""
|
||||
if remove_duplicate:
|
||||
internedTables = {}
|
||||
self._doneWriting(internedTables)
|
||||
tables = []
|
||||
extTables = []
|
||||
done = {}
|
||||
self._gatherTables(tables, extTables, done)
|
||||
|
||||
78
Tests/subset/data/expect_harfbuzz_repacker.ttx
Normal file
78
Tests/subset/data/expect_harfbuzz_repacker.ttx
Normal file
@ -0,0 +1,78 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<ttFont sfntVersion="OTTO" ttLibVersion="4.29">
|
||||
|
||||
<GSUB>
|
||||
<Version value="0x00010000"/>
|
||||
<ScriptList>
|
||||
<!-- ScriptCount=2 -->
|
||||
<ScriptRecord index="0">
|
||||
<ScriptTag value="DFLT"/>
|
||||
<Script>
|
||||
<DefaultLangSys>
|
||||
<ReqFeatureIndex value="65535"/>
|
||||
<!-- FeatureCount=1 -->
|
||||
<FeatureIndex index="0" value="0"/>
|
||||
</DefaultLangSys>
|
||||
<!-- LangSysCount=0 -->
|
||||
</Script>
|
||||
</ScriptRecord>
|
||||
<ScriptRecord index="1">
|
||||
<ScriptTag value="hang"/>
|
||||
<Script>
|
||||
<DefaultLangSys>
|
||||
<ReqFeatureIndex value="65535"/>
|
||||
<!-- FeatureCount=1 -->
|
||||
<FeatureIndex index="0" value="1"/>
|
||||
</DefaultLangSys>
|
||||
<!-- LangSysCount=0 -->
|
||||
</Script>
|
||||
</ScriptRecord>
|
||||
</ScriptList>
|
||||
<FeatureList>
|
||||
<!-- FeatureCount=2 -->
|
||||
<FeatureRecord index="0">
|
||||
<FeatureTag value="aalt"/>
|
||||
<Feature>
|
||||
<!-- LookupCount=1 -->
|
||||
<LookupListIndex index="0" value="0"/>
|
||||
</Feature>
|
||||
</FeatureRecord>
|
||||
<FeatureRecord index="1">
|
||||
<FeatureTag value="jp90"/>
|
||||
<Feature>
|
||||
<!-- LookupCount=1 -->
|
||||
<LookupListIndex index="0" value="1"/>
|
||||
</Feature>
|
||||
</FeatureRecord>
|
||||
</FeatureList>
|
||||
<LookupList>
|
||||
<!-- LookupCount=2 -->
|
||||
<Lookup index="0">
|
||||
<LookupType value="3"/>
|
||||
<LookupFlag value="0"/>
|
||||
<!-- SubTableCount=1 -->
|
||||
<AlternateSubst index="0">
|
||||
<AlternateSet glyph="cid12223">
|
||||
<Alternate glyph="cid62031"/>
|
||||
<Alternate glyph="cid62033"/>
|
||||
<Alternate glyph="cid61789"/>
|
||||
</AlternateSet>
|
||||
<AlternateSet glyph="cid61789">
|
||||
<Alternate glyph="cid62031"/>
|
||||
<Alternate glyph="cid62033"/>
|
||||
<Alternate glyph="cid12223"/>
|
||||
</AlternateSet>
|
||||
</AlternateSubst>
|
||||
</Lookup>
|
||||
<Lookup index="1">
|
||||
<LookupType value="1"/>
|
||||
<LookupFlag value="0"/>
|
||||
<!-- SubTableCount=1 -->
|
||||
<SingleSubst index="0">
|
||||
<Substitution in="cid12223" out="cid61789"/>
|
||||
</SingleSubst>
|
||||
</Lookup>
|
||||
</LookupList>
|
||||
</GSUB>
|
||||
|
||||
</ttFont>
|
||||
1542
Tests/subset/data/harfbuzz_repacker.ttx
Normal file
1542
Tests/subset/data/harfbuzz_repacker.ttx
Normal file
File diff suppressed because it is too large
Load Diff
@ -801,6 +801,16 @@ class SubsetTest(unittest.TestCase):
|
||||
["GlyphOrder", "GPOS"],
|
||||
)
|
||||
|
||||
def test_harfbuzz_repacker(self):
|
||||
_, fontpath = self.compile_font(self.getpath("harfbuzz_repacker.ttx"), ".otf")
|
||||
subsetpath = self.temp_path(".otf")
|
||||
subset.main([fontpath, "--unicodes=0x53a9", "--layout-features=*",
|
||||
"--output-file=%s" % subsetpath])
|
||||
subsetfont = TTFont(subsetpath)
|
||||
self.expect_ttx(subsetfont, self.getpath("expect_harfbuzz_repacker.ttx"),
|
||||
["GSUB"])
|
||||
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def featureVarsTestFont():
|
||||
|
||||
@ -12,3 +12,4 @@ skia-pathops==0.7.2; platform_python_implementation != "PyPy"
|
||||
ufoLib2==0.13.0
|
||||
pyobjc==8.1; sys_platform == "darwin"
|
||||
freetype-py==2.2.0
|
||||
uharfbuzz==0.24.1
|
||||
|
||||
4
setup.py
4
setup.py
@ -124,6 +124,10 @@ extras_require = {
|
||||
"pathops": [
|
||||
"skia-pathops >= 0.5.0",
|
||||
],
|
||||
# for packing GSUB/GPOS tables with Harfbuzz repacker
|
||||
"repacker": [
|
||||
"uharfbuzz >= 0.23.0",
|
||||
],
|
||||
}
|
||||
# use a special 'all' key as shorthand to includes all the extra dependencies
|
||||
extras_require["all"] = sum(extras_require.values(), [])
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user