diff --git a/.github/workflows/release-gate.yml b/.github/workflows/release-gate.yml index f8d91b7ef38..a641b23a8dd 100644 --- a/.github/workflows/release-gate.yml +++ b/.github/workflows/release-gate.yml @@ -73,7 +73,6 @@ jobs: - "rs/moq-loc/**" - "rs/moq-msf/**" - "rs/moq-json/**" - - "rs/moq-flate/**" - "rs/moq-pattern/**" - "rs/hang/**" - "rs/kio/**" @@ -234,7 +233,6 @@ jobs: - "rs/moq-cli/**" - "rs/moq-clock/**" - "rs/moq-congestion/**" - - "rs/moq-flate/**" - "rs/moq-hls/**" - "rs/moq-ice/**" - "rs/moq-json/**" diff --git a/.oss-scanner/Dockerfile b/.oss-scanner/Dockerfile index 5b368eed864..338e2689749 100644 --- a/.oss-scanner/Dockerfile +++ b/.oss-scanner/Dockerfile @@ -20,7 +20,7 @@ RUN rustup show active-toolchain || rustup toolchain install \ && curl -LsSf "https://get.nexte.st/latest/$nextest" | tar zxf - -C "$CARGO_HOME/bin" \ && cargo nextest --version -ARG CRATES="kio hang moq-auth moq-clock moq-e2ee moq-flate moq-hls moq-ice moq-json moq-loc moq-msf moq-mux moq-net moq-pattern moq-quic moq-relay moq-rtc moq-rtmp moq-rtsp moq-sock moq-srt moq-stats moq-tokio moq-uring moq-cli" +ARG CRATES="kio hang moq-auth moq-clock moq-e2ee moq-hls moq-ice moq-json moq-loc moq-msf moq-mux moq-net moq-pattern moq-quic moq-relay moq-rtc moq-rtmp moq-rtsp moq-sock moq-srt moq-stats moq-tokio moq-uring moq-cli" # Path specs, because the lockfile also has published copies of some workspace crates. # io-uring compiles the relay's io_uring QUIC workers (`--runtime-io-uring`), which the default features leave out. diff --git a/.oss-scanner/threat_model.md b/.oss-scanner/threat_model.md index cbde6250dc8..fc98d344028 100644 --- a/.oss-scanner/threat_model.md +++ b/.oss-scanner/threat_model.md @@ -35,7 +35,7 @@ Most important, in this order: 2. Authorization: a session publishing, subscribing, or seeing announcements outside its grant, or reaching another root (tenant) through path tricks, revalidation, mounts, or cluster links. 3. `rs/moq-mux` and `rs/hang`: container, codec, and catalog parsing of publisher-controlled bytes. 4. The ingest gateways: `rs/moq-rtmp`, `rs/moq-rtsp`, `rs/moq-srt`, `rs/moq-rtc`, `rs/moq-ice`, `rs/moq-hls`. -5. `rs/moq-e2ee`, `rs/moq-cli`, `rs/moq-flate`, `rs/moq-json`, `rs/moq-stats`, `rs/kio`, `rs/moq-clock`. +5. `rs/moq-e2ee`, `rs/moq-cli`, `rs/moq-json`, `rs/moq-stats`, `rs/kio`, `rs/moq-clock`. `unsafe` is rare and worth reading closely where it appears: `rs/moq-quic`, `rs/moq-net/src/model`, `rs/moq-net/src/util/cell.rs`, `rs/moq-net/src/transport.rs`, and `rs/moq-relay/src/uring.rs`. diff --git a/Cargo.lock b/Cargo.lock index ba196af3414..454cb9d0ff4 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -5319,19 +5319,6 @@ dependencies = [ "web-transport-wasm", ] -[[package]] -name = "moq-flate" -version = "0.2.0" -dependencies = [ - "bytes", - "flate2", - "futures", - "kio 0.6.2", - "moq-net", - "thiserror 2.0.21", - "tracing", -] - [[package]] name = "moq-gst" version = "0.4.12" @@ -5409,7 +5396,6 @@ dependencies = [ "futures", "json-patch", "kio 0.6.2", - "moq-flate", "moq-net", "proptest", "serde", @@ -5455,7 +5441,6 @@ dependencies = [ "libc", "memchr", "moq-clock", - "moq-flate", "moq-json", "moq-loc", "moq-msf", diff --git a/Cargo.toml b/Cargo.toml index c96c253118d..829babb00f7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -18,7 +18,6 @@ default-members = [ "rs/moq-e2ee", # "rs/moq-ffi", # requires Python/maturin # "rs/moq-gst", # requires GStreamer - "rs/moq-flate", "rs/moq-hls", "rs/moq-ice", "rs/moq-json", @@ -142,7 +141,6 @@ moq-auth = { version = "0.2.1", path = "rs/moq-auth" } moq-clock = { version = "0.11.0", path = "rs/moq-clock" } moq-clock-macros = { version = "0.1.0", path = "rs/moq-clock/macros" } moq-congestion = { version = "0.1.0", path = "rs/moq-congestion" } -moq-flate = { version = "0.2.0", path = "rs/moq-flate" } moq-hls = { version = "0.5.11", path = "rs/moq-hls", default-features = false } moq-ice = { version = "0.1.0", path = "rs/moq-ice" } moq-json = { version = "0.5.8", path = "rs/moq-json" } diff --git a/bun.lock b/bun.lock index 5132306ee14..b145f1d0bcb 100644 --- a/bun.lock +++ b/bun.lock @@ -113,7 +113,6 @@ "@moq/auth": "workspace:*", "@moq/boy": "workspace:*", "@moq/clock": "workspace:*", - "@moq/flate": "workspace:*", "@moq/hang": "workspace:*", "@moq/json": "workspace:*", "@moq/libav": "workspace:*", @@ -178,22 +177,6 @@ "typescript": "7.0.2", }, }, - "js/flate": { - "name": "@moq/flate", - "version": "0.1.3", - "dependencies": { - "@moq/net": "workspace:^", - "@moq/signals": "workspace:^", - "pako": "^3.0.2", - }, - "devDependencies": { - "@moq/clock": "workspace:^", - "@types/bun": "^1.4.3", - "fflate": "^0.8.2", - "rimraf": "^6.1.3", - "typescript": "7.0.2", - }, - }, "js/hang": { "name": "@moq/hang", "version": "0.5.2", @@ -219,8 +202,8 @@ "name": "@moq/json", "version": "0.4.2", "dependencies": { - "@moq/flate": "workspace:^", "@moq/net": "workspace:^", + "@moq/signals": "workspace:^", }, "devDependencies": { "@moq/clock": "workspace:^", @@ -878,8 +861,6 @@ "@moq/e2ee": ["@moq/e2ee@workspace:js/e2ee"], - "@moq/flate": ["@moq/flate@workspace:js/flate"], - "@moq/hang": ["@moq/hang@workspace:js/hang"], "@moq/interop-browser": ["@moq/interop-browser@workspace:test/interop/clients/js"], @@ -1366,8 +1347,6 @@ "fdir": ["fdir@6.5.0", "", { "peerDependencies": { "picomatch": "^3 || ^4" }, "optionalPeers": ["picomatch"] }, "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg=="], - "fflate": ["fflate@0.8.3", "", {}, "sha512-tbZNuJrLwGUp3zshBtdy4W+ORxZuIh8a5ilyIEQDC5rY1f3U20JMry0Ll3WBzU58EZKsEuJFXhb5gwv8CsPvgA=="], - "focus-trap": ["focus-trap@7.8.0", "", { "dependencies": { "tabbable": "^6.4.0" } }, "sha512-/yNdlIkpWbM0ptxno3ONTuf+2g318kh2ez3KSeZN5dZ8YC6AAmgeWz+GasYYiBJPFaYcSAPeu4GfhUaChzIJXA=="], "foreground-child": ["foreground-child@3.3.1", "", { "dependencies": { "cross-spawn": "^7.0.6", "signal-exit": "^4.0.1" } }, "sha512-gIXjKqtFuWEgzFRJA9WCQeSJLZDjgJUOMCMzxtvFq/37KojM1BFGufqsCy0r4qSQmYLsZYMeyRqzIWOMup03sw=="], diff --git a/dart/moq/MIGRATE.md b/dart/moq/MIGRATE.md index 6dbf79168f8..003f152eabc 100644 --- a/dart/moq/MIGRATE.md +++ b/dart/moq/MIGRATE.md @@ -4,6 +4,12 @@ How to update your code for each breaking change, newest first. ## Unreleased +### Compression moves to the track + +`package:moq/flate.dart` is removed: publish opaque bytes on a `TrackProducer`. +`SnapshotConfig` and `WindowConfig` lose `compression`, and `StreamConfig` is removed. Publish the track with `MoqTrackInfo(compress: true)` instead. +`StreamProducer` drops its `config`, and `SnapshotConsumer`, `StreamConsumer`, and `WindowConsumer` take only the track. + ### Paths with an empty segment are refused ([#6648](https://github.com/moq-dev/moq/pull/6648)) Publishing, serving, or requesting a broadcast at a path with a leading, trailing, or doubled `/` throws instead of collapsing it. Pass the canonical path, such as `room/cam`. diff --git a/dart/moq/lib/flate.dart b/dart/moq/lib/flate.dart deleted file mode 100644 index f5afdf327de..00000000000 --- a/dart/moq/lib/flate.dart +++ /dev/null @@ -1,13 +0,0 @@ -/// Opaque snapshot and stream tracks, mirroring the moq-flate crate. -library; - -import 'package:moq_ffi/moq_ffi.dart'; - -/// Publishes the latest opaque payload on a track it takes over. -typedef SnapshotProducer = MoqFlateSnapshotProducer; - -/// Publishes an ordered opaque payload log on a track it takes over. -typedef StreamProducer = MoqFlateStreamProducer; - -/// Configures compression and the opaque payload media type. -typedef Config = MoqFlateConfig; diff --git a/dart/moq/lib/json.dart b/dart/moq/lib/json.dart index 73b62c37347..a3df4dfb0c8 100644 --- a/dart/moq/lib/json.dart +++ b/dart/moq/lib/json.dart @@ -3,15 +3,20 @@ /// Each type wraps a track: a producer takes over a `TrackProducer` (the /// snapshot and stream producers also advertise it in the broadcast's catalog, /// which has no window mode), and a consumer takes over a `TrackConsumer` that -/// has not read a group yet. Values cross as JSON -/// strings. Import it with a prefix, since `dart:convert` has a `json` too: +/// has not read a group yet. Values cross as JSON strings. Compression is the +/// track's: publish JSON with `MoqTrackInfo(compress: true)`, and a consumer +/// reads it with no option of its own. Import it with a prefix, since +/// `dart:convert` has a `json` too: /// /// ```dart /// import 'package:moq/json.dart' as moq_json; /// /// final status = moq_json.SnapshotProducer( /// broadcast: broadcast, -/// track: broadcast.publishTrack(name: 'status', info: null), +/// track: broadcast.publishTrack( +/// name: 'status', +/// info: MoqTrackInfo(compress: true), +/// ), /// config: moq_json.SnapshotConfig(), /// ); /// ``` @@ -26,7 +31,7 @@ typedef SnapshotProducer = MoqJsonSnapshotProducer; /// the newest with `latest()`. typedef SnapshotConsumer = MoqJsonSnapshotConsumer; -/// Configures a lossy latest-value JSON track. +/// Configures a lossy latest-value JSON producer. typedef SnapshotConfig = MoqJsonSnapshotConfig; /// Publishes a lossless stream of JSON records on a track it takes over. @@ -35,9 +40,6 @@ typedef StreamProducer = MoqJsonStreamProducer; /// Consumes a lossless stream of JSON records from a track it takes over. typedef StreamConsumer = MoqJsonStreamConsumer; -/// Configures a lossless JSON stream track. -typedef StreamConfig = MoqJsonStreamConfig; - /// A JSON string read from a track, with the timestamp of the frame that /// carried it in microseconds, or null when untimed. Rounded down to a whole /// microsecond, so a tick on a track like 90 kHz may not survive a read and @@ -52,7 +54,7 @@ typedef WindowProducer = MoqJsonWindowProducer; /// over. Group rolls never surface. typedef WindowConsumer = MoqJsonWindowConsumer; -/// Configures a JSON window track. +/// Configures a JSON window producer. typedef WindowConfig = MoqJsonWindowConfig; /// One change to a window: [WindowEventPush], [WindowEventPop], or diff --git a/dart/moq/test/moq_test.dart b/dart/moq/test/moq_test.dart index 17fb8cf4fe7..76ed785e749 100644 --- a/dart/moq/test/moq_test.dart +++ b/dart/moq/test/moq_test.dart @@ -4,7 +4,6 @@ import 'dart:typed_data'; import 'package:moq/audio.dart' as moq_audio; import 'package:moq/media.dart' as moq_media; -import 'package:moq/flate.dart' as moq_flate; import 'package:moq/json.dart' as moq_json; import 'package:moq/moq.dart'; import 'package:moq/video.dart' as moq_video; @@ -56,39 +55,6 @@ void main() { expect(() => catalog.now(), throwsA(isA())); }); - for (final timestamp in [null, 123456]) { - for (final mode in ['snapshot', 'stream']) { - test('flate $mode preserves timestamp $timestamp', () async { - final broadcast = BroadcastProducer(); - final info = timestamp == null ? null : TrackInfo(timescale: 1000000); - final track = broadcast.publishTrack(name: 'data', info: info); - final consumer = track.consume(subscription: null); - final payload = utf8.encode('payload'); - if (mode == 'snapshot') { - final producer = moq_flate.SnapshotProducer( - broadcast: broadcast, - track: track, - config: moq_flate.Config(), - ); - producer.update(payload: payload, timestampUs: timestamp); - producer.finish(); - } else { - final producer = moq_flate.StreamProducer( - broadcast: broadcast, - track: track, - config: moq_flate.Config(), - ); - producer.append(payload: payload, timestampUs: timestamp); - producer.finish(); - } - final frame = await consumer.readFrame().timeout(timeout); - expect(frame?.payload, payload); - expect(frame?.timestampUs, timestamp); - broadcast.close(); - }); - } - } - test('raw writes without timestamps stay untimed', () async { final broadcast = BroadcastProducer(); final track = broadcast.publishTrack(name: 'untimed', info: null); @@ -544,7 +510,7 @@ void main() { broadcast: broadcast, track: broadcast.publishTrack( name: 'status', - info: MoqTrackInfo(timescale: 1000000), + info: MoqTrackInfo(timescale: 1000000, compress: true), ), config: moq_json.SnapshotConfig(), ); @@ -552,10 +518,7 @@ void main() { .consume() .subscribeTrack(name: 'status', subscription: null) .timeout(timeout); - final consumer = moq_json.SnapshotConsumer( - track: track, - config: moq_json.SnapshotConfig(), - ); + final consumer = moq_json.SnapshotConsumer(track: track); for (var n = 1; n <= 4; n++) { producer.update(value: jsonEncode({'n': n}), timestampUs: n * 1000); @@ -581,18 +544,15 @@ void main() { final producer = moq_json.WindowProducer( track: broadcast.publishTrack( name: 'log', - info: MoqTrackInfo(timescale: 1000000), + info: MoqTrackInfo(timescale: 1000000, compress: true), ), - config: moq_json.WindowConfig(compression: true), + config: moq_json.WindowConfig(), ); final track = await broadcast .consume() .subscribeTrack(name: 'log', subscription: null) .timeout(timeout); - final consumer = moq_json.WindowConsumer( - track: track, - config: moq_json.WindowConfig(compression: true), - ); + final consumer = moq_json.WindowConsumer(track: track); for (var n = 0; n < 3; n++) { producer.push(value: jsonEncode({'n': n}), timestampUs: n * 1000); diff --git a/dart/moq_ffi/lib/src/moq.dart b/dart/moq_ffi/lib/src/moq.dart index 723c2ec4b7d..92a0e4d32f3 100644 --- a/dart/moq_ffi/lib/src/moq.dart +++ b/dart/moq_ffi/lib/src/moq.dart @@ -8,7 +8,9 @@ import "dart:ffi"; import "dart:io" show Platform, File, Directory; import "dart:isolate"; import "dart:typed_data"; + import "package:ffi/ffi.dart"; + import "uniffi_runtime.dart"; export "uniffi_runtime.dart"; @@ -938,69 +940,9 @@ class FfiConverterMoqProtocolError { } } -class MoqFlateConfig { - final bool compression; - final String? mime; - MoqFlateConfig({this.compression = false, this.mime = null}); -} - -class FfiConverterMoqFlateConfig { - static MoqFlateConfig lift(RustBuffer buf) { - return FfiConverterMoqFlateConfig.read(buf.asUint8List()).value; - } - - static LiftRetVal read(Uint8List buf) { - int new_offset = buf.offsetInBytes; - final compression_lifted = FfiConverterBool.read( - Uint8List.view(buf.buffer, new_offset), - ); - final compression = compression_lifted.value; - new_offset += compression_lifted.bytesRead; - final mime_lifted = FfiConverterOptionalString.read( - Uint8List.view(buf.buffer, new_offset), - ); - final mime = mime_lifted.value; - new_offset += mime_lifted.bytesRead; - return LiftRetVal( - MoqFlateConfig(compression: compression, mime: mime), - new_offset - buf.offsetInBytes, - ); - } - - static RustBuffer lower(MoqFlateConfig value) { - final total_length = - FfiConverterBool.allocationSize(value.compression) + - FfiConverterOptionalString.allocationSize(value.mime) + - 0; - final buf = Uint8List(total_length); - write(value, buf); - return toRustBuffer(buf); - } - - static int write(MoqFlateConfig value, Uint8List buf) { - int new_offset = buf.offsetInBytes; - new_offset += FfiConverterBool.write( - value.compression, - Uint8List.view(buf.buffer, new_offset), - ); - new_offset += FfiConverterOptionalString.write( - value.mime, - Uint8List.view(buf.buffer, new_offset), - ); - return new_offset - buf.offsetInBytes; - } - - static int allocationSize(MoqFlateConfig value) { - return FfiConverterBool.allocationSize(value.compression) + - FfiConverterOptionalString.allocationSize(value.mime) + - 0; - } -} - class MoqJsonSnapshotConfig { final bool deltas; - final bool compression; - MoqJsonSnapshotConfig({this.deltas = true, this.compression = false}); + MoqJsonSnapshotConfig({this.deltas = true}); } class FfiConverterMoqJsonSnapshotConfig { @@ -1015,22 +957,14 @@ class FfiConverterMoqJsonSnapshotConfig { ); final deltas = deltas_lifted.value; new_offset += deltas_lifted.bytesRead; - final compression_lifted = FfiConverterBool.read( - Uint8List.view(buf.buffer, new_offset), - ); - final compression = compression_lifted.value; - new_offset += compression_lifted.bytesRead; return LiftRetVal( - MoqJsonSnapshotConfig(deltas: deltas, compression: compression), + MoqJsonSnapshotConfig(deltas: deltas), new_offset - buf.offsetInBytes, ); } static RustBuffer lower(MoqJsonSnapshotConfig value) { - final total_length = - FfiConverterBool.allocationSize(value.deltas) + - FfiConverterBool.allocationSize(value.compression) + - 0; + final total_length = FfiConverterBool.allocationSize(value.deltas) + 0; final buf = Uint8List(total_length); write(value, buf); return toRustBuffer(buf); @@ -1042,61 +976,11 @@ class FfiConverterMoqJsonSnapshotConfig { value.deltas, Uint8List.view(buf.buffer, new_offset), ); - new_offset += FfiConverterBool.write( - value.compression, - Uint8List.view(buf.buffer, new_offset), - ); return new_offset - buf.offsetInBytes; } static int allocationSize(MoqJsonSnapshotConfig value) { - return FfiConverterBool.allocationSize(value.deltas) + - FfiConverterBool.allocationSize(value.compression) + - 0; - } -} - -class MoqJsonStreamConfig { - final bool compression; - MoqJsonStreamConfig({this.compression = false}); -} - -class FfiConverterMoqJsonStreamConfig { - static MoqJsonStreamConfig lift(RustBuffer buf) { - return FfiConverterMoqJsonStreamConfig.read(buf.asUint8List()).value; - } - - static LiftRetVal read(Uint8List buf) { - int new_offset = buf.offsetInBytes; - final compression_lifted = FfiConverterBool.read( - Uint8List.view(buf.buffer, new_offset), - ); - final compression = compression_lifted.value; - new_offset += compression_lifted.bytesRead; - return LiftRetVal( - MoqJsonStreamConfig(compression: compression), - new_offset - buf.offsetInBytes, - ); - } - - static RustBuffer lower(MoqJsonStreamConfig value) { - final total_length = FfiConverterBool.allocationSize(value.compression) + 0; - final buf = Uint8List(total_length); - write(value, buf); - return toRustBuffer(buf); - } - - static int write(MoqJsonStreamConfig value, Uint8List buf) { - int new_offset = buf.offsetInBytes; - new_offset += FfiConverterBool.write( - value.compression, - Uint8List.view(buf.buffer, new_offset), - ); - return new_offset - buf.offsetInBytes; - } - - static int allocationSize(MoqJsonStreamConfig value) { - return FfiConverterBool.allocationSize(value.compression) + 0; + return FfiConverterBool.allocationSize(value.deltas) + 0; } } @@ -1160,12 +1044,8 @@ class FfiConverterMoqJsonValue { } class MoqJsonWindowConfig { - final bool compression; final int? checkpointRecords; - MoqJsonWindowConfig({ - this.compression = false, - this.checkpointRecords = null, - }); + MoqJsonWindowConfig({this.checkpointRecords = null}); } class FfiConverterMoqJsonWindowConfig { @@ -1175,30 +1055,20 @@ class FfiConverterMoqJsonWindowConfig { static LiftRetVal read(Uint8List buf) { int new_offset = buf.offsetInBytes; - final compression_lifted = FfiConverterBool.read( - Uint8List.view(buf.buffer, new_offset), - ); - final compression = compression_lifted.value; - new_offset += compression_lifted.bytesRead; final checkpointRecords_lifted = FfiConverterOptionalUInt64.read( Uint8List.view(buf.buffer, new_offset), ); final checkpointRecords = checkpointRecords_lifted.value; new_offset += checkpointRecords_lifted.bytesRead; return LiftRetVal( - MoqJsonWindowConfig( - compression: compression, - checkpointRecords: checkpointRecords, - ), + MoqJsonWindowConfig(checkpointRecords: checkpointRecords), new_offset - buf.offsetInBytes, ); } static RustBuffer lower(MoqJsonWindowConfig value) { final total_length = - FfiConverterBool.allocationSize(value.compression) + - FfiConverterOptionalUInt64.allocationSize(value.checkpointRecords) + - 0; + FfiConverterOptionalUInt64.allocationSize(value.checkpointRecords) + 0; final buf = Uint8List(total_length); write(value, buf); return toRustBuffer(buf); @@ -1206,10 +1076,6 @@ class FfiConverterMoqJsonWindowConfig { static int write(MoqJsonWindowConfig value, Uint8List buf) { int new_offset = buf.offsetInBytes; - new_offset += FfiConverterBool.write( - value.compression, - Uint8List.view(buf.buffer, new_offset), - ); new_offset += FfiConverterOptionalUInt64.write( value.checkpointRecords, Uint8List.view(buf.buffer, new_offset), @@ -1218,8 +1084,7 @@ class FfiConverterMoqJsonWindowConfig { } static int allocationSize(MoqJsonWindowConfig value) { - return FfiConverterBool.allocationSize(value.compression) + - FfiConverterOptionalUInt64.allocationSize(value.checkpointRecords) + + return FfiConverterOptionalUInt64.allocationSize(value.checkpointRecords) + 0; } } @@ -9983,211 +9848,6 @@ class FfiConverterMoqTrackDemand { } } -abstract class MoqFlateSnapshotProducerInterface { - void finish(); - void update({required Uint8List payload, int? timestampUs = null}); -} - -final _MoqFlateSnapshotProducerFinalizer = Finalizer>((ptr) { - rustCall( - (status) => uniffi_moq_ffi_fn_free_moqflatesnapshotproducer(ptr, status), - ); -}); - -class MoqFlateSnapshotProducer implements MoqFlateSnapshotProducerInterface { - late final Pointer _ptr; - bool _isDisposed = false; - MoqFlateSnapshotProducer._(this._ptr) { - _MoqFlateSnapshotProducerFinalizer.attach(this, _ptr, detach: this); - } - MoqFlateSnapshotProducer({ - required MoqBroadcastProducer broadcast, - required MoqTrackProducer track, - required MoqFlateConfig config, - }) : _ptr = rustCall( - (status) => uniffi_moq_ffi_fn_constructor_moqflatesnapshotproducer_new( - FfiConverterMoqBroadcastProducer.lower(broadcast), - FfiConverterMoqTrackProducer.lower(track), - FfiConverterMoqFlateConfig.lower(config), - status, - ), - moqExceptionErrorHandler, - ) { - _MoqFlateSnapshotProducerFinalizer.attach(this, _ptr, detach: this); - } - factory MoqFlateSnapshotProducer.lift(Pointer ptr) { - return MoqFlateSnapshotProducer._(ptr); - } - Pointer uniffiClonePointer() { - if (_isDisposed) { - throw StateError("Object has already been disposed"); - } - return rustCall( - (status) => - uniffi_moq_ffi_fn_clone_moqflatesnapshotproducer(_ptr, status), - ); - } - - void dispose() { - if (_isDisposed) { - return; - } - _isDisposed = true; - _MoqFlateSnapshotProducerFinalizer.detach(this); - rustCall( - (status) => uniffi_moq_ffi_fn_free_moqflatesnapshotproducer(_ptr, status), - ); - } - - void finish() { - return rustCall((status) { - uniffi_moq_ffi_fn_method_moqflatesnapshotproducer_finish( - uniffiClonePointer(), - status, - ); - }, moqExceptionErrorHandler); - } - - void update({required Uint8List payload, int? timestampUs = null}) { - return rustCall((status) { - uniffi_moq_ffi_fn_method_moqflatesnapshotproducer_update( - uniffiClonePointer(), - FfiConverterUint8List.lower(payload), - FfiConverterOptionalUInt64.lower(timestampUs), - status, - ); - }, moqExceptionErrorHandler); - } -} - -class FfiConverterMoqFlateSnapshotProducer { - static MoqFlateSnapshotProducer lift(Pointer ptr) { - return MoqFlateSnapshotProducer.lift(ptr); - } - - static Pointer lower(MoqFlateSnapshotProducer value) { - return value.uniffiClonePointer(); - } - - static int allocationSize(MoqFlateSnapshotProducer value) { - return 8; - } - - static LiftRetVal read(Uint8List buf) { - final handle = buf.buffer.asByteData(buf.offsetInBytes).getInt64(0); - final pointer = Pointer.fromAddress(handle); - return LiftRetVal(MoqFlateSnapshotProducer.lift(pointer), 8); - } - - static int write(MoqFlateSnapshotProducer value, Uint8List buf) { - final handle = lower(value); - buf.buffer.asByteData(buf.offsetInBytes).setInt64(0, handle.address); - return 8; - } -} - -abstract class MoqFlateStreamProducerInterface { - void append({required Uint8List payload, int? timestampUs = null}); - void finish(); -} - -final _MoqFlateStreamProducerFinalizer = Finalizer>((ptr) { - rustCall( - (status) => uniffi_moq_ffi_fn_free_moqflatestreamproducer(ptr, status), - ); -}); - -class MoqFlateStreamProducer implements MoqFlateStreamProducerInterface { - late final Pointer _ptr; - bool _isDisposed = false; - MoqFlateStreamProducer._(this._ptr) { - _MoqFlateStreamProducerFinalizer.attach(this, _ptr, detach: this); - } - MoqFlateStreamProducer({ - required MoqBroadcastProducer broadcast, - required MoqTrackProducer track, - required MoqFlateConfig config, - }) : _ptr = rustCall( - (status) => uniffi_moq_ffi_fn_constructor_moqflatestreamproducer_new( - FfiConverterMoqBroadcastProducer.lower(broadcast), - FfiConverterMoqTrackProducer.lower(track), - FfiConverterMoqFlateConfig.lower(config), - status, - ), - moqExceptionErrorHandler, - ) { - _MoqFlateStreamProducerFinalizer.attach(this, _ptr, detach: this); - } - factory MoqFlateStreamProducer.lift(Pointer ptr) { - return MoqFlateStreamProducer._(ptr); - } - Pointer uniffiClonePointer() { - if (_isDisposed) { - throw StateError("Object has already been disposed"); - } - return rustCall( - (status) => uniffi_moq_ffi_fn_clone_moqflatestreamproducer(_ptr, status), - ); - } - - void dispose() { - if (_isDisposed) { - return; - } - _isDisposed = true; - _MoqFlateStreamProducerFinalizer.detach(this); - rustCall( - (status) => uniffi_moq_ffi_fn_free_moqflatestreamproducer(_ptr, status), - ); - } - - void append({required Uint8List payload, int? timestampUs = null}) { - return rustCall((status) { - uniffi_moq_ffi_fn_method_moqflatestreamproducer_append( - uniffiClonePointer(), - FfiConverterUint8List.lower(payload), - FfiConverterOptionalUInt64.lower(timestampUs), - status, - ); - }, moqExceptionErrorHandler); - } - - void finish() { - return rustCall((status) { - uniffi_moq_ffi_fn_method_moqflatestreamproducer_finish( - uniffiClonePointer(), - status, - ); - }, moqExceptionErrorHandler); - } -} - -class FfiConverterMoqFlateStreamProducer { - static MoqFlateStreamProducer lift(Pointer ptr) { - return MoqFlateStreamProducer.lift(ptr); - } - - static Pointer lower(MoqFlateStreamProducer value) { - return value.uniffiClonePointer(); - } - - static int allocationSize(MoqFlateStreamProducer value) { - return 8; - } - - static LiftRetVal read(Uint8List buf) { - final handle = buf.buffer.asByteData(buf.offsetInBytes).getInt64(0); - final pointer = Pointer.fromAddress(handle); - return LiftRetVal(MoqFlateStreamProducer.lift(pointer), 8); - } - - static int write(MoqFlateStreamProducer value, Uint8List buf) { - final handle = lower(value); - buf.buffer.asByteData(buf.offsetInBytes).setInt64(0, handle.address); - return 8; - } -} - abstract class MoqJsonSnapshotConsumerInterface { void cancel(); UniffiRustFuture latest(); @@ -10206,17 +9866,14 @@ class MoqJsonSnapshotConsumer implements MoqJsonSnapshotConsumerInterface { MoqJsonSnapshotConsumer._(this._ptr) { _MoqJsonSnapshotConsumerFinalizer.attach(this, _ptr, detach: this); } - MoqJsonSnapshotConsumer({ - required MoqTrackConsumer track, - required MoqJsonSnapshotConfig config, - }) : _ptr = rustCall( - (status) => uniffi_moq_ffi_fn_constructor_moqjsonsnapshotconsumer_new( - FfiConverterMoqTrackConsumer.lower(track), - FfiConverterMoqJsonSnapshotConfig.lower(config), - status, - ), - moqExceptionErrorHandler, - ) { + MoqJsonSnapshotConsumer({required MoqTrackConsumer track}) + : _ptr = rustCall( + (status) => uniffi_moq_ffi_fn_constructor_moqjsonsnapshotconsumer_new( + FfiConverterMoqTrackConsumer.lower(track), + status, + ), + moqExceptionErrorHandler, + ) { _MoqJsonSnapshotConsumerFinalizer.attach(this, _ptr, detach: this); } factory MoqJsonSnapshotConsumer.lift(Pointer ptr) { @@ -10437,17 +10094,14 @@ class MoqJsonStreamConsumer implements MoqJsonStreamConsumerInterface { MoqJsonStreamConsumer._(this._ptr) { _MoqJsonStreamConsumerFinalizer.attach(this, _ptr, detach: this); } - MoqJsonStreamConsumer({ - required MoqTrackConsumer track, - required MoqJsonStreamConfig config, - }) : _ptr = rustCall( - (status) => uniffi_moq_ffi_fn_constructor_moqjsonstreamconsumer_new( - FfiConverterMoqTrackConsumer.lower(track), - FfiConverterMoqJsonStreamConfig.lower(config), - status, - ), - moqExceptionErrorHandler, - ) { + MoqJsonStreamConsumer({required MoqTrackConsumer track}) + : _ptr = rustCall( + (status) => uniffi_moq_ffi_fn_constructor_moqjsonstreamconsumer_new( + FfiConverterMoqTrackConsumer.lower(track), + status, + ), + moqExceptionErrorHandler, + ) { _MoqJsonStreamConsumerFinalizer.attach(this, _ptr, detach: this); } factory MoqJsonStreamConsumer.lift(Pointer ptr) { @@ -10544,12 +10198,10 @@ class MoqJsonStreamProducer implements MoqJsonStreamProducerInterface { MoqJsonStreamProducer({ required MoqBroadcastProducer broadcast, required MoqTrackProducer track, - required MoqJsonStreamConfig config, }) : _ptr = rustCall( (status) => uniffi_moq_ffi_fn_constructor_moqjsonstreamproducer_new( FfiConverterMoqBroadcastProducer.lower(broadcast), FfiConverterMoqTrackProducer.lower(track), - FfiConverterMoqJsonStreamConfig.lower(config), status, ), moqExceptionErrorHandler, @@ -10654,17 +10306,14 @@ class MoqJsonWindowConsumer implements MoqJsonWindowConsumerInterface { MoqJsonWindowConsumer._(this._ptr) { _MoqJsonWindowConsumerFinalizer.attach(this, _ptr, detach: this); } - MoqJsonWindowConsumer({ - required MoqTrackConsumer track, - required MoqJsonWindowConfig config, - }) : _ptr = rustCall( - (status) => uniffi_moq_ffi_fn_constructor_moqjsonwindowconsumer_new( - FfiConverterMoqTrackConsumer.lower(track), - FfiConverterMoqJsonWindowConfig.lower(config), - status, - ), - moqExceptionErrorHandler, - ) { + MoqJsonWindowConsumer({required MoqTrackConsumer track}) + : _ptr = rustCall( + (status) => uniffi_moq_ffi_fn_constructor_moqjsonwindowconsumer_new( + FfiConverterMoqTrackConsumer.lower(track), + status, + ), + moqExceptionErrorHandler, + ) { _MoqJsonWindowConsumerFinalizer.attach(this, _ptr, detach: this); } factory MoqJsonWindowConsumer.lift(Pointer ptr) { @@ -17814,57 +17463,7 @@ external Pointer uniffi_moq_ffi_fn_method_moqtrackdemand_wanted_changed( @Native Function(Pointer, Pointer)>( assetId: _uniffiAssetId, ) -external Pointer uniffi_moq_ffi_fn_clone_moqflatesnapshotproducer( - Pointer handle, - Pointer uniffiStatus, -); - -@Native, Pointer)>( - assetId: _uniffiAssetId, -) -external void uniffi_moq_ffi_fn_free_moqflatesnapshotproducer( - Pointer handle, - Pointer uniffiStatus, -); - -@Native< - Pointer Function( - Pointer, - Pointer, - RustBuffer, - Pointer, - ) ->(assetId: _uniffiAssetId) -external Pointer -uniffi_moq_ffi_fn_constructor_moqflatesnapshotproducer_new( - Pointer broadcast, - Pointer track, - RustBuffer config, - Pointer uniffiStatus, -); - -@Native, Pointer)>( - assetId: _uniffiAssetId, -) -external void uniffi_moq_ffi_fn_method_moqflatesnapshotproducer_finish( - Pointer ptr, - Pointer uniffiStatus, -); - -@Native< - Void Function(Pointer, RustBuffer, RustBuffer, Pointer) ->(assetId: _uniffiAssetId) -external void uniffi_moq_ffi_fn_method_moqflatesnapshotproducer_update( - Pointer ptr, - RustBuffer payload, - RustBuffer timestamp_us, - Pointer uniffiStatus, -); - -@Native Function(Pointer, Pointer)>( - assetId: _uniffiAssetId, -) -external Pointer uniffi_moq_ffi_fn_clone_moqflatestreamproducer( +external Pointer uniffi_moq_ffi_fn_clone_moqjsonsnapshotconsumer( Pointer handle, Pointer uniffiStatus, ); @@ -17872,67 +17471,17 @@ external Pointer uniffi_moq_ffi_fn_clone_moqflatestreamproducer( @Native, Pointer)>( assetId: _uniffiAssetId, ) -external void uniffi_moq_ffi_fn_free_moqflatestreamproducer( +external void uniffi_moq_ffi_fn_free_moqjsonsnapshotconsumer( Pointer handle, Pointer uniffiStatus, ); -@Native< - Pointer Function( - Pointer, - Pointer, - RustBuffer, - Pointer, - ) ->(assetId: _uniffiAssetId) -external Pointer uniffi_moq_ffi_fn_constructor_moqflatestreamproducer_new( - Pointer broadcast, - Pointer track, - RustBuffer config, - Pointer uniffiStatus, -); - -@Native< - Void Function(Pointer, RustBuffer, RustBuffer, Pointer) ->(assetId: _uniffiAssetId) -external void uniffi_moq_ffi_fn_method_moqflatestreamproducer_append( - Pointer ptr, - RustBuffer payload, - RustBuffer timestamp_us, - Pointer uniffiStatus, -); - -@Native, Pointer)>( - assetId: _uniffiAssetId, -) -external void uniffi_moq_ffi_fn_method_moqflatestreamproducer_finish( - Pointer ptr, - Pointer uniffiStatus, -); - @Native Function(Pointer, Pointer)>( assetId: _uniffiAssetId, ) -external Pointer uniffi_moq_ffi_fn_clone_moqjsonsnapshotconsumer( - Pointer handle, - Pointer uniffiStatus, -); - -@Native, Pointer)>( - assetId: _uniffiAssetId, -) -external void uniffi_moq_ffi_fn_free_moqjsonsnapshotconsumer( - Pointer handle, - Pointer uniffiStatus, -); - -@Native< - Pointer Function(Pointer, RustBuffer, Pointer) ->(assetId: _uniffiAssetId) external Pointer uniffi_moq_ffi_fn_constructor_moqjsonsnapshotconsumer_new( Pointer track, - RustBuffer config, Pointer uniffiStatus, ); @@ -18028,12 +17577,11 @@ external void uniffi_moq_ffi_fn_free_moqjsonstreamconsumer( Pointer uniffiStatus, ); -@Native< - Pointer Function(Pointer, RustBuffer, Pointer) ->(assetId: _uniffiAssetId) +@Native Function(Pointer, Pointer)>( + assetId: _uniffiAssetId, +) external Pointer uniffi_moq_ffi_fn_constructor_moqjsonstreamconsumer_new( Pointer track, - RustBuffer config, Pointer uniffiStatus, ); @@ -18067,17 +17615,11 @@ external void uniffi_moq_ffi_fn_free_moqjsonstreamproducer( ); @Native< - Pointer Function( - Pointer, - Pointer, - RustBuffer, - Pointer, - ) + Pointer Function(Pointer, Pointer, Pointer) >(assetId: _uniffiAssetId) external Pointer uniffi_moq_ffi_fn_constructor_moqjsonstreamproducer_new( Pointer broadcast, Pointer track, - RustBuffer config, Pointer uniffiStatus, ); @@ -18123,12 +17665,11 @@ external void uniffi_moq_ffi_fn_free_moqjsonwindowconsumer( Pointer uniffiStatus, ); -@Native< - Pointer Function(Pointer, RustBuffer, Pointer) ->(assetId: _uniffiAssetId) +@Native Function(Pointer, Pointer)>( + assetId: _uniffiAssetId, +) external Pointer uniffi_moq_ffi_fn_constructor_moqjsonwindowconsumer_new( Pointer track, - RustBuffer config, Pointer uniffiStatus, ); @@ -20444,18 +19985,6 @@ external int uniffi_moq_ffi_checksum_method_moqtrackdemand_wanted(); @Native(assetId: _uniffiAssetId) external int uniffi_moq_ffi_checksum_method_moqtrackdemand_wanted_changed(); -@Native(assetId: _uniffiAssetId) -external int uniffi_moq_ffi_checksum_method_moqflatesnapshotproducer_finish(); - -@Native(assetId: _uniffiAssetId) -external int uniffi_moq_ffi_checksum_method_moqflatesnapshotproducer_update(); - -@Native(assetId: _uniffiAssetId) -external int uniffi_moq_ffi_checksum_method_moqflatestreamproducer_append(); - -@Native(assetId: _uniffiAssetId) -external int uniffi_moq_ffi_checksum_method_moqflatestreamproducer_finish(); - @Native(assetId: _uniffiAssetId) external int uniffi_moq_ffi_checksum_method_moqjsonsnapshotconsumer_cancel(); @@ -20933,12 +20462,6 @@ external int uniffi_moq_ffi_checksum_constructor_moqaudioencoder_new(); @Native(assetId: _uniffiAssetId) external int uniffi_moq_ffi_checksum_constructor_moqaudioproducer_new(); -@Native(assetId: _uniffiAssetId) -external int uniffi_moq_ffi_checksum_constructor_moqflatesnapshotproducer_new(); - -@Native(assetId: _uniffiAssetId) -external int uniffi_moq_ffi_checksum_constructor_moqflatestreamproducer_new(); - @Native(assetId: _uniffiAssetId) external int uniffi_moq_ffi_checksum_constructor_moqjsonsnapshotconsumer_new(); @@ -21159,20 +20682,6 @@ void _checkApiChecksums() { if (uniffi_moq_ffi_checksum_method_moqtrackdemand_wanted_changed() != 29509) { throw UniffiInternalError.panicked("UniFFI API checksum mismatch"); } - if (uniffi_moq_ffi_checksum_method_moqflatesnapshotproducer_finish() != - 52594) { - throw UniffiInternalError.panicked("UniFFI API checksum mismatch"); - } - if (uniffi_moq_ffi_checksum_method_moqflatesnapshotproducer_update() != - 29136) { - throw UniffiInternalError.panicked("UniFFI API checksum mismatch"); - } - if (uniffi_moq_ffi_checksum_method_moqflatestreamproducer_append() != 45773) { - throw UniffiInternalError.panicked("UniFFI API checksum mismatch"); - } - if (uniffi_moq_ffi_checksum_method_moqflatestreamproducer_finish() != 6982) { - throw UniffiInternalError.panicked("UniFFI API checksum mismatch"); - } if (uniffi_moq_ffi_checksum_method_moqjsonsnapshotconsumer_cancel() != 52062) { throw UniffiInternalError.panicked("UniFFI API checksum mismatch"); @@ -21669,31 +21178,23 @@ void _checkApiChecksums() { if (uniffi_moq_ffi_checksum_constructor_moqaudioproducer_new() != 51486) { throw UniffiInternalError.panicked("UniFFI API checksum mismatch"); } - if (uniffi_moq_ffi_checksum_constructor_moqflatesnapshotproducer_new() != - 40377) { - throw UniffiInternalError.panicked("UniFFI API checksum mismatch"); - } - if (uniffi_moq_ffi_checksum_constructor_moqflatestreamproducer_new() != - 13731) { - throw UniffiInternalError.panicked("UniFFI API checksum mismatch"); - } if (uniffi_moq_ffi_checksum_constructor_moqjsonsnapshotconsumer_new() != - 62847) { + 11929) { throw UniffiInternalError.panicked("UniFFI API checksum mismatch"); } if (uniffi_moq_ffi_checksum_constructor_moqjsonsnapshotproducer_new() != - 4988) { + 14914) { throw UniffiInternalError.panicked("UniFFI API checksum mismatch"); } - if (uniffi_moq_ffi_checksum_constructor_moqjsonstreamconsumer_new() != - 44851) { + if (uniffi_moq_ffi_checksum_constructor_moqjsonstreamconsumer_new() != 3025) { throw UniffiInternalError.panicked("UniFFI API checksum mismatch"); } - if (uniffi_moq_ffi_checksum_constructor_moqjsonstreamproducer_new() != 9785) { + if (uniffi_moq_ffi_checksum_constructor_moqjsonstreamproducer_new() != + 20445) { throw UniffiInternalError.panicked("UniFFI API checksum mismatch"); } if (uniffi_moq_ffi_checksum_constructor_moqjsonwindowconsumer_new() != - 10727) { + 48790) { throw UniffiInternalError.panicked("UniFFI API checksum mismatch"); } if (uniffi_moq_ffi_checksum_constructor_moqjsonwindowproducer_new() != diff --git a/dart/moq_ffi/lib/src/uniffi_runtime.dart b/dart/moq_ffi/lib/src/uniffi_runtime.dart index c61178325f7..9018eb4e97e 100644 --- a/dart/moq_ffi/lib/src/uniffi_runtime.dart +++ b/dart/moq_ffi/lib/src/uniffi_runtime.dart @@ -8,6 +8,7 @@ import "dart:ffi"; import "dart:io" show Platform, File, Directory; import "dart:isolate"; import "dart:typed_data"; + import "package:ffi/ffi.dart"; class UniffiInternalError implements Exception { @@ -250,6 +251,7 @@ mixin FfiConverterPrimitive on FfiConverter { @override T lower(T value) => value; } + Uint8List createUint8ListFromInt(int value) { int length = value.bitLength ~/ 8 + 1; if (length != 4 && length != 8) { diff --git a/demo/carla/sim/moq_carla_sim/publish.py b/demo/carla/sim/moq_carla_sim/publish.py index b5607b62fb7..dc9ced6527b 100644 --- a/demo/carla/sim/moq_carla_sim/publish.py +++ b/demo/carla/sim/moq_carla_sim/publish.py @@ -177,14 +177,15 @@ def status_payload(status: Status) -> dict[str, Any]: class StatusPublisher: - """The `status` track: DEFLATE-compressed JSON snapshots. + """The `status` track: JSON snapshots on a compressed track. Snapshot rather than stream, because a late joiner wants the truck's current state, not the history of every command it ever accepted. """ def __init__(self, broadcast: moq.BroadcastProducer) -> None: - self._producer = moq.json.SnapshotProducer(broadcast, broadcast.publish_track("status"), compression=True) + track = broadcast.publish_track("status", moq.TrackInfo(compress=True)) + self._producer = moq.json.SnapshotProducer(broadcast, track) # Weak: watching demand neither keeps the track open nor locks it. self._demand = self._producer.demand() @@ -359,7 +360,7 @@ async def _pump_driver( log.info("driver %s connected (epoch %s)", driver_id, epoch) try: broadcast = await client.request_broadcast(path) - control = moq.json.SnapshotConsumer(await broadcast.subscribe_track("control"), compression=True) + control = moq.json.SnapshotConsumer(await broadcast.subscribe_track("control")) async for message in control: command = parse_command(driver_id, message, epoch) if command is not None: diff --git a/demo/carla/sim/tests/conftest.py b/demo/carla/sim/tests/conftest.py index 2ba51aa858c..77228ed632a 100644 --- a/demo/carla/sim/tests/conftest.py +++ b/demo/carla/sim/tests/conftest.py @@ -37,9 +37,8 @@ class AnnounceEventRestart(AnnounceEvent): class SnapshotProducer: """Records every published value; demand comes from the wrapped track.""" - def __init__(self, broadcast: object, track: SimpleNamespace, *, compression: bool = False) -> None: + def __init__(self, broadcast: object, track: SimpleNamespace) -> None: self.track = track - self.compression = compression self.values: list[object] = [] def demand(self) -> object: @@ -52,8 +51,7 @@ def update(self, value: object) -> None: class SnapshotConsumer: """Yields whatever the wrapped fake track yields, already parsed.""" - def __init__(self, track: object, *, compression: bool = False) -> None: - assert compression, "control is DEFLATE-compressed" + def __init__(self, track: object) -> None: self._track = track def __aiter__(self): @@ -68,6 +66,7 @@ def __aiter__(self): moq.AnnounceEventRestart = AnnounceEventRestart moq.AnnounceRoute = lambda **kwargs: SimpleNamespace(**kwargs) moq.mint_epoch = lambda: str(uuid.uuid4()) +moq.TrackInfo = lambda **kwargs: SimpleNamespace(**kwargs) moq_json = ModuleType("moq.json") moq_json.SnapshotProducer = SnapshotProducer diff --git a/demo/carla/sim/tests/test_runtime.py b/demo/carla/sim/tests/test_runtime.py index 263ea2375af..61698dc7509 100644 --- a/demo/carla/sim/tests/test_runtime.py +++ b/demo/carla/sim/tests/test_runtime.py @@ -372,7 +372,7 @@ def test_session_announces_with_the_run_epoch_after_populating_tracks() -> None: calls: list[object] = [] publication = SimpleNamespace( broadcast=SimpleNamespace( - publish_track=lambda name: calls.append(name) or SimpleNamespace(demand=SimpleNamespace) + publish_track=lambda name, info=None: calls.append(name) or SimpleNamespace(demand=SimpleNamespace) ), announce=lambda route: calls.append(route), ) diff --git a/demo/carla/web/src/preview.ts b/demo/carla/web/src/preview.ts index 4fec2ed2f6d..c342a52a85e 100644 --- a/demo/carla/web/src/preview.ts +++ b/demo/carla/web/src/preview.ts @@ -14,8 +14,7 @@ export function populatePreview(add: (path: Moq.Path.Valid) => Truck) { const truck = add(Moq.Path.from(`carla/truck${index + 1}/front.hang`)); const origin = new Moq.Broadcast.Producer(); const producer = new Json.Snapshot.Producer({ - track: origin.createTrack("status"), - compression: "deflate", + track: origin.createTrack("status", { compress: true }), }); (truck.broadcast.out.active as Moq.Signals.Signal).set(origin.consume()); producer.update({ diff --git a/demo/carla/web/src/truck.test.ts b/demo/carla/web/src/truck.test.ts index 9800aef2217..358d03867d3 100644 --- a/demo/carla/web/src/truck.test.ts +++ b/demo/carla/web/src/truck.test.ts @@ -61,8 +61,8 @@ describe("Truck status", () => { function statusOrigin() { const origin = new Moq.Broadcast.Producer(); - const track = origin.createTrack("status"); - const producer = new Json.Snapshot.Producer({ track, compression: "deflate" }); + const track = origin.createTrack("status", { compress: true }); + const producer = new Json.Snapshot.Producer({ track }); return { origin, producer }; } @@ -329,11 +329,9 @@ describe("Truck safety controls", () => { }); const front = new Json.Snapshot.Consumer>({ track: safety.broadcast.track("control").subscribe(), - compression: "deflate", }); const rear = new Json.Snapshot.Consumer>({ track: safety.broadcast.track("control").subscribe(), - compression: "deflate", }); try { diff --git a/demo/carla/web/src/truck.ts b/demo/carla/web/src/truck.ts index d3fc13a4a82..a7572fc066f 100644 --- a/demo/carla/web/src/truck.ts +++ b/demo/carla/web/src/truck.ts @@ -45,8 +45,8 @@ export class SafetyCommandBroadcast { constructor(command: Command, broadcast = new Moq.Broadcast.Producer()) { this.broadcast = broadcast; - const track = this.broadcast.createTrack("control"); - this.#producer = new Json.Snapshot.Producer>({ track, compression: "deflate" }); + const track = this.broadcast.createTrack("control", { compress: true }); + this.#producer = new Json.Snapshot.Producer>({ track }); this.#producer.update({ value: { ...command.cmd, sequence: command.sequence, timestamps: command.timestamps }, }); @@ -371,7 +371,6 @@ export class Truck { const consumer = new Json.Snapshot.Consumer({ track: statusTrack, schema: TruckStatusSchema, - compression: "deflate", }); effect.spawn(async () => { @@ -425,8 +424,8 @@ export class Truck { this.#sentAt.clear(); }); - const track = driverBroadcast.createTrack("control"); - const producer = new Json.Snapshot.Producer>({ track, compression: "deflate" }); + const track = driverBroadcast.createTrack("control", { compress: true }); + const producer = new Json.Snapshot.Producer>({ track }); effect.cleanup(() => producer.finish()); effect.run(this.#runControlTrack.bind(this, track, producer)); // A fresh epoch per lease: the truck binds its single driver to this path and epoch. diff --git a/doc/.vitepress/api/package.json b/doc/.vitepress/api/package.json index 0997140a5e5..fdeaf455106 100644 --- a/doc/.vitepress/api/package.json +++ b/doc/.vitepress/api/package.json @@ -8,7 +8,6 @@ "@moq/auth": "workspace:*", "@moq/boy": "workspace:*", "@moq/clock": "workspace:*", - "@moq/flate": "workspace:*", "@moq/hang": "workspace:*", "@moq/json": "workspace:*", "@moq/libav": "workspace:*", diff --git a/doc/.vitepress/config.ts b/doc/.vitepress/config.ts index 54eb955d650..dc6a49fba92 100644 --- a/doc/.vitepress/config.ts +++ b/doc/.vitepress/config.ts @@ -206,7 +206,6 @@ export default defineConfig({ { text: "moq-auth", link: "/lib/rs/moq-auth" }, { text: "moq-room", link: "/lib/rs/moq-room" }, { text: "moq-json", link: "/lib/rs/moq-json" }, - { text: "moq-flate", link: "/lib/rs/moq-flate" }, { text: "moq-clock", link: "/lib/rs/moq-clock" }, ], }, @@ -224,7 +223,6 @@ export default defineConfig({ { text: "@moq/signals", link: "/lib/js/signals" }, { text: "@moq/clock", link: "/lib/js/clock" }, { text: "@moq/json", link: "/lib/js/json" }, - { text: "@moq/flate", link: "/lib/js/flate" }, { text: "API reference", link: "/lib/js/api/" }, ], }, diff --git a/doc/bin/inspect.md b/doc/bin/inspect.md index db8ecf3a57a..d75262b5075 100644 --- a/doc/bin/inspect.md +++ b/doc/bin/inspect.md @@ -74,11 +74,10 @@ curl http://localhost:4443/fetch/.stats/node/local/host/totals.json | jq ``` The node name (`local/host` here) is `stats.node`. Each fetch returns the -newest snapshot of cumulative counters. `totals.json` sums each tier's traffic -and sessions. `group.json` (`/group.json` at `stats.depth` 1 or more) -carries a group's traffic per broadcast path and sessions per stats label: its -newest group is a full snapshot followed by merge-patch deltas, one per line. +newest group of cumulative counters: a full snapshot followed by merge-patch +deltas, one per line. `totals.json` sums each tier's traffic and sessions. +`group.json` (`/group.json` at `stats.depth` 1 or more) carries a +group's traffic per broadcast path and sessions per stats label. A subscriber may also ask for `/prefix.json`, one broadcast prefix rolled up with each child, produced only while held. Fetch twice and divide by the -interval for a rate. The `.json.z` twins carry compressed patches, which these -tools print as raw bytes. [Stats](/concept/stats) describes every field. +interval for a rate. [Stats](/concept/stats) describes every field. diff --git a/doc/concept/hang.md b/doc/concept/hang.md index b8dab921033..c1c73d076b0 100644 --- a/doc/concept/hang.md +++ b/doc/concept/hang.md @@ -19,8 +19,9 @@ payloads follow [moq-e2ee](/draft/moq-e2ee). See [Encryption](#encryption). ## Catalog `catalog.json` is a JSON track listing the renditions of each media kind and -the decoder config for each. It updates live as tracks come and go, and a -compressed twin (`catalog.json.z`) is published alongside it. +the decoder config for each. It updates live as tracks come and go, and is a +[compressed track](/concept/moq-lite#subscriptions), so a reader sees plain JSON +whether or not its session carries the compression. ```json { @@ -113,7 +114,7 @@ as plain tracks, split by whether a generic consumer can parse the payload. { "json": { "tracks": { - "chat": { "mode": "stream", "compression": "deflate" }, + "chat": { "mode": "stream", "schema": "https://example.com/chat.schema.json" }, "status": { "mode": "snapshot" } } }, @@ -137,17 +138,16 @@ A sliding window, a bounded log a reader can join in the middle, is a framing in [`moq-json`](/lib/rs/moq-json) rather than a catalog mode. Both ends opt into it on a raw track. -The rest is descriptive: `compression` (`deflate`, the same group-scoped -`deflate-raw` the catalog uses), `schema` on a JSON track, `mime` on a binary -one, `bitrate`, `jitter`, and `delay` with the same meaning as for media, plus +The rest is descriptive: `schema` on a JSON track, `mime` on a binary one, `bitrate`, `jitter`, and `delay` with the same meaning as for media, plus the optional `broadcast` reference and `track` name. A publisher measures `delay` only from payloads stamped with their capture time on the broadcast clock. A -consumer that doesn't recognize a `mode` or `compression` ignores that track and -round-trips it verbatim. +consumer that doesn't recognize a `mode` ignores that track and round-trips it +verbatim. Compression is not a catalog field: a JSON track is a compressed track, +and moq-net hands every reader plain frames. The catalog entry lives as long as its producer: dropping it retracts the -track. [`moq-json`](/lib/rs/moq-json) and [`moq-flate`](/lib/rs/moq-flate) (and -their TypeScript twins) are what read and write the payloads. +track. [`moq-json`](/lib/rs/moq-json) (and its TypeScript twin) reads and writes +JSON payloads; a binary track's payloads are the frames themselves. An application with its own per-track fields can list a data track in its own root section instead, nesting the JSON or binary config in a `config` field diff --git a/doc/concept/stats.md b/doc/concept/stats.md index 5bc22c8e491..32ec90b2c52 100644 --- a/doc/concept/stats.md +++ b/doc/concept/stats.md @@ -1,6 +1,6 @@ --- title: Stats -description: The stats broadcasts a relay publishes, their tracks, and both JSON encodings +description: The stats broadcasts a relay publishes, their tracks, and their JSON encoding --- # Stats @@ -198,8 +198,7 @@ but a group's comes in two encodings: | `[