sic image cli
Enables you to perform operations on images and convert images to a variety of image formats. 'sic' or 'sic image cli' is a (partial) image crate cli front-end.
The image conversion and operations are performed by the awesome image crate :balloon:. It was initially created to try out another awesome Rust library: clap :tada:.
Install
Install with cargo: cargo install sic
Update with cargo: cargo install --force sic
Pre build binary: see releases.
From the source:
- Setup rust and cargo with (for example) rustup Rust version >= 1.31 with 'Rust edition 2018' is required.
- Clone this repo:
git clone https://github.com/foresterre/sic.git - Switch to this repo:
cd sic - Build a release:
cargo build --release
Usage
Convert an image from one format to another, for example from PNG to JPG.
- In general:
sic <input> <output> - Example:
sic input.png output.jpg
Covert an image from one format to another while not caring about the output file extension.
- In general
sic --output-format "<format>" <input> <output>(orsic -f "<format>" <input> <output>) - Example
sic --output-format png input.bmp output.jpg(Note:output.jpgwill have the PNG format even though the extension isjpg.)
Supported image output formats are (as of 0.8.0): bmp, gif, ico, jpg (or jpeg), png, pbm, pgm, ppm and pam.
The JPEG quality can optionally be set with --jpeg-encoding-quality <value> (value should be an integer from 1 up to (including) 100). Default value if not user overridden is 80.
PNM (PBM, PGM, PPM) by default uses binary encoding (PNM P4, P5 and P6 respectively). To use ascii encoding, provide the following flag:
--pnm-encoding-ascii.
Apply image operations to an image.
- In general:
sic --apply-operations "<operations>" <input> <output>(shorthand:-Xor-A) - Example
sic input.png output.jpg --apply-operations "fliph; blur 10; resize 250 250"
When more than one image operation is provided, the separator ; should be used
between each operation.
The available image operations are:
| operations | syntax | available (from version) | description |
|---|---|---|---|
| blur | blur <uint> |
Yes (0.5.0) | Performs a Gaussian blur on the image (more info). |
| brighten | brighten <int> |
Yes (0.7.0) | |
| contrast | contrast <fp> |
Yes (0.7.0) | |
| crop | crop <int> <int> <int> <int> |
Yes (0.9.0) | Syntax: crop <lx> <ly> <rx> <ry>, where lx is top left corner x coordinate starting at 0, ly is the top left corner y coordinate starting at 0, rx is the bottom right corner x coordinate and ry is the bottom right corner y coordinate. rx and ry should be larger than lx and ly respectively. |
| filter3x3 | filter3x3 <args9> |
Yes (0.7.0) | |
| flip horizontal | fliph |
Yes (0.5.0) | Flips the image on the horizontal axis. |
| flip vertical | flipv |
Yes (0.5.0) | Flips the image on the vertical axis. |
| gray scale | grayscale |
Yes (0.7.0) | |
| hue rotate | huerotate <int> |
Yes (0.7.0) | Rotate's the hue, argument is in degrees. Rotates <int>%360 degrees. |
| invert | invert |
Yes (0.7.0) | |
| resize | resize <uint> <uint> |
Yes (0.5.0) | Resize the image using a selecteds sampling filter, which defaults to the Gaussian sampling filter. Use |
| > | set resize preserve_aspect_ratio |
Yes (0.9.0) | Enables preservation of the aspect ratio. |
| > | set resize sampling_filter <value> |
Yes (0.9.0) | Valid <value> choices are catmullrom, gaussian,lanczos3,nearest,triangle. |
| rotate90 | rotate90 |
Yes (0.7.0) | |
| rotate180 | rotate180 |
Yes (0.7.0) | |
| rotate270 | rotate270 |
Yes (0.7.0) | |
| unsharpen | unsharpen <fp> <int> |
Yes (0.7.0) |
For some operations, their behaviour can be (slightly) changed by choosing and enabling an option. These options can be overwritten and they can also be disabled.
| environment operation | syntax | available (from version) | description |
|---|---|---|---|
| set environment option | set <operation> <option-of-operation> [<args 0..n>] |
Yes (0.9.0) | Enables the use of an option by an operation. Any operation which looks at this option will use the selected option value instead of the default value. Can be overwritten by calling set again for the same operation and option. |
| unset environment option | del <operation> <option-of-operation> |
Yes (0.9.0) | Disables the use of an option by an operation. Any operation which looks at this option will use the default value instead. |
legend:
<uint> means any 32 bit unsigned integer is required as parameter input.
<int> means any 32 bit signed integer is required as parameter input.
<fp> means any 32 bit floating point number is required as parameter input.
<value> means a pre defined value.
<args9> means `<fp> <fp> <fp> <fp> <fp> <fp> <fp> <fp> <fp>`.
Syntax examples: For each example: each of the lines are valid syntactically and the full examples are valid syntactically as well.
blur example:
blur 10;
brighten example:
brighten 10;
brighten -10;
contrast example:
contrast -10;
contrast 10;
contrast 1.35;
crop example:
crop 0 0 100 100;
crop 25 50 45 65;
filter3x3 example:
filter3x3 10.0 9.0 8.0 | 7.5 6.5 5.5 | 4 3 2;
filter3x3 10.0 9.0 8.0 7.5 6.5 5.5 4 3 2;
filter3x3 12.0 29.0 28 27.5 26 25.5 14 3 2
flip horizontal example:
fliph;
flip vertical example:
flipv;
gray scale example:
grayscale;
hue rotate example:
huerotate 10;
huerotate -10;
invert example:
invert;
resize example:
resize 10 10;
resize 1 1;
resize 80 180;
rotate 90 degree example:
rotate90;
rotate 180 degree example:
rotate180;
rotate 270 degree example:
rotate270;
unsharpen example:
unsharpen -12.3 -12;
unsharpen -10.0 12;
unsharpen 12.3 1;
unsharpen 10 1;
User manual
For additional information on available options and flags, run sic --help.
Additional information on the available image operations can be found by running sic --user-manual <topic> (or sic -H <topic>).
Available topics can be listed by running sic --user-manual index.
The provided help pages in this command line accessible user manual are still a bit minimal. Additionally only the image operations are available and the layout is sub optimal for a command line. This is definitely something which is planned to be addressed in an upcoming release.
Suggestions, Questions, Bugs
Feel free to open an issue :mailbox_with_mail: if you have a suggestion, a question or found a bug =).
:guitar: :trumpet: :violin: :saxophone: