diff --git a/README.md b/README.md index 9a4524e..2a39b06 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,25 @@ -# ttf_to_binary_font +# Font to Binary Conversion Script +This script uses the following libraries: + +- **Pillow** (a fork of PIL): to load and manipulate the font image +- **numpy**: to convert glyph images to binary arrays + +## Script Functionality + +The script performs the following steps: + +1. Extracts the glyphs from the input TrueType font file using Pillow's `ImageFont` class. +2. Creates a binary representation of each glyph by converting it to an array and packing it into bytes using `struct.pack`. +3. Saves the binary font data to a file named after the input font file but with `_binary.bin` appended (e.g., `arial.ttf_binary.bin`). +4. Generates a `README.md` file describing the parameters used for generating the binary font and the output files produced. + +## Usage + +Run the script from the command line as follows: +```bash + python font_to_binary.py your_font_file.ttf out.h +``` + +Replace `your_font_file.ttf` with the path to your TrueType font file (for example, `arial.ttf`). +Replace `out.h` with the path to your TrueType font file (for example, `font_map.h`). diff --git a/font_to_binary.py b/font_to_binary.py new file mode 100644 index 0000000..8debd93 --- /dev/null +++ b/font_to_binary.py @@ -0,0 +1,87 @@ +import sys +from PIL import Image, ImageDraw, ImageFont + +FONT_SIZE = 16 # 16x16 pixels + +def render_glyph(font, char): + """Render a single character into a 16x16 monochrome bitmap.""" + img = Image.new('1', (FONT_SIZE, FONT_SIZE), 0) + draw = ImageDraw.Draw(img) + + # Get bounding box + bbox = draw.textbbox((0, 0), char, font=font) + w = bbox[2] - bbox[0] + h = bbox[3] - bbox[1] + + # Draw character centered + draw.text( + ((FONT_SIZE - w) // 2 - bbox[0], (FONT_SIZE - h) // 2 - bbox[1]), + char, + fill=1, + font=font + ) + + # Convert to 16x16 bitmap (list of 0/1) + bitmap = [[img.getpixel((x, y)) for x in range(FONT_SIZE)] for y in range(FONT_SIZE)] + return bitmap + +def bitmap_to_c_array(char, bitmap): + """Convert 16x16 bitmap to a C-style uint8_t array with binary literals.""" + lines = [] + for row in bitmap: + high = row[:8] + low = row[8:] + high_val = "0b" + "".join(str(b) for b in high) + low_val = "0b" + "".join(str(b) for b in low) + lines.append(f"{high_val}, {low_val}, // " + "".join("*" if b else " " for b in row)) + + # Use ASCII code for special characters to avoid invalid variable names + if char.isalnum(): + array_name = f"letter_{char}_16x16" + else: + array_name = f"letter_{ord(char)}_16x16" + c_code = f"static const uint8_t {array_name}[32] = {{\n " + "\n ".join(lines) + "\n};" + return array_name, c_code + +def main(ttf_path, output_file): + font = ImageFont.truetype(ttf_path, FONT_SIZE) + + # Characters to include + letters_upper = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" + letters_lower = "abcdefghijklmnopqrstuvwxyz" + digits = "0123456789" + specials = "!@#$%^&*()-_=+[]{};:'\",.<>/?\\|`~ " + + all_chars = letters_upper + letters_lower + digits + specials + array_names = [] + + with open(output_file, "w") as f: + for char in all_chars: + bitmap = render_glyph(font, char) + array_name, c_array = bitmap_to_c_array(char, bitmap) + array_names.append(array_name) + f.write(f"// Character '{char}' (ASCII {ord(char)})\n") + f.write(c_array + "\n\n") + + # Generate pointer array + f.write("// Font bitmaps array\n") + f.write(f"static const uint8_t *font_bitmaps_16x16[{len(array_names)}] = {{\n ") + f.write(", ".join(array_names)) + f.write("\n};\n\n") + + # Generate FontPack structure + f.write("// Font pack structure\n") + f.write("typedef struct {\n const uint8_t **bitmaps;\n} FontPack;\n\n") + f.write("const FontPack basic_font_pack = {\n") + f.write(" .bitmaps = {\n " + ", ".join(array_names) + "\n }\n};\n") + + print(f"C arrays and FontPack structure written to {output_file}") + +if __name__ == "__main__": + if len(sys.argv) < 3: + print("Usage: python font_to_binary.py path/to/font.ttf output_file") + sys.exit(1) + + ttf_path = sys.argv[1] + output_file = sys.argv[2] + main(ttf_path, output_file) diff --git a/raster-forge-font/.DS_Store b/raster-forge-font/.DS_Store new file mode 100644 index 0000000..8886aab Binary files /dev/null and b/raster-forge-font/.DS_Store differ diff --git a/raster-forge-font/RasterForgeRegular-JpBgm.ttf b/raster-forge-font/RasterForgeRegular-JpBgm.ttf new file mode 100644 index 0000000..8d80982 Binary files /dev/null and b/raster-forge-font/RasterForgeRegular-JpBgm.ttf differ diff --git a/raster-forge-font/RasterForgeRegular-JpBgm_binary.bin b/raster-forge-font/RasterForgeRegular-JpBgm_binary.bin new file mode 100644 index 0000000..84b1686 Binary files /dev/null and b/raster-forge-font/RasterForgeRegular-JpBgm_binary.bin differ diff --git a/raster-forge-font/info.txt b/raster-forge-font/info.txt new file mode 100644 index 0000000..62638b2 --- /dev/null +++ b/raster-forge-font/info.txt @@ -0,0 +1,2 @@ +license: Public Domain +link: https://www.fontspace.com/raster-forge-font-f135159 \ No newline at end of file diff --git a/raster-forge-font/misc/GGBotNet-ca0d.url b/raster-forge-font/misc/GGBotNet-ca0d.url new file mode 100644 index 0000000..4959776 --- /dev/null +++ b/raster-forge-font/misc/GGBotNet-ca0d.url @@ -0,0 +1,6 @@ +[InternetShortcut] +URL=https://www.ggbot.net/ +IDList= +HotKey=0 +IconFile=C:\Users\SP700\AppData\Local\Mozilla\Firefox\Profiles\tlgohe1j.default-release-1686839021344\shortcutCache\V3OJf0WjaJbbl2w8qYtwsQ==.ico +IconIndex=0 diff --git a/raster-forge-font/misc/License-473a.txt b/raster-forge-font/misc/License-473a.txt new file mode 100644 index 0000000..354f1e0 --- /dev/null +++ b/raster-forge-font/misc/License-473a.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work.