xref: /freebsd/usr.bin/vtfontcvt/vtfontcvt.c (revision cdebaff820b2a4915a16cedfd511823d78aab171)
1 /*-
2  * Copyright (c) 2009, 2014 The FreeBSD Foundation
3  * All rights reserved.
4  *
5  * This software was developed by Ed Schouten under sponsorship from the
6  * FreeBSD Foundation.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32 
33 #include <sys/types.h>
34 #include <sys/fnv_hash.h>
35 #include <sys/endian.h>
36 #include <sys/param.h>
37 #include <sys/queue.h>
38 
39 #include <assert.h>
40 #include <err.h>
41 #include <stdint.h>
42 #include <stdio.h>
43 #include <stdlib.h>
44 #include <string.h>
45 #include <unistd.h>
46 
47 #define VFNT_MAPS 4
48 #define VFNT_MAP_NORMAL 0
49 #define VFNT_MAP_NORMAL_RH 1
50 #define VFNT_MAP_BOLD 2
51 #define VFNT_MAP_BOLD_RH 3
52 
53 static unsigned int width = 8, wbytes, height = 16;
54 
55 struct glyph {
56 	TAILQ_ENTRY(glyph)	 g_list;
57 	SLIST_ENTRY(glyph)	 g_hash;
58 	uint8_t			*g_data;
59 	unsigned int		 g_index;
60 };
61 
62 #define	FONTCVT_NHASH 4096
63 TAILQ_HEAD(glyph_list, glyph);
64 static SLIST_HEAD(, glyph) glyph_hash[FONTCVT_NHASH];
65 static struct glyph_list glyphs[VFNT_MAPS] = {
66     TAILQ_HEAD_INITIALIZER(glyphs[0]),
67     TAILQ_HEAD_INITIALIZER(glyphs[1]),
68     TAILQ_HEAD_INITIALIZER(glyphs[2]),
69     TAILQ_HEAD_INITIALIZER(glyphs[3]),
70 };
71 static unsigned int glyph_total, glyph_count[4], glyph_unique, glyph_dupe;
72 
73 struct mapping {
74 	TAILQ_ENTRY(mapping)	 m_list;
75 	unsigned int		 m_char;
76 	unsigned int		 m_length;
77 	struct glyph		*m_glyph;
78 };
79 
80 TAILQ_HEAD(mapping_list, mapping);
81 static struct mapping_list maps[VFNT_MAPS] = {
82     TAILQ_HEAD_INITIALIZER(maps[0]),
83     TAILQ_HEAD_INITIALIZER(maps[1]),
84     TAILQ_HEAD_INITIALIZER(maps[2]),
85     TAILQ_HEAD_INITIALIZER(maps[3]),
86 };
87 static unsigned int mapping_total, map_count[4], map_folded_count[4],
88     mapping_unique, mapping_dupe;
89 
90 static void
91 usage(void)
92 {
93 
94 	(void)fprintf(stderr,
95 "usage: vtfontcvt [-w width] [-h height] [-v] normal.bdf [bold.bdf] out.fnt\n");
96 	exit(1);
97 }
98 
99 static void *
100 xmalloc(size_t size)
101 {
102 	void *m;
103 
104 	if ((m = malloc(size)) == NULL)
105 		errx(1, "memory allocation failure");
106 	return (m);
107 }
108 
109 static int
110 add_mapping(struct glyph *gl, unsigned int c, unsigned int map_idx)
111 {
112 	struct mapping *mp;
113 	struct mapping_list *ml;
114 
115 	mapping_total++;
116 
117 	mp = xmalloc(sizeof *mp);
118 	mp->m_char = c;
119 	mp->m_glyph = gl;
120 	mp->m_length = 0;
121 
122 	ml = &maps[map_idx];
123 	if (TAILQ_LAST(ml, mapping_list) != NULL &&
124 	    TAILQ_LAST(ml, mapping_list)->m_char >= c)
125 		errx(1, "Bad ordering at character %u", c);
126 	TAILQ_INSERT_TAIL(ml, mp, m_list);
127 
128 	map_count[map_idx]++;
129 	mapping_unique++;
130 
131 	return (0);
132 }
133 
134 static int
135 dedup_mapping(unsigned int map_idx)
136 {
137 	struct mapping *mp_bold, *mp_normal, *mp_temp;
138 	unsigned normal_map_idx = map_idx - VFNT_MAP_BOLD;
139 
140 	assert(map_idx == VFNT_MAP_BOLD || map_idx == VFNT_MAP_BOLD_RH);
141 	mp_normal = TAILQ_FIRST(&maps[normal_map_idx]);
142 	TAILQ_FOREACH_SAFE(mp_bold, &maps[map_idx], m_list, mp_temp) {
143 		while (mp_normal->m_char < mp_bold->m_char)
144 			mp_normal = TAILQ_NEXT(mp_normal, m_list);
145 		if (mp_bold->m_char != mp_normal->m_char)
146 			errx(1, "Character %u not in normal font!",
147 			    mp_bold->m_char);
148 		if (mp_bold->m_glyph != mp_normal->m_glyph)
149 			continue;
150 
151 		/* No mapping is needed if it's equal to the normal mapping. */
152 		TAILQ_REMOVE(&maps[map_idx], mp_bold, m_list);
153 		free(mp_bold);
154 		mapping_dupe++;
155 	}
156 	return (0);
157 }
158 
159 static struct glyph *
160 add_glyph(const uint8_t *bytes, unsigned int map_idx, int fallback)
161 {
162 	struct glyph *gl;
163 	int hash;
164 
165 	glyph_total++;
166 	glyph_count[map_idx]++;
167 
168 	hash = fnv_32_buf(bytes, wbytes * height, FNV1_32_INIT) % FONTCVT_NHASH;
169 	SLIST_FOREACH(gl, &glyph_hash[hash], g_hash) {
170 		if (memcmp(gl->g_data, bytes, wbytes * height) == 0) {
171 			glyph_dupe++;
172 			return (gl);
173 		}
174 	}
175 
176 	gl = xmalloc(sizeof *gl);
177 	gl->g_data = xmalloc(wbytes * height);
178 	memcpy(gl->g_data, bytes, wbytes * height);
179 	if (fallback)
180 		TAILQ_INSERT_HEAD(&glyphs[map_idx], gl, g_list);
181 	else
182 		TAILQ_INSERT_TAIL(&glyphs[map_idx], gl, g_list);
183 	SLIST_INSERT_HEAD(&glyph_hash[hash], gl, g_hash);
184 
185 	glyph_unique++;
186 	return (gl);
187 }
188 
189 static int
190 add_char(unsigned curchar, unsigned map_idx, uint8_t *bytes, uint8_t *bytes_r)
191 {
192 	struct glyph *gl;
193 
194 	/* Prevent adding two glyphs for 0xFFFD */
195 	if (curchar == 0xFFFD) {
196 		if (map_idx < VFNT_MAP_BOLD)
197 			gl = add_glyph(bytes, 0, 1);
198 	} else if (curchar >= 0x20) {
199 		gl = add_glyph(bytes, map_idx, 0);
200 		if (add_mapping(gl, curchar, map_idx) != 0)
201 			return (1);
202 		if (bytes_r != NULL) {
203 			gl = add_glyph(bytes_r, map_idx + 1, 0);
204 			if (add_mapping(gl, curchar,
205 			    map_idx + 1) != 0)
206 				return (1);
207 		}
208 	}
209 	return (0);
210 }
211 
212 
213 static int
214 parse_bitmap_line(uint8_t *left, uint8_t *right, unsigned int line,
215     unsigned int dwidth)
216 {
217 	uint8_t *p;
218 	unsigned int i, subline;
219 
220 	if (dwidth != width && dwidth != width * 2)
221 		errx(1, "Bitmap with unsupported width %u!", dwidth);
222 
223 	/* Move pixel data right to simplify splitting double characters. */
224 	line >>= (howmany(dwidth, 8) * 8) - dwidth;
225 
226 	for (i = dwidth / width; i > 0; i--) {
227 		p = (i == 2) ? right : left;
228 
229 		subline = line & ((1 << width) - 1);
230 		subline <<= (howmany(width, 8) * 8) - width;
231 
232 		if (wbytes == 1) {
233 			*p = subline;
234 		} else if (wbytes == 2) {
235 			*p++ = subline >> 8;
236 			*p = subline;
237 		} else {
238 			errx(1, "Unsupported wbytes %u!", wbytes);
239 		}
240 
241 		line >>= width;
242 	}
243 
244 	return (0);
245 }
246 
247 static int
248 parse_bdf(FILE *fp, unsigned int map_idx)
249 {
250 	char *ln;
251 	size_t length;
252 	uint8_t bytes[wbytes * height], bytes_r[wbytes * height];
253 	unsigned int curchar = 0, dwidth = 0, i, line;
254 
255 	while ((ln = fgetln(fp, &length)) != NULL) {
256 		ln[length - 1] = '\0';
257 
258 		if (strncmp(ln, "ENCODING ", 9) == 0) {
259 			curchar = atoi(ln + 9);
260 		}
261 
262 		if (strncmp(ln, "DWIDTH ", 7) == 0) {
263 			dwidth = atoi(ln + 7);
264 		}
265 
266 		if (strncmp(ln, "BITMAP", 6) == 0 &&
267 		    (ln[6] == ' ' || ln[6] == '\0')) {
268 			for (i = 0; i < height; i++) {
269 				if ((ln = fgetln(fp, &length)) == NULL)
270 					errx(1, "Unexpected EOF!");
271 				ln[length - 1] = '\0';
272 				sscanf(ln, "%x", &line);
273 				if (parse_bitmap_line(bytes + i * wbytes,
274 				     bytes_r + i * wbytes, line, dwidth) != 0)
275 					return (1);
276 			}
277 
278 			if (add_char(curchar, map_idx, bytes,
279 			    dwidth == width * 2 ? bytes_r : NULL) != 0)
280 				return (1);
281 		}
282 	}
283 
284 	return (0);
285 }
286 
287 static void
288 set_width(int w)
289 {
290 
291 	if (w <= 0 || w > 128)
292 		errx(1, "invalid width %d", w);
293 	width = w;
294 	wbytes = howmany(width, 8);
295 }
296 
297 static int
298 parse_hex(FILE *fp, unsigned int map_idx)
299 {
300 	char *ln, *p;
301 	char fmt_str[8];
302 	size_t length;
303 	uint8_t *bytes = NULL, *bytes_r = NULL;
304 	unsigned curchar = 0, i, line, chars_per_row, dwidth;
305 	int rv = 0;
306 
307 	while ((ln = fgetln(fp, &length)) != NULL) {
308 		ln[length - 1] = '\0';
309 
310 		if (strncmp(ln, "# Height: ", 10) == 0) {
311 			if (bytes != NULL)
312 				errx(1, "malformed input: Height tag after font data");
313 			height = atoi(ln + 10);
314 		} else if (strncmp(ln, "# Width: ", 9) == 0) {
315 			if (bytes != NULL)
316 				errx(1, "malformed input: Width tag after font data");
317 			set_width(atoi(ln + 9));
318 		} else if (sscanf(ln, "%6x:", &curchar)) {
319 			if (bytes == NULL) {
320 				bytes = xmalloc(wbytes * height);
321 				bytes_r = xmalloc(wbytes * height);
322 			}
323 			/* ln is guaranteed to have a colon here. */
324 			p = strchr(ln, ':') + 1;
325 			chars_per_row = strlen(p) / height;
326 			dwidth = width;
327 			if (chars_per_row / 2 > (width + 7) / 8)
328 				dwidth *= 2; /* Double-width character. */
329 			snprintf(fmt_str, sizeof(fmt_str), "%%%ux",
330 			    chars_per_row);
331 
332 			for (i = 0; i < height; i++) {
333 				sscanf(p, fmt_str, &line);
334 				p += chars_per_row;
335 				if (parse_bitmap_line(bytes + i * wbytes,
336 				    bytes_r + i * wbytes, line, dwidth) != 0) {
337 					rv = 1;
338 					goto out;
339 				}
340 			}
341 
342 			if (add_char(curchar, map_idx, bytes,
343 			    dwidth == width * 2 ? bytes_r : NULL) != 0) {
344 				rv = 1;
345 				goto out;
346 			}
347 		}
348 	}
349 out:
350 	free(bytes);
351 	free(bytes_r);
352 	return (rv);
353 }
354 
355 static int
356 parse_file(const char *filename, unsigned int map_idx)
357 {
358 	FILE *fp;
359 	size_t len;
360 	int rv;
361 
362 	fp = fopen(filename, "r");
363 	if (fp == NULL) {
364 		perror(filename);
365 		return (1);
366 	}
367 	len = strlen(filename);
368 	if (len > 4 && strcasecmp(filename + len - 4, ".hex") == 0)
369 		rv = parse_hex(fp, map_idx);
370 	else
371 		rv = parse_bdf(fp, map_idx);
372 	fclose(fp);
373 	return (rv);
374 }
375 
376 static void
377 number_glyphs(void)
378 {
379 	struct glyph *gl;
380 	unsigned int i, idx = 0;
381 
382 	for (i = 0; i < VFNT_MAPS; i++)
383 		TAILQ_FOREACH(gl, &glyphs[i], g_list)
384 			gl->g_index = idx++;
385 }
386 
387 static int
388 write_glyphs(FILE *fp)
389 {
390 	struct glyph *gl;
391 	unsigned int i;
392 
393 	for (i = 0; i < VFNT_MAPS; i++) {
394 		TAILQ_FOREACH(gl, &glyphs[i], g_list)
395 			if (fwrite(gl->g_data, wbytes * height, 1, fp) != 1)
396 				return (1);
397 	}
398 	return (0);
399 }
400 
401 static void
402 fold_mappings(unsigned int map_idx)
403 {
404 	struct mapping_list *ml = &maps[map_idx];
405 	struct mapping *mn, *mp, *mbase;
406 
407 	mp = mbase = TAILQ_FIRST(ml);
408 	for (mp = mbase = TAILQ_FIRST(ml); mp != NULL; mp = mn) {
409 		mn = TAILQ_NEXT(mp, m_list);
410 		if (mn != NULL && mn->m_char == mp->m_char + 1 &&
411 		    mn->m_glyph->g_index == mp->m_glyph->g_index + 1)
412 			continue;
413 		mbase->m_length = mp->m_char - mbase->m_char + 1;
414 		mbase = mp = mn;
415 		map_folded_count[map_idx]++;
416 	}
417 }
418 
419 struct file_mapping {
420 	uint32_t	source;
421 	uint16_t	destination;
422 	uint16_t	length;
423 } __packed;
424 
425 static int
426 write_mappings(FILE *fp, unsigned int map_idx)
427 {
428 	struct mapping_list *ml = &maps[map_idx];
429 	struct mapping *mp;
430 	struct file_mapping fm;
431 	unsigned int i = 0, j = 0;
432 
433 	TAILQ_FOREACH(mp, ml, m_list) {
434 		j++;
435 		if (mp->m_length > 0) {
436 			i += mp->m_length;
437 			fm.source = htobe32(mp->m_char);
438 			fm.destination = htobe16(mp->m_glyph->g_index);
439 			fm.length = htobe16(mp->m_length - 1);
440 			if (fwrite(&fm, sizeof fm, 1, fp) != 1)
441 				return (1);
442 		}
443 	}
444 	assert(i == j);
445 	return (0);
446 }
447 
448 struct file_header {
449 	uint8_t		magic[8];
450 	uint8_t		width;
451 	uint8_t		height;
452 	uint16_t	pad;
453 	uint32_t	glyph_count;
454 	uint32_t	map_count[4];
455 } __packed;
456 
457 static int
458 write_fnt(const char *filename)
459 {
460 	FILE *fp;
461 	struct file_header fh = {
462 		.magic = "VFNT0002",
463 	};
464 
465 	fp = fopen(filename, "wb");
466 	if (fp == NULL) {
467 		perror(filename);
468 		return (1);
469 	}
470 
471 	fh.width = width;
472 	fh.height = height;
473 	fh.glyph_count = htobe32(glyph_unique);
474 	fh.map_count[0] = htobe32(map_folded_count[0]);
475 	fh.map_count[1] = htobe32(map_folded_count[1]);
476 	fh.map_count[2] = htobe32(map_folded_count[2]);
477 	fh.map_count[3] = htobe32(map_folded_count[3]);
478 	if (fwrite(&fh, sizeof fh, 1, fp) != 1) {
479 		perror(filename);
480 		fclose(fp);
481 		return (1);
482 	}
483 
484 	if (write_glyphs(fp) != 0 ||
485 	    write_mappings(fp, VFNT_MAP_NORMAL) != 0 ||
486 	    write_mappings(fp, 1) != 0 ||
487 	    write_mappings(fp, VFNT_MAP_BOLD) != 0 ||
488 	    write_mappings(fp, 3) != 0) {
489 		perror(filename);
490 		fclose(fp);
491 		return (1);
492 	}
493 
494 	fclose(fp);
495 	return (0);
496 }
497 
498 static void
499 print_font_info(void)
500 {
501 	printf(
502 "Statistics:\n"
503 "- glyph_total:                 %6u\n"
504 "- glyph_normal:                %6u\n"
505 "- glyph_normal_right:          %6u\n"
506 "- glyph_bold:                  %6u\n"
507 "- glyph_bold_right:            %6u\n"
508 "- glyph_unique:                %6u\n"
509 "- glyph_dupe:                  %6u\n"
510 "- mapping_total:               %6u\n"
511 "- mapping_normal:              %6u\n"
512 "- mapping_normal_folded:       %6u\n"
513 "- mapping_normal_right:        %6u\n"
514 "- mapping_normal_right_folded: %6u\n"
515 "- mapping_bold:                %6u\n"
516 "- mapping_bold_folded:         %6u\n"
517 "- mapping_bold_right:          %6u\n"
518 "- mapping_bold_right_folded:   %6u\n"
519 "- mapping_unique:              %6u\n"
520 "- mapping_dupe:                %6u\n",
521 	    glyph_total,
522 	    glyph_count[0],
523 	    glyph_count[1],
524 	    glyph_count[2],
525 	    glyph_count[3],
526 	    glyph_unique, glyph_dupe,
527 	    mapping_total,
528 	    map_count[0], map_folded_count[0],
529 	    map_count[1], map_folded_count[1],
530 	    map_count[2], map_folded_count[2],
531 	    map_count[3], map_folded_count[3],
532 	    mapping_unique, mapping_dupe);
533 }
534 
535 int
536 main(int argc, char *argv[])
537 {
538 	int ch, val, verbose = 0;
539 
540 	assert(sizeof(struct file_header) == 32);
541 	assert(sizeof(struct file_mapping) == 8);
542 
543 	while ((ch = getopt(argc, argv, "h:vw:")) != -1) {
544 		switch (ch) {
545 		case 'h':
546 			val = atoi(optarg);
547 			if (val <= 0 || val > 128)
548 				errx(1, "Invalid height %d", val);
549 			height = val;
550 			break;
551 		case 'v':
552 			verbose = 1;
553 			break;
554 		case 'w':
555 			set_width(atoi(optarg));
556 			break;
557 		case '?':
558 		default:
559 			usage();
560 		}
561 	}
562 	argc -= optind;
563 	argv += optind;
564 
565 	if (argc < 2 || argc > 3)
566 		usage();
567 
568 	wbytes = howmany(width, 8);
569 
570 	if (parse_file(argv[0], VFNT_MAP_NORMAL) != 0)
571 		return (1);
572 	argc--;
573 	argv++;
574 	if (argc == 2) {
575 		if (parse_file(argv[0], VFNT_MAP_BOLD) != 0)
576 			return (1);
577 		argc--;
578 		argv++;
579 	}
580 	number_glyphs();
581 	dedup_mapping(VFNT_MAP_BOLD);
582 	dedup_mapping(VFNT_MAP_BOLD_RH);
583 	fold_mappings(0);
584 	fold_mappings(1);
585 	fold_mappings(2);
586 	fold_mappings(3);
587 	if (write_fnt(argv[0]) != 0)
588 		return (1);
589 
590 	if (verbose)
591 		print_font_info();
592 
593 	return (0);
594 }
595