greenriver 0.1.2

A command line tool to work with greenfield images
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

<p align="center">
    <img src=https://cdn0.iconfinder.com/data/icons/landscape-collection/383/mountain_river-512.png width=138/>
</p>

<h1 align="center">Greenriver</h1>

<p align="center"><strong>A command line tool to work with <a href="https://github.com/Tomcat-42/greenfield">greenfield images</a</strong></p>

<div align="center">
    <a href="https://crates.io/greenriver" target="_blank">
    <img src="https://img.shields.io/crates/v/greenriver"></a>
    <a href="https://docs.rs/greenriver" target="_blank">
    <img src="https://img.shields.io/docsrs/greenriver"></a>
    <a href="https://github.com/Tomcat-42/greenriver" target="_blank">
    <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/Tomcat-42/greenriver?style=social">
</div>

## Installation

This command line tool is available on
[crates.io/greenriver](https://crates.io/greenriver). So, just install it with
cargo:

```bash
cargo install greenriver
```

## Usage

```text
A command line tool to work with greenfield images

Usage: greenriver <COMMAND>

Commands:
  quantize  Quantizes an image and saves it to a file
  inspect   Inspet an image
  help      Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version
```

### quantize

To convert an image on a common file format to [greenfield](docs.rs/greenfield)
with a quantization level, and saving it to [greenfield](docs.rs/greenfield):

```bash
greenriver quantize 5 6 5 Lenna.png Lenna_565.gfd
```

To convert an image on a common file format to [greenfield](docs.rs/greenfield)
with a quantization level, and saving it to a common file format (the formats
are inferred by file name):

```bash
greenriver quantize 5 6 5 Lenna.png Lenna_565.png
```
![lenna]()
![Lenna_565]()

<p align="center">
  <img  src="https://user-images.githubusercontent.com/44649669/213846678-7d655eb4-2f45-431c-9eac-5a2bebd507bc.png" width="25%">
&nbsp; &nbsp; &nbsp; &nbsp;
  <img src="https://user-images.githubusercontent.com/44649669/213846681-1e603020-b853-442a-8d05-d653e3cad7bf.png" width="25%">
</p>

### convert

To convert between file formats (the formats are inferred by extension, so for [greenfield](docs.rs/greenfield) use `.gfd`):

```bash
greenriver convert ./assets/Lenna_565.gfd ./assets/Lenna_565.png
```

### inspect

To get file information about a [greenfield](docs.rs/greenfield) image, use the `inspect` command:

```bash
greenriver inspect ./assets/Lenna_565.gfd
```

```text
┌───────┬─────────────┬────────────┬────────────┬──────────────┬────────────────────────┐
│       │ Magic       │ Width      │ Height     │ Quantization │ Data                   │
├───────┼─────────────┼────────────┼────────────┼──────────────┼────────────────────────┤
│ Value │ b'grnfld42' │ 512        │ 512        │ (5, 6, 5)    │ 512x512 [RGB]          │
├───────┼─────────────┼────────────┼────────────┼──────────────┼────────────────────────┤
│ Size  │ 64 b (8 B)  │ 32 b (4 B) │ 32 b (4 B) │ 9 b (~1 B)   │ 4194304 b (512.00 KiB) │
└───────┴─────────────┴────────────┴────────────┴──────────────┴────────────────────────┘
```

You can also inspect files in other formats. They will be converted to [greenfield](docs.rs/greenfield) (8, 8, 8):

```bash
greenriver inspect ./assets/Lenna.png
```

```text
┌───────┬─────────────┬────────────┬────────────┬──────────────┬────────────────────────┐
│       │ Magic       │ Width      │ Height     │ Quantization │ Data                   │
├───────┼─────────────┼────────────┼────────────┼──────────────┼────────────────────────┤
│ Value │ b'grnfld42' │ 512        │ 512        │ (8, 8, 8)    │ 512x512 [RGB]          │
├───────┼─────────────┼────────────┼────────────┼──────────────┼────────────────────────┤
│ Size  │ 64 b (8 B)  │ 32 b (4 B) │ 32 b (4 B) │ 9 b (~1 B)   │ 6291456 b (768.00 KiB) │
└───────┴─────────────┴────────────┴────────────┴──────────────┴────────────────────────┘
```