diff --git a/examples/android.rs b/examples/android.rs index 9cdad5e..b58731d 100644 --- a/examples/android.rs +++ b/examples/android.rs @@ -60,6 +60,7 @@ where write_data(data, channels, &mut next_value) }, err_fn, + None, )?; stream.play()?; diff --git a/examples/beep.rs b/examples/beep.rs index 5f71098..4128c48 100644 --- a/examples/beep.rs +++ b/examples/beep.rs @@ -158,6 +158,7 @@ where write_data(data, channels, &mut next_value) }, err_fn, + None, )?; stream.play()?; diff --git a/examples/feedback.rs b/examples/feedback.rs index 42980e5..50697f6 100644 --- a/examples/feedback.rs +++ b/examples/feedback.rs @@ -202,8 +202,8 @@ fn main() -> anyhow::Result<()> { "Attempting to build both streams with f32 samples and `{:?}`.", config ); - let input_stream = input_device.build_input_stream(&config, input_data_fn, err_fn)?; - let output_stream = output_device.build_output_stream(&config, output_data_fn, err_fn)?; + 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."); // Play the streams. diff --git a/examples/ios-feedback/src/feedback.rs b/examples/ios-feedback/src/feedback.rs index 457cda2..6f86e25 100644 --- a/examples/ios-feedback/src/feedback.rs +++ b/examples/ios-feedback/src/feedback.rs @@ -83,9 +83,9 @@ pub fn run_example() -> Result<(), anyhow::Error> { config ); println!("Setup input stream"); - let input_stream = input_device.build_input_stream(&config, input_data_fn, err_fn)?; + let input_stream = input_device.build_input_stream(&config, input_data_fn, err_fn, None)?; println!("Setup output stream"); - let output_stream = output_device.build_output_stream(&config, output_data_fn, err_fn)?; + let output_stream = output_device.build_output_stream(&config, output_data_fn, err_fn, None)?; println!("Successfully built streams."); // Play the streams. diff --git a/examples/record_wav.rs b/examples/record_wav.rs index 0549c9b..27fd40e 100644 --- a/examples/record_wav.rs +++ b/examples/record_wav.rs @@ -147,21 +147,25 @@ fn main() -> Result<(), anyhow::Error> { &config.into(), move |data, _: &_| write_input_data::(data, &writer_2), err_fn, + None, )?, cpal::SampleFormat::I16 => device.build_input_stream( &config.into(), move |data, _: &_| write_input_data::(data, &writer_2), err_fn, + None, )?, cpal::SampleFormat::I32 => device.build_input_stream( &config.into(), move |data, _: &_| write_input_data::(data, &writer_2), err_fn, + None, )?, cpal::SampleFormat::F32 => device.build_input_stream( &config.into(), move |data, _: &_| write_input_data::(data, &writer_2), err_fn, + None, )?, sample_format => { return Err(anyhow::Error::msg(format!( diff --git a/examples/synth_tones.rs b/examples/synth_tones.rs index abb8ab4..dce9dd9 100644 --- a/examples/synth_tones.rs +++ b/examples/synth_tones.rs @@ -107,6 +107,7 @@ where on_window(output, &mut request, on_sample) }, err_fn, + None, )?; Ok(stream) diff --git a/examples/wasm-beep/src/lib.rs b/examples/wasm-beep/src/lib.rs index 8914ed5..0308650 100644 --- a/examples/wasm-beep/src/lib.rs +++ b/examples/wasm-beep/src/lib.rs @@ -62,6 +62,7 @@ where config, move |data: &mut [T], _| write_data(data, channels, &mut next_value), err_fn, + None, ) .unwrap(); stream.play().unwrap(); diff --git a/src/host/alsa/mod.rs b/src/host/alsa/mod.rs index 455d8bc..b806285 100644 --- a/src/host/alsa/mod.rs +++ b/src/host/alsa/mod.rs @@ -16,6 +16,7 @@ use std::cmp; use std::convert::TryInto; use std::sync::Arc; use std::thread::{self, JoinHandle}; +use std::time::Duration; use std::vec::IntoIter as VecIntoIter; pub use self::enumerate::{default_input_device, default_output_device, Devices}; @@ -92,6 +93,7 @@ impl DeviceTrait for Device { sample_format: SampleFormat, data_callback: D, error_callback: E, + timeout: Option, ) -> Result where D: FnMut(&Data, &InputCallbackInfo) + Send + 'static, @@ -99,7 +101,12 @@ impl DeviceTrait for Device { { let stream_inner = self.build_stream_inner(conf, sample_format, alsa::Direction::Capture)?; - let stream = Stream::new_input(Arc::new(stream_inner), data_callback, error_callback); + let stream = Stream::new_input( + Arc::new(stream_inner), + data_callback, + error_callback, + timeout, + ); Ok(stream) } @@ -109,6 +116,7 @@ impl DeviceTrait for Device { sample_format: SampleFormat, data_callback: D, error_callback: E, + timeout: Option, ) -> Result where D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static, @@ -116,7 +124,12 @@ impl DeviceTrait for Device { { let stream_inner = self.build_stream_inner(conf, sample_format, alsa::Direction::Playback)?; - let stream = Stream::new_output(Arc::new(stream_inner), data_callback, error_callback); + let stream = Stream::new_output( + Arc::new(stream_inner), + data_callback, + error_callback, + timeout, + ); Ok(stream) } } @@ -542,10 +555,26 @@ pub struct Stream { trigger: TriggerSender, } -#[derive(Default)] struct StreamWorkerContext { descriptors: Vec, buffer: Vec, + poll_timeout: i32, +} + +impl StreamWorkerContext { + fn new(poll_timeout: &Option) -> Self { + let poll_timeout: i32 = if let Some(d) = poll_timeout { + d.as_millis().try_into().unwrap() + } else { + -1 + }; + + Self { + descriptors: Vec::new(), + buffer: Vec::new(), + poll_timeout, + } + } } fn input_stream_worker( @@ -553,8 +582,9 @@ fn input_stream_worker( stream: &StreamInner, data_callback: &mut (dyn FnMut(&Data, &InputCallbackInfo) + Send + 'static), error_callback: &mut (dyn FnMut(StreamError) + Send + 'static), + timeout: Option, ) { - let mut ctxt = StreamWorkerContext::default(); + let mut ctxt = StreamWorkerContext::new(&timeout); loop { let flow = poll_descriptors_and_prepare_buffer(&rx, stream, &mut ctxt).unwrap_or_else(|err| { @@ -603,8 +633,9 @@ fn output_stream_worker( stream: &StreamInner, data_callback: &mut (dyn FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static), error_callback: &mut (dyn FnMut(StreamError) + Send + 'static), + timeout: Option, ) { - let mut ctxt = StreamWorkerContext::default(); + let mut ctxt = StreamWorkerContext::new(&timeout); loop { let flow = poll_descriptors_and_prepare_buffer(&rx, stream, &mut ctxt).unwrap_or_else(|err| { @@ -669,6 +700,7 @@ fn poll_descriptors_and_prepare_buffer( let StreamWorkerContext { ref mut descriptors, ref mut buffer, + ref poll_timeout, } = *ctxt; descriptors.clear(); @@ -694,7 +726,7 @@ fn poll_descriptors_and_prepare_buffer( debug_assert_eq!(filled, stream.num_descriptors); // Don't timeout, wait forever. - let res = alsa::poll::poll(descriptors, -1)?; + let res = alsa::poll::poll(descriptors, *poll_timeout)?; if res == 0 { let description = String::from("`alsa::poll()` spuriously returned"); return Err(BackendSpecificError { description }); @@ -881,6 +913,7 @@ impl Stream { inner: Arc, mut data_callback: D, mut error_callback: E, + timeout: Option, ) -> Stream where D: FnMut(&Data, &InputCallbackInfo) + Send + 'static, @@ -892,7 +925,13 @@ impl Stream { let thread = thread::Builder::new() .name("cpal_alsa_in".to_owned()) .spawn(move || { - input_stream_worker(rx, &stream, &mut data_callback, &mut error_callback); + input_stream_worker( + rx, + &stream, + &mut data_callback, + &mut error_callback, + timeout, + ); }) .unwrap(); Stream { @@ -906,6 +945,7 @@ impl Stream { inner: Arc, mut data_callback: D, mut error_callback: E, + timeout: Option, ) -> Stream where D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static, @@ -917,7 +957,13 @@ impl Stream { let thread = thread::Builder::new() .name("cpal_alsa_out".to_owned()) .spawn(move || { - output_stream_worker(rx, &stream, &mut data_callback, &mut error_callback); + output_stream_worker( + rx, + &stream, + &mut data_callback, + &mut error_callback, + timeout, + ); }) .unwrap(); Stream { diff --git a/src/host/asio/mod.rs b/src/host/asio/mod.rs index 5a511d7..3cf7e8c 100644 --- a/src/host/asio/mod.rs +++ b/src/host/asio/mod.rs @@ -11,6 +11,7 @@ use crate::{ pub use self::device::{Device, Devices, SupportedInputConfigs, SupportedOutputConfigs}; pub use self::stream::Stream; use std::sync::Arc; +use std::time::Duration; mod device; mod stream; @@ -88,12 +89,20 @@ impl DeviceTrait for Device { sample_format: SampleFormat, data_callback: D, error_callback: E, + timeout: Option, ) -> Result where D: FnMut(&Data, &InputCallbackInfo) + Send + 'static, E: FnMut(StreamError) + Send + 'static, { - Device::build_input_stream_raw(self, config, sample_format, data_callback, error_callback) + Device::build_input_stream_raw( + self, + config, + sample_format, + data_callback, + error_callback, + timeout, + ) } fn build_output_stream_raw( @@ -102,12 +111,20 @@ impl DeviceTrait for Device { sample_format: SampleFormat, data_callback: D, error_callback: E, + timeout: Option, ) -> Result where D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static, E: FnMut(StreamError) + Send + 'static, { - Device::build_output_stream_raw(self, config, sample_format, data_callback, error_callback) + Device::build_output_stream_raw( + self, + config, + sample_format, + data_callback, + error_callback, + timeout, + ) } } diff --git a/src/host/asio/stream.rs b/src/host/asio/stream.rs index a5da93f..29229e2 100644 --- a/src/host/asio/stream.rs +++ b/src/host/asio/stream.rs @@ -12,6 +12,7 @@ use crate::{ use std; use std::sync::atomic::{AtomicBool, Ordering}; use std::sync::Arc; +use std::time::Duration; // Used to keep track of whether or not the current asio stream buffer requires // being silencing before summing audio. @@ -48,6 +49,7 @@ impl Device { sample_format: SampleFormat, mut data_callback: D, _error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&Data, &InputCallbackInfo) + Send + 'static, @@ -229,6 +231,7 @@ impl Device { sample_format: SampleFormat, mut data_callback: D, _error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static, diff --git a/src/host/coreaudio/ios/mod.rs b/src/host/coreaudio/ios/mod.rs index 91b6a90..8d7176c 100644 --- a/src/host/coreaudio/ios/mod.rs +++ b/src/host/coreaudio/ios/mod.rs @@ -34,6 +34,7 @@ use self::enumerate::{ SupportedOutputConfigs, }; use std::slice; +use std::time::Duration; pub mod enumerate; @@ -174,6 +175,7 @@ impl DeviceTrait for Device { sample_format: SampleFormat, mut data_callback: D, mut error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&Data, &InputCallbackInfo) + Send + 'static, @@ -256,6 +258,7 @@ impl DeviceTrait for Device { sample_format: SampleFormat, mut data_callback: D, mut error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static, diff --git a/src/host/coreaudio/macos/mod.rs b/src/host/coreaudio/macos/mod.rs index 6d55cc4..002b405 100644 --- a/src/host/coreaudio/macos/mod.rs +++ b/src/host/coreaudio/macos/mod.rs @@ -116,12 +116,20 @@ impl DeviceTrait for Device { sample_format: SampleFormat, data_callback: D, error_callback: E, + timeout: Option, ) -> Result where D: FnMut(&Data, &InputCallbackInfo) + Send + 'static, E: FnMut(StreamError) + Send + 'static, { - Device::build_input_stream_raw(self, config, sample_format, data_callback, error_callback) + Device::build_input_stream_raw( + self, + config, + sample_format, + data_callback, + error_callback, + timeout, + ) } fn build_output_stream_raw( @@ -130,12 +138,20 @@ impl DeviceTrait for Device { sample_format: SampleFormat, data_callback: D, error_callback: E, + timeout: Option, ) -> Result where D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static, E: FnMut(StreamError) + Send + 'static, { - Device::build_output_stream_raw(self, config, sample_format, data_callback, error_callback) + Device::build_output_stream_raw( + self, + config, + sample_format, + data_callback, + error_callback, + timeout, + ) } } @@ -502,6 +518,7 @@ impl Device { sample_format: SampleFormat, mut data_callback: D, error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&Data, &InputCallbackInfo) + Send + 'static, @@ -611,6 +628,7 @@ impl Device { sample_format: SampleFormat, mut data_callback: D, error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static, diff --git a/src/host/emscripten/mod.rs b/src/host/emscripten/mod.rs index 91f797e..faa1291 100644 --- a/src/host/emscripten/mod.rs +++ b/src/host/emscripten/mod.rs @@ -1,6 +1,7 @@ use std::mem; use std::os::raw::c_void; use std::slice::from_raw_parts; +use std::time::Duration; use stdweb; use stdweb::unstable::TryInto; use stdweb::web::set_timeout; @@ -171,6 +172,7 @@ impl DeviceTrait for Device { _sample_format: SampleFormat, _data_callback: D, _error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&Data, &InputCallbackInfo) + Send + 'static, @@ -185,6 +187,7 @@ impl DeviceTrait for Device { sample_format: SampleFormat, data_callback: D, error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static, diff --git a/src/host/jack/device.rs b/src/host/jack/device.rs index c04e7f1..7a911dc 100644 --- a/src/host/jack/device.rs +++ b/src/host/jack/device.rs @@ -6,6 +6,7 @@ use crate::{ SupportedStreamConfigsError, }; use std::hash::{Hash, Hasher}; +use std::time::Duration; use super::stream::Stream; use super::JACK_SAMPLE_FORMAT; @@ -177,6 +178,7 @@ impl DeviceTrait for Device { sample_format: SampleFormat, data_callback: D, error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&Data, &InputCallbackInfo) + Send + 'static, @@ -215,6 +217,7 @@ impl DeviceTrait for Device { sample_format: SampleFormat, data_callback: D, error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static, diff --git a/src/host/null/mod.rs b/src/host/null/mod.rs index 1eff7b6..26497f8 100644 --- a/src/host/null/mod.rs +++ b/src/host/null/mod.rs @@ -1,3 +1,5 @@ +use std::time::Duration; + use crate::traits::{DeviceTrait, HostTrait, StreamTrait}; use crate::{ BuildStreamError, Data, DefaultStreamConfigError, DeviceNameError, DevicesError, @@ -73,6 +75,7 @@ impl DeviceTrait for Device { _sample_format: SampleFormat, _data_callback: D, _error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&Data, &InputCallbackInfo) + Send + 'static, @@ -88,6 +91,7 @@ impl DeviceTrait for Device { _sample_format: SampleFormat, _data_callback: D, _error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static, diff --git a/src/host/oboe/mod.rs b/src/host/oboe/mod.rs index a25aca1..788c054 100644 --- a/src/host/oboe/mod.rs +++ b/src/host/oboe/mod.rs @@ -1,6 +1,7 @@ use std::cell::RefCell; use std::cmp; use std::convert::TryInto; +use std::time::Duration; use std::vec::IntoIter as VecIntoIter; extern crate oboe; @@ -325,6 +326,7 @@ impl DeviceTrait for Device { sample_format: SampleFormat, data_callback: D, error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&Data, &InputCallbackInfo) + Send + 'static, @@ -398,6 +400,7 @@ impl DeviceTrait for Device { sample_format: SampleFormat, data_callback: D, error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static, diff --git a/src/host/wasapi/device.rs b/src/host/wasapi/device.rs index 8095d91..4840ec9 100644 --- a/src/host/wasapi/device.rs +++ b/src/host/wasapi/device.rs @@ -14,6 +14,7 @@ use std::os::windows::ffi::OsStringExt; use std::ptr; use std::slice; use std::sync::{Arc, Mutex, MutexGuard}; +use std::time::Duration; use super::com; use super::{windows_err_to_cpal_err, windows_err_to_cpal_err_message}; @@ -85,6 +86,7 @@ impl DeviceTrait for Device { sample_format: SampleFormat, data_callback: D, error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&Data, &InputCallbackInfo) + Send + 'static, @@ -104,6 +106,7 @@ impl DeviceTrait for Device { sample_format: SampleFormat, data_callback: D, error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static, diff --git a/src/host/webaudio/mod.rs b/src/host/webaudio/mod.rs index 27df31e..1debdfe 100644 --- a/src/host/webaudio/mod.rs +++ b/src/host/webaudio/mod.rs @@ -15,6 +15,7 @@ use crate::{ }; use std::ops::DerefMut; use std::sync::{Arc, Mutex, RwLock}; +use std::time::Duration; /// Content is false if the iterator is empty. pub struct Devices(bool); @@ -172,6 +173,7 @@ impl DeviceTrait for Device { _sample_format: SampleFormat, _data_callback: D, _error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&Data, &InputCallbackInfo) + Send + 'static, @@ -188,6 +190,7 @@ impl DeviceTrait for Device { sample_format: SampleFormat, data_callback: D, _error_callback: E, + _timeout: Option, ) -> Result where D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static, diff --git a/src/lib.rs b/src/lib.rs index 1b41c76..7c6a52c 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -69,6 +69,7 @@ //! move |err| { //! // react to errors here. //! }, +//! None // None=blocking, Some(Duration)=timeout //! ); //! ``` //! @@ -97,9 +98,9 @@ //! let sample_format = supported_config.sample_format(); //! let config = supported_config.into(); //! let stream = match sample_format { -//! SampleFormat::F32 => device.build_output_stream(&config, write_silence::, err_fn), -//! SampleFormat::I16 => device.build_output_stream(&config, write_silence::, err_fn), -//! SampleFormat::U16 => device.build_output_stream(&config, write_silence::, err_fn), +//! SampleFormat::F32 => device.build_output_stream(&config, write_silence::, err_fn, None), +//! SampleFormat::I16 => device.build_output_stream(&config, write_silence::, err_fn, None), +//! SampleFormat::U16 => device.build_output_stream(&config, write_silence::, err_fn, None), //! sample_format => panic!("Unsupported sample format '{sample_format}'") //! }.unwrap(); //! @@ -122,7 +123,7 @@ //! # let config = supported_config.into(); //! # let data_fn = move |_data: &mut cpal::Data, _: &cpal::OutputCallbackInfo| {}; //! # let err_fn = move |_err| {}; -//! # let stream = device.build_output_stream_raw(&config, sample_format, data_fn, err_fn).unwrap(); +//! # let stream = device.build_output_stream_raw(&config, sample_format, data_fn, err_fn, None).unwrap(); //! stream.play().unwrap(); //! ``` //! @@ -138,7 +139,7 @@ //! # let config = supported_config.into(); //! # let data_fn = move |_data: &mut cpal::Data, _: &cpal::OutputCallbackInfo| {}; //! # let err_fn = move |_err| {}; -//! # let stream = device.build_output_stream_raw(&config, sample_format, data_fn, err_fn).unwrap(); +//! # let stream = device.build_output_stream_raw(&config, sample_format, data_fn, err_fn, None).unwrap(); //! stream.pause().unwrap(); //! ``` diff --git a/src/platform/mod.rs b/src/platform/mod.rs index fb4550c..22a0511 100644 --- a/src/platform/mod.rs +++ b/src/platform/mod.rs @@ -360,6 +360,7 @@ macro_rules! impl_platform_host { sample_format: crate::SampleFormat, data_callback: D, error_callback: E, + timeout: Option, ) -> Result where D: FnMut(&crate::Data, &crate::InputCallbackInfo) + Send + 'static, @@ -374,6 +375,7 @@ macro_rules! impl_platform_host { sample_format, data_callback, error_callback, + timeout, ) .map(StreamInner::$HostVariant) .map(Stream::from), @@ -387,6 +389,7 @@ macro_rules! impl_platform_host { sample_format: crate::SampleFormat, data_callback: D, error_callback: E, + timeout: Option, ) -> Result where D: FnMut(&mut crate::Data, &crate::OutputCallbackInfo) + Send + 'static, @@ -401,6 +404,7 @@ macro_rules! impl_platform_host { sample_format, data_callback, error_callback, + timeout, ) .map(StreamInner::$HostVariant) .map(Stream::from), diff --git a/src/traits.rs b/src/traits.rs index 4ea6edf..f079dae 100644 --- a/src/traits.rs +++ b/src/traits.rs @@ -1,5 +1,7 @@ //! The suite of traits allowing CPAL to abstract over hosts, devices, event loops and stream IDs. +use std::time::Duration; + use crate::{ BuildStreamError, Data, DefaultStreamConfigError, DeviceNameError, DevicesError, InputCallbackInfo, InputDevices, OutputCallbackInfo, OutputDevices, PauseStreamError, @@ -120,6 +122,7 @@ pub trait DeviceTrait { config: &StreamConfig, mut data_callback: D, error_callback: E, + timeout: Option, ) -> Result where T: SizedSample, @@ -137,6 +140,7 @@ pub trait DeviceTrait { ) }, error_callback, + timeout, ) } @@ -146,6 +150,7 @@ pub trait DeviceTrait { config: &StreamConfig, mut data_callback: D, error_callback: E, + timeout: Option, ) -> Result where T: SizedSample, @@ -163,6 +168,7 @@ pub trait DeviceTrait { ) }, error_callback, + timeout, ) } @@ -173,6 +179,7 @@ pub trait DeviceTrait { sample_format: SampleFormat, data_callback: D, error_callback: E, + timeout: Option, ) -> Result where D: FnMut(&Data, &InputCallbackInfo) + Send + 'static, @@ -185,6 +192,7 @@ pub trait DeviceTrait { sample_format: SampleFormat, data_callback: D, error_callback: E, + timeout: Option, ) -> Result where D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static,