Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ARCHITECTURE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Architecture

> **Status (v0.18.0).** The bitstream format is documented below and implemented by `emberwave_core::bitstream`, with a slow CPU reference decoder in `emberwave_core::cpu`, the wgpu/WGSL decoder in `emberwave_core::gpu` and the colour conversion in `emberwave_core::color`. The encoder runs on the CPU (`emberwave_core::encode`) and on the GPU (`emberwave_core::gpu`). `emberwave-cli` decodes and encodes files with them, `emberwave-web` plays them in a browser, also packet by packet as a stream arrives, and `emberwave-ffi` offers the decoder and the GPU encoder to C, also as an XCFramework for iPhone, iPad and Mac apps, and hands Metal clients the decoded picture in a texture, or its planes in three, also into the client's own textures and on its own queue without waiting, where calls take turns at its command buffers; it runs on a client's own Vulkan device and images as well, shares textures and fences with Direct3D 12 and 11 devices on Windows, and encodes a host's pictures straight from its textures, in RGB as captures hold them too; on Metal the planes are stored straight into the textures, and on Apple silicon the frames are written where the shaders read them. A decoder can keep the last frame's detail in the blocks a frame drawn in part lacks, where the picture is still. Decode and encode times are in `BENCHMARKS.md`. The decision log at the end is kept up to date.
> **Status (v0.18.1).** The bitstream format is documented below and implemented by `emberwave_core::bitstream`, with a slow CPU reference decoder in `emberwave_core::cpu`, the wgpu/WGSL decoder in `emberwave_core::gpu` and the colour conversion in `emberwave_core::color`. The encoder runs on the CPU (`emberwave_core::encode`) and on the GPU (`emberwave_core::gpu`). `emberwave-cli` decodes and encodes files with them, `emberwave-web` plays them in a browser, also packet by packet as a stream arrives, and `emberwave-ffi` offers the decoder and the GPU encoder to C, also as an XCFramework for iPhone, iPad and Mac apps, and hands Metal clients the decoded picture in a texture, or its planes in three, also into the client's own textures and on its own queue without waiting, where calls take turns at its command buffers; it runs on a client's own Vulkan device and images as well, shares textures and fences with Direct3D 12 and 11 devices on Windows, and encodes a host's pictures straight from its textures, in RGB as captures hold them too; on Metal the planes are stored straight into the textures, and on Apple silicon the frames are written where the shaders read them. A decoder can keep the last frame's detail in the blocks a frame drawn in part lacks, where the picture is still. Decode and encode times are in `BENCHMARKS.md`. The decision log at the end is kept up to date.

## Overview

Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

