img2text 0.2.0

Image-to-text converter
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

# `img2text`

<a href="https://crates.io/crates/img2text"><img src="https://img.shields.io/crates/v/img2text?style=for-the-badge"></a>

## `img2text` on Terminal

```
img2text

Image-to-text converter

                 ⠀⠀⠀⠀⠀⠀⠀⢠⣄⣠⣶⣤⣿⣤⣶⣄⣠⡄⠀⠀⠀⠀⠀⠀⠀
                 ⠀⠀⠀⠀⣄⣸⣿⣾⡿⠿⠛⢿⣀⡿⠛⠿⢿⣷⣿⣇⣠⠀⠀⠀⠀
                 ⠀⠀⢠⣤⣿⣿⣛⣁⣀⣀⣀⣀⣉⣀⣀⣀⡀⠈⠛⢿⣿⣤⡄⠀⠀
                 ⠀⠲⣾⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣷⡄⠈⣿⣿⣷⠖⠀
                 ⠐⢾⣿⣤⠼⠇⢸⣿⣿⣿⣇⣀⣀⣀⣹⣿⣿⣿⠇⠸⢧⣤⣿⡷⠂
    powered by:  ⠰⢿⣿⡇⠀⠀⢸⣿⣿⣿⡿⠿⠿⢿⣿⣿⣿⣦⠀⠀⢀⣸⣿⡿⠆
                 ⠐⠿⣿⣷⣤⣤⣼⣿⣿⣿⣧⣤⣄⠀⢻⣿⣿⣿⣦⣤⣾⣿⣿⠿⠂
                 ⠀⠚⢿⣿⣿⡿⠿⠿⠿⠿⠿⠿⠿⠀⠈⠻⠿⠿⠿⢿⣿⣿⡿⠓⠀
                 ⠀⠀⠘⠛⣿⣿⡟⢻⡆⠀⠀⠀⠀⠀⠀⠀⣸⠛⢳⣿⣿⠛⠃⠀⠀
                 ⠀⠀⠀⠀⠉⢹⡿⢿⣿⣷⣶⣶⣶⣶⣶⣾⣿⡿⢿⡏⠉⠀⠀⠀⠀
                 ⠀⠀⠀⠀⠀⠀⠀⠈⠉⠘⠟⠙⠿⠋⠻⠃⠉⠁⠀⠀⠀⠀⠀⠀⠀

(The above image was generated by this program with an option `-s 25`.)

USAGE:
    img2text [OPTIONS] <FILE>

ARGS:
    <FILE>
            The image to process

FLAGS:
    -d, --dither
            Apply dithering to preserve the gray shades. Incompatible with `-i
            edge-canny`

    -h, --help
            Prints help information

    -V, --version
            Prints version information


OPTIONS:
    -w <cell-width>
            The width of output characters, only used when `-s` is given without
            `!` [default: 0.45]

        --dither-contrast <dither-contrast>
            Choose the contrast enhancing technique to use for dithering
            [default: median-quant] [possible values: none, median-quant,
            equalize]

        --canny-high-threshold <edge-canny-high-threshold>
            A parameter for the Canny edge detector (`-i edge-canny`).

            Edges with a strength higher than the high threshold will always
            appear as edges in the output image. [default: 20]

        --canny-low-threshold <edge-canny-low-threshold>
            A parameter for the Canny edge detector (`-i edge-canny`).

            Edges with a strength higher than the low threshold will appear in
            the output image if there are strong edges nearby. [default: 10]

    -i <input-ty>
            Specifies how to interpret the input image [default: auto] [possible
            values: auto, wob, bow, edge-canny]

    -s <out-size>
            The output size, measured in character cells or percents (e.g.,
            `80`, `80x40`, `80x40!`, `-80x40`, `100%`). [default: downscale to
            terminal size (if the output is a terminal) or 100% (otherwise)]

            - 80: Fit within 80x80 character cells

            - 80x40: Fit within 80x40 character cells, upscaling as necessary

            - -80x40: Fit within 80x40 character cells, only downscaling

            - 80x40!: Fit to 80x40 character cells, not maintaining the aspect
            ratio

            - 150%: Scale by 150%. The actual output size depends on the glyph
            set being used; for example, `2x3` maps each 2x3 block to one
            character.

    -g <style>
            The glyph set to use [default: braille] [possible values: slc, 
            ms2x3, 1x1, 1x2, 2x2, 2x3, braille]
```

### Installing

First, make sure [rustup](https://www.rust-lang.org/tools/install) or Rust 1.49.0 or later is installed. Then run the following command:

```
cargo install img2text
```

This will compile and install `img2text` the CLI app to `~/.cargo/bin` or somewhere else in your system.

### Recommended Font

[Fairfax HD](http://www.kreativekorp.com/software/fonts/fairfaxhd.shtml) can display all characters (particularly [Symbols for Legacy Computing]) generated by this program.

[Symbols for Legacy Computing]: https://en.wikipedia.org/wiki/Symbols_for_Legacy_Computing

## `img2text` on Web

<https://img2text.yvt.jp> is a single-page static website.

### Developing

Prerequisites:

 - [`wasm-pack`](https://crates.io/crates/wasm-pack)
 - [`cargo-license`](https://crates.io/crates/cargo-license)
 - [`extrude-licenses`](https://crates.io/crates/extrude-licenses)
 - [Binaryen](https://github.com/WebAssembly/binaryen)
 - [rustup](https://www.rust-lang.org/tools/install)
 - [lessc](http://lesscss.org)
 - [FontTools](https://github.com/fonttools/fonttools)
 - ... or just use [Nix](https://nixos.org) and run `nix develop` to install all of them
 - (*Optional*) [`cargo-watch`](https://crates.io/crates/cargo-watch)

```shell
cd web
make
python -m http.server
```

To continuously rebuild:

```shell
cd web/static
python -m http.server &
cd ..
cargo watch -s make -i static
```

## `img2text` in Your App

Add the following to your app's `Cargo.toml` file:

```toml
[dependencies]
img2text = { version = "0.1.0", default-features = false }
```