Promotes the Linux backend from probe-only to a live
`org.freedesktop.portal.GlobalShortcuts` session, closing the
gen2 v0.9.3 baseline's last Linux-side code item. Both gaps I
flagged on the review pass are addressed:
* Stop now closes the portal session through the dedicated
`org.freedesktop.portal.Session` interface (not the
request-cancel `Request` interface — that would only abort a
pending Request, not release the bound shortcuts).
* Ten new unit tests cover `classify_shortcuts_value`,
`publish_bound`, `publish_l0`, and the `SHORTCUT_ID` stability
contract using synthesised `OwnedValue` payloads. Live D-Bus
coverage stays in the `linux_portal_smoke` ignored
integration test (RR-PTT-004).
Live session lifecycle (gen2 Q5b — lazy, single backend instance):
1. `start(gate, binding)` spawns one `tokio::spawn` worker that
owns an async `zbus::Connection` (sharing the bridge's
tokio runtime per Q4a).
2. `CreateSession` with fresh random `handle_token` /
`session_handle_token` tokens. The worker awaits the portal
`Response` signal via a `RequestProxy` subscription and
extracts `session_handle` from the results dict.
3. `BindShortcuts(session_handle, [("chanora-ptt", { description
= "Chanora push-to-talk" })], "", {})`. The portal opens its
own system-managed dialog asking the user to choose a key
— Chanora itself never reads raw key events. The audio
engine continues at `L0Focused` while the dialog is open;
the descriptor watch publishes the transition once the
portal returns.
4. On `response_code == 0`: classify the `trigger_description`
substring (heuristic: contains "mouse" -> MouseSideButton,
else Keyboard), publish `L2GlobalHoldToTalk` (or `L3` for
mouse) through the watch sender. The raw trigger_description
string is never logged (DEC-027 / SRS-202).
5. On `response_code == 1` (cancelled) or `>= 2` (failure):
publish `L0Focused` through the watch sender. The user can
retry via the UI "Configure" button (gen2 Q6a).
6. The worker enters a `tokio::select!` loop multiplexing the
`cmd_rx` channel (Rebind / Stop) and the `Activated` /
`Deactivated` signals. Matching signals scoped to this
session handle and `chanora-ptt` shortcut id drive
`gate.set(true/false)`.
7. `Rebind` re-runs `BindShortcuts` on the same session.
8. `Stop` calls `org.freedesktop.portal.Session.Close()` on
the session-handle object path, clears the gate, exits.
UX (gen2 Q3a): when `_pttBackendId == 'gnome-wayland-portal'`,
the Flutter "Configure" button skips the in-app
`_PttBindingCaptureDialog` and shows a SnackBar telling the user
their desktop environment will open its own shortcut dialog.
The button delegates to `setPttBinding(keyboard, "portal")`
which nudges the backend; the portal handles the rest. New ARB
key `pttConfigurePortalRedirect` in en + zh-Hans.
Trait surface (cross-cutting):
* `DesktopPttBackend::descriptor_watch()` is a new trait method
with a default impl returning a never-firing receiver.
Backends with async capability transitions (only the Linux
portal backend today) override it to return the live watch
sender's receiver.
* `chanora_core::ChanoraSession::start_audio` subscribes to the
active backend's `descriptor_watch()` and spawns a forwarder
task that re-emits `SessionEvent::PttCapability` on every
transition. The initial value is emitted synchronously.
`Cargo.toml` (Linux-only):
* `futures-util` (std features, no executor) for stream
consumption on the portal signal subscriptions.
* `rand 0.8` for fresh per-process portal tokens.
* `zbus` continues at v5 with the `tokio` + `blocking-api`
features.
Tests
-----
* `chanora_audio` rises from 8 to 18 unit tests. New
coverage on the Linux module:
- `classify_returns_none_when_shortcut_id_missing`
- `classify_returns_keyboard_for_typical_trigger_description`
- `classify_returns_keyboard_when_trigger_description_missing`
- `classify_detects_mouse_substring`
- `classify_is_case_insensitive_on_mouse_substring`
- `publish_bound_keyboard_publishes_L2_with_keyboard_class`
- `publish_bound_mouse_publishes_L3`
- `publish_bound_none_publishes_L2_keyboard_default`
- `publish_l0_clears_descriptor`
- `shortcut_id_is_stable`
* Workspace total: 67 unit + integration tests, all green with
`CHANORA_DISABLE_KEYRING=1` (was 57 at v1.0.0-rc.4).
* New `crates/chanora_audio/tests/linux_portal_smoke.rs`
ignored integration test (RR-PTT-004 evidence path). Run on
a GNOME-on-Wayland host with
`cargo test -p chanora_audio --test linux_portal_smoke -- --ignored --nocapture`.
Documentation
-------------
* `docs/architecture/desktop-ptt-architecture.md` §5.3 rewritten
to describe the realised lifecycle; v0.9.4 change-history
entry added.
* `docs/governance/product-decision-register.md` v0.9.10
change-history entry recording the code-side promotion. No
decision rows mutate.
* `docs/release/release-readiness-go-nogo-record.md` RR-PTT-004
flipped from `Open` to `Implemented (live trace pending)`;
v0.9.5 change-history entry.
Verification
------------
* `cargo test --workspace`: 67/67 green.
* `cargo deny check`: advisories ok, bans ok, licenses ok,
sources ok.
* `cargo about generate --offline`: zero new warnings.
* `tools/dump_flutter_licenses.sh`: 94 packages, 0 without
LICENSE.
* `flutter analyze`: clean.
* `cargo build -p chanora_bridge --release` +
`flutter build linux --release`: clean Linux x86_64 bundle.
* Live portal trace (RR-PTT-004) — **not run**. The dev shell
is a TTY without a Wayland session. The user will run the
ignored smoke test from inside a GNOME-on-Wayland session
when available.
No Windows / macOS / iOS live verification in this commit (hosts
unavailable). The Windows + macOS backend scaffolds remain in
place reporting their target capability honestly; live OS-call
wiring is queued for their respective platform owners'
reference hosts per `docs/governance/staged-release-plan.md`.
845 lines
31 KiB
Rust
845 lines
31 KiB
Rust
//! Audio engine — owns the cpal input/output streams, the Opus
|
|
//! encoder, and the tsclientlib `AudioHandler` for decode+mix.
|
|
//!
|
|
//! The engine is started after a protocol connection is established
|
|
//! and stopped before disconnect. It does not retry on device
|
|
//! change.
|
|
|
|
use std::sync::atomic::{AtomicBool, AtomicU32, Ordering};
|
|
use std::sync::{Arc, Mutex};
|
|
|
|
use cpal::traits::{DeviceTrait, HostTrait, StreamTrait};
|
|
use cpal::{SampleFormat, SizedSample};
|
|
use tokio::sync::mpsc;
|
|
use tracing::{debug, error, info, warn};
|
|
|
|
use audiopus::coder::Encoder as OpusEncoder;
|
|
use audiopus::{Application as OpusApp, Channels as OpusChannels, SampleRate as OpusSampleRate};
|
|
|
|
use tsclientlib::audio::AudioHandler;
|
|
|
|
use chanora_protocol::{
|
|
AudioData, CodecType, InboundVoice, OutAudio, OutPacket,
|
|
};
|
|
|
|
use crate::AudioError;
|
|
|
|
/// Stable Chanora-side identifier for AudioHandler bookkeeping.
|
|
/// We only ever have one connection at a time (DEC-006), so this is
|
|
/// trivially unique.
|
|
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
|
|
pub struct SessionAudioId(pub u64);
|
|
|
|
/// Audio framing: 48 kHz mono, 20 ms = 960 samples per frame.
|
|
const SAMPLE_RATE: u32 = 48_000;
|
|
const FRAME_SAMPLES: usize = 48_000 / 50; // 960
|
|
const MAX_OPUS_FRAME: usize = 1275;
|
|
|
|
/// Engine configuration.
|
|
#[derive(Debug, Clone)]
|
|
pub struct AudioEngineConfig {
|
|
/// Input gain applied before encoding (1.0 = pass-through).
|
|
pub mic_gain: f32,
|
|
/// Initial PTT state. When false the encoder is bypassed and no
|
|
/// outbound packets are produced.
|
|
pub ptt_initial: bool,
|
|
/// Audio-effect toggles. The struct is honoured by *naming* but
|
|
/// the filters themselves are still no-op in Beta — see the
|
|
/// crate-level docs and DEC-007/008/009/010.
|
|
pub effects: crate::AudioEffects,
|
|
/// A.5 mobile: prefer the OS-provided "voice communication"
|
|
/// audio source on mobile platforms (Android
|
|
/// `MediaRecorder.AudioSource.VOICE_COMMUNICATION`, iOS
|
|
/// `AVAudioSession.Mode.voiceChat`). On Linux desktop this is
|
|
/// ignored — the DSP chain stays a no-op and we use the
|
|
/// default ALSA/PipeWire source.
|
|
///
|
|
/// Beta status: the *config flag* is plumbed through every
|
|
/// layer; the *Android-side preset switch* is documented but
|
|
/// not yet wired through cpal, which currently uses the
|
|
/// AAudio default input. RISK-AUDIO-MOBILE-001 tracks this gap.
|
|
/// Setting `true` is a forward-compatible no-op for Beta and
|
|
/// will become active once cpal exposes input-preset hooks (or
|
|
/// when Chanora ships an Oboe-based fork).
|
|
pub mobile_voice_preset: bool,
|
|
}
|
|
|
|
impl Default for AudioEngineConfig {
|
|
fn default() -> Self {
|
|
Self {
|
|
mic_gain: 1.0,
|
|
ptt_initial: false,
|
|
effects: crate::AudioEffects::default(),
|
|
mobile_voice_preset: true,
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Running audio engine. Drop = stop.
|
|
pub struct AudioEngine {
|
|
/// `transmit_active` is the authoritative gate for outbound
|
|
/// voice — the Opus encoder feed consults this flag once per
|
|
/// 20 ms frame. PTT subsystems (focused widget, future
|
|
/// Windows / macOS / Linux global backends) drive this flag
|
|
/// through [`Self::set_transmit_active`]; nothing else is
|
|
/// permitted to flip it (SAD-075 / SDD-089).
|
|
transmit_gate: crate::ptt::AudioTransmitGate,
|
|
frames_sent: Arc<AtomicU32>,
|
|
frames_received: Arc<AtomicU32>,
|
|
/// Master output gain as f32 bits in an AtomicU32. Default 1.0.
|
|
/// Adjusted via [`Self::set_output_gain`] from the bridge.
|
|
output_gain: Arc<AtomicU32>,
|
|
/// Master output mute. When true the output callback fills the
|
|
/// device buffer with silence regardless of incoming voice
|
|
/// frames. Used for self-output-mute on the local device,
|
|
/// independent of the server-side mute the protocol layer
|
|
/// broadcasts.
|
|
output_muted: Arc<AtomicBool>,
|
|
|
|
// Streams must be dropped to stop audio. Both are `!Send` because
|
|
// cpal's Stream isn't Send on some backends; we keep them in an
|
|
// Option wrapped by Mutex so stop() can move them out.
|
|
_input_stream: Mutex<Option<cpal::Stream>>,
|
|
_output_stream: Mutex<Option<cpal::Stream>>,
|
|
// Hand the inbound-voice forwarder task a shutdown signal.
|
|
shutdown_tx: Option<tokio::sync::oneshot::Sender<()>>,
|
|
/// True if the capture stream actually opened. If false (typical
|
|
/// in headless environments with null sources, or where the user
|
|
/// denied microphone permission), PTT becomes a no-op and
|
|
/// `frames_sent` stays at 0.
|
|
capture_active: bool,
|
|
/// Active desktop PTT backend (SAD-071 / SDD-081). Stored
|
|
/// inside a `Mutex<Option<_>>` so `stop()` can move it out
|
|
/// and release OS-level resources before the engine is
|
|
/// dropped. The value is always `Some` between `start_audio`
|
|
/// and `stop`.
|
|
ptt_backend: Mutex<Option<Box<dyn crate::ptt_backends::DesktopPttBackend>>>,
|
|
/// Missed-key-up watchdog. Dropping aborts the task.
|
|
ptt_watchdog: Option<crate::ptt::MissedKeyUpWatchdog>,
|
|
}
|
|
|
|
// cpal::Stream is not Send. We keep the engine pinned to the thread
|
|
// it was constructed on — `chanora_core` spawns it inside a
|
|
// `tokio::task::spawn_blocking` so the streams stay on that worker.
|
|
// This `unsafe impl Send` is necessary because the outer Arc<AudioEngine>
|
|
// is stored in core's session and must move into a task. The streams
|
|
// themselves are only mutated through the Mutex and are dropped on
|
|
// the same thread that owns them.
|
|
//
|
|
// SAFETY: cpal's Stream is not Send because the underlying audio API
|
|
// callback thread may not be transferable. We never invoke methods on
|
|
// the streams from any thread but the owning one; we only ever *drop*
|
|
// them, which cpal documents as safe from any thread for ALSA and
|
|
// PipeWire (Linux backend used here). For Windows/macOS the contract
|
|
// may differ; production Beta+ work must revisit per-platform.
|
|
unsafe impl Send for AudioEngine {}
|
|
unsafe impl Sync for AudioEngine {}
|
|
|
|
impl AudioEngine {
|
|
/// Start the engine: open capture + playback streams, spawn the
|
|
/// inbound-voice forwarder, return a handle.
|
|
pub fn start(
|
|
cfg: AudioEngineConfig,
|
|
voice_out_tx: mpsc::Sender<OutPacket>,
|
|
mut voice_in_rx: mpsc::Receiver<InboundVoice>,
|
|
) -> Result<Self, AudioError> {
|
|
let host = cpal::default_host();
|
|
let in_dev = host
|
|
.default_input_device()
|
|
.ok_or(AudioError::NoInputDevice)?;
|
|
let out_dev = host
|
|
.default_output_device()
|
|
.ok_or(AudioError::NoOutputDevice)?;
|
|
|
|
info!(
|
|
target: "chanora_audio",
|
|
in_device = %in_dev.name().unwrap_or_default(),
|
|
out_device = %out_dev.name().unwrap_or_default(),
|
|
"starting audio engine"
|
|
);
|
|
|
|
// A.5 mobile-only preset acknowledgement. On Linux desktop
|
|
// the flag is ignored; on Android we log it so a future cpal
|
|
// / Oboe wiring can be observed in the diagnostic export.
|
|
#[cfg(target_os = "android")]
|
|
{
|
|
if cfg.mobile_voice_preset {
|
|
match android_engage_voice_communication() {
|
|
Ok(()) => info!(
|
|
target: "chanora_audio",
|
|
"android: AudioManager mode set to MODE_IN_COMMUNICATION"
|
|
),
|
|
Err(e) => warn!(
|
|
target: "chanora_audio",
|
|
error = %e,
|
|
"android: failed to set MODE_IN_COMMUNICATION; falling back to default routing"
|
|
),
|
|
}
|
|
}
|
|
if cfg.effects.aec || cfg.effects.noise_suppression {
|
|
info!(
|
|
target: "chanora_audio",
|
|
aec = cfg.effects.aec,
|
|
ns = cfg.effects.noise_suppression,
|
|
"android: effects requested; engagement depends on device AEC/NS support under MODE_IN_COMMUNICATION"
|
|
);
|
|
}
|
|
}
|
|
#[cfg(target_os = "ios")]
|
|
{
|
|
if cfg.mobile_voice_preset {
|
|
info!(
|
|
target: "chanora_audio",
|
|
"ios: voice-chat session mode requested (binding pending — Chanora iOS audio is documented-only for Beta)"
|
|
);
|
|
}
|
|
}
|
|
|
|
let transmit_gate = crate::ptt::AudioTransmitGate::new(cfg.ptt_initial);
|
|
let transmit_flag_for_capture = transmit_gate.flag_arc();
|
|
let frames_sent = Arc::new(AtomicU32::new(0));
|
|
let frames_received = Arc::new(AtomicU32::new(0));
|
|
let output_gain = Arc::new(AtomicU32::new(1.0_f32.to_bits()));
|
|
let output_muted = Arc::new(AtomicBool::new(false));
|
|
|
|
// ---------- Capture ----------
|
|
// Capture is best-effort. If the platform default input
|
|
// device refuses any supported config (typical for
|
|
// headless null sources or for users who deny the mic
|
|
// permission) we log and continue — playback alone is
|
|
// still useful. PTT becomes a no-op in that case.
|
|
let capture_result = try_open_capture(
|
|
&in_dev,
|
|
voice_out_tx,
|
|
transmit_flag_for_capture,
|
|
frames_sent.clone(),
|
|
cfg.mic_gain,
|
|
);
|
|
let (input_stream, capture_active) = match capture_result {
|
|
Ok(s) => (Some(s), true),
|
|
Err(e) => {
|
|
warn!(
|
|
target: "chanora_audio",
|
|
error = %e,
|
|
"capture stream unavailable; continuing with playback only"
|
|
);
|
|
(None, false)
|
|
}
|
|
};
|
|
if let Some(s) = &input_stream {
|
|
s.play()
|
|
.map_err(|e| AudioError::Backend(format!("input play: {e}")))?;
|
|
}
|
|
|
|
// ---------- Playback ----------
|
|
let audio_handler: Arc<Mutex<AudioHandler<SessionAudioId>>> =
|
|
Arc::new(Mutex::new(AudioHandler::new()));
|
|
|
|
let out_cfg = out_dev
|
|
.default_output_config()
|
|
.map_err(|e| AudioError::StreamConfig(format!("output default: {e}")))?;
|
|
let out_format = out_cfg.sample_format();
|
|
// AudioHandler::fill_buffer expects 48 kHz stereo f32.
|
|
let out_stream_cfg = cpal::StreamConfig {
|
|
channels: 2,
|
|
sample_rate: cpal::SampleRate(SAMPLE_RATE),
|
|
buffer_size: cpal::BufferSize::Default,
|
|
};
|
|
|
|
let output_stream = match out_format {
|
|
SampleFormat::F32 => build_output_stream::<f32>(
|
|
&out_dev,
|
|
&out_stream_cfg,
|
|
audio_handler.clone(),
|
|
output_gain.clone(),
|
|
output_muted.clone(),
|
|
)?,
|
|
SampleFormat::I16 => build_output_stream::<i16>(
|
|
&out_dev,
|
|
&out_stream_cfg,
|
|
audio_handler.clone(),
|
|
output_gain.clone(),
|
|
output_muted.clone(),
|
|
)?,
|
|
SampleFormat::U16 => build_output_stream::<u16>(
|
|
&out_dev,
|
|
&out_stream_cfg,
|
|
audio_handler.clone(),
|
|
output_gain.clone(),
|
|
output_muted.clone(),
|
|
)?,
|
|
other => {
|
|
return Err(AudioError::StreamConfig(format!(
|
|
"unsupported output format: {other:?}"
|
|
)))
|
|
}
|
|
};
|
|
output_stream
|
|
.play()
|
|
.map_err(|e| AudioError::Backend(format!("output play: {e}")))?;
|
|
|
|
// ---------- Inbound forwarder ----------
|
|
let (shutdown_tx, mut shutdown_rx) = tokio::sync::oneshot::channel();
|
|
let handler_for_task = audio_handler.clone();
|
|
let frames_received_for_task = frames_received.clone();
|
|
tokio::spawn(async move {
|
|
loop {
|
|
tokio::select! {
|
|
_ = &mut shutdown_rx => {
|
|
debug!(target: "chanora_audio", "inbound forwarder shutting down");
|
|
break;
|
|
}
|
|
item = voice_in_rx.recv() => {
|
|
match item {
|
|
Some(v) => {
|
|
let id = SessionAudioId(v.from_client);
|
|
let mut h = handler_for_task.lock().unwrap();
|
|
if let Err(e) = h.handle_packet(id, v.packet) {
|
|
debug!(target: "chanora_audio", error = %e, "decode failed");
|
|
} else {
|
|
frames_received_for_task.fetch_add(1, Ordering::Relaxed);
|
|
}
|
|
}
|
|
None => break,
|
|
}
|
|
}
|
|
}
|
|
}
|
|
});
|
|
|
|
// Select and arm the desktop PTT backend (SAD-071,
|
|
// SDD-081). This call is the only place that talks to the
|
|
// platform-input layer; the rest of the engine consumes
|
|
// the typed `AudioTransmitGate`. We always have a backend
|
|
// because the cross-platform factory falls back to
|
|
// `FocusedPttBackend` (SDD-087).
|
|
let mut ptt_backend = crate::ptt_backends::select();
|
|
let initial_binding = crate::ptt_backends::PttBinding::none();
|
|
match ptt_backend.start(transmit_gate.clone(), initial_binding) {
|
|
Ok(()) => {
|
|
let d = ptt_backend.descriptor();
|
|
info!(
|
|
target: "chanora_audio",
|
|
capability_level = %d.level,
|
|
backend_id = d.backend_id,
|
|
bound_input_class = ?d.bound_input_class,
|
|
"ptt backend armed"
|
|
);
|
|
}
|
|
Err(e) => {
|
|
warn!(
|
|
target: "chanora_audio",
|
|
error = %e,
|
|
"ptt backend start failed; engine continues with Focused fallback"
|
|
);
|
|
}
|
|
}
|
|
|
|
// Spawn the missed-key-up watchdog. The task aborts on
|
|
// Drop of `MissedKeyUpWatchdog`, so the engine's `stop`
|
|
// / Drop chain releases it without explicit cleanup.
|
|
let ptt_watchdog = crate::ptt::MissedKeyUpWatchdog::spawn(
|
|
transmit_gate.clone(),
|
|
crate::ptt::MissedKeyUpWatchdog::DEFAULT_TIMEOUT,
|
|
);
|
|
|
|
Ok(Self {
|
|
transmit_gate,
|
|
frames_sent,
|
|
frames_received,
|
|
output_gain,
|
|
output_muted,
|
|
_input_stream: Mutex::new(input_stream),
|
|
_output_stream: Mutex::new(Some(output_stream)),
|
|
shutdown_tx: Some(shutdown_tx),
|
|
capture_active,
|
|
ptt_backend: Mutex::new(Some(ptt_backend)),
|
|
ptt_watchdog: Some(ptt_watchdog),
|
|
})
|
|
}
|
|
|
|
/// Stop the engine. Idempotent.
|
|
pub fn stop(&mut self) {
|
|
if let Some(tx) = self.shutdown_tx.take() {
|
|
let _ = tx.send(());
|
|
}
|
|
// Release the active PTT backend's OS resources before
|
|
// dropping the streams; the backend may hold a worker
|
|
// thread (Raw Input message loop, Event Tap run loop, etc.)
|
|
// that needs an explicit stop() to wind down cleanly.
|
|
if let Ok(mut guard) = self.ptt_backend.lock() {
|
|
if let Some(mut backend) = guard.take() {
|
|
backend.stop();
|
|
}
|
|
}
|
|
// Aborting the watchdog cancels its tokio task.
|
|
self.ptt_watchdog.take();
|
|
// Drop the streams, which stops their callback threads.
|
|
let _ = self._input_stream.lock().unwrap().take();
|
|
let _ = self._output_stream.lock().unwrap().take();
|
|
info!(target: "chanora_audio", "audio engine stopped");
|
|
}
|
|
|
|
/// Set the **transmission gate** (SRS-201). When true the
|
|
/// encoder feed is allowed to emit Opus frames; when false the
|
|
/// captured audio is discarded before encoding. This is the
|
|
/// only writer permitted on `transmit_active` (SAD-075 /
|
|
/// SDD-089). Push-to-Talk subsystems — focused PTT today,
|
|
/// per-platform global backends in a follow-up — call this
|
|
/// method exclusively. No-op when capture is inactive.
|
|
pub fn set_transmit_active(&self, active: bool) {
|
|
self.transmit_gate.set(active);
|
|
}
|
|
|
|
/// Current transmit gate state.
|
|
pub fn transmit_active(&self) -> bool {
|
|
self.transmit_gate.load()
|
|
}
|
|
|
|
/// Shared handle to the underlying transmit gate (SAD-075 /
|
|
/// SDD-089). Returned for diagnostics and integration tests
|
|
/// only; never mutate the underlying atomic directly — use
|
|
/// [`Self::set_transmit_active`] instead.
|
|
pub fn transmit_gate(&self) -> &crate::ptt::AudioTransmitGate {
|
|
&self.transmit_gate
|
|
}
|
|
|
|
/// Privacy-safe descriptor of the currently active PTT
|
|
/// backend (SDD-081 / SDD-091). Returns the universal Focused
|
|
/// fallback descriptor when the backend slot is empty
|
|
/// (typically only between `stop()` and Drop).
|
|
pub fn ptt_descriptor(&self) -> crate::ptt::PttBackendDescriptor {
|
|
if let Ok(guard) = self.ptt_backend.lock() {
|
|
if let Some(b) = guard.as_ref() {
|
|
return b.descriptor();
|
|
}
|
|
}
|
|
crate::ptt::PttBackendDescriptor::focused()
|
|
}
|
|
|
|
/// Replace the PTT binding on the active backend. Returns the
|
|
/// freshly-published descriptor so callers can re-emit the
|
|
/// capability event.
|
|
pub fn rebind_ptt(
|
|
&self,
|
|
binding: crate::ptt_backends::PttBinding,
|
|
) -> Result<crate::ptt::PttBackendDescriptor, AudioError> {
|
|
let mut guard = self
|
|
.ptt_backend
|
|
.lock()
|
|
.map_err(|_| AudioError::Backend("ptt_backend mutex poisoned".to_string()))?;
|
|
let backend = guard
|
|
.as_mut()
|
|
.ok_or_else(|| AudioError::Backend("ptt backend not armed".to_string()))?;
|
|
backend
|
|
.rebind(binding)
|
|
.map_err(|e| AudioError::Backend(format!("rebind: {e}")))?;
|
|
Ok(backend.descriptor())
|
|
}
|
|
|
|
/// Subscribe to PTT descriptor transitions on the active
|
|
/// backend. The Linux GNOME-Wayland portal backend uses this
|
|
/// channel to publish the post-`BindShortcuts` capability
|
|
/// transition. Returns `None` when the engine has no backend
|
|
/// armed (e.g. between `stop()` and Drop).
|
|
pub fn ptt_descriptor_watch(
|
|
&self,
|
|
) -> Option<tokio::sync::watch::Receiver<crate::ptt::PttBackendDescriptor>> {
|
|
let guard = self.ptt_backend.lock().ok()?;
|
|
let backend = guard.as_ref()?;
|
|
Some(backend.descriptor_watch())
|
|
}
|
|
|
|
/// Legacy alias for [`Self::set_transmit_active`]. Retained so
|
|
/// the existing bridge `set_ptt` command and the existing
|
|
/// Flutter UI continue to compile during the v0.9.3 PTT
|
|
/// migration (SRS-201 splits the conceptual `ptt` flag into
|
|
/// `transmit_active` / `capture_active`).
|
|
#[doc(hidden)]
|
|
pub fn set_ptt(&self, active: bool) {
|
|
self.set_transmit_active(active);
|
|
}
|
|
|
|
/// Legacy alias for [`Self::transmit_active`].
|
|
#[doc(hidden)]
|
|
pub fn ptt(&self) -> bool {
|
|
self.transmit_active()
|
|
}
|
|
|
|
/// True if the capture stream opened. When false, the engine
|
|
/// runs in playback-only mode and the transmit gate is a
|
|
/// no-op (no frames will ever be encoded).
|
|
pub fn capture_active(&self) -> bool {
|
|
self.capture_active
|
|
}
|
|
|
|
/// Number of Opus frames sent since the engine started.
|
|
pub fn frames_sent(&self) -> u32 {
|
|
self.frames_sent.load(Ordering::Relaxed)
|
|
}
|
|
|
|
/// Number of inbound voice packets received and decoded.
|
|
pub fn frames_received(&self) -> u32 {
|
|
self.frames_received.load(Ordering::Relaxed)
|
|
}
|
|
|
|
/// Set master output mute. When true the output stream emits
|
|
/// silence regardless of incoming voice frames.
|
|
pub fn set_output_muted(&self, muted: bool) {
|
|
self.output_muted.store(muted, Ordering::Relaxed);
|
|
}
|
|
|
|
/// True if the master output is currently muted locally.
|
|
pub fn output_muted(&self) -> bool {
|
|
self.output_muted.load(Ordering::Relaxed)
|
|
}
|
|
|
|
/// Set master output gain. 1.0 is unity; 0.0 is silent. Values
|
|
/// above 1.0 amplify (and may clip downstream). Clamped to a
|
|
/// sensible range internally.
|
|
pub fn set_output_gain(&self, gain: f32) {
|
|
let clamped = gain.clamp(0.0, 4.0);
|
|
self.output_gain
|
|
.store(clamped.to_bits(), Ordering::Relaxed);
|
|
}
|
|
|
|
/// Current master output gain.
|
|
pub fn output_gain(&self) -> f32 {
|
|
f32::from_bits(self.output_gain.load(Ordering::Relaxed))
|
|
}
|
|
}
|
|
|
|
impl Drop for AudioEngine {
|
|
fn drop(&mut self) {
|
|
self.stop();
|
|
}
|
|
}
|
|
|
|
// ---------- Capture pipeline ----------
|
|
|
|
fn try_open_capture(
|
|
in_dev: &cpal::Device,
|
|
voice_out_tx: mpsc::Sender<OutPacket>,
|
|
transmit_active: Arc<AtomicBool>,
|
|
frames_sent: Arc<AtomicU32>,
|
|
mic_gain: f32,
|
|
) -> Result<cpal::Stream, AudioError> {
|
|
let in_cfg = in_dev
|
|
.default_input_config()
|
|
.map_err(|e| AudioError::StreamConfig(format!("input default: {e}")))?;
|
|
let in_sample_rate = in_cfg.sample_rate().0;
|
|
let in_channels = in_cfg.channels() as usize;
|
|
let in_format = in_cfg.sample_format();
|
|
let in_stream_cfg: cpal::StreamConfig = in_cfg.into();
|
|
|
|
let opus_enc = OpusEncoder::new(
|
|
OpusSampleRate::Hz48000,
|
|
OpusChannels::Mono,
|
|
OpusApp::Voip,
|
|
)
|
|
.map_err(|e| AudioError::Opus(format!("encoder new: {e}")))?;
|
|
|
|
let capture_state = Arc::new(Mutex::new(CaptureState::new(
|
|
opus_enc,
|
|
in_sample_rate,
|
|
in_channels,
|
|
mic_gain,
|
|
voice_out_tx,
|
|
transmit_active,
|
|
frames_sent,
|
|
)));
|
|
|
|
let stream = match in_format {
|
|
SampleFormat::F32 => build_input_stream::<f32>(in_dev, &in_stream_cfg, capture_state)?,
|
|
SampleFormat::I16 => build_input_stream::<i16>(in_dev, &in_stream_cfg, capture_state)?,
|
|
SampleFormat::U16 => build_input_stream::<u16>(in_dev, &in_stream_cfg, capture_state)?,
|
|
other => {
|
|
return Err(AudioError::StreamConfig(format!(
|
|
"unsupported input format: {other:?}"
|
|
)))
|
|
}
|
|
};
|
|
Ok(stream)
|
|
}
|
|
|
|
struct CaptureState {
|
|
encoder: OpusEncoder,
|
|
in_sample_rate: u32,
|
|
in_channels: usize,
|
|
mic_gain: f32,
|
|
/// 48 kHz mono buffer accumulated to FRAME_SAMPLES before each encode.
|
|
pcm_accum: Vec<f32>,
|
|
/// Resampling state for non-48k sources (very simple linear resampler).
|
|
resample_pos: f64,
|
|
opus_out: [u8; MAX_OPUS_FRAME],
|
|
voice_out_tx: mpsc::Sender<OutPacket>,
|
|
/// The PTT transmission gate. Read once per outbound frame; the
|
|
/// CaptureState never mutates this flag.
|
|
transmit_active: Arc<AtomicBool>,
|
|
frames_sent: Arc<AtomicU32>,
|
|
}
|
|
|
|
impl CaptureState {
|
|
fn new(
|
|
encoder: OpusEncoder,
|
|
in_sample_rate: u32,
|
|
in_channels: usize,
|
|
mic_gain: f32,
|
|
voice_out_tx: mpsc::Sender<OutPacket>,
|
|
transmit_active: Arc<AtomicBool>,
|
|
frames_sent: Arc<AtomicU32>,
|
|
) -> Self {
|
|
Self {
|
|
encoder,
|
|
in_sample_rate,
|
|
in_channels,
|
|
mic_gain,
|
|
pcm_accum: Vec::with_capacity(FRAME_SAMPLES * 2),
|
|
resample_pos: 0.0,
|
|
opus_out: [0u8; MAX_OPUS_FRAME],
|
|
voice_out_tx,
|
|
transmit_active,
|
|
frames_sent,
|
|
}
|
|
}
|
|
|
|
/// Consume an arbitrary-rate, multichannel cpal buffer; produce
|
|
/// 48 kHz mono frames; encode and send when `transmit_active`
|
|
/// is true (PTT engaged).
|
|
fn ingest<T: ToF32 + Copy>(&mut self, buf: &[T]) {
|
|
if !self.transmit_active.load(Ordering::Relaxed) {
|
|
// Drain accumulator while muted so we don't pop on PTT release.
|
|
self.pcm_accum.clear();
|
|
return;
|
|
}
|
|
|
|
// 1. Down-mix to mono + gain.
|
|
let mono: Vec<f32> = buf
|
|
.chunks(self.in_channels)
|
|
.map(|frame| {
|
|
let sum: f32 = frame.iter().map(|s| s.to_f32_sample()).sum();
|
|
(sum / frame.len() as f32) * self.mic_gain
|
|
})
|
|
.collect();
|
|
|
|
// 2. Resample to 48 kHz if needed.
|
|
if self.in_sample_rate == SAMPLE_RATE {
|
|
self.pcm_accum.extend_from_slice(&mono);
|
|
} else {
|
|
self.resample_into_accum(&mono);
|
|
}
|
|
|
|
// 3. Encode any complete frames.
|
|
while self.pcm_accum.len() >= FRAME_SAMPLES {
|
|
let frame: Vec<f32> = self.pcm_accum.drain(..FRAME_SAMPLES).collect();
|
|
match self.encoder.encode_float(&frame, &mut self.opus_out[..]) {
|
|
Ok(len) => {
|
|
let packet = OutAudio::new(&AudioData::C2S {
|
|
id: 0,
|
|
codec: CodecType::OpusVoice,
|
|
data: &self.opus_out[..len],
|
|
});
|
|
match self.voice_out_tx.try_send(packet) {
|
|
Ok(()) => {
|
|
self.frames_sent.fetch_add(1, Ordering::Relaxed);
|
|
}
|
|
Err(mpsc::error::TrySendError::Full(_)) => {
|
|
warn!(target: "chanora_audio", "voice_out queue full; dropping frame");
|
|
}
|
|
Err(mpsc::error::TrySendError::Closed(_)) => {
|
|
warn!(target: "chanora_audio", "voice_out closed; stopping send");
|
|
}
|
|
}
|
|
}
|
|
Err(e) => {
|
|
error!(target: "chanora_audio", error = %e, "opus encode failed");
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Simple linear resampler for `in_sample_rate → 48000`.
|
|
/// Production quality work belongs in a Beta+ DSP module.
|
|
fn resample_into_accum(&mut self, mono: &[f32]) {
|
|
let ratio = self.in_sample_rate as f64 / SAMPLE_RATE as f64;
|
|
let mut pos = self.resample_pos;
|
|
while pos < mono.len() as f64 {
|
|
let i = pos as usize;
|
|
let frac = pos - i as f64;
|
|
let a = mono[i];
|
|
let b = if i + 1 < mono.len() { mono[i + 1] } else { a };
|
|
self.pcm_accum
|
|
.push((a as f64 + frac * (b - a) as f64) as f32);
|
|
pos += ratio;
|
|
}
|
|
// Keep the leftover sub-sample offset for the next buffer.
|
|
self.resample_pos = pos - mono.len() as f64;
|
|
}
|
|
}
|
|
|
|
/// Per-sample format conversion to f32 in the range [-1.0, 1.0].
|
|
trait ToF32 {
|
|
fn to_f32_sample(self) -> f32;
|
|
}
|
|
impl ToF32 for f32 {
|
|
fn to_f32_sample(self) -> f32 {
|
|
self
|
|
}
|
|
}
|
|
impl ToF32 for i16 {
|
|
fn to_f32_sample(self) -> f32 {
|
|
f32::from(self) / f32::from(i16::MAX)
|
|
}
|
|
}
|
|
impl ToF32 for u16 {
|
|
fn to_f32_sample(self) -> f32 {
|
|
(f32::from(self) - f32::from(i16::MAX) - 1.0) / f32::from(i16::MAX)
|
|
}
|
|
}
|
|
|
|
fn build_input_stream<T>(
|
|
device: &cpal::Device,
|
|
config: &cpal::StreamConfig,
|
|
state: Arc<Mutex<CaptureState>>,
|
|
) -> Result<cpal::Stream, AudioError>
|
|
where
|
|
T: SizedSample + ToF32 + Send + 'static,
|
|
{
|
|
let stream = device
|
|
.build_input_stream(
|
|
config,
|
|
move |data: &[T], _| {
|
|
let mut s = state.lock().unwrap();
|
|
s.ingest(data);
|
|
},
|
|
move |e| {
|
|
error!(target: "chanora_audio", error = %e, "input stream error");
|
|
},
|
|
None,
|
|
)
|
|
.map_err(|e| AudioError::Backend(format!("build_input_stream: {e}")))?;
|
|
Ok(stream)
|
|
}
|
|
|
|
// ---------- Playback pipeline ----------
|
|
|
|
fn build_output_stream<T>(
|
|
device: &cpal::Device,
|
|
config: &cpal::StreamConfig,
|
|
handler: Arc<Mutex<AudioHandler<SessionAudioId>>>,
|
|
output_gain: Arc<AtomicU32>,
|
|
output_muted: Arc<AtomicBool>,
|
|
) -> Result<cpal::Stream, AudioError>
|
|
where
|
|
T: SizedSample + FromF32 + Send + 'static,
|
|
{
|
|
let stream = device
|
|
.build_output_stream(
|
|
config,
|
|
move |out: &mut [T], _| {
|
|
let muted = output_muted.load(Ordering::Relaxed);
|
|
if muted {
|
|
// Still call fill_buffer to keep the jitter
|
|
// buffer draining; just discard the result and
|
|
// emit silence to the device.
|
|
let mut scratch = vec![0.0f32; out.len()];
|
|
{
|
|
let mut h = handler.lock().unwrap();
|
|
h.fill_buffer(&mut scratch);
|
|
}
|
|
for dst in out.iter_mut() {
|
|
*dst = T::from_f32_sample(0.0);
|
|
}
|
|
return;
|
|
}
|
|
let gain = f32::from_bits(output_gain.load(Ordering::Relaxed));
|
|
let mut scratch = vec![0.0f32; out.len()];
|
|
{
|
|
let mut h = handler.lock().unwrap();
|
|
h.fill_buffer(&mut scratch);
|
|
}
|
|
for (dst, src) in out.iter_mut().zip(scratch.into_iter()) {
|
|
*dst = T::from_f32_sample(src * gain);
|
|
}
|
|
},
|
|
move |e| {
|
|
error!(target: "chanora_audio", error = %e, "output stream error");
|
|
},
|
|
None,
|
|
)
|
|
.map_err(|e| AudioError::Backend(format!("build_output_stream: {e}")))?;
|
|
Ok(stream)
|
|
}
|
|
|
|
trait FromF32 {
|
|
fn from_f32_sample(v: f32) -> Self;
|
|
}
|
|
impl FromF32 for f32 {
|
|
fn from_f32_sample(v: f32) -> Self {
|
|
v
|
|
}
|
|
}
|
|
impl FromF32 for i16 {
|
|
fn from_f32_sample(v: f32) -> Self {
|
|
(v.clamp(-1.0, 1.0) * f32::from(i16::MAX)) as i16
|
|
}
|
|
}
|
|
impl FromF32 for u16 {
|
|
fn from_f32_sample(v: f32) -> Self {
|
|
let s = (v.clamp(-1.0, 1.0) * f32::from(i16::MAX)) as i32;
|
|
(s + i32::from(i16::MAX) + 1) as u16
|
|
}
|
|
}
|
|
|
|
// ---------- Android voice-communication routing ----------
|
|
//
|
|
// Engages `AudioManager.MODE_IN_COMMUNICATION` on the Android-side
|
|
// AudioManager. This is the routing-level lever that tells the OS
|
|
// "this is a voice call, please use the earpiece / engage hardware
|
|
// AEC / NS / AGC where the device supports it". cpal opens its
|
|
// input stream at the AAudio default preset; on most Android
|
|
// devices this honours the global mode and chooses the right
|
|
// pipeline. Fully wiring `setInputPreset(VOICE_COMMUNICATION)` would
|
|
// need either a cpal fork or a parallel Oboe input — out of scope
|
|
// for External Beta.
|
|
#[cfg(target_os = "android")]
|
|
fn android_engage_voice_communication() -> Result<(), String> {
|
|
use jni::objects::{JObject, JString, JValue};
|
|
let ctx = ndk_context::android_context();
|
|
let vm_ptr = ctx.vm();
|
|
if vm_ptr.is_null() {
|
|
return Err("ndk_context vm is null".to_string());
|
|
}
|
|
// SAFETY: ndk_context::android_context guarantees `vm` points at
|
|
// a live JavaVM* set by our bridge_init JNI hook. The unsafe
|
|
// block contains only the cast required by `JavaVM::from_raw`.
|
|
let jvm = unsafe { jni::JavaVM::from_raw(vm_ptr as *mut _) }
|
|
.map_err(|e| format!("jvm from_raw: {e}"))?;
|
|
let mut env = jvm
|
|
.attach_current_thread()
|
|
.map_err(|e| format!("attach: {e}"))?;
|
|
|
|
let context_obj = unsafe { JObject::from_raw(ctx.context() as jni::sys::jobject) };
|
|
|
|
let service_name: JString = env
|
|
.new_string("audio")
|
|
.map_err(|e| format!("new_string: {e}"))?;
|
|
let audio_manager = env
|
|
.call_method(
|
|
&context_obj,
|
|
"getSystemService",
|
|
"(Ljava/lang/String;)Ljava/lang/Object;",
|
|
&[JValue::Object(&service_name.into())],
|
|
)
|
|
.map_err(|e| format!("getSystemService: {e}"))?
|
|
.l()
|
|
.map_err(|e| format!("getSystemService obj: {e}"))?;
|
|
if audio_manager.is_null() {
|
|
return Err("AudioManager service is null".to_string());
|
|
}
|
|
// AudioManager.MODE_IN_COMMUNICATION == 3.
|
|
env.call_method(&audio_manager, "setMode", "(I)V", &[JValue::Int(3)])
|
|
.map_err(|e| format!("setMode: {e}"))?;
|
|
Ok(())
|
|
}
|