C++ library for text to png awesomeness
C++ Python PHP Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
debian
m4
obj
src
tests
.gitignore
AUTHORS
ChangeLog
LICENSE
Makefile.am
NEWS
README
README.md
autogen.sh
build-code-coverage-report.sh
configure.ac
font-awesome.py
run-unit-tests.sh
russian_sample.txt
version.h.in

README.md

Overview

font-awesome is a command line tool to render TTF/OTF fonts to PNG.

Dependencies

Ubuntu

Building on Ubuntu requires the boost development libaries and the pkg-config tool:

$ sudo apt-get install libboost-all-dev
$ sudo apt-get install pkg-config

OS X

Dependencies can be installed on OS X using homebrew:

$ brew install freetype
$ brew install libpng
$ brew install libjpeg
$ brew install boost
$ brew install gcc47

If you plan to generate nice HTML code coverage reports, you'll also want lcov:

$ brew install lcov

Compiling

A standard set of the GNU autotools (autoconf, automake, libtool, etc) is required for configuration.

$ ./autogen.sh
$ ./configure
$ make

Configuration Options

There are several optional options which can be passed to the configure script.

  • --enable-gcov - enable code coverage data to be generated
  • --enable-debug - enable the unit tests to be built
  • --enable-static-boost - statically link the boost library dependencies in the application

You'll most likely want to use the gcov and debug options in development.
The static boost option may be useful for production builds where you don't want to have the separate boost dependencies installed.

Usage

Since font-awesome was made to interface with the PHP website, it takes its input through stdin, and dumps out the PNG file through STDOUT.

You can still test it on the command line using:

    $ cat "Hello world" | ./font-awesome -f in_file.ttf -s 36 > output.png

You can test the unicode capabilities using:

    $ cat tests/data/unicode_sample.txt | ./src/font-awesome --filename tests/data/2.otf --fontsize 62 --verbose > output.png

CLI Options

Text Input

The text to be rendered should be piped into the tool via STDIN. The default input text mode is regular text strings. If the --codepoints flag is used then the input should be a series of unicode code points instead. Each code point should be specified on a separate line.

Rendering Options

The --gracefulempty option can be used to force a 1x1 pixel transparent PNG to be output in cases when no text can actually be rendered. The --fix0glyph flag instructs the tool to draw a rectangle representing missing character glyphs in the input string. This is useful for fonts which do not have their own missing glyph character defined.

Backends

Text can be rendered using either one of two different backends chosen using the --backend argument. Valid values are pixel and cairo. The pixel rendering backend is the original implementation. It simply copies rasterized FreeType glyphs directly into an image buffer. Kerning and advanced multi-glyph ligature features are not supported by this backend. The Cairo backend should be used if you need to support these font features.

Image Output

The default mode is to send the PNG image data directly to STDOUT. In some situations it may be more convenient to write the image directly to a file rather than piping or redirecting the output. In those cases the --outfile argument can be passed with the output image filename to be written to instead.

Text Color

The text color can be controlled via the --color and --emptycolor options. The arguments should be hex formatted RGBA color values. The --emptycolor option can be used to control the color used to render missing character glyphs. By default missing glyphs will be rendered using the same color as normal characters.

OpenType Features

The Cairo backend supports enabling different OpenType feature tags available in fonts via the --feature flag. This flag can be used multiple times, once per (Feature Tag)[http://partners.adobe.com/public/developer/opentype/index_tag3.html] you want to use. The available features are enumerated within the "opentype_features" section of th --metrics option's output.

Metrics

There are several options for querying information about fonts. The --metrics flag will switch from outputting image data to displaying information about the text input string and the font itself. The output information includes the total number of glyphs in the font and the count of characters in the text input which have corresponding renderable glyphs. The --glyphinfo option can be used to display information about a single glyph corresponding to the option's argument. When paired with the --showempty flag, information about the missing glyph will be displayed instead of the specified character glyph. The format of the output data is either JSON or XML depending on whether the --json or --xml flag is used. If the --codepoints flag is included then the character map data will list the Unicode code points instead of the actual characters.

Issues

  • Fix Python version (it used to segfault, and now it doesn't but it also no longer works right)
  • On OS X, if there are runtime crash issues with boost and libc, it may be necessary to install boost from source instead of relying on the prepackaged homebrew version.

License

MIT

Contributors

Extra m4 sugar from: