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 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
|
jp2a
====

jp2a is a simple JPEG/PNG/WebP to ASCII converter.
The source is available at <https://github.com/Talinx/jp2a>. This project
used to be hosted on SourceForge.
License
-------
Copyright 2006-2016 Christian Stigen Larsen and 2020-2024 Christoph Raitzig
Distributed under the GNU General Public License v2.
You can read the full license in the file COPYING. jp2a also uses other
libraries. These licenses can be found in the file LICENSES.
Example: Oswald the lucky rabbit
--------------------------------
......
.:lOKMMMMMMMMMM0l
.;dOMMMMMMMMMMMMMMMMMMW.
.ckWMMMMMMMMMMMMMMMMMMMMMMMO
.dXMMMMMMMMMMMMMMMMMMMMMMMMMMO
.xWMMMMMMMMMMMMMMMMMMMMMMMMMMO:.
lXMMMMMMMMMMMMMMMMMMMMMWOOxc'
.;lxOOOOOxdl:. cMMMMMMMMMMMMMMMMWKklc'..
'llc.. ..:oMMMMMMKxNMMMMMMMMMM0kl:'.
:0' cMMMMMMMMMMMMWd'.
.K:l0 .MMMMMMMMMMl.
,K W ,MMMMMMMMMMMMN0dl'
M. M MMMMMMMMMMMMMMMMMMKx:.
cMMK WMMMMMMMMMMMMMMMMMMMMMXd'
NMMM: MMMMMMMMMMMXWMMMMMMMMMMMMNd'
KMMMW MMMMMMMMMMM' ;XMMMMMMMMMMMMMWd'
MMMM XMMMMMMMMMMM dMMMMMMMMMMMMMMMNc
'' NMKWl' .KMMMMMMMMMMM' :MMMMMMMMMMMMMMMMMd
KMWMKOk ' ,lXMMMMMMMMMMM; .KMMMMMMMMMMMMMMMM0
KMMMMM. .cOMMMMMW' kMMMMMMMMMMMMMMMMX
cOXMNXl. ...... .MWd. .0cc:' .NMMMMMMMMMMMMMMMk
.cololoxKWWWXWMMMMMMM: M c:. .l0ok oMMMMMMMMMMMMMMM
.'Mo,MMMMNk:lO' :l .OMMMMl .OMMMMMMMMMMMMN
X0'OkxkxOK;. :: ,.XMMMMMMO :O lXMMMMMMMMk
kc,,o0M0.:;c'N ko;lMMMMMM:'xMMMNWKO,.clxdl:.
;00xkM:d , .. oMMMMMM cMMMMMMMMl
c N0l . .l:;;oKMMk MMMMMMMMM0
O ,.ocOc..l..k' .:c;'O 0MMMMMMMX.
X N..l .c K. OMMMMMMM
.' c. : M . OMMM0,.;
:, N.;W ; O...o .,.
d M ;X' :l :
d..':. lcKol,,,,'.:c,,'.cd;'o,'.
. ;:,WMMMMMMXx,; M0XXNNWM.
MMMMMMMM .MMMMMMMM
MMMMMMMM .MMMMMMMM.
:ONMMMMMM0:':MMMMMMMMM:
;c:,'',::lX' '','' .MMMMMMMMMMWK:c:
x. .lloc;.',lxl..lKMMMMMKl M
0 .;,;'......;::c' .. ;dl;l'
;O: .d' .lkk::::;, 'k
N.'oc'. M : X
lo:. ',::xN: .x0'
.,lccccM .ll,. . ;;:::;c'.0
.kl. .c::lcccccc:cc::; .''clccl.
'lcl:lc::,,'::cc:cc:c,..
The Oswald character is Copyright Walt Disney, and, unfortunately, not in the
public domain. However, I believe that I can use this picture under the fair
use clause, for demonstrational purposes, especially in low-resolution, ASCII
format. If I am wrong, I will promptly remove it.
Installation
------------
Look in your system's package manager. I don't maintain Windows binaries
anymore.
Graphical UI
------------
[Letterpress](https://apps.gnome.org/Letterpress/) is a graphical user interface
for jp2a. Letterpress can be installed from
[Flathub](https://flathub.org/apps/io.gitlab.gregorni.Letterpress).
Docker
------
You can run jp2a using [Docker](https://www.docker.com/):
```
docker run -t --rm -e COLORTERM="$COLORTERM" -v "$(pwd)":/app talinx/jp2a [options] <filenames or URLs>
```
See [hub.docker.com/r/talinx/jp2a](https://hub.docker.com/r/talinx/jp2a) for details.
Building
--------
`jp2a` can be compiled as usual: `./configure && make && make install`
If you want to compile after cloning the git repo (i.e. generate the `configure` script yourself), you need autotools, automake and optionally autoconf-archive. You may need to specify the path to jpeglib. I usually just do
autoreconf -vi
./configure --with-jpeg-prefix=/usr/local \
--with-curl-config=`which curl-config`
make -j
Before installing, you may want to check that jp2a works by running `src/jp2a`
on some `.jpg` and `.png` files. You can also use `make check`. When you're ready to install,
make -j install
Extract the archive and follow the instructions inside 'install.txt' to build and
install it. For a default install, the corresponding `.so` (shared object) files
will be present in `/usr/local/lib/`
Next, run the command `ldconfig` (escalated privileges may be required) to configure dynamic linker run-time bindings. See
its man page for more details. The configure command should work after that.
If configure can't automatically find jpeglib, specify with
./configure --with-jpeg-include=PATH --with-jpeg-lib=PATH
or you can just type the prefix
./configure --with-jpeg-prefix=/usr/local/
You can also compile jp2a with libcurl, so it can automatically download images
from the net:
./configure --enable-curl
This will look for `curl-config` in $PATH, but you can specify it directly with
`--with-curl-config=PATH` if you need to.
### Documentation
jp2a is documented with [doxygen](https://www.doxygen.nl/). To build the documentation you need doxygen installed. It can then be built with:
autoreconf -vi
./configure
make doc
This will create HTML and LaTeX documentation in the doxygen-doc folder.
### Runtime dependencies
- [jpeglib](https://www.ijg.org/) or [libjpeg-turbo](https://libjpeg-turbo.org/)
- [libpng](http://libpng.org/pub/png/libpng.html)
- [libwebp](https://developers.google.com/speed/webp/)
- [curl](https://curl.haxx.se/) (optional)
- [ncurses](https://invisible-island.net/ncurses/ncurses.html) (optional)
- [libexif](https://libexif.github.io/)
### Build dependencies
- make (e.g. [GNU Make](https://www.gnu.org/software/make/))
- a C compiler like [gcc](https://gcc.gnu.org/)
If you generate the `configure` script yourself (i.e. run `autoreconf`) you also need these:
- autotools
- [automake](https://www.gnu.org/software/automake/)
- [autoconf](https://www.gnu.org/software/autoconf/autoconf.html)
- (optional, only required for building documentation) [autoconf-archive](https://www.gnu.org/software/autoconf-archive/)
Windows
-------
### Cross compiling
You can cross compile.
### WSL
You can use the Windows Subsystem for Linux.
### Compile with `configure`
The `configure` script requires a Bourne shell, so you got to install one (e.g. Bash).
The easiest way is to install [Cygwin](https://cygwin.com/). Make sure to install the used libraries (curl, jpeglib, libpng, ncurses) as well as gcc and make.
Open Cygwin and proceed as usual: `./configure && make && make install`
You can also "cross compile" with Cygwin so that you get a binary that does not depend on Cygwin.
### Compile without `configure`
You need a working jpeglib for Windows and set up include paths yourself.
You will need to manually type out a `config.h` file. Example:
WIN32
NDEBUG
_CONSOLE
PACKAGE_STRING=\"jp2a x.x.x-win32\"
PACKAGE_BUGREPORT=\"chris-r@posteo.net\"
HAVE_STRING_H
HAVE_STDLIB_H
FEAT_CURL
HAVE_CURL_CURL_H
CURL_STATICLIB
FEAT_TERMLIB
You need to add jpeg.lib to the linker. If you want libcurl support, you need
that as well. It should be available from https://curl.haxx.se
|