This is intended to fill the void felt by Kobo developers and tinkerers when they realize they do not have a builtin way to print stuff on the device's screen!
It's especially cruel when moving to a Kobo, after being used to the ubiquity of
eips on Kindle...
In short, it prints messages or images on your screen, handling the low-level tinkering with both the Linux framebuffer interface, and the i.MX EPDC (as well as the MTK one on Kindle, and the sunxi one on Kobo).
It's been tested on Kobo, Kindle, BQ Cervantes, reMarkable and PocketBook, but porting it to other Linux, i.MX eInk devices should be trivial (hell, even Sipix support shouldn't be too hard). #64 proved that we can even bend sunxi APIs to our will, if you don't care too much about losing your sanity in the process ;).
By default, text rendering relies on bundled fixed cell bitmap fonts (see this post for a small sampling), but thanks to @shermp's contributions (#20), you can also rely on full-fledged TrueType/OpenType font rendering!
Image support includes most common formats (JPEG/PNG/TGA/BMP/GIF/PNM), as well as raw packed pixels in the most relevant pixel formats (Gray8 & RGB32; both +/- Alpha).
It also happens to work perfectly fine on any kind of Linux framebuffer device, and supports a wide range of bitdepths (4bpp, 8bpp, 16bpp, 24bpp & 32bpp), so you could use this to draw on your EFI fb, for instance ;).
For Kobo devices, there's a discussion thread open over here on MobileRead, where you'll happen to find standalone binaries. It's purposefully lacking in detailed instructions, because the target audience is mainly developers and tinkerers. Think of this as a safety precaution ;).
There's also a sister thread for Kindle devices over here where, besides binaries, you'll also find examples of people doing crazy things with it ;).
In practice, most Kindle & Kobo users will in fact get it for free, as it's bundled with most of my packages.
As an example of usage in the wild, see KFMon, where I'm using it to provide visual feedback, or kobo-rclone, where it's also used for screen scraping. We're also using it in KOReader, to make the OTA update process more user-friendly.
A quick GitHub search for code mentioning fbink should also yield interesting results, e.g., a DAMAGE-handling shim for X11, a Qt5 QPA or InkVT, a terminal emulator.
See also the various bindings in other languages, which often include a few examples.
A CLI utility is available, built around the same public API that can be used via a shared or static library for C projects, or via FFI in other languages (beware, though, it's licensed under the GPLv3+, not the LGPL).
For the CLI utility, see its documentation or run
fbink --help for details.
For the library, see the public header. Don't hesitate to contact me if things appear unclear!
NOTE: It generally makes NO attempt at handling software rotation, because that currently appears to be the right thing to do with both current Kobo FW versions and on Kindle.
YMMV on older FW, or if something else is fudging with fb rotation, or if your application is implementing rotation in software (i.e., a rotated viewport).
As far as hardware rotation is concerned, there are a few specific exceptions made for Kobo devices:
Those running in 16bpp mode and appearing to be in landscape mode: since that seems to be their native state, we attempt to compensate for this, as we can legitimately be used before Nickel itself corrects this.
On devices with an accelerometer, like the Forma & Libra, where Nickel itself will handle the hardware rotation.
A few basic examples of the fixed cell text rendering...
Or if we drop an image in there...
And with all the bells and whistles of working transparency, even on ancient hardware :).
Here's a few other fonts, as well as a progress bar...
And when using shiny TrueType fonts :).
Unless you're just trying to take it for a spin on a native pure Linux system (
make linux), you'll need a cross-compiler targeting your, well, target device.
The Makefile is tailored to automatically detect my own cross-compilation ToolChain setups, which I evidently heartily recommend using instead of relying on generic cross-compilation toolchains which may not exactly target the right kernel/libc duo ;).
Using the koxtoolchain frontend should make building one of these a fairly painless process.
In case you're using your own toolchain, please note that we require C11 support (GCC >= 4.9, Clang >= 3.0).
Provided you're not using an older compiler, I highly recommend building this with LTO enabled!
With that out of the way, the default target (i.e.,
make) will yield a static Kobo build, while
make kobo will yield a stripped shared build, and additionally package everything the Kobo way. The package found in the Kobo thread is built this way.
There's a few convenience targets for usual build types (
make static for a static build,
make shared for a shared build,
make strip for a stripped static build,
make release for a stripped shared build,
make debug for a debug build), as well as a few unusual ones for very specific use cases, usually related to FFI bindings (
make pic for a PIC static build, or passing
STATIC_LIBM=1 to make to attempt to link against libm statically).
The choice of target platform is handled via a simple variable:
KINDLE=1to make for a Kindle build (
make kindledoes that on a stripped static build).
KINDLE=1 LEGACY=1to make for a FW 2.x Kindle build (
make legacydoes that on a stripped static build). This basically just disables CLOEXEC, which might not be supported on FW 2.x.
CERVANTES=1to make for a BQ/Cervantes build (
make cervantesdoes that on a stripped static build).
REMARKABLE=1to make for a reMarkable build (
make remarkabledoes that on a stripped static build).
POCKETBOOK=1to make for a PocketBook build (
make pocketbookdoes that on a stripped static build).
The same logic is used to allow for a bit of tailoring:
MINIMAL=1to make for a build with very limited functionality (no drawing primitives, no fixed-cell font rendering, no image rendering, no extra fonts, no OpenType), which yields a much smaller application & library.
DEBUG=1to make for a Debug build, and pass
DEBUG=1 DEBUGFLAGS=1to make for a Debug build with enforced debug CFLAGS.
You can also append features one by one to a
DRAW=1to add support for drawing primitives.
BITMAP=1to add support for fixed-cell font rendering. (Implies
FONTS=1to add support for the extra bundled fixed-cell fonts. (Implies
IMAGE=1to add image support. (Implies
OPENTYPE=1to add OTF/TTF font rendering support. (Implies
BUTTON_SCAN=1to add support for the Kobo-specific button scan stuff. (Implies
If you really need extreme Unicode coverage in the fixed-cell codepath, you can also choose to embed GNU Unifont, by passing
Be warned that this'll add almost 2MB to the binary size, and that the font is actually split in two (double-wide glyphs are punted off to a specific font), which may dampen its usefulness in practice...
For obvious reasons, this is never enabled by default.
Unless you're doing very specific things, you generally want at least
BITMAP enabled in a
Don't forget to run at the very least a
make cleanlib when changing target platforms or feature flags, otherwise the latest matching library build will be kept, because it'll fullfill the make dependencies ;).
Along the way, a few auxiliary tools may crop up in the
make utils will do a static build of these (which is the recommended way to do it, as they rather crudely piggyback on FBInk's internal API). Currently, these consist of a diagnostic tool regarding rotation behavior, and the doom stress-test mentioned below.
Most of these have only been tested on Kobo, and should probably be left alone unless you know what you're doing ;).
A tool to properly manipulate the bitdepth on eInk devices is also available, and can be built for e-Ink targets with
Its uninspired name is
fbdepth, and it's used by KOReader on Kobo & reMarkable to enforce a sane rotation and switch to a more efficient bitdepth.
It has also been tested on Kindle, where rotation handling, at the very least, should be behaving properly. Do note that on FW 5.x, the stock GUI runs under X, and X will not like you rotating the fb from under its feet ;).
If you want the smallest binary possible, make sure you build it alone, from a pristine source tree.
There's also a fairly stupid example showcasing the dump/restore API that can be built via
Another stupid demo based on the PSX Doom fire effect was implemented, to stress-test the EPDC in a mildly interesting manner.
If you ever were curious about the whole mxcfb alt_buffer shindig, you can take a look at this PoC.
In the same vein, if you're looking into rotation & input shenanigans on Kobo,
make devcap will build a tarball containing a few binaries and a devcap_test.sh script, that, when run on the target device, will compile quite a bit of info. In particular, if you ever need to report a bug against
fbdepth, I'll probably ask you to run that and attach the results to the issue ;).
And on the subject of input & rotation on Kobo,
make ftrace will build a simple pointer trail utility, which leverages libevdev and a few of our funkier API calls to try to make sense of the input translation shenanigans happening on Kobo.
If you intend to handle touch input in any way in your code, this should be a good place to look ;).
It also demonstrates how to deal effectively with pen input & drawing on the Elipsa.
Kindle support covers the full Kindle lineup, starting from the K2.
Kobo support covers the full Kobo lineup, starting from the Kobo Touch A/B/C (NOTE: some features are unavailable on sunxi SoCs, c.f., API docs).
If, instead of writing to the framebuffer, you want to grab a PNG snapshot of it (which can come in handy), I have a heavily modified version of FBGrab that should sanely deal with the various quirks of eInk framebuffers ;).
If you don't actually need a PNG file and just want to play with in-memory fb dumps, look into the whole
fbink_restore API calls.
So that everyone gets to have fun, even if you can't stand C!
Note that as the API may not be entirely stable on master, these are all tethered to a specific tag (generally, the latest release). You should honor that requirement, or all hell will break loose ;).
I generally attempt to keep breakages to a minimum, or barring that, make the upgrade paths as painless as possible, but, there you have it, supporting new stuff often means existing stuff has to work slightly differently.
I try to detail API/ABI breakages in each tag's comments, but a good way to visualize that is of course to diff the single public header (or, for a quick contextless overview, the minimal headers generated for FFI bindings) ;).