blob: d88df8b32e7f3e2ae6a484ae7ffa8e9c30416cd1 (
plain) (
blame)
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
|
# buchstabensuppe
```
█
█
█
█ ███ ████
██ █ █ █
█ █ █
█ █ ██
█ █ ██
█ █ █
██ █ █ █
█ ███ ████
```
> at least better than PIL.ImageFont
toy font rendering for low pixelcount high contrast displays,
i. e. [openlab's flipdot display](https://wiki.openlab-augsburg.de/Flipdots).
## features
* supports [text shaping](https://harfbuzz.github.io/what-is-harfbuzz.html#what-is-text-shaping)
via harfbuzz
* per grapheme cluster font fallback
* grayscale and binary b/w support
## building
requirements:
* [redo-c](https://github.com/leahneukirchen/redo-c)
* Optionally `make` for install script and such
* [utf8proc](https://juliastrings.github.io/utf8proc)
* [harfbuzz](harfbuzz.github.io/)
* [libschrift](https://github.com/tomolt/libschrift) == 0.10.1
```
# run inside nix-shell if you have nix!
# static library
$ redo libbuchstabensuppe.a
# demo binary
$ redo bs-renderflipdot.exe
# tests
$ redo test.exe && ./test.exe
```
alternatively you can just run `nix-build`
## demo
if you want to play around with the font rendering in binary
mode you can use the dry run mode of the supplied `./bs-renderflipdot.exe`
(or `./result/bin/bs-renderflipdot` if you use nix) binary.
Run `./bs-renderflipdot.exe -?` for usage instructions and don't forget `-n`
for dry running!
```
$ ./bs-renderflipdot.exe -f fonts/unifont.ttf -f fonts/unifont_upper.ttf -n "Greetings ❣️" 2>/dev/null
███ ███
█████████
█ █████████
████ █ █ █████████
█ █ █ █ ███████
█ █ █ ███ ████ ████ █ ██ █ ███ ███ █ ████ ███
█ ██ █ █ █ █ █ █████ █ ██ █ █ █ █ █ █
█ █ █ █ █ █ █ █ █ █ █ █ █ █
█ ███ █ ██████ ██████ █ █ █ █ █ █ ██ ███
█ █ █ █ █ █ █ █ █ ███ ██ █████
█ █ █ █ █ █ █ █ █ █ █ █████
█ ██ █ █ █ █ █ █ █ █ █ ████ █ █ █████
███ █ █ ████ ████ ██ █████ █ █ █ █ ████ ███
█ █
████
```
## flipdot interaction
the picture above shows buchstabensuppe being used to render text
onto a simulated flipdot display. take notice especially of the following:
* fallback fonts are supported: the emoji is not found in `unifont.ttf`,
but rendered from `unifont_upper.ttf`
* correct text shaping is supported (as far as the font supports it):
g̈ which consists of two codepoints is rendered as a combined cluster
consisting of two glyphs.
[bs-renderflipdot.c](./bs-renderflipdot.c) is a simple example showing
how to interact with a flipdot display. mainly it involves:
* rendering a string to a bitmap using `bs_render_utf8_string`
* making sure that the dimensions of the display and the image
match with `bs_bitmap_extend`
* processing the resulting bitmap using `bs_bitmap_map`
* rendering the resulting bitmap on the display using
`bs_flipdot_render`.
* dealing with bitmaps too big for the display using
`bs_scroll_next_view` and `bs_page_next_view`.
you can also play around with its cli: the following command
renders “Hello World” black on white using GNU Unifont onto
a flipdot display (or simulator) running on `localhost:2323`.
See [bs-renderflipdot(1)](https://sternenseemann.github.io/buchstabensuppe/bs-renderflipdot.1.html)
for more usage details.
```
./bs-renderflipdot.exe -f /path/to/unifont.ttf -f /path/to/unifont_upper.ttf -i "Hello World"
```
## caveats
* buchstabensuppe loads all fonts into memory and keeps them there pretty much
all the time.
* there is no support for right to left nor vertical script (but planned)
|
