image-to-braille
utility to generate a braille text from an image
Installation
requirements:
npm:
npm install -g image-to-braille
Usage
$ image-to-braille image/lena.jpg
⣿⣿⣿⣿⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠉⢏⣹⣾⣻⣿⣿⣿⣿⣿⣻⣿⣻⣿⣿⢟⣿⡵⠋⠓⠅⡀⠀⠀⢹⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣧⡀⠀⠀⠀⠀⠀⠀⣠⠄⠉
⣿⣿⣿⣿⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀⠚⡭⠻⣭⣋⣿⡓⣽⣏⠋⠫⠊⡉⢛⢿⣽⠂⡏⠀⠋⠃⠀⠀⠀⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣷⡀⠀⠀⠀⢦⠟⠁⠀⠀
⣿⣿⣿⣿⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀⠘⠈⠨⡳⠋⢄⢛⢺⣀⣄⣠⣤⣄⣈⡘⠓⠀⣥⣄⠵⢊⠀⠀⠀⢻⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡄⠀⠘⠁⠀⠀⠀⠀
⣿⣿⠏⢹⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀⠀⠈⠁⠁⠤⠞⠐⣿⣿⣿⣿⣿⣿⣿⣿⣷⣦⣀⠂⠀⠀⠀⠀⠀⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⠂⠀⠀⠀⠀⠀⠀
⣿⠃⠀⢸⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⠰⠀⠀⠀⠘⠟⣾⣿⣿⣿⣿⣿⣿⣿⣿⣿⣷⣤⡀⠀⠀⠀⣾⣿⣿⡏⠙⣿⣿⣿⣿⣿⣿⣿⠟⠁⠀⠀⠀⠀⠀⠀⣠
⠃⠀⠀⢸⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀⢀⠀⠀⠀⠀⠀⣠⣼⣻⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣷⣄⠀⠀⢺⣿⣿⡇⠀⠈⢿⣿⣿⣿⡿⠃⠀⠀⠀⠀⠀⠀⢠⣾⣿
⠀⠀⠀⢸⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀⡆⠀⠀⠀⠀⣨⢾⢿⠿⢉⣭⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣷⡀⢸⣿⣿⡇⠀⠀⢀⣽⣿⣟⠁⠀⠀⠀⠀⠀⢀⣴⣿⣿⣿
⠀⠀⠀⢸⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⢸⠇⠀⠀⢀⠈⣡⠮⣃⣴⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣷⣼⣿⣿⢇⣠⣴⣿⣿⣿⣿⠀⠀⠀⠀⠀⢠⣾⣿⣿⣿⣿
⠀⠀⠀⢸⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⣾⣇⠀⠀⠀⠠⣠⣾⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡟⠀⠀⠀⠀⣠⣿⣿⣿⣿⣿⣿
⠀⠀⠀⢸⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⣿⣿⣃⠀⡠⣾⠟⣹⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡿⣿⠁⠀⠀⠀⣰⣿⣿⣿⣿⣿⣿⣿
⠀⠀⠀⣸⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⣿⣿⢿⣂⠈⣡⡾⢫⡾⣿⢟⢕⠀⠈⠻⠈⠉⠙⠉⢉⣿⣿⣿⣿⣿⣿⣿⣿⡿⠟⠋⣁⡼⠃⠀⠀⠀⣰⣿⣿⣿⣿⣿⣿⣿⣿
⠀⠀⠀⢼⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⢹⣿⣿⠣⠼⢋⠐⣩⠞⠃⠉⠀⠀⠀⠀⠀⠀⡠⣲⣿⣿⣿⣿⣿⣿⠟⠋⡉⣶⣶⡿⠋⠀⠀⠀⠀⢰⣿⣿⣿⣿⣿⣿⣿⣿⣿
⠀⠀⠀⢸⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀⢹⡿⠁⠀⣩⠔⠂⠀⠀⠀⠀⠀⠀⠀⡀⣹⣾⣿⣿⣿⣿⣿⣿⣿⣧⠀⠀⣾⠉⠀⠀⠀⠀⠀⢀⢣⣿⣿⣿⣿⣿⣿⣿⣿⣿
⠀⠀⠀⢸⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⠀⢘⡇⣀⠤⠀⠀⠀⠀⠀⠀⠀⠰⠀⣪⣾⡿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡆⠀⢸⠀⠀⠀⠀⠀⢀⣾⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
⠀⠀⠀⢸⣿⣿⣿⠀⠀⠀⠀⠀⠀⠀⣰⡆⢡⠍⠀⠀⠀⠀⠀⠀⠀⠀⢔⣼⣿⡿⢿⡭⡙⠛⢿⣿⣿⣿⡿⠟⡃⠀⠈⡆⠀⠀⠀⠀⣼⣾⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
⠀⠀⠀⢸⣿⣿⣿⠃⠀⠀⠀⠀⢰⣿⡟⠏⠀⠀⢀⠀⠀⠀⠀⠀⠀⢬⣿⡿⠋⠀⠀⢀⣦⠈⠻⣿⣿⢏⠀⣠⠀⠀⠀⡇⠀⠀⠀⢰⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
⠀⠀⠀⢸⣿⣿⣿⡇⠀⠀⠠⠴⠉⠁⠀⠈⠀⠀⠈⢀⠀⠀⠀⢀⣲⣿⠋⢰⣿⣷⣶⣿⣽⣿⣦⣾⣿⣷⣯⡁⠀⠀⠀⣧⠀⠀⠀⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
⠀⠀⠀⢸⣿⣿⣿⡇⢀⠀⡉⠁⠀⠀⢐⠀⠀⠀⠀⠀⡢⡀⢀⢲⡟⠁⠀⢼⣿⣿⣿⣿⣿⣿⡿⢸⣿⣿⣿⣟⠂⠀⠀⣿⠀⠀⣸⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
⠀⠀⠀⢸⣿⣿⣿⡇⠨⠈⠃⠀⠀⠈⡵⢁⠀⠀⠀⠊⠁⢠⣆⠏⠀⠀⠀⠘⣿⣿⣿⣿⣿⡏⡧⠜⣿⣿⣿⠋⠀⠀⠀⢸⡆⢀⣿⣿⣿⣿⣿⣿⣿⢿⣿⣿⣿⣿⣿⣿
⠀⠀⠀⢸⣿⣿⣿⡇⠀⠠⠀⠀⠈⠀⠀⢙⠀⠒⠀⣠⡔⠩⠋⠀⠀⠀⠀⢠⢽⣿⣿⣿⣿⣷⣶⣶⣾⣿⡿⠁⠀⠀⠀⠘⠄⣼⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿
⠀⠀⠀⢸⣿⣿⣿⣇⠔⡠⠀⠀⠀⢀⠀⠀⠈⢐⢷⢏⡔⠀⠀⠀⠀⠀⠀⠐⠹⣿⣿⣉⠛⣛⣋⣛⣛⡹⠃⠀⠀⠀⠀⠀⣧⣿⣿⣿⣿⣿⣿⣿⡏⣿⣿⣿⣿⣿⣿⣿
⠀⠀⠀⢸⣿⣿⣿⡇⠰⠀⠘⠀⠀⠼⢠⠀⠒⡿⡷⠋⠀⠀⠀⠀⠀⠀⠀⠀⠀⢘⣿⣿⣶⣥⣭⣽⡿⠁⠀⠀⠀⠀⠀⠀⣿⣿⣿⣿⣿⣿⣿⣿⠃⣿⣿⣿⣿⣿⣿⣿
⠀⠀⠀⢸⣿⣿⣿⠇⡠⠄⠀⠀⠀⠰⠀⠑⡬⡧⢄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⣈⣙⣿⣿⣿⣿⣁⠀⠀⠀⠀⠀⠀⠀⣿⠛⠿⠿⣿⣿⣿⡟⢰⣿⣿⣿⣿⡿⠟⠋
⣤⡀⠀⠀⣿⣿⣿⣇⠐⠀⠀⣀⠀⠀⠀⠰⠁⣠⡐⠑⠄⠀⠀⠀⠀⠀⠀⠀⠀⢀⢜⣿⣿⣿⣿⣿⣿⣿⣶⣤⡀⠀⠀⠀⣿⣾⣦⣤⣀⠀⠈⡁⢸⣿⣿⡿⠋⠀⠀⠀
⠘⣿⡆⠀⣿⣿⣿⣏⠀⠀⠀⠀⠀⠀⠈⠀⠀⠸⣋⡌⢰⠀⠀⠀⠀⠀⠀⠀⠀⡰⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣆⠀⢠⣿⣿⣿⣿⣿⡧⠄⣦⣿⣿⡿⠁⠀⠀⠀⠀
⠀⣻⡇⠀⣿⣿⣿⡷⠀⠀⠀⠀⠃⠀⠀⠀⠀⠀⢮⠗⣜⠀⠀⠀⠀⠀⠀⠀⠀⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡆⢸⣿⣿⣿⣿⣯⠓⣾⣿⣿⣿⠃⠀⠀⠀⠀⠀
⠀⢸⣿⠀⣿⣿⣿⣧⠀⠀⠀⠀⠀⠀⠀⠀⠀⠠⠀⠂⡀⠀⠀⠀⠀⠀⠐⠀⣸⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣷⣸⠿⢿⣿⣿⣧⣶⣿⣿⣿⠇⠀⠀⠀⠀⠀⠀
⠀⢸⣿⠀⣿⣿⣿⡏⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⡀⠀⠀⠀⠀⠀⠀⠀⠀⣰⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣇⠀⠀⠀⠉⠙⣻⣿⣿⡟⠀⠀⠀⠀⠀⠀⠀
⠀⠸⣿⡂⣿⣿⣿⡄⠀⠀⠀⠀⠀⠀⠀⠀⠀⠀⢀⠀⠀⠀⠀⠀⠀⠀⣀⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡀⠀⠀⠀⠀⢽⠟⠋⠀⠀⠀⠀⠀⠀⠀⠀
⠀⠀⣿⡇⣿⣿⣿⠅⠀⠀⠀⠀⠠⠀⠐⠀⡀⠀⠀⠀⠀⠀⠀⠀⠀⠐⠡⣞⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣇⠀⠀⠀⡀⢀⡠⠀⠀⠀⠀⢠⠀⠀⠀⠀
* The braille characters cannot display on Windows.
Options
$ image-to-braille --help
Usage: image-to-braille [options] path/to/image
-w, --width Number width(cols) of the converted text
-h, --height Number height(rows) of the converted text
-t, --threshold Number threshold for binarization - default: 128
-i, --invert invert to negative
-o, --output String write the converted text to this file
-p, --print print out the converted text
-v, --version show version
--help show help
API
convert(src: string|Buffer, opts: object): Promise<string>
src: string
path of the source image filesrc: Buffer
Buffer of the source imageopts: object
width
width(cols) of the converted text - default: 60height
height(rows) of the converted textthreshold
threshold for binarization - default: 128
Example
var imageToBraille = ; imageToBraille;
License
MIT