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.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.
> **Status (v0.19.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.

## Overview

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

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.19.0] - 2026-11-19

The shared library's name carries the major version, and the road to 1.0 is written down. **A change for programs that link the shared library**: the library now names itself `libemberwave_ffi.so.0` on Linux and `@rpath/libemberwave_ffi.0.dylib` on macOS (the 0 is emberwave's major version, 1 from 1.0.0, when it starts to mean the ABI), so a program linked from this version on records that name and needs that file at run time. The release archives hold it, with `libemberwave_ffi.so` and `.dylib` as links to it, so programs linked before still find the unversioned name. Windows, the static libraries and the XCFramework are unchanged.

### Added
- The README lists what 1.0.0 needs and where each item stands; decision D75 records the three choices made before it: the versioned library name, a later split of the GPU code into an `emberwave-wgpu` crate so that `emberwave-core` has no wgpu type in its API (designed, not done), and the notices in the crates.
- `THIRD_PARTY_NOTICES.md` is in both crates on crates.io, next to `LICENSE`, and CI keeps the copies equal to the root's.
- A test checks that the shared library exports the C header's functions and nothing else (macOS has four Objective-C class names of a dependency beside them, which it names), and that it names itself by the crate's version.
- `scripts/package_ffi.sh` makes the release archives' `lib` directory and checks the library's own name; the C example job runs it on Linux, macOS and Windows.
- Measurements, in `BENCHMARKS.md`: decoding beside a display loop on the Mac (`scripts/bench_app_on_mac.sh -display`, #81), a model that estimates other devices from the M3 Max and the iPhone 17 (`scripts/perf_model.py`), and AV1, HEVC and H.264 in Chrome as a stand-in for NVENC (`scripts/chrome_codecs.mjs`, #82's first stage): at the same bytes the codecs with predicted frames lead emberwave in PSNR, which is what emberwave's frames standing alone cost.

### Changed
- wgpu 30.0.2 (fixes of a use after free of a mapped buffer when a device is lost, and of a texture id leak).
- Documentation corrections found by a review, and decision D74 on the crates on crates.io.

## [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.
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.1"
version = "0.19.0"
edition = "2024"
license = "MIT"
repository = "https://github.com/with-developer/emberwave"
Expand All @@ -19,7 +19,7 @@ rust-version = "1.87"
publish = false

[workspace.dependencies]
emberwave-core = { path = "crates/emberwave-core", version = "0.18.1" }
emberwave-core = { path = "crates/emberwave-core", version = "0.19.0" }
thiserror = "2"
proptest = "1"
# Native backends only: GLES would need EGL and the browser backend is for the
Expand Down
2 changes: 1 addition & 1 deletion crates/emberwave-ffi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,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.1/Emberwave.xcframework.zip",
url: "https://github.com/with-developer/emberwave/releases/download/v0.19.0/Emberwave.xcframework.zip",
checksum: "..." // the release's SHA256SUMS line for Emberwave.xcframework.zip
),
.target(
Expand Down
6 changes: 3 additions & 3 deletions crates/emberwave-ffi/include/emberwave.h
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,16 @@
#define EMBERWAVE_VERSION_MAJOR 0

// The minor version of emberwave that this header belongs to.
#define EMBERWAVE_VERSION_MINOR 18
#define EMBERWAVE_VERSION_MINOR 19

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

// 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 1801
#define EMBERWAVE_VERSION 1900

// 4:2:0: the chroma planes have half the width and height of the luma plane,
// whose width and height are even.
Expand Down
6 changes: 3 additions & 3 deletions crates/emberwave-ffi/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -92,14 +92,14 @@ pub enum EmberwaveStatus {
/// The major version of emberwave that this header belongs to.
pub const EMBERWAVE_VERSION_MAJOR: u32 = 0;
/// The minor version of emberwave that this header belongs to.
pub const EMBERWAVE_VERSION_MINOR: u32 = 18;
pub const EMBERWAVE_VERSION_MINOR: u32 = 19;
/// The patch version of emberwave that this header belongs to.
pub const EMBERWAVE_VERSION_PATCH: u32 = 1;
pub const EMBERWAVE_VERSION_PATCH: u32 = 0;
/// 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 = 1801;
pub const EMBERWAVE_VERSION: u32 = 1900;

/// 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