Struct audio_processor_traits::audio_buffer::vst::VSTAudioBuffer

pub struct VSTAudioBuffer<'a, SampleType> { /* fields omitted */ }

Wraps a VST buffer with a generic AudioBuffer.

NOTE:

Due to Rust VST using different references for input & output buffers the API here is slightly dubious.

audio_buffer.get(channel, sample) will return a sample from the INPUT buffer. Meanwhile audio_buffer.get_mut(channel, sample) will return a sample from the OUTPUT buffer.

This means it might be that audio_buffer.get(channel, sample) is different to audio_buffer.get_mut(channel, sample).

Implementations

impl<'a, SampleType: Float> VSTAudioBuffer<'a, SampleType>

pub fn new(
    inputs: Inputs<'a, SampleType>,
    outputs: Outputs<'a, SampleType>
) -> Self

👎 Deprecated

pub fn with_buffer(buffer: &'a mut AudioBuffer<'a, SampleType>) -> Self

👎 Deprecated

Trait Implementations

impl<'a, SampleType> AudioBuffer for VSTAudioBuffer<'a, SampleType>

type SampleType = SampleType

The type of samples within this buffer.

fn num_channels(&self) -> usize

The number of channels in this buffer

fn num_samples(&self) -> usize

The number of samples in this buffer

fn slice(&self) -> &[Self::SampleType]

Get a slice to the internal data. Will not work with VST adapter

fn slice_mut(&mut self) -> &mut [Self::SampleType]

Get a mutable slice to the internal data. Will not work with VST adapter

fn get(&self, channel: usize, sample: usize) -> &Self::SampleType

Get a ref to an INPUT sample in this buffer.

fn get_mut(&mut self, channel: usize, sample: usize) -> &mut Self::SampleType

Get a mutable ref to an OUTPUT sample in this buffer

fn set(&mut self, channel: usize, sample: usize, value: Self::SampleType)

Set an OUTPUT sample in this buffer

fn frames(&self) -> Chunks<'_, Self::SampleType>

Shortcut for .slice().chunks(num_channels)

fn frames_mut(&mut self) -> ChunksMut<'_, Self::SampleType>

Shortcut for .slice_mut().chunks_mut(num_channels)

unsafe fn get_unchecked(
    &self,
    channel: usize,
    sample: usize
) -> &Self::SampleType

Unsafe, no bounds check - Get a ref to an INPUT sample in this buffer

unsafe fn get_unchecked_mut(
    &mut self,
    channel: usize,
    sample: usize
) -> &mut Self::SampleType

Unsafe, no bounds check - Get a mutable ref to an OUTPUT sample in this buffer

unsafe fn set_unchecked(
    &mut self,
    channel: usize,
    sample: usize,
    value: Self::SampleType
)

Unsafe, no bounds check - Set an OUTPUT sample in this buffer