├── requirements.txt ├── README.md ├── setup.py ├── bitmapfont2otb └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | bdflib>=1.1 2 | prettytable>=2.4 3 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # `bitmapfont2otb` v2.4.0 2 | 3 | This tool converts a bitmap font in BDF, PCF, or SFD format, into an OTB (OpenType Bitmap) font. 4 | 5 | New versions of HarfBuzz no longer support BDF, so this is necessary. However, existing scripts either only create outlines with squares, or only create bitmaps. This script does both: it creates fallback glyphs made of square outlines, but _also_ adds a bitmap strike to the font. 6 | 7 | ## Requirements 8 | 9 | * FontForge — not installable via Pip (as of 9 November 2021)! 10 | * [`bdflib`](https://pypi.org/project/bdflib/) 11 | * [`prettytable`](https://pypi.org/project/bdflib/) 12 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | from setuptools import setup, find_packages 4 | import os 5 | import glob 6 | 7 | thelibFolder = os.path.dirname(os.path.realpath(__file__)) 8 | requirementPath = thelibFolder + '/requirements.txt' 9 | install_requires = [] 10 | if os.path.isfile(requirementPath): 11 | with open(requirementPath) as f: 12 | install_requires = f.read().splitlines() 13 | 14 | config = { 15 | 'name': 'bitmapfont2otb', 16 | 'author': 'Fredrick R. Brennan', 17 | 'url': 'https://github.com/ctrlcctrlv/bitmapfont2otb', 18 | 'description': 'Convert UFO .glif files to SVG', 19 | 'long_description': open('README.md', 'r').read(), 20 | 'license': 'MIT', 21 | 'version': '2.4.0', 22 | 'install_requires': install_requires, 23 | 'classifiers': [ 24 | "Programming Language :: Python", 25 | "Programming Language :: Python :: 3", 26 | "License :: OSI Approved :: MIT License", 27 | "Development Status :: 4 - Beta" 28 | 29 | ], 30 | 'package_dir': {'bitmapfont2otb': '.'}, 31 | 'packages': find_packages(), 32 | 'scripts': ["bitmapfont2otb"], 33 | 'zip_safe': False 34 | } 35 | 36 | if __name__ == '__main__': 37 | setup(**config) 38 | -------------------------------------------------------------------------------- /bitmapfont2otb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | import argparse 3 | import prettytable 4 | import re 5 | import sys 6 | try: 7 | import fontforge 8 | except ImportError as ie: 9 | print(f"FontForge (fontforge.org) must be separately installed, not available as pip package! {ie}", file=sys.stderr) 10 | sys.exit(1) 11 | import glob 12 | import os 13 | import warnings 14 | from bdflib import reader as bdfreader 15 | 16 | ap = argparse.ArgumentParser(description="Convert bitmap font to OpenType font with squares in outlines and bitmap strike") 17 | ap.add_argument("--no-rename", action="store_true", help="Don't rename glyphs based on their encodings, nor re-encode glyphs based on their names") 18 | ap.add_argument("--keep-temp-sfd", action="store_true", help="Keep temporary SFD for debugging") 19 | ap.add_argument("--ignore-encoding", action="store_true", help="Ignore encoding?") 20 | ap.add_argument("infile") 21 | ap.add_argument("outfile") 22 | args = ap.parse_args() 23 | 24 | def rename_glyphs(font): 25 | global args 26 | if args.no_rename: return 27 | for g in font.glyphs(): 28 | oldenc = g.unicode 29 | oldname = g.glyphname 30 | try: 31 | newname = fontforge.nameFromUnicode(oldenc, "AGL without afii") 32 | except ValueError: 33 | continue 34 | newenc = fontforge.unicodeFromName(oldname) 35 | if newenc == -1: continue 36 | if oldname != newname and g.altuni is None: 37 | print(("Changing glyph name {} to {} (because encoding is U+{:04X}"+ 38 | " && !altuni)").format(oldname, newname, g.unicode), file=sys.stderr) 39 | if g.altuni is None: 40 | g.glyphname = newname 41 | g.unicode = newenc 42 | 43 | def clean_glyph_names(font): 44 | for g in font.glyphs(): 45 | if '$' in g.glyphname: 46 | g.glyphname = g.glyphname.replace('$','') 47 | 48 | def default_char(bdf, f): 49 | if b"DEFAULT_CHAR" in bdf.properties: 50 | notdef = bdf.properties[b"DEFAULT_CHAR"] 51 | if not notdef in f: return 52 | ndg = f[notdef] 53 | fore = ndg.layers["Fore"] 54 | if f[0].unicode == 0: 55 | f.removeGlyph(f[0]) 56 | notdef = f.createChar(0, ".notdef") 57 | notdef.layers["Fore"] = fore 58 | notdef.width = ndg.width 59 | f.removeGlyph(ndg) 60 | 61 | cm = fontforge.open(args.infile) 62 | out_ext_i = args.outfile.rindex(".") 63 | out_ext = args.outfile[out_ext_i:] 64 | if out_ext == ".otb" or out_ext == ".otf": 65 | output_req = "opentype" 66 | elif out_ext == ".ttf" or out_ext == ".ttb": 67 | output_req = "truetype" 68 | else: 69 | print("Output format must be one of: otb, otf, ttf, ttb (file ext. mandatory)", file=sys.stderr) 70 | sys.exit(1) 71 | out_bdf = args.outfile.replace(out_ext, ".bdf") 72 | if out_ext[-1] == "b": 73 | out_ext = out_ext[:-1] + "f" 74 | rename_glyphs(cm) 75 | cm.generate(out_bdf) 76 | for bdf in glob.glob("*.bdf"): 77 | if bdf.startswith(out_bdf.split(".")[0] + "-") and re.search(bdf, r"\d+\.bdf$"): 78 | out_bdf = out_bdf.replace(".bdf","_ffout.bdf") 79 | os.rename(bdf, out_bdf) 80 | break 81 | f = fontforge.font() 82 | f.ascent = cm.ascent 83 | f.descent = cm.descent 84 | f.importBitmaps(out_bdf, True) 85 | with open(out_bdf, "rb") as bdff: 86 | bdf = bdfreader.read_bdf(bdff) 87 | 88 | t = prettytable.PrettyTable(['BDF Property', 'Value']) 89 | for key, val in bdf.properties.items(): 90 | k = key.decode('latin1') if isinstance(key, bytes) else repr(key) 91 | v = val.decode('latin1') if isinstance(val, bytes) else repr(val) 92 | t.add_row([k, v]) 93 | print(t, file=sys.stderr) 94 | 95 | if b"PIXEL_SIZE" in bdf.properties: 96 | pxsz = bdf.properties[b"PIXEL_SIZE"] 97 | elif all([e in bdf.properties for e in [b"FONT_ASCENT", b"FONT_DESCENT"]]): 98 | pxsz = int(bdf.properties[b"FONT_ASCENT"]) + int(bdf.properties[b"FONT_DESCENT"]) 99 | else: 100 | raise ValueError(bdf) 101 | 102 | block_size = f.em / pxsz 103 | quad_width = bdf.properties[b"QUAD_WIDTH"] if b"QUAD_WIDTH" in bdf.properties else pxsz 104 | 105 | def is_monospace(bdf): 106 | if b"SPACING" in bdf.properties: 107 | return bdf.properties[b"SPACING"] in [b"C", b"M"] 108 | else: 109 | advances = [g.advance for g in bdf.glyphs] 110 | return len(advances) > 0 and all([a == advances[0] or a == 0 for a in advances]) 111 | 112 | def pos_to_contour(x, y): 113 | pos_x, pos_y = x*block_size, y*block_size 114 | c = fontforge.contour() 115 | c.moveTo(pos_x, pos_y) 116 | c.lineTo(pos_x+block_size, pos_y) 117 | c.lineTo(pos_x+block_size, pos_y+block_size) 118 | c.lineTo(pos_x, pos_y+block_size) 119 | c.closed = True 120 | return c 121 | 122 | is_mono = is_monospace(bdf) 123 | for i, g in enumerate(bdf.glyphs): 124 | gn = g.name.decode("utf-8") 125 | x, y, w, h = g.get_bounding_box() 126 | orig_x = x 127 | l = fontforge.layer() 128 | pixels = list() 129 | for row in g.iter_pixels(): 130 | pixels.append([p for p in row]) 131 | for row in reversed(pixels): 132 | for p in row: 133 | if p: 134 | c = pos_to_contour(x, y) 135 | l += c 136 | x += 1 137 | x = orig_x 138 | y += 1 139 | if re.match(r'^\d+$', gn): 140 | e = int(gn, 10) 141 | else: 142 | e = -1 143 | if gn in f: 144 | f.removeGlyph(-1,gn) 145 | elif e in f and e != -1: 146 | try: 147 | f.removeGlyph(f[e]) 148 | except: pass 149 | ffg = f.createChar(e,gn) 150 | ffg.foreground = l 151 | if is_mono: 152 | ffg.width = int(block_size*quad_width) 153 | else: 154 | ffg.width = int(block_size*(g.advance)) 155 | 156 | f.selection.all() 157 | known_encodings = { 158 | b"KOI8": "KOI8-R" 159 | } 160 | ignored_encodings = [] 161 | bdf_encoding = bdf.properties.get(b"CHARSET_REGISTRY") 162 | ignore_encoding = bdf_encoding in ignored_encodings or args.ignore_encoding 163 | if bdf_encoding not in known_encodings and not ignore_encoding: 164 | f.encoding = "UnicodeFull" 165 | elif not ignore_encoding: 166 | f.encoding = known_encodings[bdf_encoding] 167 | f.importBitmaps(out_bdf) 168 | clean_glyph_names(f) 169 | if not args.keep_temp_sfd: 170 | try: 171 | os.unlink("output.sfd") 172 | except: pass 173 | if out_ext == ".ttf": 174 | f.is_quadratic = True 175 | output_req = "opentype" 176 | default_char(bdf, f) 177 | f.save("output.sfd") 178 | out_otf = out_bdf.replace(".bdf", out_ext) 179 | f.encoding = "UnicodeFull" 180 | rename_glyphs(f) 181 | f.generate(out_otf, flags=(output_req,), bitmap_type="otf") 182 | os.rename(out_otf, args.outfile) 183 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------