Compare commits
12 Commits
e527cd426f
...
0.9.9
| Author | SHA1 | Date | |
|---|---|---|---|
| d1a55c98f4 | |||
| 72672b731c | |||
| d19b64e64a | |||
| 8624fbea47 | |||
| a55ae54832 | |||
| 140476e3a0 | |||
| 06c36fb1ec | |||
| 1581d40473 | |||
| d4d87fffe3 | |||
| 222b0e2c7b | |||
| 0e20ccddc7 | |||
| 3ce9420664 |
40
.gitea/workflows/build.yaml
Normal file
40
.gitea/workflows/build.yaml
Normal file
@@ -0,0 +1,40 @@
|
||||
name: build release package
|
||||
run-name: ${{ gitea.actor }} is building newest nightly release
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents:
|
||||
write
|
||||
steps:
|
||||
- run: echo "Build process started by ${{ gitea.event_name }} event."
|
||||
- run: echo "Running build process on ${{ runner.os }}"
|
||||
- run: echo "The name of your branch is ${{ gitea.ref }} and your repository is ${{ gitea.repository }}."
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v4
|
||||
- run: echo "The ${{ gitea.repository }} repository has been cloned to the runner."
|
||||
- name: List files in the repository
|
||||
run: |
|
||||
ls ${{ gitea.workspace }}
|
||||
- run: echo "🍏 This job's status is ${{ job.status }}."
|
||||
- name: Install cargo
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: stable
|
||||
override: true
|
||||
components: rustfmt, clippy
|
||||
- run: echo "Starting build"
|
||||
- run: cargo build -r
|
||||
- run: echo "Build finished"
|
||||
- name: Create new release
|
||||
uses: ncipollo/release-action@v1
|
||||
with:
|
||||
artifacts: "target/release/qoi"
|
||||
body: "Automically generated release"
|
||||
|
||||
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1,3 +1,4 @@
|
||||
/target
|
||||
/qoi_test_images
|
||||
*.qoi
|
||||
*.png
|
||||
|
||||
288
Cargo.lock
generated
288
Cargo.lock
generated
@@ -3,16 +3,65 @@
|
||||
version = 3
|
||||
|
||||
[[package]]
|
||||
name = "adler"
|
||||
version = "1.0.2"
|
||||
name = "adler2"
|
||||
version = "2.0.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f26201604c87b1e01bd3d98f8d5d9a8fcbb815e8cedb41ffccbeb4bf593a35fe"
|
||||
checksum = "512761e0bb2578dd7380c6baaa0f4ce03e84f95e960231d1dec8bf4d7d6e2627"
|
||||
|
||||
[[package]]
|
||||
name = "anstream"
|
||||
version = "0.6.18"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "8acc5369981196006228e28809f761875c0327210a891e941f4c683b3a99529b"
|
||||
dependencies = [
|
||||
"anstyle",
|
||||
"anstyle-parse",
|
||||
"anstyle-query",
|
||||
"anstyle-wincon",
|
||||
"colorchoice",
|
||||
"is_terminal_polyfill",
|
||||
"utf8parse",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "anstyle"
|
||||
version = "1.0.10"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "55cc3b69f167a1ef2e161439aa98aed94e6028e5f9a59be9a6ffb47aef1651f9"
|
||||
|
||||
[[package]]
|
||||
name = "anstyle-parse"
|
||||
version = "0.2.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "3b2d16507662817a6a20a9ea92df6652ee4f94f914589377d69f3b21bc5798a9"
|
||||
dependencies = [
|
||||
"utf8parse",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "anstyle-query"
|
||||
version = "1.1.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "79947af37f4177cfead1110013d678905c37501914fba0efea834c3fe9a8d60c"
|
||||
dependencies = [
|
||||
"windows-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "anstyle-wincon"
|
||||
version = "3.0.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2109dbce0e72be3ec00bed26e6a7479ca384ad226efdd66db8fa2e3a38c83125"
|
||||
dependencies = [
|
||||
"anstyle",
|
||||
"windows-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "array-init"
|
||||
version = "2.0.1"
|
||||
version = "2.1.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "bfb6d71005dc22a708c7496eee5c8dc0300ee47355de6256c3b35b12b5fef596"
|
||||
checksum = "3d62b7694a562cdf5a74227903507c56ab2cc8bdd1f781ed5cb4cf9c9f810bfc"
|
||||
|
||||
[[package]]
|
||||
name = "bitflags"
|
||||
@@ -26,6 +75,52 @@ version = "1.0.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
|
||||
|
||||
[[package]]
|
||||
name = "clap"
|
||||
version = "4.5.21"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "fb3b4b9e5a7c7514dfa52869339ee98b3156b0bfb4e8a77c4ff4babb64b1604f"
|
||||
dependencies = [
|
||||
"clap_builder",
|
||||
"clap_derive",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "clap_builder"
|
||||
version = "4.5.21"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "b17a95aa67cc7b5ebd32aa5370189aa0d79069ef1c64ce893bd30fb24bff20ec"
|
||||
dependencies = [
|
||||
"anstream",
|
||||
"anstyle",
|
||||
"clap_lex",
|
||||
"strsim",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "clap_derive"
|
||||
version = "4.5.18"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "4ac6a0c7b1a9e9a5186361f67dfa1b88213572f427fb9ab038efb2bd8c582dab"
|
||||
dependencies = [
|
||||
"heck",
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "clap_lex"
|
||||
version = "0.7.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "afb84c814227b90d6895e01398aee0d8033c00e7466aca416fb6a8e0eb19d8a7"
|
||||
|
||||
[[package]]
|
||||
name = "colorchoice"
|
||||
version = "1.0.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5b63caa9aa9397e2d9480a9b13673856c78d8ac123288526c37d7839f2a86990"
|
||||
|
||||
[[package]]
|
||||
name = "colors-transform"
|
||||
version = "0.2.11"
|
||||
@@ -34,59 +129,206 @@ checksum = "9226dbc05df4fb986f48d730b001532580883c4c06c5d1c213f4b34c1c157178"
|
||||
|
||||
[[package]]
|
||||
name = "crc32fast"
|
||||
version = "1.3.2"
|
||||
version = "1.4.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "b540bd8bc810d3885c6ea91e2018302f68baba2129ab3e88f32389ee9370880d"
|
||||
checksum = "a97769d94ddab943e4510d138150169a2758b5ef3eb191a9ee688de3e23ef7b3"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "flate2"
|
||||
version = "1.0.24"
|
||||
name = "fdeflate"
|
||||
version = "0.3.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f82b0f4c27ad9f8bfd1f3208d882da2b09c301bc1c828fd3a00d0216d2fbbff6"
|
||||
checksum = "07c6f4c64c1d33a3111c4466f7365ebdcc37c5bd1ea0d62aae2e3d722aacbedb"
|
||||
dependencies = [
|
||||
"simd-adler32",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "flate2"
|
||||
version = "1.0.35"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c936bfdafb507ebbf50b8074c54fa31c5be9a1e7e5f467dd659697041407d07c"
|
||||
dependencies = [
|
||||
"crc32fast",
|
||||
"miniz_oxide",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "log"
|
||||
version = "0.4.17"
|
||||
name = "heck"
|
||||
version = "0.5.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "abb12e687cfb44aa40f41fc3978ef76448f9b6038cad6aef4259d3c095a2382e"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
]
|
||||
checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
|
||||
|
||||
[[package]]
|
||||
name = "is_terminal_polyfill"
|
||||
version = "1.70.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "7943c866cc5cd64cbc25b2e01621d07fa8eb2a1a23160ee81ce38704e97b8ecf"
|
||||
|
||||
[[package]]
|
||||
name = "log"
|
||||
version = "0.4.22"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a7a70ba024b9dc04c27ea2f0c0548feb474ec5c54bba33a7f72f873a39d07b24"
|
||||
|
||||
[[package]]
|
||||
name = "miniz_oxide"
|
||||
version = "0.5.4"
|
||||
version = "0.8.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "96590ba8f175222643a85693f33d26e9c8a015f599c216509b1a6894af675d34"
|
||||
checksum = "e2d80299ef12ff69b16a84bb182e3b9df68b5a91574d3d4fa6e41b65deec4df1"
|
||||
dependencies = [
|
||||
"adler",
|
||||
"adler2",
|
||||
"simd-adler32",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "png"
|
||||
version = "0.17.6"
|
||||
version = "0.17.14"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "8f0e7f4c94ec26ff209cee506314212639d6c91b80afb82984819fafce9df01c"
|
||||
checksum = "52f9d46a34a05a6a57566bc2bfae066ef07585a6e3fa30fbbdff5936380623f0"
|
||||
dependencies = [
|
||||
"bitflags",
|
||||
"crc32fast",
|
||||
"fdeflate",
|
||||
"flate2",
|
||||
"miniz_oxide",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "qoi-test"
|
||||
version = "0.1.0"
|
||||
name = "proc-macro2"
|
||||
version = "1.0.89"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f139b0662de085916d1fb67d2b4169d1addddda1919e696f3252b740b629986e"
|
||||
dependencies = [
|
||||
"unicode-ident",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "qoi"
|
||||
version = "0.9.9"
|
||||
dependencies = [
|
||||
"array-init",
|
||||
"clap",
|
||||
"colors-transform",
|
||||
"log",
|
||||
"png",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "quote"
|
||||
version = "1.0.37"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "b5b9d34b8991d19d98081b46eacdd8eb58c6f2b201139f7c5f643cc155a633af"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "simd-adler32"
|
||||
version = "0.3.7"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "d66dc143e6b11c1eddc06d5c423cfc97062865baf299914ab64caa38182078fe"
|
||||
|
||||
[[package]]
|
||||
name = "strsim"
|
||||
version = "0.11.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f"
|
||||
|
||||
[[package]]
|
||||
name = "syn"
|
||||
version = "2.0.87"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "25aa4ce346d03a6dcd68dd8b4010bcb74e54e62c90c573f394c46eae99aba32d"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"unicode-ident",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "unicode-ident"
|
||||
version = "1.0.13"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "e91b56cd4cadaeb79bbf1a5645f6b4f8dc5bde8834ad5894a8db35fda9efa1fe"
|
||||
|
||||
[[package]]
|
||||
name = "utf8parse"
|
||||
version = "0.2.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
|
||||
|
||||
[[package]]
|
||||
name = "windows-sys"
|
||||
version = "0.59.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b"
|
||||
dependencies = [
|
||||
"windows-targets",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "windows-targets"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973"
|
||||
dependencies = [
|
||||
"windows_aarch64_gnullvm",
|
||||
"windows_aarch64_msvc",
|
||||
"windows_i686_gnu",
|
||||
"windows_i686_gnullvm",
|
||||
"windows_i686_msvc",
|
||||
"windows_x86_64_gnu",
|
||||
"windows_x86_64_gnullvm",
|
||||
"windows_x86_64_msvc",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "windows_aarch64_gnullvm"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3"
|
||||
|
||||
[[package]]
|
||||
name = "windows_aarch64_msvc"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469"
|
||||
|
||||
[[package]]
|
||||
name = "windows_i686_gnu"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b"
|
||||
|
||||
[[package]]
|
||||
name = "windows_i686_gnullvm"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66"
|
||||
|
||||
[[package]]
|
||||
name = "windows_i686_msvc"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66"
|
||||
|
||||
[[package]]
|
||||
name = "windows_x86_64_gnu"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78"
|
||||
|
||||
[[package]]
|
||||
name = "windows_x86_64_gnullvm"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d"
|
||||
|
||||
[[package]]
|
||||
name = "windows_x86_64_msvc"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
|
||||
|
||||
20
Cargo.toml
20
Cargo.toml
@@ -1,12 +1,24 @@
|
||||
[package]
|
||||
name = "qoi-test"
|
||||
version = "0.1.0"
|
||||
name = "qoi"
|
||||
version = "0.9.9"
|
||||
edition = "2021"
|
||||
authors = ["nihil carcosa <nihil@valhrafnaz.gay>"]
|
||||
description = "CLI tool and rust library for the de- and encoding of images to the QOI format."
|
||||
readme = "README.md"
|
||||
homepage = "https://valhrafnaz.gay"
|
||||
repository = "https://git.valhrafnaz.gay/valhrafnaz/qoi-img"
|
||||
license-file = "LICENSE"
|
||||
keywords = ["image_compression", "encoding", "qoi", "cli", "library"]
|
||||
categories = ["command-line-utilities", "encoding", "graphics", "compression"]
|
||||
exclude = ["/qoi_test_images"]
|
||||
publish = ["gitea"]
|
||||
|
||||
|
||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||
|
||||
[dependencies]
|
||||
array-init = "2.0.1"
|
||||
png = "0.17.6"
|
||||
log = "0.4.17"
|
||||
png = "0.17.14"
|
||||
log = "0.4.22"
|
||||
colors-transform = "0.2.11"
|
||||
clap = { version = "4.5.18", features = ["derive"] }
|
||||
|
||||
674
LICENSE
Normal file
674
LICENSE
Normal file
@@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) 2024 Nihil Carcosa
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) 2024 Nihil Carcosa
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
18
README.md
18
README.md
@@ -1,9 +1,21 @@
|
||||
# QOI (Quite OK Image Format) Rust De-/Encoder
|
||||
|
||||
This is a (currently not bug free) implementation of the QOI image compression algorithm in Rust.
|
||||
This is a rust CLI application and library to decode and encode raw pixel data to and from the .qoi image format.
|
||||
See [qoiformat.org](https://qoiformat.org/) for more information on the format. Both decoder and encoder pass all the test images provided by the format's maintainers.
|
||||
|
||||
Currently supports de- and encoding from and to PNG.
|
||||
I have created this largely to learn rust myself and do not recommend using this crate over the [Image crate](https://crates.io/crates/image).
|
||||
Please observe that this crate is licensed under the GPL-v3-or-later only and can thus not be for non-FOSS projects. No MIT/BSD dual-licensing will be considered.
|
||||
|
||||
## To install
|
||||
|
||||
Simply grab the [latest release](https://git.valhrafnaz.gay/valhrafnaz/qoi-img/releases/latest) and place the binary in a path that is searched via your `$PATH` variable. Please keep in mind that the release binary provided is for linux-x86_64 only (code uses u64 and as thus is likely not functional on IA-32). Should you wish to run the program on different operating systems, please refer to build instructions below.
|
||||
|
||||
## To build
|
||||
|
||||
run `cargo build -r` to build a stable version for your rustc toolchain in `./target/release`
|
||||
Make sure rustup has cargo and your preferred toolchain installed.
|
||||
|
||||
Clone the repository by running `git clone https://git.valhrafnaz.gay/valhrafnaz/qoi-img.git`
|
||||
|
||||
Move into the directory `cd qoi-img`
|
||||
|
||||
Run `cargo build -r` to build a stable version for your rustc toolchain in `./target/release`.
|
||||
|
||||
451
src/lib.rs
451
src/lib.rs
@@ -1,14 +1,17 @@
|
||||
//! # qoi_img
|
||||
//! `qoi_img` is a bad, from-scratch implementation of the decoder and encoder for the `.qoi` file format as described as on [qoiformat.org](https://qoiformat.org/qoi-specification.pdf).
|
||||
//! This crate should not be published as better crates are available, e.g. [rapid-qoi](https://crates.io/crates/rapid-qoi).
|
||||
|
||||
#![allow(dead_code, unused_variables)]
|
||||
pub mod qoi_img {
|
||||
pub mod qoi_lib {
|
||||
|
||||
use log::{debug, info, Level, LevelFilter, Record, SetLoggerError};
|
||||
use std::fmt;
|
||||
use std::fs::*;
|
||||
use std::io::prelude::*;
|
||||
use std::fs::File;
|
||||
use log::{debug,info, Level, Record, SetLoggerError, LevelFilter};
|
||||
use std::io::BufWriter;
|
||||
use std::path::Path;
|
||||
use png;
|
||||
|
||||
|
||||
use array_init;
|
||||
|
||||
@@ -23,22 +26,24 @@ pub mod qoi_img {
|
||||
//inherit from base Error
|
||||
impl std::error::Error for ImgError {}
|
||||
|
||||
|
||||
//Output for error handling
|
||||
impl fmt::Display for ImgError {
|
||||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||
match self {
|
||||
ImgError::DataError => write!(f, "invalid number of bytes (must be devisible by 4)"),
|
||||
ImgError::PixelNumberError => write!(f, "number of pixels does not match height and width params"),
|
||||
ImgError::DataError => {
|
||||
write!(f, "invalid number of bytes (must be devisible by 4)")
|
||||
}
|
||||
ImgError::PixelNumberError => {
|
||||
write!(f, "number of pixels does not match height and width params")
|
||||
}
|
||||
ImgError::DecodeError => write!(f, "decoder failed to construct valid image"),
|
||||
ImgError::HeaderError => write!(f, "not a valid QOI file header")
|
||||
ImgError::HeaderError => write!(f, "not a valid QOI file header"),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
//boilerplate implementation of the log crate
|
||||
struct SimpleLogger;
|
||||
pub struct SimpleLogger;
|
||||
|
||||
impl log::Log for SimpleLogger {
|
||||
fn enabled(&self, metadata: &log::Metadata) -> bool {
|
||||
@@ -49,9 +54,7 @@ pub mod qoi_img {
|
||||
eprintln!("{} - {}", record.level(), record.args());
|
||||
}
|
||||
}
|
||||
fn flush(&self) {
|
||||
|
||||
}
|
||||
fn flush(&self) {}
|
||||
}
|
||||
//logging boilerplate
|
||||
static LOGGER: SimpleLogger = SimpleLogger;
|
||||
@@ -60,7 +63,7 @@ pub mod qoi_img {
|
||||
///
|
||||
/// ```
|
||||
/// # use std::error::Error;
|
||||
/// # use crate::qoi_test::qoi_img::*;
|
||||
/// # use crate::qoi::qoi_lib::*;
|
||||
/// # fn main() -> Result<(), Box<ImgError>> {
|
||||
/// init().expect("Failed to initialize logger");
|
||||
/// #
|
||||
@@ -73,7 +76,7 @@ pub mod qoi_img {
|
||||
///
|
||||
/// ```
|
||||
/// # use std::error::Error;
|
||||
/// # use crate::qoi_test::qoi_img::*;
|
||||
/// # use crate::qoi::qoi_lib::*;
|
||||
/// # fn main() -> Result<(), ImgError> {
|
||||
/// match init() {
|
||||
/// Ok(()) => (),
|
||||
@@ -84,11 +87,10 @@ pub mod qoi_img {
|
||||
/// #
|
||||
/// # }
|
||||
/// ```
|
||||
pub fn init() -> Result<(), SetLoggerError>{
|
||||
log::set_logger(&LOGGER).map(|()| log::set_max_level(LevelFilter::Debug))
|
||||
pub fn init(level: LevelFilter) -> Result<(), SetLoggerError> {
|
||||
log::set_logger(&LOGGER).map(|()| log::set_max_level(level))
|
||||
}
|
||||
|
||||
|
||||
/// Custom image struct, which is used to store decoded data. Used by [encode_from_image] to encode the necessary data in bytes. Requires a Vector over [Pixel] values, `Vec<Pixel>`,
|
||||
/// which can be generated by [`self::new`] if given byte data. Otherwise, [self.pixels] must be given filled vector.
|
||||
/// `height` and `width` are given as u32 (note that qoi encoding does not guarantee functionality for images containing over 4000000 pixels.)
|
||||
@@ -98,7 +100,7 @@ pub mod qoi_img {
|
||||
/// Create a new image via constructor [`Image::new()`];
|
||||
/// ```rust
|
||||
/// # use std::error::Error;
|
||||
/// # use crate::qoi_test::qoi_img::*;
|
||||
/// # use crate::qoi::qoi_lib::*;
|
||||
/// # fn main() -> Result<(), Box<ImgError>> {
|
||||
///
|
||||
/// let pixels: Vec<u8> = vec![0;1024*1024*4];
|
||||
@@ -123,8 +125,20 @@ pub mod qoi_img {
|
||||
|
||||
impl Image {
|
||||
//Image constructor, expects an array of u8 pixels values in order, left to right, top to bottom.
|
||||
pub fn new(data: Vec<u8>, height: u32, width: u32, channels: u8, colorspace: u8,) -> Result<Image, ImgError> {
|
||||
let pixels: Vec<Pixel> = match Image::pixels_from_bytes(data) {
|
||||
pub fn new(
|
||||
data: Vec<u8>,
|
||||
height: u32,
|
||||
width: u32,
|
||||
channels: u8,
|
||||
colorspace: u8,
|
||||
) -> Result<Image, ImgError> {
|
||||
let alpha: bool;
|
||||
if channels == 4 {
|
||||
alpha = true;
|
||||
} else {
|
||||
alpha = false;
|
||||
}
|
||||
let pixels: Vec<Pixel> = match Image::pixels_from_bytes(data, alpha) {
|
||||
Ok(out) => out,
|
||||
Err(error) => return Err(error),
|
||||
};
|
||||
@@ -140,22 +154,29 @@ pub mod qoi_img {
|
||||
} else {
|
||||
Err(ImgError::PixelNumberError)
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
pub fn from_pixels(pixels: Vec<Pixel>, height: u32, width: u32, channels: u8, colorspace: u8) -> Image {
|
||||
pub fn from_pixels(
|
||||
pixels: Vec<Pixel>,
|
||||
height: u32,
|
||||
width: u32,
|
||||
channels: u8,
|
||||
colorspace: u8,
|
||||
) -> Image {
|
||||
let img = Image {
|
||||
pixels,
|
||||
height,
|
||||
width,
|
||||
channels,
|
||||
colorspace
|
||||
colorspace,
|
||||
};
|
||||
img
|
||||
}
|
||||
|
||||
fn pixels_from_bytes(data: Vec<u8>) -> Result<Vec<Pixel>, ImgError> {
|
||||
//Expects pixel data in order left to right, top to bottom, with values for rgba in sequential order
|
||||
fn pixels_from_bytes(data: Vec<u8>, alpha: bool) -> Result<Vec<Pixel>, ImgError> {
|
||||
let mut pixels: Vec<Pixel> = Vec::with_capacity(data.len() / 4);
|
||||
if alpha {
|
||||
if data.len() % 4 == 0 {
|
||||
for i in 0..data.len() / 4 {
|
||||
pixels.push(Pixel {
|
||||
@@ -169,6 +190,65 @@ pub mod qoi_img {
|
||||
} else {
|
||||
Err(ImgError::DataError)
|
||||
}
|
||||
} else {
|
||||
if data.len() % 4 == 0 {
|
||||
for i in 0..data.len() / 3 {
|
||||
pixels.push(Pixel {
|
||||
r: data[i * 3],
|
||||
g: data[i * 3 + 1],
|
||||
b: data[i * 3 + 2],
|
||||
a: 255,
|
||||
});
|
||||
}
|
||||
Ok(pixels)
|
||||
} else {
|
||||
Err(ImgError::DataError)
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
pub fn to_bytes(&self) -> Vec<u8> {
|
||||
let mut buf: Vec<u8> = Vec::with_capacity(self.height as usize * self.width as usize * 4 as usize);
|
||||
for pixel in &self.pixels {
|
||||
buf.push(pixel.r);
|
||||
buf.push(pixel.g);
|
||||
buf.push(pixel.b);
|
||||
buf.push(pixel.a);
|
||||
}
|
||||
return buf;
|
||||
}
|
||||
pub fn write_png(&self, path: &str) {
|
||||
let mut file_path: String = String::new();
|
||||
file_path.push_str(path);
|
||||
if !path.contains(".png") {
|
||||
file_path.push_str(".png");
|
||||
}
|
||||
let path = Path::new(&file_path);
|
||||
let file = match File::create(path) {
|
||||
Ok(f) => f,
|
||||
Err(e) => panic!("ERROR during writing output file: {e:?}")
|
||||
};
|
||||
let buf: Vec<u8> = self.to_bytes();
|
||||
let ref mut w = BufWriter::new(file);
|
||||
let mut encoder = png::Encoder::new(w, self.width, self.height);
|
||||
|
||||
encoder.set_color(png::ColorType::Rgba);
|
||||
encoder.set_depth(png::BitDepth::Eight);
|
||||
|
||||
encoder.set_source_gamma(png::ScaledFloat::new(1.0 / 2.2)); // 1.0 / 2.2, unscaled, but rounded
|
||||
let source_chromaticities = png::SourceChromaticities::new( // Using unscaled instantiation here
|
||||
(0.31270, 0.32900),
|
||||
(0.64000, 0.33000),
|
||||
(0.30000, 0.60000),
|
||||
(0.15000, 0.06000)
|
||||
);
|
||||
encoder.set_source_chromaticities(source_chromaticities);
|
||||
let mut writer = encoder.write_header().unwrap();
|
||||
match writer.write_image_data(&buf) {
|
||||
Ok(_a) => (),
|
||||
Err(e) => panic!("Cannot write output file! {e:?}")
|
||||
}
|
||||
writer.finish().unwrap();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -187,22 +267,19 @@ pub mod qoi_img {
|
||||
Luma,
|
||||
Diff,
|
||||
RGB,
|
||||
RGBA
|
||||
RGBA,
|
||||
}
|
||||
|
||||
impl Pixel {
|
||||
|
||||
|
||||
pub fn new(r: u8, g: u8, b: u8, a: u8) -> Pixel {
|
||||
Pixel {
|
||||
r,
|
||||
g,
|
||||
b,
|
||||
a,
|
||||
}
|
||||
Pixel { r, g, b, a }
|
||||
}
|
||||
fn equals(&self, other: &Pixel) -> bool {
|
||||
if (self.r == other.r) && (self.g == other.g) && (self.b == other.b) && (self.a == other.a) {
|
||||
if (self.r == other.r)
|
||||
&& (self.g == other.g)
|
||||
&& (self.b == other.b)
|
||||
&& (self.a == other.a)
|
||||
{
|
||||
true
|
||||
} else {
|
||||
false
|
||||
@@ -217,10 +294,12 @@ pub mod qoi_img {
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
//self = curr pixel, other = prev pixel
|
||||
pub fn determine_chunk(&self, other: &Pixel, buffer: &Vec<Pixel>) -> (ChunkType, Option<(u8,u8,u8)>){
|
||||
|
||||
pub fn determine_chunk(
|
||||
&self,
|
||||
other: &Pixel,
|
||||
buffer: &Vec<Pixel>,
|
||||
) -> (ChunkType, Option<(u8, u8, u8)>) {
|
||||
if self.equals(&other) {
|
||||
return (ChunkType::Run, None);
|
||||
}
|
||||
@@ -243,7 +322,12 @@ pub mod qoi_img {
|
||||
let dg: u8 = (dg + DIFF_BIAS as i16) as u8;
|
||||
let db: u8 = (db + DIFF_BIAS as i16) as u8;
|
||||
return (ChunkType::Diff, Some((dr, dg, db)));
|
||||
} else if (dg > -33 && dg < 32) && ((dr - dg) > -9) && ((dr - dg) < 8) && ((db - dg) > -9) && ((db - dg) < 8) {
|
||||
} else if (dg > -33 && dg < 32)
|
||||
&& ((dr - dg) > -9)
|
||||
&& ((dr - dg) < 8)
|
||||
&& ((db - dg) > -9)
|
||||
&& ((db - dg) < 8)
|
||||
{
|
||||
let dg_out: u8 = (dg + LUMA_BIAS_G as i16) as u8;
|
||||
let dr_dg: u8 = (dr - dg + LUMA_BIAS_RB as i16) as u8;
|
||||
let db_dg: u8 = (db - dg + LUMA_BIAS_RB as i16) as u8;
|
||||
@@ -251,7 +335,6 @@ pub mod qoi_img {
|
||||
} else {
|
||||
return (ChunkType::RGB, None);
|
||||
}
|
||||
|
||||
}
|
||||
pub fn diff(&self, other: &Pixel) -> (i16, i16, i16) {
|
||||
let mut dr: i16;
|
||||
@@ -286,7 +369,6 @@ pub mod qoi_img {
|
||||
}
|
||||
|
||||
(dr, dg, db)
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
@@ -333,12 +415,12 @@ pub mod qoi_img {
|
||||
//Definition of End of Stream bytes
|
||||
#[derive(Debug)]
|
||||
struct End {
|
||||
bytes: [u8;8]
|
||||
bytes: [u8; 8],
|
||||
}
|
||||
impl End {
|
||||
fn new() -> End {
|
||||
End {
|
||||
bytes: [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01]
|
||||
bytes: [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01],
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -359,48 +441,55 @@ pub mod qoi_img {
|
||||
const LUMA_BIAS_G: u8 = 32;
|
||||
const LUMA_BIAS_RB: u8 = 8;
|
||||
|
||||
|
||||
|
||||
//hash function for assigning buffer indices to stored pixels
|
||||
fn color_hash(pixel: &Pixel) -> u8 {
|
||||
let store: u32 = pixel.r as u32 * 3 + pixel.g as u32 * 5 + pixel.b as u32 * 7 + pixel.a as u32 * 11;
|
||||
let store: u32 =
|
||||
pixel.r as u32 * 3 + pixel.g as u32 * 5 + pixel.b as u32 * 7 + pixel.a as u32 * 11;
|
||||
(store % 64) as u8
|
||||
}
|
||||
|
||||
pub fn encode_from_image(img: Image) -> Vec<u8> {
|
||||
|
||||
let mut prev_pixel: Pixel = Pixel {r: 0u8, b: 0u8, g: 0u8, a: 255u8};
|
||||
let mut prev_pixel: Pixel = Pixel {
|
||||
r: 0u8,
|
||||
b: 0u8,
|
||||
g: 0u8,
|
||||
a: 255u8,
|
||||
};
|
||||
|
||||
let mut prev_buffer: Vec<Pixel> = Vec::with_capacity(64);
|
||||
|
||||
for i in 0..64 {
|
||||
let pix: Pixel = Pixel {r:0,g:0,b:0,a:0};
|
||||
let pix: Pixel = Pixel {
|
||||
r: 0,
|
||||
g: 0,
|
||||
b: 0,
|
||||
a: 0,
|
||||
};
|
||||
prev_buffer.push(pix);
|
||||
}
|
||||
|
||||
let mut encoded_bytes: Vec<u8> = Vec::new();
|
||||
let mut run: u8 = 0;
|
||||
|
||||
let mut run: u64 = 0;
|
||||
|
||||
let head = Header {
|
||||
magic: ['q', 'o', 'i', 'f'],
|
||||
width: img.width,
|
||||
height: img.height,
|
||||
channels: img.channels,
|
||||
colorspace: img.colorspace
|
||||
colorspace: img.colorspace,
|
||||
};
|
||||
let head_stream = head.convert_to_bytestream();
|
||||
|
||||
|
||||
for i in head_stream {
|
||||
encoded_bytes.push(i);
|
||||
}
|
||||
|
||||
let mut counter: u32 = 0;
|
||||
let mut counter: u64 = 0;
|
||||
|
||||
for pixel in img.pixels {
|
||||
counter += 1;
|
||||
let chunk: (ChunkType, Option<(u8,u8,u8)>) = pixel.determine_chunk(&prev_pixel, &prev_buffer);
|
||||
let chunk: (ChunkType, Option<(u8, u8, u8)>) =
|
||||
pixel.determine_chunk(&prev_pixel, &prev_buffer);
|
||||
if chunk == (ChunkType::Run, None) {
|
||||
run += 1;
|
||||
prev_pixel = pixel.clone();
|
||||
@@ -413,23 +502,26 @@ pub mod qoi_img {
|
||||
encoded_bytes.push(QOI_OP_RUN | (62 - RUN_BIAS));
|
||||
run -= 62;
|
||||
} else if run % 62 > 0 {
|
||||
encoded_bytes.push(QOI_OP_RUN | (run-RUN_BIAS));
|
||||
let run_remainder: u8 = run.try_into().unwrap();
|
||||
encoded_bytes.push(QOI_OP_RUN | (run_remainder - RUN_BIAS));
|
||||
run = 0;
|
||||
} else {
|
||||
break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
encoded_bytes.push(QOI_OP_RUN | (run-RUN_BIAS));
|
||||
let run8: u8 = run.try_into().unwrap();
|
||||
encoded_bytes.push(QOI_OP_RUN | (run8 - RUN_BIAS));
|
||||
run = 0;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
match chunk {
|
||||
(ChunkType::Index, Some((index, irr1, irr2))) => {
|
||||
encoded_bytes.push(QOI_OP_INDEX | index);
|
||||
prev_pixel = pixel;
|
||||
},
|
||||
}
|
||||
(ChunkType::Diff, Some((dr, dg, db))) => {
|
||||
let mut out: u8 = 0b0000_0000;
|
||||
out = out | db;
|
||||
@@ -438,7 +530,7 @@ pub mod qoi_img {
|
||||
encoded_bytes.push(QOI_OP_DIFF | out);
|
||||
prev_pixel = pixel.clone();
|
||||
prev_buffer[color_hash(&pixel) as usize] = pixel;
|
||||
},
|
||||
}
|
||||
(ChunkType::Luma, Some((dg, dr_dg, db_dg))) => {
|
||||
let mut out: [u8; 2] = [0b0000_0000; 2];
|
||||
out[0] |= dg;
|
||||
@@ -449,7 +541,7 @@ pub mod qoi_img {
|
||||
encoded_bytes.push(out[1]);
|
||||
prev_pixel = pixel.clone();
|
||||
prev_buffer[color_hash(&pixel) as usize] = pixel;
|
||||
},
|
||||
}
|
||||
(ChunkType::RGB, None) => {
|
||||
encoded_bytes.push(QOI_OP_RGB);
|
||||
encoded_bytes.push(pixel.r);
|
||||
@@ -457,7 +549,7 @@ pub mod qoi_img {
|
||||
encoded_bytes.push(pixel.b);
|
||||
prev_pixel = pixel.clone();
|
||||
prev_buffer[color_hash(&pixel) as usize] = pixel;
|
||||
},
|
||||
}
|
||||
(ChunkType::RGBA, None) => {
|
||||
if (pixel.a as i16 - prev_pixel.a as i16) == 0i16 {
|
||||
//this should never be reached, but it is
|
||||
@@ -476,10 +568,11 @@ pub mod qoi_img {
|
||||
prev_pixel = pixel.clone();
|
||||
prev_buffer[color_hash(&pixel) as usize] = pixel;
|
||||
}
|
||||
},
|
||||
_ => panic!("Critical error at encoding stage: Illegal output from difference function.")
|
||||
}
|
||||
|
||||
_ => panic!(
|
||||
"Critical error at encoding stage: Illegal output from difference function."
|
||||
),
|
||||
}
|
||||
}
|
||||
|
||||
if run > 0 {
|
||||
@@ -489,14 +582,17 @@ pub mod qoi_img {
|
||||
encoded_bytes.push(QOI_OP_RUN | (62 - RUN_BIAS));
|
||||
run -= 62;
|
||||
} else if run % 62 > 0 {
|
||||
encoded_bytes.push(QOI_OP_RUN | (run-RUN_BIAS));
|
||||
let run_remainder: u8 = run.try_into().unwrap();
|
||||
encoded_bytes.push(QOI_OP_RUN | (run_remainder - RUN_BIAS));
|
||||
run = 0;
|
||||
} else {
|
||||
break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
encoded_bytes.push(QOI_OP_RUN | (run-RUN_BIAS));
|
||||
let run8: u8 = run.try_into().unwrap();
|
||||
encoded_bytes.push(QOI_OP_RUN | (run8 - RUN_BIAS));
|
||||
// run = 0;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -506,16 +602,31 @@ pub mod qoi_img {
|
||||
}
|
||||
|
||||
info!("Number of pixels processed: {}.", counter);
|
||||
info!("Number of bytes in encoding: {:?}.", encoded_bytes.len()-22);
|
||||
info!("Compression rate: {:.2}%.", (1.0-(encoded_bytes.len()-22) as f64/(counter*4)as f64)*100.0);
|
||||
info!(
|
||||
"Number of bytes in encoding: {:?}.",
|
||||
encoded_bytes.len() - 22
|
||||
);
|
||||
info!(
|
||||
"Compression rate: {:.2}%.",
|
||||
(1.0 - (encoded_bytes.len() - 22) as f64 / (counter * 4) as f64) * 100.0
|
||||
);
|
||||
|
||||
encoded_bytes
|
||||
|
||||
}
|
||||
|
||||
/// Writes Image as byte vector to file with name given as string slice.
|
||||
/// ```rust
|
||||
/// use qoi::qoi_lib::*
|
||||
///
|
||||
/// let img = Image::new();
|
||||
/// let bytes: Vec<u8> = img.to_bytes();
|
||||
/// let name = "qoi-image";
|
||||
/// write_to_file(bytes, name);
|
||||
/// ```
|
||||
pub fn write_to_file(bytes: Vec<u8>, filename: &str) -> std::io::Result<()> {
|
||||
let mut file_path: String = String::from(filename);
|
||||
if !filename.contains(".qoi") {
|
||||
file_path.push_str(".qoi");
|
||||
}
|
||||
|
||||
let mut buffer = File::create(file_path)?;
|
||||
let mut pos = 0;
|
||||
@@ -528,7 +639,11 @@ pub mod qoi_img {
|
||||
}
|
||||
|
||||
fn read_header(bytes: &[u8]) -> Result<(u32, u32, u8, u8), ImgError> {
|
||||
if bytes[0] == 'q' as u8 && bytes[1] == 'o' as u8 && bytes[2] == 'i' as u8 && bytes[3] == 'f' as u8 {
|
||||
if bytes[0] == 'q' as u8
|
||||
&& bytes[1] == 'o' as u8
|
||||
&& bytes[2] == 'i' as u8
|
||||
&& bytes[3] == 'f' as u8
|
||||
{
|
||||
let mut width: u32 = 0b0000_0000_0000_0000_0000_0000_0000_0000;
|
||||
let mut height: u32 = 0b0000_0000_0000_0000_0000_0000_0000_0000;
|
||||
width |= ((bytes[4] as u32) << 24) as u32;
|
||||
@@ -631,7 +746,12 @@ pub mod qoi_img {
|
||||
let channels: u8;
|
||||
let colorspace: u8;
|
||||
|
||||
let mut prev_pixel: Pixel = Pixel {r: 0u8, g: 0u8, b: 0u8, a: 255u8};
|
||||
let mut prev_pixel: Pixel = Pixel {
|
||||
r: 0u8,
|
||||
g: 0u8,
|
||||
b: 0u8,
|
||||
a: 255u8,
|
||||
};
|
||||
|
||||
let mut prev_buffer: [Pixel; 64] = array_init::array_init(|_| Pixel::new(0, 0, 0, 0));
|
||||
|
||||
@@ -641,7 +761,7 @@ pub mod qoi_img {
|
||||
height = h;
|
||||
channels = ch;
|
||||
colorspace = c;
|
||||
},
|
||||
}
|
||||
Err(err) => {
|
||||
return Err(err);
|
||||
}
|
||||
@@ -667,41 +787,40 @@ pub mod qoi_img {
|
||||
|
||||
while i < bytes.len() {
|
||||
match read_tag(bytes[i]) {
|
||||
Ok(tag) => {
|
||||
match tag {
|
||||
Ok(tag) => match tag {
|
||||
ChunkType::RGB => {
|
||||
let dec_pix: Pixel = dec_rgb(&bytes[i..i + 4], prev_pixel.a);
|
||||
prev_pixel = dec_pix.clone();
|
||||
prev_buffer[color_hash(&dec_pix) as usize] = dec_pix.clone();
|
||||
pixels.push(dec_pix);
|
||||
i += 3;
|
||||
},
|
||||
}
|
||||
ChunkType::RGBA => {
|
||||
let dec_pix: Pixel = dec_rgba(&bytes[i..i + 5]);
|
||||
prev_pixel = dec_pix.clone();
|
||||
prev_buffer[color_hash(&dec_pix) as usize] = dec_pix.clone();
|
||||
pixels.push(dec_pix);
|
||||
i += 4;
|
||||
},
|
||||
}
|
||||
ChunkType::Diff => {
|
||||
let dec_pix: Pixel = dec_diff(bytes[i], &prev_pixel);
|
||||
prev_pixel = dec_pix.clone();
|
||||
prev_buffer[color_hash(&dec_pix) as usize] = dec_pix.clone();
|
||||
pixels.push(dec_pix);
|
||||
},
|
||||
}
|
||||
ChunkType::Index => {
|
||||
let dec_pix: Pixel = prev_buffer[bytes[i] as usize];
|
||||
prev_pixel = dec_pix.clone();
|
||||
prev_buffer[color_hash(&dec_pix) as usize] = dec_pix.clone();
|
||||
pixels.push(dec_pix);
|
||||
},
|
||||
}
|
||||
ChunkType::Luma => {
|
||||
let dec_pix: Pixel = dec_luma(&bytes[i..i + 2], &prev_pixel);
|
||||
prev_pixel = dec_pix.clone();
|
||||
prev_buffer[color_hash(&dec_pix) as usize] = dec_pix.clone();
|
||||
pixels.push(dec_pix);
|
||||
i += 1;
|
||||
},
|
||||
}
|
||||
ChunkType::Run => {
|
||||
let length: u8 = (bytes[i] & 0b00111111) + RUN_BIAS;
|
||||
for j in 0..length {
|
||||
@@ -709,7 +828,6 @@ pub mod qoi_img {
|
||||
}
|
||||
prev_buffer[color_hash(&prev_pixel) as usize] = prev_pixel.clone();
|
||||
}
|
||||
}
|
||||
},
|
||||
Err(err) => return Err(err),
|
||||
}
|
||||
@@ -724,19 +842,21 @@ pub mod qoi_img {
|
||||
|
||||
let img = Image::from_pixels(pixels, height, width, channels, colorspace);
|
||||
Ok(img)
|
||||
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
|
||||
use png::ColorType;
|
||||
|
||||
use super::*;
|
||||
use std::io;
|
||||
use std::io::{Read, BufReader};
|
||||
use std::fs::File;
|
||||
use std::io::{BufReader, Read};
|
||||
|
||||
#[test]
|
||||
fn diff_test() {
|
||||
init().expect("Logger initialisation failed!");
|
||||
let level: LevelFilter = LevelFilter::Debug;
|
||||
init(level).expect("Logger initialisation failed!");
|
||||
let pix1: Pixel = Pixel::new(0, 0, 0, 255);
|
||||
let pix2: Pixel = Pixel::new(255, 255, 255, 255);
|
||||
|
||||
@@ -750,42 +870,132 @@ mod tests {
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn encode_test() -> io::Result<()> {
|
||||
let f: File = File::open("test.qoi")?;
|
||||
let mut reader = BufReader::new(f);
|
||||
fn qoi_to_qoi_test() -> io::Result<()> {
|
||||
//Open path to test images
|
||||
let path: &Path = Path::new("./qoi_test_images/");
|
||||
let dir: ReadDir = match path.read_dir() {
|
||||
Ok(d) => d,
|
||||
Err(e) => panic!("Error reading path {e:?}"),
|
||||
};
|
||||
//Loop over files in directory, attempt to decode .qoi images and reencode
|
||||
for entry in dir {
|
||||
|
||||
let file_path = match entry {
|
||||
Ok(d) => d.path(),
|
||||
Err(e) => panic!("Non-functional dir entry! \n {e:?}")
|
||||
};
|
||||
let file_path_str = match file_path.to_str() {
|
||||
Some(s) => s,
|
||||
None => ""
|
||||
};
|
||||
if !(file_path_str.contains(".qoi")) {
|
||||
continue;
|
||||
}
|
||||
|
||||
let file = match File::open(&file_path) {
|
||||
Ok(f) => f,
|
||||
Err(e) => panic!("Error reading file with path {:?}", file_path_str),
|
||||
};
|
||||
let mut reader = BufReader::new(file);
|
||||
let mut bytes: Vec<u8> = Vec::new();
|
||||
|
||||
reader.read_to_end(&mut bytes)?;
|
||||
|
||||
let out_img: super::Image;
|
||||
|
||||
let output_image: super::Image;
|
||||
match super::decode(bytes) {
|
||||
Ok(img) => out_img = img,
|
||||
Err(err) => panic!("wallah geht nicht :/ {:?}", err)
|
||||
Ok(img) => output_image = img,
|
||||
Err(err) => panic!("Image decode failed for {:?}" , file_path.to_str())
|
||||
}
|
||||
write_to_file(encode_from_image(out_img), "test_dec").expect("wallahi!");
|
||||
let mut name = match file_path.file_name() {
|
||||
Some(s) => match s.to_str() {
|
||||
Some(ss) => ss,
|
||||
None => panic!("File Name Error!")
|
||||
},
|
||||
None => panic!("File Name Error!"),
|
||||
};
|
||||
name = match name.strip_suffix(".qoi") {
|
||||
Some(n) => n,
|
||||
None => name,
|
||||
};
|
||||
write_to_file(encode_from_image(output_image), name).expect("Writing image failed!");
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn decode_test() -> io::Result<()> {
|
||||
let f: File = File::open("testcard_rgba.qoi")?;
|
||||
let mut reader = BufReader::new(f);
|
||||
let mut bytes: Vec<u8> = Vec::new();
|
||||
fn png_to_qoi_test() -> io::Result<()> {
|
||||
//Open path to test images
|
||||
let path: &Path = Path::new("./qoi_test_images/");
|
||||
let dir: ReadDir = match path.read_dir() {
|
||||
Ok(d) => d,
|
||||
Err(e) => panic!("Error reading path {e:?}"),
|
||||
};
|
||||
//Loop over files in directory, attempt to decode png and encode as qoi, compare to qoi
|
||||
for entry in dir {
|
||||
|
||||
reader.read_to_end(&mut bytes)?;
|
||||
let file_path = match entry {
|
||||
Ok(d) => d.path(),
|
||||
Err(e) => panic!("Non-functional dir entry! \n {e:?}")
|
||||
};
|
||||
let file_path_str = match file_path.to_str() {
|
||||
Some(s) => s,
|
||||
None => ""
|
||||
};
|
||||
if !(file_path_str.contains(".png")) {
|
||||
continue;
|
||||
}
|
||||
debug!("{:}",file_path_str);
|
||||
let file = match File::open(&file_path) {
|
||||
Ok(f) => f,
|
||||
Err(e) => panic!("Cannot read file! \n {e:?}")
|
||||
};
|
||||
let decoder = png::Decoder::new(file);
|
||||
let mut reader = match decoder.read_info() {
|
||||
Ok(reader) => reader,
|
||||
Err(e) => panic!("ERROR: couldn't decode file: {e:}"),
|
||||
};
|
||||
//read image metadata
|
||||
let width: u32 = reader.info().width;
|
||||
let height: u32 = reader.info().height;
|
||||
//for now: hardcoded to 4
|
||||
let channels = match reader.info().color_type {
|
||||
ColorType::Rgb => 3,
|
||||
ColorType::Rgba => 4,
|
||||
_ => panic!("ERROR: Incompatible png file!")
|
||||
};
|
||||
|
||||
let out_img: super::Image;
|
||||
//create buffer matching the size of png-decoder output, writing size to output
|
||||
let mut buf = vec![0; reader.output_buffer_size()];
|
||||
let info = match reader.next_frame(&mut buf) {
|
||||
Ok(i) => i,
|
||||
Err(e) => panic!("ERROR: {e:?}"),
|
||||
};
|
||||
let bytes = &buf[..info.buffer_size()];
|
||||
let byte_vec: Vec<u8> = bytes.to_vec();
|
||||
|
||||
match super::decode(bytes) {
|
||||
Ok(img) => out_img = img,
|
||||
Err(err) => panic!("Ja bruder war nicht so erfolgreich ahahahahahha {:?}", err)
|
||||
//create bitmap data from raw byte vector
|
||||
let img: Image = match Image::new(byte_vec, height, width, channels, 0) {
|
||||
Ok(image) => image,
|
||||
Err(err) => panic!("Problem generating image: {:?}", err),
|
||||
};
|
||||
|
||||
let encoded_buffer = super::encode_from_image(img);
|
||||
let mut name = match file_path.file_name() {
|
||||
None => panic!("whoops!"),
|
||||
Some(n) => match n.to_str() {
|
||||
None => panic!("im shiddin"),
|
||||
Some(s) => s,
|
||||
},
|
||||
};
|
||||
name = match name.strip_suffix(".png") {
|
||||
Some(n) => n,
|
||||
None => name,
|
||||
};
|
||||
write_to_file(encoded_buffer,name ).expect("Can't write resulting file!");
|
||||
}
|
||||
|
||||
write_to_file(encode_from_image(out_img), "testcard_new").expect("Boowomb!");
|
||||
|
||||
Ok(())
|
||||
|
||||
}
|
||||
|
||||
#[test]
|
||||
@@ -798,7 +1008,6 @@ mod tests {
|
||||
let test_diff: u8 = 0b0110_1010;
|
||||
let test_index: u8 = 0b0010_1010;
|
||||
|
||||
|
||||
assert_eq!(Ok(ChunkType::RGB), super::read_tag(test_rgb));
|
||||
assert_eq!(Ok(ChunkType::RGBA), super::read_tag(test_rgba));
|
||||
assert_eq!(Ok(ChunkType::Luma), super::read_tag(test_luma));
|
||||
@@ -810,19 +1019,37 @@ mod tests {
|
||||
#[test]
|
||||
fn sub_decoders_test() {
|
||||
//init().expect("Logger initialisation failed!");
|
||||
let pix: Pixel = Pixel { r: 255, g: 255, b: 255, a: 255 };
|
||||
let prev: Pixel = Pixel { r: 1, g: 1, b: 1, a: 255 };
|
||||
let pix: Pixel = Pixel {
|
||||
r: 255,
|
||||
g: 255,
|
||||
b: 255,
|
||||
a: 255,
|
||||
};
|
||||
let prev: Pixel = Pixel {
|
||||
r: 1,
|
||||
g: 1,
|
||||
b: 1,
|
||||
a: 255,
|
||||
};
|
||||
let byte: u8 = 0b01000000;
|
||||
|
||||
assert_eq!(pix, dec_diff(byte, &prev));
|
||||
|
||||
let pix: Pixel = Pixel { r: 17, g: 22, b: 28, a: 100 };
|
||||
let prev: Pixel = Pixel { r: 10, g: 10, b: 10, a: 100 };
|
||||
let pix: Pixel = Pixel {
|
||||
r: 17,
|
||||
g: 22,
|
||||
b: 28,
|
||||
a: 100,
|
||||
};
|
||||
let prev: Pixel = Pixel {
|
||||
r: 10,
|
||||
g: 10,
|
||||
b: 10,
|
||||
a: 100,
|
||||
};
|
||||
let byte: [u8; 2] = [0b10101100, 0b00111110];
|
||||
|
||||
assert_eq!(pix, dec_luma(&byte[0..2], &prev));
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
248
src/main.rs
248
src/main.rs
@@ -1,12 +1,13 @@
|
||||
use std::env;
|
||||
|
||||
use clap::{Args,Parser, Subcommand};
|
||||
use std::fs::File;
|
||||
use std::io;
|
||||
use std::io::{BufReader, Read};
|
||||
use std::time::SystemTime;
|
||||
|
||||
use colors_transform::{Color, Hsl, Rgb};
|
||||
use png;
|
||||
use qoi_test::qoi_img::*;
|
||||
use qoi::qoi_lib::*;
|
||||
use log::{error,info};
|
||||
|
||||
fn encode_checkerboard() {
|
||||
let mut pixels: Vec<Pixel> = Vec::with_capacity(64 * 64);
|
||||
@@ -59,7 +60,7 @@ fn encode_debug() {
|
||||
1 => img_data.push(rgb.get_green() as u8),
|
||||
2 => img_data.push(rgb.get_blue() as u8),
|
||||
3 => img_data.push(alpha as u8),
|
||||
_ => panic!("unrecoverable for-loop failure"),
|
||||
_ => error!("unrecoverable for-loop failure"),
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -73,50 +74,21 @@ fn encode_debug() {
|
||||
let stop = match start.elapsed() {
|
||||
Ok(elapsed) => elapsed.as_millis(),
|
||||
Err(e) => {
|
||||
println!("Error: {e:?}");
|
||||
error!("Error: {e:?}");
|
||||
return ();
|
||||
}
|
||||
};
|
||||
println!("Encode took: {} ms.", stop);
|
||||
info!("Encode took: {} ms.", stop);
|
||||
write_to_file(img_bytes, "test").expect("Error writing file!");
|
||||
}
|
||||
|
||||
fn demo() {
|
||||
let decoder = png::Decoder::new(File::open("testcard_rgba.png").unwrap());
|
||||
let mut reader = match decoder.read_info() {
|
||||
Ok(reader) => reader,
|
||||
Err(e) => panic!("ERROR: couldn't read file: {e:}"),
|
||||
};
|
||||
let mut buf = vec![0; reader.output_buffer_size()];
|
||||
|
||||
let info = match reader.next_frame(&mut buf) {
|
||||
Ok(i) => i,
|
||||
Err(e) => panic!("ERROR: {e:?}"),
|
||||
};
|
||||
|
||||
let bytes = &buf[..info.buffer_size()];
|
||||
let byte_vec: Vec<u8> = bytes.to_vec();
|
||||
|
||||
let img: Image = match Image::new(byte_vec, 256, 256, 4, 0) {
|
||||
Ok(image) => image,
|
||||
Err(err) => panic!("Problem generating imag: {:?}", err),
|
||||
};
|
||||
let start = SystemTime::now();
|
||||
write_to_file(encode_from_image(img), "img").expect("Error writing file!");
|
||||
let stop = match start.elapsed() {
|
||||
Ok(elapsed) => elapsed.as_millis(),
|
||||
Err(e) => {
|
||||
println!("Error: {e:?}");
|
||||
return ();
|
||||
}
|
||||
};
|
||||
println!("Encode took: {} ms.", stop);
|
||||
let start = SystemTime::now();
|
||||
encode_checkerboard();
|
||||
let stop = match start.elapsed() {
|
||||
Ok(elapsed) => elapsed.as_millis(),
|
||||
Err(e) => {
|
||||
println!("Error: {e:?}");
|
||||
error!("Error: {e:?}");
|
||||
return ();
|
||||
}
|
||||
};
|
||||
@@ -125,12 +97,10 @@ fn demo() {
|
||||
}
|
||||
|
||||
//Attempts to encode given png image as second argument into qoi
|
||||
fn encode(args: &Vec<String>) {
|
||||
//Path is fetched from arguments
|
||||
let path = &args[2];
|
||||
fn encode(in_path: &str, out_path: &str) {
|
||||
|
||||
//Init png decoder, attempt to decode png into bitmap, throw error if unsuccessful
|
||||
let decoder = png::Decoder::new(File::open(path).unwrap());
|
||||
let decoder = png::Decoder::new(File::open(in_path).unwrap());
|
||||
let mut reader = match decoder.read_info() {
|
||||
Ok(reader) => reader,
|
||||
Err(e) => panic!("ERROR: couldn't read file: {e:}"),
|
||||
@@ -159,30 +129,13 @@ fn encode(args: &Vec<String>) {
|
||||
Err(err) => panic!("Problem generating image: {:?}", err),
|
||||
};
|
||||
|
||||
//encode generated bitmap
|
||||
if args.len() >= 4 {
|
||||
let filename: &String = &args[3];
|
||||
write_to_file(encode_from_image(img), filename).expect("ERROR: Can't write file.");
|
||||
} else {
|
||||
let mut filename = path.clone();
|
||||
for _i in 0..4 {
|
||||
filename.pop();
|
||||
}
|
||||
write_to_file(encode_from_image(img), filename.as_str()).expect("ERROR: Can't write file.");
|
||||
}
|
||||
println!("Encoding successful!");
|
||||
write_to_file(encode_from_image(img), out_path).expect("ERROR: Can't write file.");
|
||||
info!("Encoding successful!");
|
||||
}
|
||||
|
||||
fn decode(args: &Vec<String>) -> io::Result<()> {
|
||||
let mut path: String = String::new();
|
||||
if args.len() > 2 {
|
||||
path.push_str(args[2].as_str());
|
||||
} else {
|
||||
println!("ERROR: incorrect number of arguments! (specify file to decode!).");
|
||||
()
|
||||
}
|
||||
|
||||
let f: File = match File::open(path.as_str()) {
|
||||
fn decode(path: &str) -> Result<Image, std::io::Error> {
|
||||
let f: File = match File::open(path) {
|
||||
Ok(f) => f,
|
||||
Err(e) => panic!("ERROR: {e:?}"),
|
||||
};
|
||||
@@ -191,66 +144,155 @@ fn decode(args: &Vec<String>) -> io::Result<()> {
|
||||
|
||||
reader.read_to_end(&mut bytes)?;
|
||||
|
||||
match qoi_test::qoi_img::decode(bytes) {
|
||||
Ok(_img) => println!("Decoding successful!"),
|
||||
match qoi::qoi_lib::decode(bytes) {
|
||||
Ok(img) => {
|
||||
info!("Decoding successful!");
|
||||
return Ok(img);
|
||||
},
|
||||
Err(err) => panic!("ERROR: {err:?}"),
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn bench(args: &Vec<String>) {
|
||||
if args.len() < 4 {
|
||||
panic!("ERROR: invalid number of arguments!");
|
||||
}
|
||||
fn bench(input: &str, output: Option<String>) {
|
||||
|
||||
let start = SystemTime::now();
|
||||
encode(args);
|
||||
let out_path = match output {
|
||||
Some(s) => s,
|
||||
None => input.strip_suffix(".png").unwrap_or(input).to_owned()
|
||||
};
|
||||
|
||||
encode(input, &out_path);
|
||||
|
||||
match start.elapsed() {
|
||||
Ok(elapsed) => println!("Encode took {} μs", elapsed.as_micros()),
|
||||
Ok(elapsed) => {
|
||||
if elapsed.as_millis() == 0 {
|
||||
println!("Encode took {:?} μs to complete", elapsed.as_micros());
|
||||
} else if elapsed.as_millis() > 999 {
|
||||
println!("Encode took {:.3} s to complete", elapsed.as_secs_f32());
|
||||
} else {
|
||||
println!("Encode took {:?} ms to complete", elapsed.as_millis());
|
||||
}
|
||||
},
|
||||
|
||||
Err(e) => panic!("ERROR: {e:?}"),
|
||||
}
|
||||
let mut new_arg: Vec<String> = Vec::new();
|
||||
new_arg.push(String::from(""));
|
||||
new_arg.push(String::from(""));
|
||||
let mut to_push: String = args[3].clone();
|
||||
to_push.push_str(".qoi");
|
||||
new_arg.push(to_push);
|
||||
let start = SystemTime::now();
|
||||
decode(&new_arg).expect(
|
||||
"ERROR: Unspecified error during io-pipeline. Ensure file path is valid and can be read.",
|
||||
);
|
||||
let mut out_path: String = out_path.to_owned();
|
||||
if !out_path.contains(".qoi") {
|
||||
out_path.push_str(".qoi");
|
||||
}
|
||||
match decode(&out_path) {
|
||||
Ok(img) => {
|
||||
|
||||
let out_buf = img.to_bytes();
|
||||
let _ = write_to_file(out_buf, out_path.strip_suffix(".qoi").unwrap()).expect("whoops!");
|
||||
},
|
||||
Err(e) => panic!("Error: {e:?}")
|
||||
}
|
||||
match start.elapsed() {
|
||||
Ok(elapsed) => println!("Decode took {} μs", elapsed.as_micros()),
|
||||
Ok(elapsed) => {
|
||||
if elapsed.as_millis() == 0 {
|
||||
println!("Encode took {:?} μs to complete", elapsed.as_micros());
|
||||
} else if elapsed.as_millis() > 999 {
|
||||
println!("Encode took {:.3} s to complete", elapsed.as_secs_f32());
|
||||
} else {
|
||||
println!("Encode took {:?} ms to complete", elapsed.as_millis());
|
||||
}
|
||||
},
|
||||
|
||||
Err(e) => panic!("ERROR: {e:?}"),
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Parser)]
|
||||
#[command(name = "QOI Image Transcoder")]
|
||||
#[command(version, about, long_about = None)]
|
||||
#[command(next_line_help = true)]
|
||||
struct Cli {
|
||||
/// Specify log verbosity, respects multiple applications.
|
||||
#[arg(short,long, action = clap::ArgAction::Count)]
|
||||
verbose: Option<u8>,
|
||||
|
||||
#[command(subcommand)]
|
||||
command: Commands
|
||||
}
|
||||
|
||||
#[derive(Subcommand)]
|
||||
enum Commands {
|
||||
/// Encode given [IMAGE] from { png } to qoi.
|
||||
Encode(EncodeArgs),
|
||||
/// Decode given qoi to specified [FORMAT].
|
||||
Decode(DecodeArgs),
|
||||
/// Benchmark en- and decoder by passing in [IMAGE] and optionally specifying [OUTPUT] file.
|
||||
Bench(BenchArgs),
|
||||
/// Demo the application.
|
||||
Demo {
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Args)]
|
||||
struct BenchArgs {
|
||||
/// File to be encoded.
|
||||
#[arg(short,long)]
|
||||
input: String,
|
||||
/// Optional output path.
|
||||
#[arg(short,long)]
|
||||
output: Option<String>
|
||||
}
|
||||
|
||||
#[derive(Args)]
|
||||
struct DecodeArgs {
|
||||
/// Qoi file to be decoded
|
||||
#[arg(short,long)]
|
||||
input: String,
|
||||
/// Format to transcode into
|
||||
#[arg(short,long)]
|
||||
format: String,
|
||||
/// Optional file path
|
||||
#[arg(short,long)]
|
||||
output: Option<String>
|
||||
}
|
||||
|
||||
#[derive(Args)]
|
||||
struct EncodeArgs {
|
||||
// File to be encoded
|
||||
#[arg(short,long)]
|
||||
input: String,
|
||||
// Optional output path
|
||||
#[arg(short,long)]
|
||||
output: Option<String>
|
||||
}
|
||||
|
||||
fn main() {
|
||||
//Initialize logger
|
||||
init().expect("Failed to initialize logger.");
|
||||
let cli: Cli = Cli::parse();
|
||||
|
||||
let args: Vec<String> = env::args().collect();
|
||||
|
||||
if args.len() == 1 {
|
||||
panic!("ERROR: no arguments send!");
|
||||
}
|
||||
|
||||
match args[1].as_str() {
|
||||
"demo" => {
|
||||
demo();
|
||||
}
|
||||
//can only handle pngs for now
|
||||
"encode" => {
|
||||
encode(&args);
|
||||
}
|
||||
"decode" => {
|
||||
decode(&args).expect("ERROR: Unspecified error during io-pipeline. Ensure file path is valid and can be read.");
|
||||
}
|
||||
"bench" => {
|
||||
bench(&args);
|
||||
}
|
||||
_ => {
|
||||
panic!("Invalid arguments!")
|
||||
match &cli.command {
|
||||
Commands::Bench(args) => {
|
||||
bench(&args.input, args.output.clone());
|
||||
},
|
||||
Commands::Decode(args)=> {
|
||||
if args.format != "png" {
|
||||
panic!("Unsupported output format!")
|
||||
} else {
|
||||
let img = match decode(&args.input) {
|
||||
Ok(i) => i,
|
||||
Err(e) => panic!("Error: {e:?}")
|
||||
};
|
||||
let out_path = match &args.output {
|
||||
Some(s) => s,
|
||||
None => &args.input
|
||||
};
|
||||
img.write_png(&out_path);
|
||||
}
|
||||
},
|
||||
Commands::Encode(args) => {
|
||||
let out_path = match &args.output {
|
||||
Some(s) => s,
|
||||
None => &args.input
|
||||
};
|
||||
encode(&args.input, &out_path);
|
||||
},
|
||||
Commands::Demo { } => demo()
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user