From 35d594032e728a3400b117d6d959edfb6e285bf1 Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Tue, 23 Jul 2024 15:40:22 +0200 Subject: [PATCH 01/17] Add no_std support --- Cargo.toml | 7 ++++++- src/base83.rs | 3 +++ src/error.rs | 24 ++++++++++++++---------- src/lib.rs | 16 +++++++++++++++- 4 files changed, 38 insertions(+), 12 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 259a3c0..d19e13b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -10,9 +10,13 @@ version = "0.2.3" authors = ["Ruben De Smet ", "Raincal "] edition = "2018" +[lib] +crate-type = ["cdylib", "rlib"] + [dependencies] image = { version = ">= 0.23, <= 0.25", optional = true } gdk-pixbuf = { version = ">= 0.18, <= 0.19", optional = true } +num-traits = { version = "0.2", default-features = false, features = ["libm"] } [dev-dependencies] image = ">= 0.23, <= 0.25" @@ -20,7 +24,8 @@ criterion = "0.5" proptest = "1" [features] -default = ["fast-linear-to-srgb"] +default = ["fast-linear-to-srgb", "std"] +std = [] image = [ "dep:image" ] gdk-pixbuf = [ "dep:gdk-pixbuf" ] fast-linear-to-srgb = [] diff --git a/src/base83.rs b/src/base83.rs index 1593679..98bf7b9 100644 --- a/src/base83.rs +++ b/src/base83.rs @@ -1,3 +1,6 @@ +#[cfg(not(feature = "std"))] +use alloc::string::String; + use crate::Error; include!(concat!(env!("OUT_DIR"), "/base83_lookup.rs")); diff --git a/src/error.rs b/src/error.rs index 3910428..689f6cc 100644 --- a/src/error.rs +++ b/src/error.rs @@ -1,4 +1,4 @@ -use std::fmt; +use core::fmt; #[derive(Debug)] pub enum Error { @@ -11,18 +11,22 @@ pub enum Error { impl fmt::Display for Error { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { - let message = match self { - Error::HashTooShort => "blurhash must be at least 6 characters long".to_string(), - Error::LengthMismatch { expected, actual } => format!( + match self { + Error::HashTooShort => write!(f, "blurhash must be at least 6 characters long"), + Error::LengthMismatch { expected, actual } => write!( + f, "blurhash length mismatch: length is {} but it should be {}", actual, expected ), - Error::InvalidBase83(byte) => format!("Invalid base83 character: {:?}", *byte as char), - Error::InvalidAscii => "blurhash must be valid ASCII".into(), - Error::ComponentsOutOfRange => "blurhash must have between 1 and 9 components".into(), - }; - write!(f, "{}", message) + Error::InvalidBase83(byte) => { + write!(f, "Invalid base83 character: {:?}", *byte as char) + } + Error::InvalidAscii => write!(f, "blurhash must be valid ASCII"), + Error::ComponentsOutOfRange => { + write!(f, "blurhash must have between 1 and 9 components") + } + } } } -impl std::error::Error for Error {} +impl core::error::Error for Error {} diff --git a/src/lib.rs b/src/lib.rs index 05c3a05..68839d4 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,6 @@ +#![cfg_attr(not(any(test, feature = "std")), no_std)] +#![cfg_attr(not(any(test, feature = "std")), feature(error_in_core))] + //! A pure Rust implementation of [woltapp/blurhash][1]. //! //! ### Encoding @@ -27,9 +30,20 @@ mod dc; mod error; mod util; +#[cfg(not(feature = "std"))] +#[macro_use] +extern crate alloc; + +#[cfg(not(feature = "std"))] +use alloc::{string::String, vec::Vec}; + +#[cfg(not(feature = "std"))] +#[allow(unused_imports)] +use num_traits::real::Real; + pub use error::Error; -use std::f32::consts::PI; +use core::f32::consts::PI; use util::{linear_to_srgb, srgb_to_linear}; /// Calculates the blurhash for an image using the given x and y component counts. From 1857b096ecfef6419bd97eac2e228573fab083c0 Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Tue, 23 Jul 2024 15:50:54 +0200 Subject: [PATCH 02/17] Add feature matrix to CI --- .github/workflows/build.yml | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 394c27c..6d929a5 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -24,6 +24,19 @@ jobs: matrix: toolchain: ["stable", "beta"] coverage: [false] + features: [ + # With std + "std,gdk-pixbuf", + "std,gdk-pixbuf,fast-linear-to-srgb", + "std,image", + "std,image,fast-linear-to-srgb", + "std,fast-linear-to-srgb", + "std", + + # no_std + "fast-linear-to-srgb", + "", + ] include: - toolchain: "nightly" coverage: true @@ -47,18 +60,25 @@ jobs: - name: Run tests with default features uses: actions-rs/cargo@v1 - if: ${{ !matrix.coverage }} + if: ${{ !matrix.coverage && matrix.features == '' }} with: command: test args: --all-targets --no-fail-fast - name: Run tests with all features uses: actions-rs/cargo@v1 - if: ${{ !matrix.coverage }} + if: ${{ !matrix.coverage && matrix.features == '' }} with: command: test args: --all-targets --no-fail-fast --all-features + - name: Run tests with ${{ matrix.features }} + uses: actions-rs/cargo@v1 + if: ${{ !matrix.coverage && matrix.features != '' }} + with: + command: test + args: --all-targets --no-fail-fast --no-default-features --features ${{ matrix.features }} + - name: Run doc tests uses: actions-rs/cargo@v1 if: ${{ !matrix.coverage }} From 5d19aa6588cfbb8272aba5f8f896a1eb9bfd1292 Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Tue, 23 Jul 2024 15:56:44 +0200 Subject: [PATCH 03/17] Only execute no_std tests on nightly --- .github/workflows/build.yml | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 6d929a5..37f5905 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -32,14 +32,17 @@ jobs: "std,image,fast-linear-to-srgb", "std,fast-linear-to-srgb", "std", - - # no_std - "fast-linear-to-srgb", - "", ] include: - toolchain: "nightly" coverage: true + features: "" + - toolchain: "nightly" + coverage: false + features: "fast-linear-to-srgb" + - toolchain: "nightly" + coverage: false + features: "" steps: - name: Checkout repository uses: actions/checkout@v2 From 4e9777357978f20ec274d1b8736ab39489cb5bb1 Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Tue, 23 Jul 2024 15:59:43 +0200 Subject: [PATCH 04/17] Use std::error on std builds --- src/error.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/error.rs b/src/error.rs index 689f6cc..2f140de 100644 --- a/src/error.rs +++ b/src/error.rs @@ -29,4 +29,7 @@ impl fmt::Display for Error { } } +#[cfg(not(feature = "std"))] impl core::error::Error for Error {} +#[cfg(feature = "std")] +impl std::error::Error for Error {} From 9254a30ebaccc0caf61d437208a48af57ec0bf6f Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Tue, 23 Jul 2024 16:03:52 +0200 Subject: [PATCH 05/17] Document no_std usage --- README.md | 11 ++++++++++- src/lib.rs | 1 - 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ab25377..d194c1d 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,18 @@ If this overhead is problematic, you can disable it by instead specifying the fo ```toml [dependencies] -blurhash = { version = "0.2.3", default-features = false } +blurhash = { version = "0.2.3", default-features = false, features = ["std"] } ``` +Blurhash can also run in `no_std` environments (with `alloc`) by disabling the default features: + +```toml +[dependencies] +blurhash = { version = "0.2.4", default-features = false, features = ["fast-linear-to-srgb"] } +``` + +Blurhash requires Rust 1.82 or later when using `no_std`. + ### Encoding ```rust use blurhash::encode; diff --git a/src/lib.rs b/src/lib.rs index 68839d4..1a5c9ef 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,5 +1,4 @@ #![cfg_attr(not(any(test, feature = "std")), no_std)] -#![cfg_attr(not(any(test, feature = "std")), feature(error_in_core))] //! A pure Rust implementation of [woltapp/blurhash][1]. //! From 77692e387eec06899c1040955ce32e5d61fbbe7e Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Tue, 23 Jul 2024 16:05:22 +0200 Subject: [PATCH 06/17] Enable empty featureset test --- .github/workflows/build.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 37f5905..3db6668 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -75,12 +75,12 @@ jobs: command: test args: --all-targets --no-fail-fast --all-features - - name: Run tests with ${{ matrix.features }} + - name: "Run tests with features: ${{ matrix.features }}" uses: actions-rs/cargo@v1 - if: ${{ !matrix.coverage && matrix.features != '' }} + if: ${{ !matrix.coverage }} with: command: test - args: --all-targets --no-fail-fast --no-default-features --features ${{ matrix.features }} + args: --all-targets --no-fail-fast --no-default-features --features "${{ matrix.features }}" - name: Run doc tests uses: actions-rs/cargo@v1 From 93c1022afc0a225222ba74bf9b10abe2e5660254 Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Tue, 23 Jul 2024 16:20:33 +0200 Subject: [PATCH 07/17] Run default/all-features on empty OR std featureset --- .github/workflows/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3db6668..4d00aa0 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -63,14 +63,14 @@ jobs: - name: Run tests with default features uses: actions-rs/cargo@v1 - if: ${{ !matrix.coverage && matrix.features == '' }} + if: ${{ !matrix.coverage && (matrix.features == '' || matrix.features == 'std') }} with: command: test args: --all-targets --no-fail-fast - name: Run tests with all features uses: actions-rs/cargo@v1 - if: ${{ !matrix.coverage && matrix.features == '' }} + if: ${{ !matrix.coverage && (matrix.features == '' || matrix.features == 'std') }} with: command: test args: --all-targets --no-fail-fast --all-features From 5708e4c7b18b4d326fe1e1793f2939c7c26c7d49 Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Tue, 23 Jul 2024 16:21:23 +0200 Subject: [PATCH 08/17] Document no-std CI --- .github/workflows/build.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 4d00aa0..77035ce 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -34,12 +34,16 @@ jobs: "std", ] include: + # Coverage on nightly - toolchain: "nightly" coverage: true features: "" + + # no-std build and tests - toolchain: "nightly" coverage: false features: "fast-linear-to-srgb" + - toolchain: "nightly" coverage: false features: "" From 8c83d712c170c2d299b6f2a5fdfb2e582993471f Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Tue, 23 Jul 2024 17:07:09 +0200 Subject: [PATCH 09/17] Add wasm feature --- Cargo.toml | 4 ++++ src/lib.rs | 3 +++ src/wasm.rs | 29 +++++++++++++++++++++++++++++ 3 files changed, 36 insertions(+) create mode 100644 src/wasm.rs diff --git a/Cargo.toml b/Cargo.toml index d19e13b..742074d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -17,6 +17,8 @@ crate-type = ["cdylib", "rlib"] image = { version = ">= 0.23, <= 0.25", optional = true } gdk-pixbuf = { version = ">= 0.18, <= 0.19", optional = true } num-traits = { version = "0.2", default-features = false, features = ["libm"] } +wasm-bindgen = { version = "0.2", optional = true } +js-sys = { version = "0.3", optional = true } [dev-dependencies] image = ">= 0.23, <= 0.25" @@ -30,6 +32,8 @@ image = [ "dep:image" ] gdk-pixbuf = [ "dep:gdk-pixbuf" ] fast-linear-to-srgb = [] +wasm = ["dep:wasm-bindgen", "dep:js-sys"] + [[bench]] name = "decode" harness = false diff --git a/src/lib.rs b/src/lib.rs index 1a5c9ef..2c5d0b4 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -40,6 +40,9 @@ use alloc::{string::String, vec::Vec}; #[allow(unused_imports)] use num_traits::real::Real; +#[cfg(feature = "wasm")] +mod wasm; + pub use error::Error; use core::f32::consts::PI; diff --git a/src/wasm.rs b/src/wasm.rs new file mode 100644 index 0000000..95c31d3 --- /dev/null +++ b/src/wasm.rs @@ -0,0 +1,29 @@ +#[cfg(not(feature = "std"))] +use alloc::{ + string::{String, ToString}, + vec::Vec, +}; +use wasm_bindgen::prelude::*; + +#[wasm_bindgen] +pub fn encode( + components_x: u32, + components_y: u32, + width: u32, + height: u32, + rgba_image: &[u8], +) -> Result { + crate::encode(components_x, components_y, width, height, rgba_image) + .map_err(|err| js_sys::Error::new(&err.to_string()).into()) +} + +#[wasm_bindgen] +pub fn decode( + blurhash: &str, + width: u32, + height: u32, + punch: f32, +) -> Result, js_sys::Error> { + crate::decode(blurhash, width, height, punch) + .map_err(|err| js_sys::Error::new(&err.to_string()).into()) +} From ad21ac0a3c6a59a89aa08fdd56ab5338870a24d3 Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Tue, 23 Jul 2024 17:08:04 +0200 Subject: [PATCH 10/17] Document WASM feature --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index d194c1d..227b9c9 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,15 @@ blurhash = { version = "0.2.4", default-features = false, features = ["fast-line Blurhash requires Rust 1.82 or later when using `no_std`. +Blurhash can also be run with WebAssembly by enabling the `wasm` feature: + +```toml +[dependencies] +blurhash = { version = "0.2.4", features = ["wasm"] } +``` + +The `wasm` feature is compatible with `no_std`. + ### Encoding ```rust use blurhash::encode; From ee5d43fe7db46716bb8959c820f381b34241c659 Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Tue, 23 Jul 2024 17:08:31 +0200 Subject: [PATCH 11/17] Add wasm to CI --- .github/workflows/build.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 77035ce..5282824 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -31,6 +31,8 @@ jobs: "std,image", "std,image,fast-linear-to-srgb", "std,fast-linear-to-srgb", + "std,fast-linear-to-srgb,wasm", + "std,wasm", "std", ] include: @@ -44,6 +46,10 @@ jobs: coverage: false features: "fast-linear-to-srgb" + - toolchain: "nightly" + coverage: false + features: "wasm" + - toolchain: "nightly" coverage: false features: "" From 511fee0a8aadf361808f03bb5d6153e92f4fd702 Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Wed, 24 Jul 2024 10:20:39 +0200 Subject: [PATCH 12/17] Add punch as option --- src/wasm.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/wasm.rs b/src/wasm.rs index 95c31d3..cf5c386 100644 --- a/src/wasm.rs +++ b/src/wasm.rs @@ -22,8 +22,9 @@ pub fn decode( blurhash: &str, width: u32, height: u32, - punch: f32, + punch: Option, ) -> Result, js_sys::Error> { + let punch = punch.unwrap_or(1.0); crate::decode(blurhash, width, height, punch) .map_err(|err| js_sys::Error::new(&err.to_string()).into()) } From 5f4ff1a1d841cc1f037936b49bff373dd0fd4283 Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Wed, 24 Jul 2024 10:56:10 +0200 Subject: [PATCH 13/17] Move wasm stuff into separate crate --- Cargo.toml | 16 +-- blurhash-rs-wasm/.gitignore | 6 + blurhash-rs-wasm/.travis.yml | 69 +++++++++++ blurhash-rs-wasm/Cargo.toml | 27 +++++ blurhash-rs-wasm/LICENSE-APACHE | 201 ++++++++++++++++++++++++++++++++ blurhash-rs-wasm/LICENSE-MIT | 25 ++++ blurhash-rs-wasm/README.md | 84 +++++++++++++ blurhash-rs-wasm/src/lib.rs | 45 +++++++ blurhash-rs-wasm/src/utils.rs | 10 ++ blurhash-rs-wasm/tests/web.rs | 13 +++ src/ac.rs | 3 + src/lib.rs | 4 - src/util.rs | 3 + 13 files changed, 495 insertions(+), 11 deletions(-) create mode 100644 blurhash-rs-wasm/.gitignore create mode 100644 blurhash-rs-wasm/.travis.yml create mode 100644 blurhash-rs-wasm/Cargo.toml create mode 100644 blurhash-rs-wasm/LICENSE-APACHE create mode 100644 blurhash-rs-wasm/LICENSE-MIT create mode 100644 blurhash-rs-wasm/README.md create mode 100644 blurhash-rs-wasm/src/lib.rs create mode 100644 blurhash-rs-wasm/src/utils.rs create mode 100644 blurhash-rs-wasm/tests/web.rs diff --git a/Cargo.toml b/Cargo.toml index 742074d..988df8f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -10,15 +10,10 @@ version = "0.2.3" authors = ["Ruben De Smet ", "Raincal "] edition = "2018" -[lib] -crate-type = ["cdylib", "rlib"] - [dependencies] image = { version = ">= 0.23, <= 0.25", optional = true } gdk-pixbuf = { version = ">= 0.18, <= 0.19", optional = true } num-traits = { version = "0.2", default-features = false, features = ["libm"] } -wasm-bindgen = { version = "0.2", optional = true } -js-sys = { version = "0.3", optional = true } [dev-dependencies] image = ">= 0.23, <= 0.25" @@ -32,8 +27,6 @@ image = [ "dep:image" ] gdk-pixbuf = [ "dep:gdk-pixbuf" ] fast-linear-to-srgb = [] -wasm = ["dep:wasm-bindgen", "dep:js-sys"] - [[bench]] name = "decode" harness = false @@ -41,3 +34,12 @@ harness = false [[bench]] name = "encode" harness = false + +[workspace] +members = [ + "blurhash-rs-wasm", +] + +[profile.release] #.package.blurhash-rs-wasm] +# Tell `rustc` to optimize for small code size. +opt-level = "z" diff --git a/blurhash-rs-wasm/.gitignore b/blurhash-rs-wasm/.gitignore new file mode 100644 index 0000000..4e30131 --- /dev/null +++ b/blurhash-rs-wasm/.gitignore @@ -0,0 +1,6 @@ +/target +**/*.rs.bk +Cargo.lock +bin/ +pkg/ +wasm-pack.log diff --git a/blurhash-rs-wasm/.travis.yml b/blurhash-rs-wasm/.travis.yml new file mode 100644 index 0000000..7a91325 --- /dev/null +++ b/blurhash-rs-wasm/.travis.yml @@ -0,0 +1,69 @@ +language: rust +sudo: false + +cache: cargo + +matrix: + include: + + # Builds with wasm-pack. + - rust: beta + env: RUST_BACKTRACE=1 + addons: + firefox: latest + chrome: stable + before_script: + - (test -x $HOME/.cargo/bin/cargo-install-update || cargo install cargo-update) + - (test -x $HOME/.cargo/bin/cargo-generate || cargo install --vers "^0.2" cargo-generate) + - cargo install-update -a + - curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh -s -- -f + script: + - cargo generate --git . --name testing + # Having a broken Cargo.toml (in that it has curlies in fields) anywhere + # in any of our parent dirs is problematic. + - mv Cargo.toml Cargo.toml.tmpl + - cd testing + - wasm-pack build + - wasm-pack test --chrome --firefox --headless + + # Builds on nightly. + - rust: nightly + env: RUST_BACKTRACE=1 + before_script: + - (test -x $HOME/.cargo/bin/cargo-install-update || cargo install cargo-update) + - (test -x $HOME/.cargo/bin/cargo-generate || cargo install --vers "^0.2" cargo-generate) + - cargo install-update -a + - rustup target add wasm32-unknown-unknown + script: + - cargo generate --git . --name testing + - mv Cargo.toml Cargo.toml.tmpl + - cd testing + - cargo check + - cargo check --target wasm32-unknown-unknown + - cargo check --no-default-features + - cargo check --target wasm32-unknown-unknown --no-default-features + - cargo check --no-default-features --features console_error_panic_hook + - cargo check --target wasm32-unknown-unknown --no-default-features --features console_error_panic_hook + - cargo check --no-default-features --features "console_error_panic_hook wee_alloc" + - cargo check --target wasm32-unknown-unknown --no-default-features --features "console_error_panic_hook wee_alloc" + + # Builds on beta. + - rust: beta + env: RUST_BACKTRACE=1 + before_script: + - (test -x $HOME/.cargo/bin/cargo-install-update || cargo install cargo-update) + - (test -x $HOME/.cargo/bin/cargo-generate || cargo install --vers "^0.2" cargo-generate) + - cargo install-update -a + - rustup target add wasm32-unknown-unknown + script: + - cargo generate --git . --name testing + - mv Cargo.toml Cargo.toml.tmpl + - cd testing + - cargo check + - cargo check --target wasm32-unknown-unknown + - cargo check --no-default-features + - cargo check --target wasm32-unknown-unknown --no-default-features + - cargo check --no-default-features --features console_error_panic_hook + - cargo check --target wasm32-unknown-unknown --no-default-features --features console_error_panic_hook + # Note: no enabling the `wee_alloc` feature here because it requires + # nightly for now. diff --git a/blurhash-rs-wasm/Cargo.toml b/blurhash-rs-wasm/Cargo.toml new file mode 100644 index 0000000..aab6025 --- /dev/null +++ b/blurhash-rs-wasm/Cargo.toml @@ -0,0 +1,27 @@ +[package] +name = "blurhash-rs-wasm" +version = "0.1.0" +authors = ["Ruben De Smet ", "Raincal "] +edition = "2018" + +[lib] +crate-type = ["cdylib", "rlib"] + +[features] +default = ["console_error_panic_hook", "fast-linear-to-srgb"] +fast-linear-to-srgb = ["blurhash/fast-linear-to-srgb"] + +[dependencies] +wasm-bindgen = "0.2.84" +js-sys = { version = "0.3" } + +# The `console_error_panic_hook` crate provides better debugging of panics by +# logging them with `console.error`. This is great for development, but requires +# all the `std::fmt` and `std::panicking` infrastructure, so isn't great for +# code size when deploying. +console_error_panic_hook = { version = "0.1.7", optional = true } + +blurhash = { path = "../", default-features = false, features = []} + +[dev-dependencies] +wasm-bindgen-test = "0.3.34" diff --git a/blurhash-rs-wasm/LICENSE-APACHE b/blurhash-rs-wasm/LICENSE-APACHE new file mode 100644 index 0000000..11069ed --- /dev/null +++ b/blurhash-rs-wasm/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/blurhash-rs-wasm/LICENSE-MIT b/blurhash-rs-wasm/LICENSE-MIT new file mode 100644 index 0000000..9e6ddc5 --- /dev/null +++ b/blurhash-rs-wasm/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2018 Ruben De Smet + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/blurhash-rs-wasm/README.md b/blurhash-rs-wasm/README.md new file mode 100644 index 0000000..6b68408 --- /dev/null +++ b/blurhash-rs-wasm/README.md @@ -0,0 +1,84 @@ +
+ +

