sic image cli

Convert images and perform image operations from the command-line.

sic (sic image cli) is a front-end for the image crate. Aside from image operations supplied by the image crate, a few additional helpful operations such as diff, are available. We intend to also support various operations provided by the imageproc crate in a future release.

Installation

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 (for example using rustup) Current MSRV: 1.35 (edition 2018 is required); we aim to always develop against the latest stable release.
• 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 images

Convert an image from one format to another, for example from PNG to JPG.

• Command: sic --input <input> --output <output>
• Shorthand: sic -i <input> -o <output>
• Example: sic -i input.png -o output.jpg

If you want to explicitly set the image output format, you may do so by providing the --output-format <format> argument. Otherwise, sic will attempt to infer the format from the output file extension.

--help can be used to view a complete list of supported image output formats. Included are: bmp, farbfeld, gif, ico, jpg (jpeg), png, pam, pbm, pgm and ppm. The JPEG quality can optionally be set with --jpeg-encoding-quality <value>. The value should be in the range 1-100 (with default 80). The PNM format (specifically PBM, PGM and PPM) use binary encoding (PNM P4, P5 and P6 respectively) by default. To use ascii encoding, provide the following flag: --pnm-encoding-ascii.

Convert or apply operations on a set of images

For the use case where you have a directory several (hundred) images which you like to convert to different format, or perhaps image operations on a subset, sic provides built-in glob pattern matching. This mode has to be activated separately using the --mode glob option (as opposed to the single input, single output simple mode).

Examples:

• To convert a directory of images from PNG to JPG, you can run sic with the following arguments:
  • sic --mode glob -i "*.png" -o output_dir --output-format jpg"
• To convert all images with the jpg, jpeg and png extensions to BMP:
  • sic --mode glob -i "*.{jpg, jpeg, png}" -o output_dir --output-format bmp
• To emboss all images in a folder (assuming it contains only supported image files and no folders):
  • sic --mode glob -i "*" -o embossed_output -f png --filter3x3 -1 -1 0 -1 1 1 0 1 1

A few things worth noticing: 1) We use quotation marks (") around the input argument, so our shell won't expand the glob pattern to a list of files. 2) When using glob mode, our output (-o) should be a folder instead of a file. 3) We need to explicitly state the output format with --output-format, since we can't infer it from an output extension.

Output images are placed in the output folder using the directory structure mirrored from the first common directory of all input files. If output directories do not exist, they will be created.

Apply image operations

There are two methods to apply image operations. You can only use one at a time.

The first method is called the script operations method (or: script), and the second method is called the cli operations method (or cli ops).

The operations are applied in the same order as they are provided (left-to-right) and are generally not commutative.

📜 script operations method

Use this method by using the --apply-operations "<operations>" (shorthand: -x) cli argument and providing statements which tell sic what operations should be applied on the image, for example: sic -i input.jpg -o output.jpg --apply-operations "fliph; blur 10; resize 250 250" When more than one image operation is provided, the separator ; should be used to separate each operation statement.

✏️ cli operations method

Use this method by providing cli image operation arguments, such as --blur and --crop, directly.
If we use the cli operations method the previously shown example becomes: sic -i input.png -o output.jpg --flip-horizontal --blur 10 --resize 250 250

Supported operations

* The exact syntax applies to the --apply-operations method, but can also be used as a reference for the image operations as cli arguments method.

For some operations, their behaviour can be adapted by setting an operation modifier. These modifiers can be overwritten and they can also be reset (to their default behaviour).

legend:

<uint> means any 32 bit unsigned integer is required as argument.
<int> means any 32 bit signed integer is required as argument.
<fp> means any 32 bit floating point number is required as argument.
<value> means a pre defined value. 
<args9> means `<fp> <fp> <fp> <fp> <fp> <fp> <fp> <fp> <fp>`.
<path> means a qualified path to, for example, an image, surrounded by quotation marks (`"`).

Image operation example usage:

blur example: sic -i in.png -o out.png --apply-operations "blur 1.3;" or sic -i in.png -o out.png --blur 1.3

brighten example: sic -i in.png -o out.png --apply-operations "brighten 2;" or sic -i in.png -o out.png --brighten 2

contrast example: sic -i in.png -o out.png --apply-operations "contrast 0.7;" or sic -i in.png -o out.png --contrast 0.7

crop example: sic -i in.png -o out.png --apply-operations "crop 0 0 10 10;" or sic -i in.png -o out.png --crop 0 0 10 10

diff example: sic -i a.png -o diff_between_a_and_b.png --apply-operations "diff 'b.png'" or sic -i a.png -o diff_between_a_and_b.png --diff b.png

a	b	output

filter3x3 example: sic -i in.png -o out.png --apply-operations "filter3x3 -1 -1 0 -1 0 1 0 1 1" or sic -i in.png -o out.png --filter3x3 -1 -1 0 -1 0 1 0 1 1

flip horizontal example: sic -i in.png -o out.png --apply-operations "fliph" or sic -i in.png -o out.png --flip-horizontal

flip vertical example: sic -i in.png -o out.png --apply-operations "flipv" or sic -i in.png -o out.png --flip-vertical

gray scale example: sic -i in.png -o out.png --apply-operations "grayscale" or sic -i in.png -o out.png --grayscale

hue rotate example: sic -i in.png -o out.png --apply-operations "huerotate -90" or sic -i in.png -o out.png --hue-rotate -90

invert example: sic -i in.png -o out.png --apply-operations "invert" or sic -i in.png -o out.png --invert

resize example: sic -i in.png -o out.png --apply-operations "resize 100 100" or sic -i in.png -o out.png --resize 100 100

resize with preserve aspect ratio example: sic -i in.png -o out.png --apply-operations "set resize preserve_aspect_ratio; resize 100 100" or sic -i in.png -o out.png --set-resize-preserve-aspect-ratio true --resize 100 100

resize with custom sampling filter (default is 'gaussian') example: sic -i in.png -o out.png --apply-operations "set resize sampling_filter triangle; resize 100 100" or sic -i in.png -o out.png --set-resize-sampling-filter triangle --resize 100 100

rotate 90 degree example: sic -i in.png -o out.png --apply-operations "rotate90" or sic -i in.png -o out.png --rotate90

rotate 180 degree example: sic -i in.png -o out.png --apply-operations "rotate180" or sic -i in.png -o out.png --rotate180

rotate 270 degree example: sic -i in.png -o out.png --apply-operations "rotate270" or sic -i in.png -o out.png --rotate270

unsharpen example: sic -i in.png -o out.png --apply-operations "unsharpen -0.7 1" or sic -i in.png -o out.png --unsharpen -0.7 1

example with multiple image operations which are applied from left-to-right: sic -i in.png -o out.png --apply-operations "rotate180; fliph; set resize sampling_filter nearest; resize 75 80; huerotate 75" or sic -i in.png -o out.png --rotate180 --flip-horizontal --set-resize-sampling-filter nearest --resize 75 80 --hue-rotate 75

Other resources on image operations

For additional information on available options and flags, run sic --help.

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: