1f2b1dedcc
* Install dependencies before executing unit tests. * Split out UTF-8 decoder. * Fixup python formatting rules. * Add documentation for QGF/QFF and the RLE format used. * Add CLI commands for converting images and fonts. * Add stub rules.mk for QP. * Add stream type. * Add base driver and comms interfaces. * Add support for SPI, SPI+D/C comms drivers. * Include <qp.h> when enabled. * Add base support for SPI+D/C+RST panels, as well as concrete implementation of ST7789. * Add support for GC9A01. * Add support for ILI9341. * Add support for ILI9163. * Add support for SSD1351. * Implement qp_setpixel, including pixdata buffer management. * Implement qp_line. * Implement qp_rect. * Implement qp_circle. * Implement qp_ellipse. * Implement palette interpolation. * Allow for streams to work with either flash or RAM. * Image loading. * Font loading. * QGF palette loading. * Progressive decoder of pixel data supporting Raw+RLE, 1-,2-,4-,8-bpp monochrome and palette-based images. * Image drawing. * Animations. * Font rendering. * Check against 256 colours, dump out the loaded palette if debugging enabled. * Fix build. * AVR is not the intended audience. * `qmk format-c` * Generation fix. * First batch of docs. * More docs and examples. * Review comments. * Public API documentation.
88 lines
4.1 KiB
Python
88 lines
4.1 KiB
Python
"""This script automates the conversion of font files into a format QMK firmware understands.
|
|
"""
|
|
|
|
import re
|
|
import datetime
|
|
from io import BytesIO
|
|
from qmk.path import normpath
|
|
from qmk.painter_qff import QFFFont
|
|
from qmk.painter import render_header, render_source, render_license, render_bytes, valid_formats
|
|
from milc import cli
|
|
|
|
|
|
@cli.argument('-f', '--font', required=True, help='Specify input font file.')
|
|
@cli.argument('-o', '--output', required=True, help='Specify output image path.')
|
|
@cli.argument('-s', '--size', default=12, help='Specify font size. Default 12.')
|
|
@cli.argument('-n', '--no-ascii', arg_only=True, action='store_true', help='Disables output of the full ASCII character set (0x20..0x7E), exporting only the glyphs specified.')
|
|
@cli.argument('-u', '--unicode-glyphs', default='', help='Also generate the specified unicode glyphs.')
|
|
@cli.argument('-a', '--no-aa', arg_only=True, action='store_true', help='Disable anti-aliasing on fonts.')
|
|
@cli.subcommand('Converts an input font to something QMK understands')
|
|
def painter_make_font_image(cli):
|
|
# Create the font object
|
|
font = QFFFont(cli)
|
|
# Read from the input file
|
|
cli.args.font = normpath(cli.args.font)
|
|
font.generate_image(cli.args.font, cli.args.size, include_ascii_glyphs=(not cli.args.no_ascii), unicode_glyphs=cli.args.unicode_glyphs, use_aa=(False if cli.args.no_aa else True))
|
|
# Render out the data
|
|
font.save_to_image(normpath(cli.args.output))
|
|
|
|
|
|
@cli.argument('-i', '--input', help='Specify input graphic file.')
|
|
@cli.argument('-o', '--output', default='', help='Specify output directory. Defaults to same directory as input.')
|
|
@cli.argument('-n', '--no-ascii', arg_only=True, action='store_true', help='Disables output of the full ASCII character set (0x20..0x7E), exporting only the glyphs specified.')
|
|
@cli.argument('-u', '--unicode-glyphs', default='', help='Also generate the specified unicode glyphs.')
|
|
@cli.argument('-f', '--format', required=True, help='Output format, valid types: %s' % (', '.join(valid_formats.keys())))
|
|
@cli.argument('-r', '--no-rle', arg_only=True, action='store_true', help='Disable the use of RLE to minimise converted image size.')
|
|
@cli.subcommand('Converts an input font image to something QMK firmware understands')
|
|
def painter_convert_font_image(cli):
|
|
# Work out the format
|
|
format = valid_formats[cli.args.format]
|
|
|
|
# Create the font object
|
|
font = QFFFont(cli.log)
|
|
|
|
# Read from the input file
|
|
cli.args.input = normpath(cli.args.input)
|
|
font.read_from_image(cli.args.input, include_ascii_glyphs=(not cli.args.no_ascii), unicode_glyphs=cli.args.unicode_glyphs)
|
|
|
|
# Work out the output directory
|
|
if len(cli.args.output) == 0:
|
|
cli.args.output = cli.args.input.parent
|
|
cli.args.output = normpath(cli.args.output)
|
|
|
|
# Render out the data
|
|
out_data = BytesIO()
|
|
font.save_to_qff(format, (False if cli.args.no_rle else True), out_data)
|
|
|
|
# Work out the text substitutions for rendering the output data
|
|
subs = {
|
|
'generated_type': 'font',
|
|
'var_prefix': 'font',
|
|
'generator_command': f'qmk painter-convert-font-image -i {cli.args.input.name} -f {cli.args.format}',
|
|
'year': datetime.date.today().strftime("%Y"),
|
|
'input_file': cli.args.input.name,
|
|
'sane_name': re.sub(r"[^a-zA-Z0-9]", "_", cli.args.input.stem),
|
|
'byte_count': out_data.getbuffer().nbytes,
|
|
'bytes_lines': render_bytes(out_data.getbuffer().tobytes()),
|
|
'format': cli.args.format,
|
|
}
|
|
|
|
# Render the license
|
|
subs.update({'license': render_license(subs)})
|
|
|
|
# Render and write the header file
|
|
header_text = render_header(subs)
|
|
header_file = cli.args.output / (cli.args.input.stem + ".qff.h")
|
|
with open(header_file, 'w') as header:
|
|
print(f"Writing {header_file}...")
|
|
header.write(header_text)
|
|
header.close()
|
|
|
|
# Render and write the source file
|
|
source_text = render_source(subs)
|
|
source_file = cli.args.output / (cli.args.input.stem + ".qff.c")
|
|
with open(source_file, 'w') as source:
|
|
print(f"Writing {source_file}...")
|
|
source.write(source_text)
|
|
source.close()
|