fonttools · anthrotype · Jan 12, 2022 · Jan 6, 2022 · Jan 6, 2022 · Jan 6, 2022
diff --git a/Doc/source/pens/freetypePen.rst b/Doc/source/pens/freetypePen.rst
@@ -0,0 +1,8 @@
+###########
+freetypePen
+###########
+
+.. automodule:: fontTools.pens.freetypePen
+   :inherited-members:
+   :members:
+   :undoc-members:
diff --git a/Doc/source/pens/index.rst b/Doc/source/pens/index.rst
@@ -11,6 +11,7 @@ pens
    cocoaPen
    cu2quPen
    filterPen
+   freetypePen
    momentsPen
    perimeterPen
    pointInsidePen

diff --git a/Lib/fontTools/pens/freetypePen.py b/Lib/fontTools/pens/freetypePen.py
diff --git a/README.rst b/README.rst
@@ -199,6 +199,13 @@ are required to unlock the extra features named "ufo", etc.
   * `reportlab <https://pypi.python.org/pypi/reportlab>`__: Python toolkit
     for generating PDFs and graphics.
 
+- ``Lib/fontTools/pens/freetypePen.py``
+
+  Pen to drawing glyphs with FreeType as raster images, requires:
+
+  * `freetype-py <https://pypi.python.org/pypi/freetype-py>`__: Python binding 
+    for the FreeType library.
+
 How to make a new release
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -238,9 +245,9 @@ aschmitz, Olivier Berten, Samyak Bhuta, Erik van Blokland, Petr van Blokland,
 Jelle Bosma, Sascha Brawer, Tom Byrer, Antonio Cavedoni, Frédéric 
 Coiffier, Vincent Connare, David Corbett, Simon Cozens, Dave Crossland, 
 Simon Daniels, Peter Dekkers, Behdad Esfahbod, Behnam Esfahbod, Hannes 
-Famira, Sam Fishman, Matt Fontaine, Yannis Haralambous, Greg Hitchcock, 
-Jeremie Hornus, Khaled Hosny, John Hudson, Denis Moyogo Jacquerye, Jack 
-Jansen, Tom Kacvinsky, Jens Kutilek, Antoine Leca, Werner Lemberg, Tal 
+Famira, Sam Fishman, Matt Fontaine, Takaaki Fuji, Yannis Haralambous, Greg 
+Hitchcock, Jeremie Hornus, Khaled Hosny, John Hudson, Denis Moyogo Jacquerye, 
+Ja
8000
ck Jansen, Tom Kacvinsky, Jens Kutilek, Antoine Leca, Werner Lemberg, Tal 
 Leming, Peter Lofting, Cosimo Lupo, Masaya Nakamura, Dave Opstad, 
 Laurence Penney, Roozbeh Pournader, Garret Rieger, Read Roberts, Guido 
 van Rossum, Just van Rossum, Andreas Seidel, Georg Seifert, Chris 

