aboutsummaryrefslogtreecommitdiff
path: root/Tests/pens/freetypePen_test.py
blob: b6edc8bb9e608cc990c105413cde8e81d73f6230 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
import unittest
import os
import math

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, offset=(0, 0)):
    pen.moveTo((0 + offset[0], 0 + offset[1]))
    pen.lineTo((0 + offset[0], 500 + offset[1]))
    pen.lineTo((500 + offset[0], 500 + offset[1]))
    pen.lineTo((500 + offset[0], 0 + offset[1]))
    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_rotate(self):
        pen = FreeTypePen(None)
        box(pen)
        t = Scale(0.05, 0.05).rotate(math.pi / 4.0).translate(1234, 5678)
        width, height = None, None
        buf1, size1 = pen.buffer(width=width, height=height, transform=t)
        buf2, size2 = load_pgm(os.path.join(DATA_DIR, "test_rotate.pgm"))
        self.assertEqual(len(buf1), len(buf2))
        self.assertEqual(size1, size2)
        self.assertGreater(psnr(buf1, buf2), PSNR_THRESHOLD)

    def test_skew(self):
        pen = FreeTypePen(None)
        box(pen)
        t = Scale(0.05, 0.05).skew(math.pi / 4.0).translate(1234, 5678)
        width, height = None, None
        buf1, size1 = pen.buffer(width=width, height=height, transform=t)
        buf2, size2 = load_pgm(os.path.join(DATA_DIR, "test_skew.pgm"))
        self.assertEqual(len(buf1), len(buf2))
        self.assertEqual(size1, size2)
        self.assertGreater(psnr(buf1, buf2), PSNR_THRESHOLD)

    def test_none_size(self):
        pen = FreeTypePen(None)
        star(pen)
        width, height = None, None
        buf1, size = pen.buffer(width=width, height=height, transform=Offset(0, 200))
        buf2, _ = pen.buffer(width=1000, height=1000, transform=Offset(0, 200))
        self.assertEqual(size, (1000, 1000))
        self.assertEqual(buf1, buf2)

        pen = FreeTypePen(None)
        box(pen, offset=(250, 250))
        width, height = None, None
        buf1, size = pen.buffer(width=width, height=height)
        buf2, _ = pen.buffer(width=500, height=500, transform=Offset(-250, -250))
        self.assertEqual(size, (500, 500))
        self.assertEqual(buf1, buf2)

        pen = FreeTypePen(None)
        box(pen, offset=(-1234, -5678))
        width, height = None, None
        buf1, size = pen.buffer(width=width, height=height)
        buf2, _ = pen.buffer(width=500, height=500, transform=Offset(1234, 5678))
        self.assertEqual(size, (500, 500))
        self.assertEqual(buf1, buf2)

    def test_zero_size(self):
        pen = FreeTypePen(None)
        star(pen)
        width, height = 0, 0
        buf1, size = pen.buffer(
            width=width, height=height, transform=Offset(0, 200), contain=True
        )
        buf2, _ = pen.buffer(
            width=1000, height=1000, transform=Offset(0, 200), contain=True
        )
        self.assertEqual(size, (1000, 1000))
        self.assertEqual(buf1, buf2)

        pen = FreeTypePen(None)
        box(pen, offset=(250, 250))
        width, height = 0, 0
        buf1, size = pen.buffer(width=width, height=height, contain=True)
        buf2, _ = pen.buffer(
            width=500, height=500, transform=Offset(0, 0), contain=True
        )
        self.assertEqual(size, (750, 750))
        self.assertEqual(buf1, buf2)

        pen = FreeTypePen(None)
        box(pen, offset=(-1234, -5678))
        width, height = 0, 0
        buf1, size = pen.buffer(width=width, height=height, contain=True)
        buf2, _ = pen.buffer(
            width=500, height=500, transform=Offset(1234, 5678), contain=True
        )
        self.assertEqual(size, (500, 500))
        self.assertEqual(buf1, buf2)


if __name__ == "__main__":
    import sys

    sys.exit(unittest.main())