wasm-pack-template

+ + A template for kick starting a Rust and WebAssembly project using wasm-pack. + +

+ Build Status +

+ +

+ Tutorial + | + Chat +

+ + Built with 🦀🕸 by The Rust and WebAssembly Working Group +
+ +## About + +[**📚 Read this template tutorial! 📚**][template-docs] + +This template is designed for compiling Rust libraries into WebAssembly and +publishing the resulting package to NPM. + +Be sure to check out [other `wasm-pack` tutorials online][tutorials] for other +templates and usages of `wasm-pack`. + +[tutorials]: https://rustwasm.github.io/docs/wasm-pack/tutorials/index.html +[template-docs]: https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html + +## 🚴 Usage + +### 🐑 Use `cargo generate` to Clone this Template + +[Learn more about `cargo generate` here.](https://github.com/ashleygwilliams/cargo-generate) + +``` +cargo generate --git https://github.com/rustwasm/wasm-pack-template.git --name my-project +cd my-project +``` + +### 🛠️ Build with `wasm-pack build` + +``` +wasm-pack build +``` + +### 🔬 Test in Headless Browsers with `wasm-pack test` + +``` +wasm-pack test --headless --firefox +``` + +### 🎁 Publish to NPM with `wasm-pack publish` + +``` +wasm-pack publish +``` + +## 🔋 Batteries Included + +* [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen) for communicating + between WebAssembly and JavaScript. +* [`console_error_panic_hook`](https://github.com/rustwasm/console_error_panic_hook) + for logging panic messages to the developer console. +* `LICENSE-APACHE` and `LICENSE-MIT`: most Rust projects are licensed this way, so these are included for you + +## License + +Licensed under either of + +* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) +* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally +submitted for inclusion in the work by you, as defined in the Apache-2.0 +license, shall be dual licensed as above, without any additional terms or +conditions. diff --git a/blurhash-rs-wasm/src/lib.rs b/blurhash-rs-wasm/src/lib.rs new file mode 100644 index 0000000..2440d10 --- /dev/null +++ b/blurhash-rs-wasm/src/lib.rs @@ -0,0 +1,45 @@ +#![no_std] +mod utils; + +use wasm_bindgen::prelude::*; + +extern crate alloc; + +#[wasm_bindgen] +extern "C" { + fn alert(s: &str); +} + +#[wasm_bindgen] +pub fn greet() { + alert("Hello, blurhash-rs-wasm!"); +} + +use alloc::{ + string::{String, ToString}, + vec::Vec, +}; + +#[wasm_bindgen] +pub fn encode( + components_x: u32, + components_y: u32, + width: u32, + height: u32, + rgba_image: &[u8], +) -> Result { + blurhash::encode(components_x, components_y, width, height, rgba_image) + .map_err(|err| js_sys::Error::new(&err.to_string()).into()) +} + +#[wasm_bindgen] +pub fn decode( + blurhash: &str, + width: u32, + height: u32, + punch: Option, +) -> Result, js_sys::Error> { + let punch = punch.unwrap_or(1.0); + blurhash::decode(blurhash, width, height, punch) + .map_err(|err| js_sys::Error::new(&err.to_string()).into()) +} diff --git a/blurhash-rs-wasm/src/utils.rs b/blurhash-rs-wasm/src/utils.rs new file mode 100644 index 0000000..b1d7929 --- /dev/null +++ b/blurhash-rs-wasm/src/utils.rs @@ -0,0 +1,10 @@ +pub fn set_panic_hook() { + // When the `console_error_panic_hook` feature is enabled, we can call the + // `set_panic_hook` function at least once during initialization, and then + // we will get better error messages if our code ever panics. + // + // For more details see + // https://github.com/rustwasm/console_error_panic_hook#readme + #[cfg(feature = "console_error_panic_hook")] + console_error_panic_hook::set_once(); +} diff --git a/blurhash-rs-wasm/tests/web.rs b/blurhash-rs-wasm/tests/web.rs new file mode 100644 index 0000000..de5c1da --- /dev/null +++ b/blurhash-rs-wasm/tests/web.rs @@ -0,0 +1,13 @@ +//! Test suite for the Web and headless browsers. + +#![cfg(target_arch = "wasm32")] + +extern crate wasm_bindgen_test; +use wasm_bindgen_test::*; + +wasm_bindgen_test_configure!(run_in_browser); + +#[wasm_bindgen_test] +fn pass() { + assert_eq!(1 + 1, 2); +} diff --git a/src/ac.rs b/src/ac.rs index 63d1eeb..318d3a3 100644 --- a/src/ac.rs +++ b/src/ac.rs @@ -1,3 +1,6 @@ +#[cfg(not(feature = "std"))] +use num_traits::real::Real; + use super::util::sign_pow; pub fn encode(value: [f32; 3], maximum_value: f32) -> u32 { diff --git a/src/lib.rs b/src/lib.rs index 2c5d0b4..b78747c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -37,12 +37,8 @@ extern crate alloc; use alloc::{string::String, vec::Vec}; #[cfg(not(feature = "std"))] -#[allow(unused_imports)] use num_traits::real::Real; -#[cfg(feature = "wasm")] -mod wasm; - pub use error::Error; use core::f32::consts::PI; diff --git a/src/util.rs b/src/util.rs index 2c4d5c4..d112544 100644 --- a/src/util.rs +++ b/src/util.rs @@ -1,5 +1,8 @@ include!(concat!(env!("OUT_DIR"), "/srgb_lookup.rs")); +#[cfg(not(feature = "std"))] +use num_traits::Float; + /// linear 0.0-1.0 floating point to srgb 0-255 integer conversion. #[cfg(not(feature = "fast-linear-to-srgb"))] pub fn linear_to_srgb(value: f32) -> u8 { From 3d887121834d40e46535c026ae777cba5014095e Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Wed, 24 Jul 2024 10:59:28 +0200 Subject: [PATCH 14/17] Remove wasm feature from ci --- .github/workflows/build.yml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 5282824..77035ce 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -31,8 +31,6 @@ jobs: "std,image", "std,image,fast-linear-to-srgb", "std,fast-linear-to-srgb", - "std,fast-linear-to-srgb,wasm", - "std,wasm", "std", ] include: @@ -46,10 +44,6 @@ jobs: coverage: false features: "fast-linear-to-srgb" - - toolchain: "nightly" - coverage: false - features: "wasm" - - toolchain: "nightly" coverage: false features: "" From f938eb3e5657b0ee84c82aea666216ac0c20bac0 Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Wed, 24 Jul 2024 11:54:55 +0200 Subject: [PATCH 15/17] Add unused guards to num-traits imports When the test harness is built in lib mode, it seems that the `std` feature flag is disabled, but the f32::* methods are actually available. --- src/ac.rs | 3 ++- src/lib.rs | 2 ++ src/util.rs | 3 ++- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/ac.rs b/src/ac.rs index 318d3a3..3bec956 100644 --- a/src/ac.rs +++ b/src/ac.rs @@ -1,4 +1,5 @@ -#[cfg(not(feature = "std"))] +#[cfg(all(not(test), not(feature = "std")))] +#[allow(unused)] use num_traits::real::Real; use super::util::sign_pow; diff --git a/src/lib.rs b/src/lib.rs index b78747c..31ad5ff 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -36,7 +36,9 @@ extern crate alloc; #[cfg(not(feature = "std"))] use alloc::{string::String, vec::Vec}; +#[cfg(not(test))] #[cfg(not(feature = "std"))] +#[allow(unused)] use num_traits::real::Real; pub use error::Error; diff --git a/src/util.rs b/src/util.rs index d112544..944e120 100644 --- a/src/util.rs +++ b/src/util.rs @@ -1,6 +1,7 @@ include!(concat!(env!("OUT_DIR"), "/srgb_lookup.rs")); -#[cfg(not(feature = "std"))] +#[cfg(all(not(test), not(feature = "std"), not(feature = "fast-linear-to-srgb")))] +#[allow(unused)] use num_traits::Float; /// linear 0.0-1.0 floating point to srgb 0-255 integer conversion. From 2c2907af318049672221560805fd9f61793a79da Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Wed, 24 Jul 2024 12:09:12 +0200 Subject: [PATCH 16/17] Add wasm job --- .github/workflows/build.yml | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 77035ce..e8ee41a 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -14,6 +14,19 @@ concurrency: cancel-in-progress: true jobs: + wasm: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - name: Install + run: curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh + + - run: cd blurhash-rs-wasm + - run: cargo test + - run: wasm-pack test --headless --chrome + - run: wasm-pack test --headless --firefox + build_and_test: name: cargo test runs-on: ubuntu-latest From 69a9e2bab9cebe4b4c90ea85fed68dc333fac327 Mon Sep 17 00:00:00 2001 From: Ruben De Smet Date: Wed, 24 Jul 2024 13:02:37 +0200 Subject: [PATCH 17/17] Only test wasm subpackage in browser --- .github/workflows/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index e8ee41a..c3125c7 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -24,8 +24,8 @@ jobs: - run: cd blurhash-rs-wasm - run: cargo test - - run: wasm-pack test --headless --chrome - - run: wasm-pack test --headless --firefox + - run: wasm-pack test --headless --chrome -- --package blurhash-rs-wasm + - run: wasm-pack test --headless --firefox -- --package blurhash-rs-wasm build_and_test: name: cargo test