Skip to content
This repository has been archived by the owner on Dec 17, 2024. It is now read-only.

Commit

Permalink
Bump version to 0.1.3 to update README
Browse files Browse the repository at this point in the history
  • Loading branch information
BuyMyMojo committed Nov 26, 2022
1 parent 7493eb7 commit 2f1b7df
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 8 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "as2c"
version = "0.1.2"
version = "0.1.3"
authors = ["BuyMyMojo <hello@buymymojo.net>", "Josh Holmer <jholmer.in@gmail.com>", "Luigi311 <git@luigi311.com>"]
edition = "2021"
categories = [
Expand Down
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,31 @@

A fork of [ssimulacra2_bin](https://github.com/rust-av/ssimulacra2_bin) that I could not stop adding things to. *whoops*

If you want **full video input support** check out their version, mine is going to be a little jank as it focusses on multithreaded speed.
If you want **full ffmpeg based video support** check out their version. My version is based on folders of images and full windows compatability.

Binary interface to the Rust implementation of the SSIMULACRA2 metric: <https://github.com/rust-av/ssimulacra2>
CLI for the Rust implementation of SSIMULACRA2: <https://github.com/rust-av/ssimulacra2>

## Download

Get the latest executable from the automated [release build action](https://github.com/BuyMyMojo/ssimulacra2_bin/actions/workflows/rust.yml)
Get the release version from [here](https://github.com/BuyMyMojo/another_ssimulacra2_cli/releases)

Get the requivalent of a nightly build from the [build action](https://github.com/BuyMyMojo/ssimulacra2_bin/actions/workflows/rust.yml)

## Install

To install with cargo just run:
### Cargo Crates.io

```bash
cargo install --path .
cargo install as2c
```

then you can just execute `as2c` from your terminal.
### Cargo Git

```bash
cargo install as2c --git https://github.com/BuyMyMojo/another_ssimulacra2_cli
```

then you can just run `as2c` from your terminal.

## usage

Expand Down Expand Up @@ -81,6 +89,8 @@ or just
as2c[.exe] -f ./source/ ./compressed/ ./
```

example csv table:

| frame | ssimulacra2 |
| ----- | ------------------ |
| 0 | 49.924279448275605 |
Expand Down Expand Up @@ -137,3 +147,5 @@ HybridLogGamma
## Memory usage

On my 5600x when comparing two folders of 1440p PNG files it can use 3-4GB of ram since it basically has 12 pairs of raw 1440p images in memory.

make sure to lower the threads used with `--threads` if you run out of memory.

0 comments on commit 2f1b7df

Please sign in to comment.