Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/liny18/image-to-ascii
🖼️ A command-line tool for converting images to ASCII art
https://github.com/liny18/image-to-ascii
ascii ascii-art cli command-line cpp cuda docker image-processing image-to-ascii mpi opencv terminal
Last synced: about 2 months ago
JSON representation
🖼️ A command-line tool for converting images to ASCII art
- Host: GitHub
- URL: https://github.com/liny18/image-to-ascii
- Owner: liny18
- License: mit
- Created: 2024-04-19T02:28:28.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-08-29T05:58:39.000Z (5 months ago)
- Last Synced: 2024-08-29T06:51:18.042Z (5 months ago)
- Topics: ascii, ascii-art, cli, command-line, cpp, cuda, docker, image-processing, image-to-ascii, mpi, opencv, terminal
- Language: C++
- Homepage:
- Size: 10.1 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Image to ASCII Converter
Transform your images into ASCII art. Leveraging MPI and optional CUDA support, this application executes parallel processing to ensure both speed and efficiency in image conversion.
## Examples :eyes:
| Input | Output |
|-----------------------------------------------|------------------------------------------------------------------------|
| 
| 
|
| command: | `mpirun -np 4 ./out -i images/cpp.png -c -w 150` |
| 
| 
|
| command: | `mpirun -np 4 ./out -i images/hwoarang.png -c -w 150` |
| 
| 
|
| command: | `mpirun -np 4 ./out -i images/pikachu.png -c -w 150` |
| 
| 
|
| command: | `mpirun -np 4 ./out -i images/miffy.png -c -w 150` |
## Installation
If you do not have Docker installed, install at [Docker🐳](https://docs.docker.com/engine/install/)
## Usage :clipboard:
### Pull the Docker Image
- For systems with CUDA support (ensure your environment is CUDA-capable):
```shell
docker pull yuxlin21/image-to-ascii:cuda
```
- For systems without CUDA support:
```shell
docker pull yuxlin21/image-to-ascii:latest
```
### Preparing Your Images
1. Create an Image Directory:
Create a directory on your host machine to store the images you want to convert.
```shell
mkdir images
```
2. Add Images:
Place the images you want to convert into this directory.
### Running The Application
- Template for running
```shell
docker run -v "$(pwd)"/outputs:/app/outputs -v "$(pwd)"/images:/app/images -it yuxlin21/image-to-ascii:[latest/cuda] '[COMMAND]'
```
- ${PWD} if using PowerShell
- Choose either latest or cuda depending on your image for [latest/cuda]
- Replace '[COMMAND]' with these options:
```
Command: 'mpirun -np (number of processes) ./out [Options]'
Options:
-h, --help Display this help message
-i, --input Specify the path of the input image filepath (required)
-o, --output Specify the name of the output file name (e.g. image)
-w, --width Set the width of the ASCII output; maintains aspect ratio
-s, --chars Define the set of characters used in the ASCII output
-p, --print Print the ASCII output to the console
-n, --negate Create a negative ASCII art
-f, --factor Set the scale factor from 0.1 to 1.0 (default) to resize the image
-c, --color Get ASCII PNGs in colors
-t, --threads Set the number of threads to use, default is 256
```
- Example
```shell
docker run -v "$(pwd)"/outputs:/app/outputs -v "$(pwd)"/images:/app/images -it yuxlin21/image-to-ascii:latest 'mpirun -np 1 ./out -i images/hwoarang.png -w 90 -c -p'
```
Note:
When running with CUDA, OpenCV generates many warnings, but they do not affect the usability of the program, safely ignore.