Add tests and benchmarks

.ci/bench.sh

@@ -0,0 +1,46 @@
+#!/bin/bash
+set -e
+
+name=$(basename "$0")
+root=$(realpath "$(dirname "$(dirname "$0")")")
+target_dir="$root/lib/target"
+
+if ! [ -x "$(command -v critcmp)" ]; then
+    echo "Installing critcmp..."
+    cargo install critcmp
+fi
+
+function sub_help() {
+    printf "Usage: %s <subcommand> [options]\n" "$name"
+    echo "Subcommands:"
+    echo "    export    Exports the specified baselines to json in the benches dir"
+    echo "    cmp       Compare two benchmarks by name"
+    echo ""
+    echo "For help with each subcommand run:"
+    echo "$name <subcommand> -h | --help"
+    echo ""
+}
+
+function sub_cmp() {
+    critcmp --target-dir "$target_dir" "$@"
+}
+
+function sub_export() {
+    critcmp --target-dir "$target_dir" --export "$1" > "$root/lib/benches/${2:-$1}.json"
+}
+
+subcommand=$1
+case $subcommand in
+    "" | "-h" | "--help")
+        sub_help
+        ;;
+    *)
+        shift
+        "sub_${subcommand}" "$@"
+        if [ $? = 127 ]; then
+            echo "Error: '$subcommand' is not a known subcommand." >&2
+            echo "       Run '$name --help' for a list of known subcommands." >&2
+            exit 1
+        fi
+        ;;
+esac

.githooks/pre-push

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+# Run rustfmt and fail if there is a diff
+cargo fmt -- --check

.githooks/setup.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+# Run this script from your shell (git bash if you're on windows!)
+# * pre-push - Fails to push if you haven't run `cargo fmt`
+
+git config core.hooksPath .githooks

.gitignore

@@ -1,5 +1,6 @@
 /target
 cli/target
+lib/target
 **/*.rs.bk
 Cargo.lock
 /out

CHANGELOG.md

@@ -5,6 +5,18 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- You can now specify the maximum number of threads that can be used at any one time
+via `SessionBuilder::max_thread_count`
+- CLI: You can now specify the maximum thread count via `-t | --threads`
+- Added `From<image::DynamicImage>` for `ImageSource`
+- Added integrations tests for different examples, to catch regressions in generation
+- Added criterion benchmarks for the different examples, to catch performance regressions
+
+### Changed
+- `SampleMethod::From<AsRef<Path>>` is now `SampleMethod::From<Into<ImageSource>>`
+- `Example::From<AsRef<Path>>` is now `Example::From<Into<ImageSource>>`
+
 ### Fixed
 - Disabled unused `rand` default features (OS random number generator)
 

Cargo.toml

@@ -3,3 +3,9 @@ members = [
     "lib",
     "cli",
 ]
+
+[patch.crates-io]
+# https://github.com/abonander/img_hash/pull/30
+# * Updates to use image 0.22
+# * Fixes a bug with to/from_base64
+img_hash = { git = "https://github.com/EmbarkStudios/img_hash.git", rev = "c40da78" }

cli/Cargo.toml

@@ -19,14 +19,15 @@ keywords = ["texture", "synthesis", "procedural", "cli"]
 [[bin]]
 name = "texture-synthesis"
 path = "src/main.rs"
+bench = false
 
 [dependencies]
 # We unfortunately can't use clicolors-control which is used by indicatif
 # because it only ever operates on stdout, even though we only ever print
 # to stderr. This is also why indicatif colors don't work if you pipe
 # the image output :(
 atty = "0.2.13"
-indicatif = "0.11.0"
+indicatif = "0.12.0"
 minifb = { version = "0.13.0", optional = true }
 structopt = "0.3.0"
 texture-synthesis = { version = "0.4.2", path = "../lib" }

cli/src/main.rs

@@ -165,6 +165,10 @@ struct Opt {
     /// * `uncertainty.png` - Map of pixels the generator was uncertain of
     #[structopt(long, parse(from_os_str))]
     debug_out_dir: Option<PathBuf>,
+    /// The maximum number of worker threads that can be active at any one time
+    /// while synthesizing images. Defaults to the logical core count.
+    #[structopt(short = "t", long = "threads")]
+    max_threads: Option<usize>,
     #[structopt(flatten)]
     tweaks: Tweaks,
     #[structopt(subcommand)]
@@ -255,9 +259,14 @@ fn real_main() -> Result<(), Error> {
         .guide_alpha(args.tweaks.alpha)
         .tiling_mode(args.tweaks.enable_tiling);
 
+    if let Some(mt) = args.max_threads {
+        sb = sb.max_thread_count(mt);
+    }
+
     if let Some(ref tg) = target_guide {
         sb = sb.load_target_guide(tg);
     }
+
     if let Some(rand_init) = args.tweaks.rand_init {
         sb = sb.random_init(rand_init);
     }

deny.toml

@@ -15,14 +15,14 @@ deny = [
     { name = "term" },
 ]
 skip = [
-    # indicatif uses an older version of parking_lot which brings
-    # in an older version of rand crates
+    # minifb orbclient uses an older version rand 0.6.5
     { name = "rand", version = "=0.6.5" },
     { name = "rand_chacha", version = "=0.1.1" },
     { name = "rand_core", version = "=0.4.2" },
     { name = "rand_core", version = "=0.3.1" },
     { name = "rand_hc", version = "=0.1.0" },
     { name = "rand_pcg", version = "=0.1.2" },
+    { name = "rand_os", version = "=0.1.3" },
 ]
 
 [licenses]
@@ -33,11 +33,24 @@ confidence_threshold = 0.92
 allow = [
     "Apache-2.0",
     "BSD-2-Clause",
+    "BSD-2-Clause-FreeBSD",
     "BSD-3-Clause",
+    "BSL-1.0",
     "CC0-1.0",
     "ISC",
     "LLVM-exception",
     "MIT",
     "Unlicense",
     "Zlib",
 ]
+
+[[licenses.ignore]]
+name = "criterion-plot"
+license_files = [
+    # This is just a symlink to a the license in the root or criterion, which
+    # is a normal Apache-2.0, but when published, the symlink is converted
+    # to a regular file, pointing to a now non-existent root file.
+    { path = "LICENSE-APACHE", hash = 0xa577772b },
+    # Ditto
+    { path = "LICENSE-MIT", hash = 0x343f7050 },
+]

lib/Cargo.toml

@@ -33,6 +33,17 @@ default-features = false
 features = []
 
 [dependencies.image]
-version = "0.22.1"
+version = "0.22.2"
 default-features = false
 features = ["jpeg", "png_codec", "bmp"]
+
+[dev-dependencies]
+criterion = "0.3.0"
+img_hash = { version = "2.1.0", default-features = false }
+
+[lib]
+bench = false
+
+[[bench]]
+name = "all-the-things"
+harness = false