pub struct AudioBuffer<'a, S = f32>where
S: Sample,{ /* private fields */ }Expand description
Borrowed host channel buffers for one process block.
Channel ordering is [main inputs] [sidechain inputs] /
[main outputs] [aux outputs].
Implementations§
Source§impl<'a, S> AudioBuffer<'a, S>where
S: Sample,
impl<'a, S> AudioBuffer<'a, S>where
S: Sample,
Sourcepub unsafe fn from_slices(
inputs: &'a [&'a [S]],
outputs: &'a mut [&'a mut [S]],
num_samples: usize,
) -> AudioBuffer<'a, S>
pub unsafe fn from_slices( inputs: &'a [&'a [S]], outputs: &'a mut [&'a mut [S]], num_samples: usize, ) -> AudioBuffer<'a, S>
§Safety
Slices must be valid for 'a; num_samples must not exceed any channel length.
Treats all inputs as main inputs and all outputs as main outputs.
Sourcepub fn from_slices_checked(
inputs: &'a [&'a [S]],
outputs: &'a mut [&'a mut [S]],
num_samples: usize,
) -> AudioBuffer<'a, S>
pub fn from_slices_checked( inputs: &'a [&'a [S]], outputs: &'a mut [&'a mut [S]], num_samples: usize, ) -> AudioBuffer<'a, S>
Sourcepub fn from_slices_checked_with_sidechain(
inputs: &'a [&'a [S]],
outputs: &'a mut [&'a mut [S]],
num_samples: usize,
main_input_count: usize,
sidechain_input_count: usize,
) -> AudioBuffer<'a, S>
pub fn from_slices_checked_with_sidechain( inputs: &'a [&'a [S]], outputs: &'a mut [&'a mut [S]], num_samples: usize, main_input_count: usize, sidechain_input_count: usize, ) -> AudioBuffer<'a, S>
Build a buffer with separated main + sidechain inputs (all outs = main).
§Panics
Panics if counts don’t match inputs / channel lengths.
Sourcepub unsafe fn from_slices_with_sidechain_unchecked(
inputs: &'a [&'a [S]],
outputs: &'a mut [&'a mut [S]],
num_samples: usize,
main_input_count: usize,
sidechain_input_count: usize,
) -> AudioBuffer<'a, S>
pub unsafe fn from_slices_with_sidechain_unchecked( inputs: &'a [&'a [S]], outputs: &'a mut [&'a mut [S]], num_samples: usize, main_input_count: usize, sidechain_input_count: usize, ) -> AudioBuffer<'a, S>
§Safety
Same as from_slices; all outputs count as main.
Sourcepub unsafe fn from_slices_with_buses_unchecked(
inputs: &'a [&'a [S]],
outputs: &'a mut [&'a mut [S]],
num_samples: usize,
main_input_count: usize,
sidechain_input_count: usize,
main_output_count: usize,
) -> AudioBuffer<'a, S>
pub unsafe fn from_slices_with_buses_unchecked( inputs: &'a [&'a [S]], outputs: &'a mut [&'a mut [S]], num_samples: usize, main_input_count: usize, sidechain_input_count: usize, main_output_count: usize, ) -> AudioBuffer<'a, S>
§Safety
Caller ensures counts match slice lengths; main_output_count ≤ outputs.len().
pub fn num_samples(&self) -> usize
pub fn num_inputs(&self) -> usize
pub fn num_main_inputs(&self) -> usize
pub fn num_sidechain_inputs(&self) -> usize
pub fn num_outputs(&self) -> usize
pub fn num_main_outputs(&self) -> usize
pub fn num_aux_outputs(&self) -> usize
pub fn input(&self, ch: usize) -> &[S]
pub fn main_input(&self, ch: usize) -> &[S]
pub fn sidechain_input(&self, ch: usize) -> &[S]
pub fn output(&mut self, ch: usize) -> &mut [S]
pub fn main_output(&mut self, ch: usize) -> &mut [S]
pub fn aux_output(&mut self, ch: usize) -> &mut [S]
Auto Trait Implementations§
impl<'a, S = f32> !UnwindSafe for AudioBuffer<'a, S>
impl<'a, S> Forget for AudioBuffer<'a, S>
impl<'a, S> Freeze for AudioBuffer<'a, S>
impl<'a, S> RefUnwindSafe for AudioBuffer<'a, S>
impl<'a, S> Send for AudioBuffer<'a, S>
impl<'a, S> Sync for AudioBuffer<'a, S>
impl<'a, S> Unpin for AudioBuffer<'a, S>
impl<'a, S> UnsafeUnpin for AudioBuffer<'a, S>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more