EdisonJwa
af686ca7a6
Skeleton scaffolding for the iOS VoiceProcessingIO backend that
will replace cpal on iOS. This commit lands the dependency + the
module + a constructable AudioUnit that emits silence and drops
input; nothing in engine.rs is wired up yet (that is commit 2).
Compilation contract for this commit:
* Linux / Windows / macOS / Android builds unaffected (the new
module is target_os='ios' gated, the new dep is in
'[target."cfg(target_os = \"ios\")"]').
* iOS build pulls in coreaudio-rs 0.14, constructs a VPIO unit,
pins stream format to 48 kHz Int16 mono on both buses, installs
no-op input + silence-emitting render callbacks, initializes,
and starts. No audio is actually moved until commits 3/4.
Why VPIO and not RemoteIO via cpal: cpal's iOS backend opens
RemoteIO with no control over stream format / buffer size /
channels and produces a mono-only output element that stays bound
to the route present at construction time. End-user symptom on
iPhone 16 Pro iOS 18.7.8: tapping Speaker in the picker flips
AVAudioSession.currentRoute.outputs to Speaker (confirmed in our
diagnostic logs from commit da631a2) but audio keeps coming out
the receiver because the AudioUnit's output binding is stale.
Every production iOS VoIP client (Mumble iOS, Linphone /
mediastreamer2, Signal-iOS, Jitsi Meet iOS, the WebRTC reference
impl) avoids RemoteIO and uses VoiceProcessingIO instead. VPIO is
Apple's recommended voice unit; it ships hardware AEC + AGC + NS
and re-binds the physical transducer correctly on route changes
because it IS the canonical voice unit on iOS — FaceTime's audio
path runs through it.
coreaudio-rs 0.14 (RustAudio org, 8.6M downloads, same maintainers
as cpal) gives us a safe wrapper around the AudioUnit C API on
iOS. Uses objc2-* crates underneath so links cleanly into iOS
builds. ios_voice_unit.rs sits next to sdl_output.rs as the iOS
sibling of the Linux SDL2 output path.
Build verify (Linux host): `cargo check -p chanora_audio`
finished clean in 16.09s. iOS build verification happens in
commit 2 when the module is exercised; for this commit the module
compiles in isolation but is dead code on iOS too (no caller).
117 lines
3.6 KiB
Rust
117 lines
3.6 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 mod release_tail;
|
|
pub mod transmit_mode;
|
|
pub mod transmit_selector;
|
|
|
|
#[cfg(target_os = "linux")]
|
|
mod sdl_output;
|
|
|
|
#[cfg(target_os = "ios")]
|
|
mod ios_voice_unit;
|
|
|
|
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,
|
|
};
|
|
pub use release_tail::{ReleaseTailTimer, DEFAULT_TAIL_MS, MAX_TAIL_MS};
|
|
pub use transmit_mode::TransmitMode;
|
|
pub use transmit_selector::TransmitModeSelector;
|
|
|
|
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);
|
|
}
|
|
}
|