diff --git a/Tests/pens/data/test_even_odd_fill.pgm b/Tests/pens/data/test_even_odd_fill.pgm
diff --git a/Tests/pens/data/test_non_zero_fill.pgm b/Tests/pens/data/test_non_zero_fill.pgm
diff --git a/Tests/pens/freetypePen_test.py b/Tests/pens/freetypePen_test.py
@@ -0,0 +1,159 @@
+import unittest
+import os
+
+try:
+    from fontTools.pens.freetypePen import FreeTypePen
+    FREETYPE_PY_AVAILABLE = True
+except ImportError:
+    FREETYPE_PY_AVAILABLE = False
+
+from fontTools.misc.transform import Scale, Offset
+
+DATA_DIR = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'data')
+
+def box(pen):
+    pen.moveTo((0, 0))
+    pen.lineTo((0, 500))
+    pen.lineTo((500, 500))
+    pen.lineTo((500, 0))
+    pen.closePath()
+
+def draw_cubic(pen):
+    pen.moveTo((50, 0))
+    pen.lineTo((50, 500))
+    pen.lineTo((200, 500))
+    pen.curveTo((350, 500), (450, 400), (450, 250))
+    pen.curveTo((450, 100), (350, 0), (200, 0))
+    pen.closePath()
+
+def draw_quadratic(pen):
+    pen.moveTo((50, 0))
+    pen.lineTo((50, 500))
+    pen.lineTo((200, 500))
+    pen.qCurveTo((274, 500), (388, 438), (450, 324), (450, 250))
+    pen.qCurveTo((450, 176), (388, 62), (274, 0), (200, 0))
+    pen.closePath()
+
+def star(pen):
+    pen.moveTo((0, 420))
+    pen.lineTo((1000, 420))
+    pen.lineTo((200, -200))
+    pen.lineTo((500, 800))
+    pen.lineTo((800, -200))
+    pen.closePath()
+
+# For the PGM format, see the following resources:
+#   https://en.wikipedia.org/wiki/Netpbm
+#   http://netpbm.sourceforge.net/doc/pgm.html
+def load_pgm(filename):
+    with open(filename, 'rb') as fp:
+        assert fp.readline() == 'P5\n'.encode()
+        w, h = (int(c) for c in fp.readline().decode().rstrip().split(' '))
+        assert fp.readline() == '255\n'.encode()
+        return fp.read(), (w, h)
+
+def save_pgm(filename, buf, size):
+    with open(filename, 'wb') as fp:
+        fp.write('P5\n'.encode())
+        fp.write('{0:d} {1:d}\n'.format(*size).encode())
+        fp.write('255\n'.encode())
+        fp.write(buf)
+
+# Assume the buffers are equal when PSNR > 38dB. See also:
+#   Peak signal-to-noise ratio
+#   https://en.wikipedia.org/wiki/Peak_signal-to-noise_ratio
+PSNR_THRESHOLD = 38.0
+
+def psnr(b1, b2):
+    import math
+    mse = sum((c1-c2) * (c1-c2) for c1, c2 in zip(b1, b2)) / float(len(b1))
+    return 10.0 * math.log10((255.0 ** 2) / float(mse)) if mse > 0 else math.inf
+
+@unittest.skipUnless(FREETYPE_PY_AVAILABLE, "freetype-py not installed")
+class FreeTypePenTest(unittest.TestCase):
+    def test_draw(self):
+        pen = FreeTypePen(None)
+        box(pen)
+        width, height = 500, 500
+        buf1, _ = pen.buffer(width=width, height=height)
+        buf2 = b'\xff' * width * height
+        self.assertEqual(buf1, buf2)
+
+    def test_empty(self):
+        pen = FreeTypePen(None)
+        width, height = 500, 500
+        buf, size = pen.buffer(width=width, height=height)
+        self.assertEqual(b'\0' * size[0] * size[1], buf)
+
+    def test_bbox_and_cbox(self):
+        pen = FreeTypePen(None)
+        draw_cubic(pen)
+        self.assertEqual(pen.bbox, (50.0, 0.0, 450.0, 500.0))
+        self.assertEqual(pen.cbox, (50.0, 0.0, 450.0, 500.0))
+
+    def test_non_zero_fill(self):
+        pen = FreeTypePen(None)
+        star(pen)
+        t = Scale(0.05, 0.05)
+        width, height = t.transformPoint((1000, 1000))
+        t = t.translate(0, 200)
+        buf1, size1 = pen.buffer(width=width, height=height, transform=t, evenOdd=False)
+        buf2, size2 = load_pgm(os.path.join(DATA_DIR, 'test_non_zero_fill.pgm'))
+        self.assertEqual(len(buf1), len(buf2))
+        self.assertEqual(size1, size2)
+        self.assertGreater(psnr(buf1, buf2), PSNR_THRESHOLD)
+
+    def test_even_odd_fill(self):
+        pen = FreeTypePen(None)
+        star(pen)
+        t = Scale(0.05, 0.05)
+        width, height = t.transformPoint((1000, 1000))
+        t = t.translate(0, 200)
+        buf1, size1 = pen.buffer(width=width, height=height, transform=t, evenOdd=True)
+        buf2, size2 = load_pgm(os.path.join(DATA_DIR, 'test_even_odd_fill.pgm'))
+        self.assertEqual(len(buf1), len(buf2))
+        self.assertEqual(size1, size2)
+        self.assertGreater(psnr(buf1, buf2), PSNR_THRESHOLD)
+
+    def test_cubic_vs_quadratic(self):
+        pen1, pen2 = FreeTypePen(None), FreeTypePen(None)
+        draw_cubic(pen1)
+        draw_quadratic(pen2)
+        width, height = 500, 500
+        buf1, _ = pen1.buffer(width=width, height=height)
+        buf2, _ = pen2.buffer(width=width, height=height)
+        self.assertEqual(len(buf1), len(buf2))
+        self.assertGreater(psnr(buf1, buf2), PSNR_THRESHOLD)
+
+    def test_contain(self):
+        pen = FreeTypePen(None)
+        star(pen)
+        t = Scale(0.05, 0.05)
+        width, height = 0, 0
+        buf1, size1 = pen.buffer(width=width, height=height, transform=t, contain=True)
+        buf2, size2 = load_pgm(os.path.join(DATA_DIR, 'test_non_zero_fill.pgm'))
+        self.assertEqual(len(buf1), len(buf2))
+        self.assertEqual(size1, size2)
+        self.assertGreater(psnr(buf1, buf2), PSNR_THRESHOLD)
+
+    def test_none_width(self):
+        pen = FreeTypePen(None)
+        star(pen)
+        width, height = None, 1000
+        buf1, size = pen.buffer(width=width, height=height, transform=Offset(0, 200))
+        buf2, _    = pen.buffer(width=1000,  height=height, transform=Offset(0, 200))
+        self.assertEqual(size, (1000, 1000))
+        self.assertEqual(buf1, buf2)
+
+    def test_none_height(self):
+        pen = FreeTypePen(None)
+        star(pen)
+        width, height = 1000, None
+        buf1, size = pen.buffer(width=width, height=height)
+        buf2, _    = pen.buffer(width=width, height=1000, transform=Offset(0, 200))
+        self.assertEqual(size, (1000, 1000))
+        self.assertEqual(buf1, buf2)
+
+if __name__ == '__main__':
+    import sys
+    sys.exit(unittest.main())
diff --git a/requirements.txt b/requirements.txt
@@ -11,3 +11,4 @@ skia-pathops==0.7.2; platform_python_implementation != "PyPy"
 # this is only required to run Tests/cu2qu/{ufo,cli}_test.py
 ufoLib2==0.13.0
 pyobjc==8.1; sys_platform == "darwin"
+freetype-py==2.2.0