EdisonJwa
7188a5a69d
Implementation of SDD-120 §1-§8: Bench harness (crates/chanora_audio/benches/): - common.rs: deterministic synthetic audio (440 Hz sine, no RNG). - realtime_capture.rs: bench_capture_alloc_count (dhat) + bench_capture_callback_wall_clock (criterion). - opus_codec.rs: bench_opus_encode_latency + bench_opus_decode_latency (direct audiopus, not AudioHandler — SDD-120 §3 item 4). - resampler.rs: bench_resampler_throughput across 44.1->48 / 16->48 / 48->48 passthrough. CI tooling (crates/chanora_audio/examples/): - emit_baseline.rs: aggregates criterion estimates.json outputs into the SRS-217 baseline schema. - compare_baseline.rs: applies SRS-219 tolerance, renders markdown table with 🟢/🟡/🔴 markers + yellow simpler-form realization per SDD-120 §8. Deviation from SDD-120 §2 / §5 / §7 placement: these tools live under examples/, not benches/ or src/bin/. Rationale: they must consume serde_json (a dev-only dep — production builds must not pull it). Cargo only resolves dev-dependencies for [[test]], [[bench]], and [[example]] targets; [[bin]] targets under src/bin/ see only regular [dependencies]. examples/ keeps the binaries out of the production dep tree while still giving them cargo run --example invocation. An SDD-120 amendment should reflect this. Workflows (.github/workflows/): - bench-advisory.yml: PR + push triggers; runs benches; posts a sticky PR comment via actions/github-script@v7; job status is always success (SRS-218 clause 4 — non-blocking). - bench-baseline-update.yml: workflow_dispatch only; runs benches; opens PR via peter-evans/create-pull-request@v6 (sole writer of the SAD-089 baseline JSON). Cargo.toml additions ([dev-dependencies] only — verified excluded from --release builds): criterion 0.5, dhat 0.3, serde_json 1. Source-code seam: minimal pub-but-#[doc(hidden)] bench_seam module in chanora_audio (engine.rs + lib.rs re-export) so the criterion bench harness can construct a CaptureState and drive CaptureState::ingest without re-implementing the engine (SDD-120 §3). Non-iOS targets only — CaptureState itself is iOS-gated. Initial baseline seed: crates/chanora_audio/benches/baselines/ x86_64-unknown-linux-gnu.json = {}. compare_baseline handles the missing-baseline case gracefully and emits a 'no red markers' report; the first manual dispatch of bench-baseline-update.yml after merge establishes the real values. Out of scope per SDD-120 §10: production telemetry export, build-failing hard CI gate, multi-host benchmarking, IDE integration, Dart-side bridge round-trip bench. Verification: - cargo check --workspace --all-targets: PASS. - cargo bench --bench realtime_capture --no-run: PASS. - cargo bench --bench opus_codec --no-run: PASS. - cargo bench --bench resampler --no-run: PASS. - cargo build --example emit_baseline --example compare_baseline -p chanora_audio: PASS. - cargo test --workspace: 106 passed, 0 failed, 3 ignored — no regression from prior count.
54 lines
2.0 KiB
Rust
54 lines
2.0 KiB
Rust
// SDD-120 §3 items 3-4 — Opus encode/decode latency benches.
|
|
//
|
|
// Both benches measure the codec-level call directly (audiopus
|
|
// Encoder::encode_float / Decoder::decode_float) and not the
|
|
// composite tsclientlib AudioHandler::fill_buffer call. Rationale
|
|
// per SDD-120 §3 item 4: AudioHandler::fill_buffer conflates
|
|
// jitter-buffer dequeue + Opus decode + PCM mix in a single call
|
|
// and the wall-clock measurement would conflate three distinct
|
|
// concerns. The canonical `opus_decode_latency` metric here is
|
|
// codec-only.
|
|
|
|
use audiopus::coder::{Decoder, Encoder};
|
|
use audiopus::packet::Packet;
|
|
use audiopus::{Application, Channels, MutSignals, SampleRate};
|
|
use std::convert::TryFrom;
|
|
use criterion::{black_box, criterion_group, criterion_main, Criterion};
|
|
|
|
mod common;
|
|
use common::{synthetic_opus_bytes, synthetic_opus_frame};
|
|
|
|
fn bench_opus_encode_latency(c: &mut Criterion) {
|
|
let mut enc = Encoder::new(SampleRate::Hz48000, Channels::Mono, Application::Voip)
|
|
.expect("opus encoder init");
|
|
let pcm = synthetic_opus_frame();
|
|
let mut out = vec![0u8; 1275];
|
|
|
|
c.bench_function("opus_encode_latency", |b| {
|
|
b.iter(|| {
|
|
let len = enc
|
|
.encode_float(black_box(&pcm[..]), &mut out[..])
|
|
.expect("encode");
|
|
black_box(len);
|
|
});
|
|
});
|
|
}
|
|
|
|
fn bench_opus_decode_latency(c: &mut Criterion) {
|
|
let mut dec = Decoder::new(SampleRate::Hz48000, Channels::Mono).expect("opus decoder init");
|
|
let bytes = synthetic_opus_bytes();
|
|
let mut pcm_out = vec![0.0f32; 960];
|
|
|
|
c.bench_function("opus_decode_latency", |b| {
|
|
b.iter(|| {
|
|
let input = Packet::try_from(black_box(&bytes[..])).expect("packet");
|
|
let output = MutSignals::try_from(&mut pcm_out[..]).expect("signals");
|
|
let n = dec.decode_float(Some(input), output, false).expect("decode");
|
|
black_box(n);
|
|
});
|
|
});
|
|
}
|
|
|
|
criterion_group!(opus_codec, bench_opus_encode_latency, bench_opus_decode_latency);
|
|
criterion_main!(opus_codec);
|