Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mgjules/batimag
Batch image processing done simply.
https://github.com/mgjules/batimag
cli golang image-processing
Last synced: 11 days ago
JSON representation
Batch image processing done simply.
- Host: GitHub
- URL: https://github.com/mgjules/batimag
- Owner: mgjules
- License: apache-2.0
- Created: 2023-02-13T12:26:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-04T00:53:41.000Z (11 months ago)
- Last Synced: 2024-06-21T12:58:59.875Z (5 months ago)
- Topics: cli, golang, image-processing
- Language: Go
- Homepage:
- Size: 118 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# batimag
[](https://godoc.org/github.com/mgjules/batimag)
[](LICENSE)
Batimag is short for Batch Imager which applies basic image processing functions to a batch of images in a specific directory recursively.
JPG/JPEG, GIF, PNG, TIF/TIFF, BMP and WEBP images are supported.
## Installation
### From Source (recommended)
```shell
go install github.com/mgjules/[email protected]
```
### From Binary
Download the corresponding binary for your operating system and architecture from the [releases](https://github.com/mgjules/batimag/releases) page and place it in a `$PATH` directory.
## Usage
```shell
❯ batimag
NAME:
batimag - Batch Image Processor!
USAGE:
batimag [global options] command [command options] [arguments...]
DESCRIPTION:
Batimag applies a set of image processing functions to images in a given directory recursively.
AUTHOR:
Michaël Giovanni Jules
COMMANDS:
process Process some images!
version, v Shows the version
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help, -h show help
COPYRIGHT:
(c) 2023 Michaël Giovanni Jules
```
```shell
❯ batimag help process
NAME:
batimag process - Process some images!
USAGE:
batimag process [command options] [arguments...]
OPTIONS:
--debug run in debug mode (default: false)
--clean remove images in output directory (default: false)
--config-path value path to config file (default: config.yml)
--help, -h show help
```
### Example usage
Run batimag using the default configuration file `config.yml`.
```shell
batimag process --clean --debug
```
## Configuration
Example configuration (see [config.example.yml](config.example.yml)):
```yaml
input_dir: "./samples/input"
output_dir: "./samples/output"
resize:
# Desired width in pixels.
# Zero value will resize image proportionally to height.
# Default value: 0.
width: 100
# Desired height in pixels.
# Zero value will resize image proportionally to width.
# Default value: 0.
height: 50
# Whether to upscale.
# Default value: false.
upscale: true
# Resize type.
# Accepted values: Normal, Thumbnail, Fit and Fill.
# Default value: Normal.
type: Normal
# Resize resampling filter.
# Accepted values: Lanczos, CatmullRom, MitchellNetravali, Linear, Box and NearestNeighbor.
# Default value: Lanczos.
filter: Lanczos
# Anchor is used for image alignment when using Resize Type 'Fill'.
# Accepted values: Center, TopLeft, Top, TopRight, Left, Right, BottomLeft, Bottom and BottomRight.
# Default value: Center.
anchor: Center
transform:
# Automatically fix orientation after processing.
# Default value: false.
auto_orientation: true
# Rotate clockwise by certain angle in degrees.
# Accepted values: 0 90 180 270.
# Default value: 0.
rotate: 90
# Flip on a certain axis.
# Accepted values: Vertical and Horizontal.
# Default value: None.
flip: Vertical
effect:
# Strength of the gaussian blur effect.
# Accepted values: 0.0 to 5.0.
# Default value: 0.
gaussian_blur: 2.0
# Strength of the sharpening effect.
# Accepted values: 0.0 to 5.0.
# Default value: 0.
sharpen: 1.0
adjust:
# Gamma correction.
# Accepted values: 0.0 to 5.0.
# Values less that 1.0 are darker while values greater than 1.0 are lighter.
# Default value: 0.
gamma: 0.5
# Percentage value.
# Accepted values: -100 to 100.
# Negative values are grayer.
# Default value: 0.
contrast: 50
# Percentage value.
# Accepted values: -100 to 100.
# Lower negative values are darker while higher positive values are lighter.
# Default value: 0.
brightness: 50
# Percentage value.
# Accepted values: -100 to 100.
# Negative values decrease image saturation while positive values increase image saturation.
# Default value: 0.
saturation: 50
# Grayscale version.
# Default value: false.
grayscale: true
```
## Credits
- [github.com/disintegration/imaging](https://github.com/disintegration/imaging) - Image processing functions.
- [github.com/chai2010/webp](https://github.com/chai2010/webp) - Webp support.
- [github.com/sourcegraph/conc](https://github.com/sourcegraph/conc) - Concurrency made easy.
- [github.com/mcuadros/go-defaults](https://github.com/mcuadros/go-defaults) - Struct default values.
- [github.com/go-playground/validator/v10](https://github.com/go-playground/validator) - Struct validation.
- [github.com/urfave/cli/v2](https://github.com/urfave/cli) - CLI.
## Stability
This project follows [SemVer](http://semver.org/) strictly and is not yet `v1`.
Breaking changes might be introduced until `v1` is released.
This project follows the [Go Release Policy](https://golang.org/doc/devel/release.html#policy). Each major version of Go is supported until there are two newer major releases.