Skip to content

Fix macOS VoiceProcessingIO input setup for screenpipe AEC. #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
louis030195 merged 4 commits into from
May 23, 2026
Merged

Fix macOS VoiceProcessingIO input setup for screenpipe AEC. #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1af4862
Fix macOS VoiceProcessingIO input setup for screenpipe AEC.
divanshu-go May 19, 2026
9fb6ce2
cargo fmt
divanshu-go May 19, 2026
9e2b188
fix
divanshu-go May 19, 2026
bf174e5
fix(coreaudio): sample rate tolerance and continuous-range device sup…
divanshu-go May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions examples/feedback.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,10 @@ fn main() -> anyhow::Result<()> {
"Attempting to build both streams with f32 samples and `{:?}`.",
config
);
#[cfg(target_os = "macos")]
let input_stream =
input_device.build_input_stream(&config, input_data_fn, err_fn, None, None)?;
#[cfg(not(target_os = "macos"))]
let input_stream = input_device.build_input_stream(&config, input_data_fn, err_fn, None)?;
let output_stream = output_device.build_output_stream(&config, output_data_fn, err_fn, None)?;
println!("Successfully built streams.");
Expand Down
68 changes: 44 additions & 24 deletions examples/record_wav.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,31 +100,20 @@ fn main() -> Result<(), anyhow::Error> {
eprintln!("an error occurred on stream: {}", err);
};

