EdisonJwa
5199e3d005
Lands SDD-081..088 + SDD-092 implementations on top of v1.0.0-rc.3.
The cross-platform pieces — `AudioTransmitGate`, the per-platform
backend ladder, and the missed-key-up watchdog — are wired into the
audio engine lifecycle. Per-platform live verification on Windows
/ macOS / GNOME-Wayland reference hosts is the remaining work
(RR-PTT-001..006/008 in `release-readiness-go-nogo-record.md`).
`chanora_audio::ptt`
--------------------
* `AudioTransmitGate` now owns an `Arc<AtomicBool>` plus a
`tokio::sync::watch::Sender<bool>` (SAD-075 / SDD-089). The
encoder feed reads the atomic on the hot path; the watchdog
subscribes to the watch channel.
* `MissedKeyUpWatchdog::spawn(gate, timeout)` watches the gate
transitions and self-clears `transmit_active` if the
`false -> true` lifetime exceeds the configured ceiling
(DEC-028, default 30s). Two unit tests cover the timeout-fires
and the no-fire-on-normal-release paths.
`chanora_audio::ptt_backends`
-----------------------------
* `DesktopPttBackend` trait + `PttBinding` value type + `PttInputClass`
enum + `PttBackendError` (SDD-081). `PttBinding` deliberately
carries only `input_class` and an opaque `platform_key`
string; raw key codes never appear in the type surface.
* `select()` factory (SAD-071): runtime ladder evaluation per
OS. Windows → Raw Input → low-level hook → Focused; macOS →
Event Tap → Focused; Linux → GNOME-Wayland portal probe →
Focused.
* `FocusedPttBackend` (SDD-087): universal terminal fallback;
integrates with the existing Flutter Listener-driven PTT.
* `WindowsRawInputBackend` + `WindowsHookBackend` (SDD-083 /
SDD-084): three-rung ladder evaluated once at engine start.
Each backend runs a dedicated worker thread that holds the
OS-level handle; `start`/`stop` lifecycle is honest. Live
`RegisterRawInputDevices` / `SetWindowsHookEx` wiring is
platform-verification work — the scaffolding lets the
descriptor + watchdog + capability event be exercised
end-to-end now.
* `MacOSEventTapBackend` (SDD-085): two-rung ladder with
explicit `PermissionState` (Granted / Denied / Undetermined).
`Undetermined` resolves to `L0Focused` so capability
advertising matches actual runtime behaviour even before
Input Monitoring is granted. Live `CGEventTap` + `IOHIDCheckAccess`
wiring is platform-verification work.
* `LinuxGnomeWaylandBackend` (SDD-086): probes GNOME-on-Wayland
via `XDG_SESSION_TYPE` + `XDG_CURRENT_DESKTOP`, then verifies
the `org.freedesktop.portal.GlobalShortcuts` D-Bus interface
is reachable by reading the `version` property over a
blocking zbus session. Reports `gnome-wayland-portal` /
`L2GlobalHoldToTalk`. Other Linux environments fall through
to the universal Focused backend (DEC-025).
`chanora_audio::engine`
-----------------------
* Engine now owns `transmit_gate: AudioTransmitGate` and
threads a `flag_arc()` clone into the existing capture
state for the cheap hot-path read. `set_transmit_active` /
`transmit_active()` go through the gate so subscribers see
every transition.
* `start_audio` selects the highest-capability backend via
`ptt_backends::select()`, calls `backend.start(gate, none())`,
and spawns the watchdog. Both are released in `stop()` and
on Drop.
* New `engine.rebind_ptt(binding) -> PttBackendDescriptor`
drives the binding-capture flow without restarting the engine.
* New `engine.ptt_descriptor()` returns the privacy-safe
descriptor for the initial UI render before the first
capability event arrives.
`chanora_core`
--------------
* Re-exports `PttBinding` + `PttInputClass`.
* New `ChanoraSession::set_ptt_binding(binding)` — calls
`audio.rebind_ptt` and broadcasts the freshly-published
`SessionEvent::PttCapability` so the UI badge updates live.
* New `ChanoraSession::ptt_descriptor()` for the initial render.
`chanora_bridge`
----------------
* New `BridgePttInputClass` enum + `set_ptt_binding(input_class,
platform_key)` async function. The `platform_key` string is
opaque to the bridge and never logged.
* New `ptt_descriptor()` async accessor returning the
`(level, backend_id, bound_input_class)` triple.
Flutter
-------
* `_AudioControls` now has a "Configure" button next to the
capability badge; `_PttBindingCaptureDialog` captures the
next key press (via `Focus.onKeyEvent`) or mouse side button
(via `Listener.onPointerDown` filtered to button bitmasks
`0x08` / `0x10`). The captured value is the platform-neutral
`LogicalKeyboardKey.keyLabel` or `mouse-side-button:{button}`.
* The dialog explicitly tells the user that the actual key
value never leaves it (DEC-027).
* New ARB keys: `pttConfigureAction`, `pttConfigureTitle`,
`pttConfigurePrompt`, `pttConfigureWaiting`,
`pttConfigureCaptured`, `pttConfigurePrivacyNote`,
`pttConfigureSaveAction` (en + zh-Hans).
Dependencies
------------
* `chanora_audio` adds (Linux only) `zbus = "5"` with the
`tokio` runtime selector + `blocking-api` feature for the
GlobalShortcuts portal probe.
* `chanora_audio` adds `tokio` `test-util` to dev-deps for
`start_paused` watchdog tests (the live watchdog tests use
multi-threaded real time).
Verification
------------
* `cargo test --workspace` with `CHANORA_DISABLE_KEYRING=1`:
57 tests green (was 53). chanora_audio rises from 4 to 8.
* `cargo deny check`: advisories ok, bans ok, licenses ok,
sources ok.
* `cargo about generate --offline`: regenerates
`docs/security/license-inventory.{md,html}`. The crate count
rises from 364 to 383 with the addition of the zbus tree.
* `tools/dump_flutter_licenses.sh`: 94 packages, zero without
LICENSE (unchanged).
* `flutter analyze`: clean.
* `cargo build -p chanora_bridge --release` + `flutter build
linux --release`: clean Linux x86_64 bundle.
Documentation
-------------
* `docs/release/release-readiness-go-nogo-record.md` flips
RR-PTT-007 (missed-key-up watchdog) to Done with a pointer
to the two passing unit tests; bumps to v0.9.4. Live
per-platform traces (RR-PTT-001..005, RR-PTT-008) remain
open and are blocked only on platform reference hosts.
Per-platform live verification (Raw Input registration, Event Tap
creation under granted permission, GlobalShortcuts CreateSession +
BindShortcuts) is queued for the platform owners' reference hosts
per `staged-release-plan.md`.
105 lines
3.3 KiB
Rust
105 lines
3.3 KiB
Rust
//! # `chanora_audio`
|
|
//!
|
|
//! Audio subsystem promoted from `poc/audio-capture-playback-spike`
|
|
//! and wired against `chanora_protocol`'s voice channels.
|
|
//!
|
|
//! ## What's wired in this Beta
|
|
//!
|
|
//! * Default-input capture via `cpal` (DEC-011.1)
|
|
//! * Frame-aligned 20 ms / 48 kHz mono Opus encoding via `audiopus`
|
|
//! * Forward encoded frames to the protocol crate as `OutPacket`s
|
|
//! * Inbound voice packets fed to `tsclientlib::audio::AudioHandler`
|
|
//! which owns Opus decode + per-client jitter buffer + mix
|
|
//! * Mixed f32 PCM pulled by the cpal output callback at 48 kHz stereo
|
|
//! * Push-to-talk: capture stream is permanently open; encoding is
|
|
//! gated by an atomic `ptt_active` flag
|
|
//!
|
|
//! ## What's NOT wired in this Beta
|
|
//!
|
|
//! * AEC / AGC / NS / HPF DSP chain (DEC-007/008/009/010 — Beta+
|
|
//! work; the toggles in `AudioEffects` are honoured by *naming*
|
|
//! but the filters are no-ops)
|
|
//! * Mobile audio paths (DEC-011.1 desktop + Android proven; this
|
|
//! integration is desktop-only for v0.2.0-beta.1)
|
|
//! * Hot-plug device-change handling
|
|
//! * Sample-rate adaptation if the device cannot do 48 kHz / mono in
|
|
//! the format we request (returns `AudioError::StreamConfig`)
|
|
//! * Multi-channel speaker layouts beyond stereo
|
|
|
|
#![warn(missing_docs)]
|
|
|
|
mod engine;
|
|
pub mod ptt;
|
|
pub mod ptt_backends;
|
|
|
|
pub use engine::{AudioEngine, AudioEngineConfig};
|
|
pub use ptt::{
|
|
AudioTransmitGate, MissedKeyUpWatchdog, PttBackendDescriptor, PttCapabilityLevel,
|
|
};
|
|
pub use ptt_backends::{
|
|
select as select_ptt_backend, DesktopPttBackend, FocusedPttBackend, PttBackendError,
|
|
PttBinding, PttInputClass,
|
|
};
|
|
|
|
use thiserror::Error;
|
|
|
|
/// Errors raised by the audio subsystem.
|
|
#[derive(Debug, Error)]
|
|
pub enum AudioError {
|
|
/// Platform did not expose a usable default input device.
|
|
#[error("no default input device")]
|
|
NoInputDevice,
|
|
/// Platform did not expose a usable default output device.
|
|
#[error("no default output device")]
|
|
NoOutputDevice,
|
|
/// The audio backend rejected a stream configuration.
|
|
#[error("stream config rejected: {0}")]
|
|
StreamConfig(String),
|
|
/// Opus codec init/encode/decode failure.
|
|
#[error("opus: {0}")]
|
|
Opus(String),
|
|
/// A backend-specific failure surfaced without a typed mapping.
|
|
#[error("audio backend: {0}")]
|
|
Backend(String),
|
|
}
|
|
|
|
/// Audio-effect toggles. Defaults match DEC-007 (AEC),
|
|
/// DEC-008 (AGC), DEC-009 (NS), DEC-010 (HPF) — all enabled.
|
|
///
|
|
/// Note: in Beta v0.2.0-beta.1 the actual DSP filters are not yet
|
|
/// implemented; the struct is kept here as the public API surface so
|
|
/// later work can flip an internal flag without breaking callers.
|
|
#[derive(Debug, Clone, Copy)]
|
|
pub struct AudioEffects {
|
|
/// Acoustic echo cancellation (DEC-007).
|
|
pub aec: bool,
|
|
/// Automatic gain control (DEC-008).
|
|
pub agc: bool,
|
|
/// Noise suppression (DEC-009).
|
|
pub noise_suppression: bool,
|
|
/// High-pass filter (DEC-010).
|
|
pub high_pass: bool,
|
|
}
|
|
|
|
impl Default for AudioEffects {
|
|
fn default() -> Self {
|
|
Self {
|
|
aec: true,
|
|
agc: true,
|
|
noise_suppression: true,
|
|
high_pass: true,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn defaults_match_decisions() {
|
|
let e = AudioEffects::default();
|
|
assert!(e.aec && e.agc && e.noise_suppression && e.high_pass);
|
|
}
|
|
}
|