RFC: Rework the API [WIP] (#165)
* Rework the API to not use futures anymore * Add some comments * Update the MacOS backend * Restore the null implementation * Add an emscripten backend * Remove erroneously added feature * Fix to_f32 formula * [WIP] Alsa backend * Alsa backend compiling * Working ALSA backend * Fix tests * Move WASAPI endpoint to endpoint module * Fix WASAPI warnings * Rework the WASAPI backend * Check overflows for voice ID * Add comments and minor fixes to WASAPI backend * Add a changelog
This commit is contained in:
parent
4b019243c2
commit
6ae01f437c
13 changed files with 1472 additions and 1447 deletions
|
|
@ -2,28 +2,13 @@ extern crate winapi;
|
|||
extern crate ole32;
|
||||
extern crate kernel32;
|
||||
|
||||
use std::ffi::OsString;
|
||||
use std::io::Error as IoError;
|
||||
use std::mem;
|
||||
use std::os::windows::ffi::OsStringExt;
|
||||
use std::ptr;
|
||||
use std::slice;
|
||||
use std::sync::{Arc, Mutex, MutexGuard};
|
||||
|
||||
use ChannelPosition;
|
||||
use Format;
|
||||
use FormatsEnumerationError;
|
||||
use SampleFormat;
|
||||
use SamplesRate;
|
||||
|
||||
pub use self::enumerate::{EndpointsIterator, default_endpoint};
|
||||
pub use self::voice::{Buffer, EventLoop, SamplesStream, Voice};
|
||||
pub use std::option::IntoIter as OptionIntoIter;
|
||||
|
||||
pub type SupportedFormatsIterator = OptionIntoIter<Format>;
|
||||
pub use self::endpoint::{Endpoint, EndpointsIterator, default_endpoint, SupportedFormatsIterator};
|
||||
pub use self::voice::{Buffer, EventLoop, VoiceId};
|
||||
|
||||
mod com;
|
||||
mod enumerate;
|
||||
mod endpoint;
|
||||
mod voice;
|
||||
|
||||
#[inline]
|
||||
|
|
@ -34,272 +19,3 @@ fn check_result(result: winapi::HRESULT) -> Result<(), IoError> {
|
|||
Ok(())
|
||||
}
|
||||
}
|
||||
|
||||
/// Wrapper because of that stupid decision to remove `Send` and `Sync` from raw pointers.
|
||||
#[derive(Copy, Clone)]
|
||||
struct IAudioClientWrapper(*mut winapi::IAudioClient);
|
||||
unsafe impl Send for IAudioClientWrapper {
|
||||
}
|
||||
unsafe impl Sync for IAudioClientWrapper {
|
||||
}
|
||||
|
||||
/// An opaque type that identifies an end point.
|
||||
pub struct Endpoint {
|
||||
device: *mut winapi::IMMDevice,
|
||||
|
||||
/// We cache an uninitialized `IAudioClient` so that we can call functions from it without
|
||||
/// having to create/destroy audio clients all the time.
|
||||
future_audio_client: Arc<Mutex<Option<IAudioClientWrapper>>>, // TODO: add NonZero around the ptr
|
||||
}
|
||||
|
||||
unsafe impl Send for Endpoint {
|
||||
}
|
||||
unsafe impl Sync for Endpoint {
|
||||
}
|
||||
|
||||
impl Endpoint {
|
||||
// TODO: this function returns a GUID of the endpoin
|
||||
// instead it should use the property store and return the friendly name
|
||||
pub fn name(&self) -> String {
|
||||
unsafe {
|
||||
let mut name_ptr = mem::uninitialized();
|
||||
// can only fail if wrong params or out of memory
|
||||
check_result((*self.device).GetId(&mut name_ptr)).unwrap();
|
||||
|
||||
// finding the length of the name
|
||||
let mut len = 0;
|
||||
while *name_ptr.offset(len) != 0 {
|
||||
len += 1;
|
||||
}
|
||||
|
||||
// building a slice containing the name
|
||||
let name_slice = slice::from_raw_parts(name_ptr, len as usize);
|
||||
|
||||
// and turning it into a string
|
||||
let name_string: OsString = OsStringExt::from_wide(name_slice);
|
||||
ole32::CoTaskMemFree(name_ptr as *mut _);
|
||||
name_string.into_string().unwrap()
|
||||
}
|
||||
}
|
||||
|
||||
#[inline]
|
||||
fn from_immdevice(device: *mut winapi::IMMDevice) -> Endpoint {
|
||||
Endpoint {
|
||||
device: device,
|
||||
future_audio_client: Arc::new(Mutex::new(None)),
|
||||
}
|
||||
}
|
||||
|
||||
/// Ensures that `future_audio_client` contains a `Some` and returns a locked mutex to it.
|
||||
fn ensure_future_audio_client(&self)
|
||||
-> Result<MutexGuard<Option<IAudioClientWrapper>>, IoError> {
|
||||
let mut lock = self.future_audio_client.lock().unwrap();
|
||||
if lock.is_some() {
|
||||
return Ok(lock);
|
||||
}
|
||||
|
||||
let audio_client: *mut winapi::IAudioClient = unsafe {
|
||||
let mut audio_client = mem::uninitialized();
|
||||
let hresult = (*self.device).Activate(&winapi::IID_IAudioClient,
|
||||
winapi::CLSCTX_ALL,
|
||||
ptr::null_mut(),
|
||||
&mut audio_client);
|
||||
|
||||
// can fail if the device has been disconnected since we enumerated it, or if
|
||||
// the device doesn't support playback for some reason
|
||||
check_result(hresult)?;
|
||||
assert!(!audio_client.is_null());
|
||||
audio_client as *mut _
|
||||
};
|
||||
|
||||
*lock = Some(IAudioClientWrapper(audio_client));
|
||||
Ok(lock)
|
||||
}
|
||||
|
||||
/// Returns an uninitialized `IAudioClient`.
|
||||
#[inline]
|
||||
fn build_audioclient(&self) -> Result<*mut winapi::IAudioClient, IoError> {
|
||||
let mut lock = self.ensure_future_audio_client()?;
|
||||
let client = lock.unwrap().0;
|
||||
*lock = None;
|
||||
Ok(client)
|
||||
}
|
||||
|
||||
pub fn supported_formats(
|
||||
&self)
|
||||
-> Result<SupportedFormatsIterator, FormatsEnumerationError> {
|
||||
// We always create voices in shared mode, therefore all samples go through an audio
|
||||
// processor to mix them together.
|
||||
// However there is no way to query the list of all formats that are supported by the
|
||||
// audio processor, but one format is guaranteed to be supported, the one returned by
|
||||
// `GetMixFormat`.
|
||||
|
||||
// initializing COM because we call `CoTaskMemFree`
|
||||
com::com_initialized();
|
||||
|
||||
let lock = match self.ensure_future_audio_client() {
|
||||
Err(ref e) if e.raw_os_error() == Some(winapi::AUDCLNT_E_DEVICE_INVALIDATED) =>
|
||||
return Err(FormatsEnumerationError::DeviceNotAvailable),
|
||||
e => e.unwrap(),
|
||||
};
|
||||
let client = lock.unwrap().0;
|
||||
|
||||
unsafe {
|
||||
let mut format_ptr = mem::uninitialized();
|
||||
match check_result((*client).GetMixFormat(&mut format_ptr)) {
|
||||
Err(ref e) if e.raw_os_error() == Some(winapi::AUDCLNT_E_DEVICE_INVALIDATED) => {
|
||||
return Err(FormatsEnumerationError::DeviceNotAvailable);
|
||||
},
|
||||
Err(e) => panic!("{:?}", e),
|
||||
Ok(()) => (),
|
||||
};
|
||||
|
||||
let format = {
|
||||
let (channels, data_type) = match (*format_ptr).wFormatTag {
|
||||
winapi::WAVE_FORMAT_PCM => {
|
||||
(vec![ChannelPosition::FrontLeft, ChannelPosition::FrontRight],
|
||||
SampleFormat::I16)
|
||||
},
|
||||
winapi::WAVE_FORMAT_EXTENSIBLE => {
|
||||
let format_ptr = format_ptr as *const winapi::WAVEFORMATEXTENSIBLE;
|
||||
|
||||
let channels = {
|
||||
let mut channels = Vec::new();
|
||||
|
||||
let mask = (*format_ptr).dwChannelMask;
|
||||
if (mask & winapi::SPEAKER_FRONT_LEFT) != 0 {
|
||||
channels.push(ChannelPosition::FrontLeft);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_FRONT_RIGHT) != 0 {
|
||||
channels.push(ChannelPosition::FrontRight);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_FRONT_CENTER) != 0 {
|
||||
channels.push(ChannelPosition::FrontCenter);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_LOW_FREQUENCY) != 0 {
|
||||
channels.push(ChannelPosition::LowFrequency);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_BACK_LEFT) != 0 {
|
||||
channels.push(ChannelPosition::BackLeft);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_BACK_RIGHT) != 0 {
|
||||
channels.push(ChannelPosition::BackRight);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_FRONT_LEFT_OF_CENTER) != 0 {
|
||||
channels.push(ChannelPosition::FrontLeftOfCenter);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_FRONT_RIGHT_OF_CENTER) != 0 {
|
||||
channels.push(ChannelPosition::FrontRightOfCenter);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_BACK_CENTER) != 0 {
|
||||
channels.push(ChannelPosition::BackCenter);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_SIDE_LEFT) != 0 {
|
||||
channels.push(ChannelPosition::SideLeft);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_SIDE_RIGHT) != 0 {
|
||||
channels.push(ChannelPosition::SideRight);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_TOP_CENTER) != 0 {
|
||||
channels.push(ChannelPosition::TopCenter);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_TOP_FRONT_LEFT) != 0 {
|
||||
channels.push(ChannelPosition::TopFrontLeft);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_TOP_FRONT_CENTER) != 0 {
|
||||
channels.push(ChannelPosition::TopFrontCenter);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_TOP_FRONT_RIGHT) != 0 {
|
||||
channels.push(ChannelPosition::TopFrontRight);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_TOP_BACK_LEFT) != 0 {
|
||||
channels.push(ChannelPosition::TopBackLeft);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_TOP_BACK_CENTER) != 0 {
|
||||
channels.push(ChannelPosition::TopBackCenter);
|
||||
}
|
||||
if (mask & winapi::SPEAKER_TOP_BACK_RIGHT) != 0 {
|
||||
channels.push(ChannelPosition::TopBackRight);
|
||||
}
|
||||
|
||||
assert_eq!((*format_ptr).Format.nChannels as usize, channels.len());
|
||||
channels
|
||||
};
|
||||
|
||||
let format = {
|
||||
fn cmp_guid(a: &winapi::GUID, b: &winapi::GUID) -> bool {
|
||||
a.Data1 == b.Data1 && a.Data2 == b.Data2 && a.Data3 == b.Data3 &&
|
||||
a.Data4 == b.Data4
|
||||
}
|
||||
if cmp_guid(&(*format_ptr).SubFormat,
|
||||
&winapi::KSDATAFORMAT_SUBTYPE_IEEE_FLOAT)
|
||||
{
|
||||
SampleFormat::F32
|
||||
} else if cmp_guid(&(*format_ptr).SubFormat,
|
||||
&winapi::KSDATAFORMAT_SUBTYPE_PCM)
|
||||
{
|
||||
SampleFormat::I16
|
||||
} else {
|
||||
panic!("Unknown SubFormat GUID returned by GetMixFormat: {:?}",
|
||||
(*format_ptr).SubFormat)
|
||||
}
|
||||
};
|
||||
|
||||
(channels, format)
|
||||
},
|
||||
|
||||
f => panic!("Unknown data format returned by GetMixFormat: {:?}", f),
|
||||
};
|
||||
|
||||
Format {
|
||||
channels: channels,
|
||||
samples_rate: SamplesRate((*format_ptr).nSamplesPerSec),
|
||||
data_type: data_type,
|
||||
}
|
||||
};
|
||||
|
||||
ole32::CoTaskMemFree(format_ptr as *mut _);
|
||||
|
||||
Ok(Some(format).into_iter())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl PartialEq for Endpoint {
|
||||
#[inline]
|
||||
fn eq(&self, other: &Endpoint) -> bool {
|
||||
self.device == other.device
|
||||
}
|
||||
}
|
||||
|
||||
impl Eq for Endpoint {
|
||||
}
|
||||
|
||||
impl Clone for Endpoint {
|
||||
#[inline]
|
||||
fn clone(&self) -> Endpoint {
|
||||
unsafe {
|
||||
(*self.device).AddRef();
|
||||
}
|
||||
|
||||
Endpoint {
|
||||
device: self.device,
|
||||
future_audio_client: self.future_audio_client.clone(),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl Drop for Endpoint {
|
||||
#[inline]
|
||||
fn drop(&mut self) {
|
||||
unsafe {
|
||||
(*self.device).Release();
|
||||
}
|
||||
|
||||
if let Some(client) = self.future_audio_client.lock().unwrap().take() {
|
||||
unsafe {
|
||||
(*client.0).Release();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue