Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ern0/shrinkshot
✂ CLI tool for shrink images by removing empty regions (best use case: screenshot)
https://github.com/ern0/shrinkshot
concept image-processing imagemagick screenshot
Last synced: 3 months ago
JSON representation
✂ CLI tool for shrink images by removing empty regions (best use case: screenshot)
- Host: GitHub
- URL: https://github.com/ern0/shrinkshot
- Owner: ern0
- License: other
- Created: 2016-08-05T07:16:05.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-11-18T07:50:30.000Z (about 5 years ago)
- Last Synced: 2024-08-02T16:39:32.804Z (6 months ago)
- Topics: concept, image-processing, imagemagick, screenshot
- Language: C++
- Homepage:
- Size: 1.65 MB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- my-awesome-github-stars - ern0/shrinkshot - ✂ CLI tool for shrink images by removing empty regions (best use case: screenshot) (C++)
README
# ShrinkShot
A simple CLI tool to detect and cut out empty areas of an image (screenshot) in order to make it smaller without resizing its content.
## Features
The program simply scans for whole pixel columns and lines which are identical to their neigbours. These columns and lines can be cut out from the image, no information will be loss, but the image will be smaller and more compact.
The program itself only a CLI tool, which tries to detect empty areas in a specified PNG image, then calls - with a bunch of parameters - ImageMagick's `convert` utility, which is doing the actual job.
You may assign a hotkey to yout script, which makes a screenshot of a window, passing through it on shrinkshot, and saves it.
## Installation
To make it work, first, you should install ImageMagick:
- MacOS: `brew install imagemagick`
- Debian/Ubuntu Linux: `sudo apt-get install imagemagick`
- etc.
Also, don't forget to checkout the `upng` GIT submodule:
`git submodule update --init --recursive`
## Usage
```
$ shrinkshot screenshot.png result.png
```
To make it work, first, you should install ImageMagick:
- MacOS: `brew install imagemagick`
- Debian/Ubuntu Linux: `sudo apt install imagemagick`
- Windows: `choco install imagemagick`
Then you may pass the parameters to `convert` utility>
If any problem occurs, `shrinkshot` prints error messages to `stderr`.
## Build
### For Unix systems
Just start `compile.sh`. Requires GCC to be installed.
### For Windows
You can build Windows executable on both Windows and Unix systems
(not tested on Linux). All you have to do is install MinGW and
launch `compile-for-windows.sh` on Unix systems or `compile-on-windows.bat`
on Windows.
Also, you may use the executable provided in `bin/` directory.
## TODO
### Needs more test
- Only tested on sample images you can found in the `test/` directory
(converted images are also included).
- Not tested on Linux distros yet.
### Known issues to be fixed
- If you make a screenshot by marking the cut region by hand (sometimes called snipping tool), empty area detection may fail on the background image. A simple solution is just simply ignore 3-4 pixels on the borders, this hack will be applied soon.
- Noisy regions are not detected.
### Algorithm enhancements
It would be great to split the image to more regions
(e.g. horizontal stripes), and cut out (same width) areas from it
at different (horizontal) positions.
The most known use case of it is the status bar, which should be
cut separately:
This image has no columns to cut (only lines):
````
---------------------------
| content content |
| on left on the |
| right side |
| |
| |
| status |
---------------------------
````
But it should be:
````
----------------------
| content content |
| on left on the |
| right side |
| |
| |
| status |
---------------------
````
The "status" line occupies small vertical size,
so it's a good candidate to handle differently from the main area.
Empty areas marked with numbers (vertical only):
````
--------------------------- --
| content 111111 content | |
| on left 111111 on the | | large area
| 111111 right side | |
| 111111 | |
| 111111 | --
| 22222222 status 222222222 | | small area
--------------------------- --
````
The program should detect main area (primary target for shrinking),
and try to shrink same amout from smaller areas.
### Enhance distribution
ShrinkShot is now a CLI tool for. It should be turned to an easy-to-install solution for making shrinked screenshots with a hotkey.
I don't want to turn it to a boxed software with printed manual, but the distribution should be more user-friendly:
- Linux: provide a shell script, which can be assigned to a hotkey. Probably release it as a `.deb` package.
- MacOS: have no idea.
- Windows: have no idea.
## Credits
The idea and some sample images come from a question issued by *@Thomas* on the Software Recommendation (StackExchange) site.
The actual conversation is done by **ImageMagick**.
ShrinkShot is using **UPNG** library to load and parse PNG files. It's included in the repository as a GIT submodule.
## Copyright
Use it as you want. I'll be happy if you integrate it and mention it in the credits.