All notable changes to emberwave. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and versions follow [Semantic Versioning](https://semver.org/).

## [0.18.1] - 2026-11-04

`emberwave-core` and `emberwave-cli` are on crates.io: `cargo add emberwave-core` for the library, `cargo install emberwave-cli` for the command line decoder. The code is that of 0.18.0.

## [0.18.0] - 2026-10-31

What a client can ask: how much of a frame has arrived, and which GPU a context runs on, in Rust, through the C API and in the browser player. Nothing breaks.
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ After a deliberate change to what the encoder writes, `scripts/gen_encoder_vecto
- **No "fix later" comments.** Open an issue instead.
- **New dependencies** need a reason in the pull request.
- **The C API's structs.** A struct the C API takes or fills in through a pointer starts with `struct_size` (decision D69). A member is added at the end, only, and its zero is its default; the struct's `FIRST_SIZE` stays the size it had before. The calls read and write a struct through `read_struct` and `write_struct`, never by dereferencing the pointer.
- **A release** changes the version in `Cargo.toml` and `EMBERWAVE_VERSION_MAJOR`, `_MINOR`, `_PATCH` and `EMBERWAVE_VERSION` in `crates/emberwave-ffi/src/lib.rs` together, as the build fails otherwise, and regenerates the header.
- **A release** changes the version in `Cargo.toml` and `EMBERWAVE_VERSION_MAJOR`, `_MINOR`, `_PATCH` and `EMBERWAVE_VERSION` in `crates/emberwave-ffi/src/lib.rs` together, as the build fails otherwise, and regenerates the header. Once its tag's release is out, `cargo publish -p emberwave-core` and then `cargo publish -p emberwave-cli` put the two crates on crates.io; `emberwave-ffi` and `emberwave-web` are not published. `LICENSE` is copied into both crates, so a change to it goes into the copies too.

## Commits and pull requests

Expand Down
8 changes: 4 additions & 4 deletions Cargo.lock

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

4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ members = [
]

[workspace.package]
version = "0.18.0"
version = "0.18.1"
edition = "2024"
license = "MIT"
repository = "https://github.com/with-developer/emberwave"
Expand All @@ -17,7 +17,7 @@ rust-version = "1.87"
publish = false

[workspace.dependencies]
emberwave-core = { path = "crates/emberwave-core", version = "0.18.0" }
emberwave-core = { path = "crates/emberwave-core", version = "0.18.1" }
thiserror = "2"
proptest = "1"
# Native backends only: GLES would need EGL and the browser backend is for the
Expand Down
2 changes: 2 additions & 0 deletions README.ko.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ target/release/emberwave-cli decode testdata/gradient_200x120_420.pwv1 --out-dir

처음 빌드할 때는 몇 분이 걸립니다. 마지막 명령은 사용 중인 어댑터와 프레임별 시간을 출력하고, 색 그러데이션 그림 `out/gradient_200x120_420_000000.png`부터 `000002.png`까지를 만듭니다. `testdata/`의 `.pwv1` 파일은 업스트림 인코더로 만든 작은 스트림입니다.

Rust가 있다면 명령줄 디코더를 [crates.io](https://crates.io/crates/emberwave-cli)에서 `cargo install emberwave-cli`로 설치할 수도 있습니다. Rust 프로젝트에서 라이브러리를 쓰려면 `cargo add emberwave-core`를 실행하세요([문서](https://docs.rs/emberwave-core)).

Rust가 없다면 [릴리스](https://github.com/with-developer/emberwave/releases)에서 Linux(x86_64), macOS(Apple silicon), Windows(x86_64)용 `emberwave-cli`를 내려받아 `testdata/`의 `.pwv1` 파일을 디코딩해 보면 됩니다. macOS 바이너리는 서명이 없으므로, 내려받은 뒤 `xattr -d com.apple.quarantine emberwave-cli`를 한 번 실행하세요.

## 사용법
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ target/release/emberwave-cli decode testdata/gradient_200x120_420.pwv1 --out-dir

The first build takes a few minutes. The last command prints the adapter it uses and the time of each frame, and leaves `out/gradient_200x120_420_000000.png` to `000002.png`: a colour gradient. The `.pwv1` files in `testdata/` are small streams made by upstream's encoder.

With Rust, the command line decoder also installs from [crates.io](https://crates.io/crates/emberwave-cli) with `cargo install emberwave-cli`, and a Rust project takes the library with `cargo add emberwave-core` ([documentation](https://docs.rs/emberwave-core)).

Without Rust, take `emberwave-cli` for Linux (x86_64), macOS (Apple Silicon) or Windows (x86_64) from the [releases](https://github.com/with-developer/emberwave/releases) and decode a `.pwv1` file from `testdata/` with it. The macOS binary is not signed, so run `xattr -d com.apple.quarantine emberwave-cli` once after downloading it.

## Usage
Expand Down
4 changes: 3 additions & 1 deletion crates/emberwave-cli/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ edition.workspace = true
license.workspace = true
repository.workspace = true
rust-version.workspace = true
publish.workspace = true
readme = "../../README.md"
keywords = ["pyrowave", "video", "codec", "wavelet", "wgpu"]
categories = ["multimedia::video", "command-line-utilities"]

[dependencies]
emberwave-core.workspace = true
Expand Down
21 changes: 21 additions & 0 deletions crates/emberwave-cli/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 emberwave contributors

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.
4 changes: 3 additions & 1 deletion crates/emberwave-core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ edition.workspace = true
license.workspace = true
repository.workspace = true
rust-version.workspace = true
publish.workspace = true
readme = "../../README.md"
keywords = ["pyrowave", "video", "codec", "wavelet", "wgpu"]
categories = ["multimedia::video", "multimedia::encoding", "graphics"]

[features]
default = ["gpu"]
Expand Down
21 changes: 21 additions & 0 deletions crates/emberwave-core/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 emberwave contributors

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.
2 changes: 1 addition & 1 deletion crates/emberwave-ffi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ A Swift package names the XCFramework as a binary target. From a release, it tak
// In the app's Package.swift, with the version of the release:
.binaryTarget(
name: "Emberwave",
url: "https://github.com/with-developer/emberwave/releases/download/v0.18.0/Emberwave.xcframework.zip",
url: "https://github.com/with-developer/emberwave/releases/download/v0.18.1/Emberwave.xcframework.zip",
checksum: "..." // the release's SHA256SUMS line for Emberwave.xcframework.zip
),
.target(
Expand Down
4 changes: 2 additions & 2 deletions crates/emberwave-ffi/include/emberwave.h
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@
#define EMBERWAVE_VERSION_MINOR 18

// The patch version of emberwave that this header belongs to.
#define EMBERWAVE_VERSION_PATCH 0
#define EMBERWAVE_VERSION_PATCH 1

// The version this header belongs to as one number, major times 10000 plus
// minor times 100 plus patch: 1600 for 0.16.0. `emberwave_version_number()`
// gives the library's, which differs when a program runs with another
// library than the one it was built for.
#define EMBERWAVE_VERSION 1800
#define EMBERWAVE_VERSION 1801

// 4:2:0: the chroma planes have half the width and height of the luma plane,
// whose width and height are even.
Expand Down
4 changes: 2 additions & 2 deletions crates/emberwave-ffi/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -94,12 +94,12 @@ pub const EMBERWAVE_VERSION_MAJOR: u32 = 0;
/// The minor version of emberwave that this header belongs to.
pub const EMBERWAVE_VERSION_MINOR: u32 = 18;
/// The patch version of emberwave that this header belongs to.
pub const EMBERWAVE_VERSION_PATCH: u32 = 0;
pub const EMBERWAVE_VERSION_PATCH: u32 = 1;
/// The version this header belongs to as one number, major times 10000 plus
/// minor times 100 plus patch: 1600 for 0.16.0. `emberwave_version_number()`
/// gives the library's, which differs when a program runs with another
/// library than the one it was built for.
pub const EMBERWAVE_VERSION: u32 = 1800;
pub const EMBERWAVE_VERSION: u32 = 1801;

/// The library's version as `EMBERWAVE_VERSION` numbers it, from the crate's.
const VERSION_NUMBER: u32 = decimal(env!("CARGO_PKG_VERSION_MAJOR")) * 10000
Expand Down
Loading