let stream_config = config.config();
let stream = match config.sample_format() {
cpal::SampleFormat::I8 => device.build_input_stream(
&config.into(),
move |data, _: &_| write_input_data::<i8, i8>(data, &writer_2),
err_fn,
None,
)?,
cpal::SampleFormat::I16 => device.build_input_stream(
&config.into(),
move |data, _: &_| write_input_data::<i16, i16>(data, &writer_2),
err_fn,
None,
)?,
cpal::SampleFormat::I32 => device.build_input_stream(
&config.into(),
move |data, _: &_| write_input_data::<i32, i32>(data, &writer_2),
err_fn,
None,
)?,
cpal::SampleFormat::F32 => device.build_input_stream(
&config.into(),
move |data, _: &_| write_input_data::<f32, f32>(data, &writer_2),
err_fn,
None,
)?,
cpal::SampleFormat::I8 => {
build_recording_stream::<i8, i8>(&device, &stream_config, writer_2, err_fn)?
}
cpal::SampleFormat::I16 => {
build_recording_stream::<i16, i16>(&device, &stream_config, writer_2, err_fn)?
}
cpal::SampleFormat::I32 => {
build_recording_stream::<i32, i32>(&device, &stream_config, writer_2, err_fn)?
}
cpal::SampleFormat::F32 => {
build_recording_stream::<f32, f32>(&device, &stream_config, writer_2, err_fn)?
}
sample_format => {
return Err(anyhow::Error::msg(format!(
"Unsupported sample format '{sample_format}'"
Expand Down Expand Up @@ -161,6 +150,37 @@ fn wav_spec_from_config(config: &cpal::SupportedStreamConfig) -> hound::WavSpec

type WavWriterHandle = Arc<Mutex<Option<hound::WavWriter<BufWriter<File>>>>>;

fn build_recording_stream<T, U>(
device: &cpal::Device,
config: &cpal::StreamConfig,
writer: WavWriterHandle,
err_fn: impl FnMut(cpal::StreamError) + Send + 'static,
) -> Result<cpal::Stream, cpal::BuildStreamError>
where
T: Sample + cpal::SizedSample,
U: Sample + hound::Sample + FromSample<T>,
{
#[cfg(target_os = "macos")]
{
device.build_input_stream(
config,
move |data: &[T], _: &cpal::InputCallbackInfo| write_input_data::<T, U>(data, &writer),
err_fn,
None,
None,
)
}
#[cfg(not(target_os = "macos"))]
{
device.build_input_stream(
config,
move |data: &[T], _: &cpal::InputCallbackInfo| write_input_data::<T, U>(data, &writer),
err_fn,
None,
)
}
}

fn write_input_data<T, U>(input: &[T], writer: &WavWriterHandle)
where
T: Sample,
Expand Down
90 changes: 58 additions & 32 deletions examples/record_wav_aec.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//! Records a WAV file using the default input device with Screenpipe's Windows WASAPI AEC enabled.
//! Records a WAV file using the default input device with echo cancellation requested.
//!
//! AEC is requested only on Windows WASAPI input streams. Unsupported devices continue recording
//! normally without echo cancellation.
//! On Windows, sets `StreamConfig.windows_input_aec`. On macOS, passes
//! `MacosVoiceProcessingInputConfig::screenpipe_aec()`. Other platforms record normally.

use clap::Parser;
use cpal::traits::{DeviceTrait, HostTrait, StreamTrait};
Expand All @@ -13,7 +13,10 @@ use std::sync::{Arc, Mutex};
use std::time::Duration;

#[derive(Parser, Debug)]
#[command(version, about = "Record a WAV file with Windows WASAPI AEC requested")]
#[command(
version,
about = "Record a WAV file with platform AEC requested when available"
)]
struct Opt {
/// The audio input device to use.
#[arg(short, long, default_value_t = String::from("default"))]
Expand All @@ -31,8 +34,8 @@ struct Opt {
fn main() -> Result<(), anyhow::Error> {
let opt = Opt::parse();

#[cfg(not(target_os = "windows"))]
eprintln!("AEC is only requested by the Windows WASAPI backend; recording normally here.");
#[cfg(not(any(target_os = "windows", target_os = "macos")))]
eprintln!("AEC is only requested on Windows WASAPI and macOS VoiceProcessingIO; recording normally here.");

let host = cpal::default_host();
let device = if opt.device == "default" {
Expand Down Expand Up @@ -62,30 +65,18 @@ fn main() -> Result<(), anyhow::Error> {
let stream_config = aec_stream_config(&config);

let stream = match config.sample_format() {
cpal::SampleFormat::I8 => device.build_input_stream(
&stream_config,
move |data, _: &_| write_input_data::<i8, i8>(data, &writer_2),
err_fn,
None,
)?,
cpal::SampleFormat::I16 => device.build_input_stream(
&stream_config,
move |data, _: &_| write_input_data::<i16, i16>(data, &writer_2),
err_fn,
None,
)?,
cpal::SampleFormat::I32 => device.build_input_stream(
&stream_config,
move |data, _: &_| write_input_data::<i32, i32>(data, &writer_2),
err_fn,
None,
)?,
cpal::SampleFormat::F32 => device.build_input_stream(
&stream_config,
move |data, _: &_| write_input_data::<f32, f32>(data, &writer_2),
err_fn,
None,
)?,
cpal::SampleFormat::I8 => {
build_aec_recording_stream::<i8, i8>(&device, &stream_config, writer_2, err_fn)?
}
cpal::SampleFormat::I16 => {
build_aec_recording_stream::<i16, i16>(&device, &stream_config, writer_2, err_fn)?
}
cpal::SampleFormat::I32 => {
build_aec_recording_stream::<i32, i32>(&device, &stream_config, writer_2, err_fn)?
}
cpal::SampleFormat::F32 => {
build_aec_recording_stream::<f32, f32>(&device, &stream_config, writer_2, err_fn)?
}
sample_format => {
return Err(anyhow::anyhow!(
"unsupported sample format '{sample_format}'"
Expand All @@ -109,12 +100,16 @@ fn main() -> Result<(), anyhow::Error> {
}

fn aec_stream_config(config: &cpal::SupportedStreamConfig) -> cpal::StreamConfig {
let mut stream_config = config.config();
#[cfg(target_os = "windows")]
{
let mut stream_config = config.config();
stream_config.windows_input_aec = true;
stream_config
}
#[cfg(not(target_os = "windows"))]
{
config.config()
}
stream_config
}

fn sample_format(format: cpal::SampleFormat) -> hound::SampleFormat {
Expand All @@ -136,6 +131,37 @@ fn wav_spec_from_config(config: &cpal::SupportedStreamConfig) -> hound::WavSpec

type WavWriterHandle = Arc<Mutex<Option<hound::WavWriter<BufWriter<File>>>>>;

fn build_aec_recording_stream<T, U>(
device: &cpal::Device,
config: &cpal::StreamConfig,
writer: WavWriterHandle,
err_fn: impl FnMut(cpal::StreamError) + Send + 'static,
) -> Result<cpal::Stream, cpal::BuildStreamError>
where
T: Sample + cpal::SizedSample,
U: Sample + hound::Sample + FromSample<T>,
{
#[cfg(target_os = "macos")]
{
device.build_input_stream(
config,
move |data: &[T], _: &cpal::InputCallbackInfo| write_input_data::<T, U>(data, &writer),
err_fn,
None,
Some(cpal::MacosVoiceProcessingInputConfig::screenpipe_aec()),
)
}
#[cfg(not(target_os = "macos"))]
{
device.build_input_stream(
config,
move |data: &[T], _: &cpal::InputCallbackInfo| write_input_data::<T, U>(data, &writer),
err_fn,
None,
)
}
}

fn write_input_data<T, U>(input: &[T], writer: &WavWriterHandle)
where
T: Sample,
Expand Down
Loading
Loading