Struct BufferData

pub struct BufferData { /* private fields */ }

A buffer of audio samples that owns its data.

This is a simple implementation of Buffer that owns its data on the heap. It is useful for testing and as a simple way to create buffers.

Examples

let buffer = BufferData::new_mono(vec![1.0, 2.0, 3.0]);
assert_eq!(buffer.channel(0), [1.0, 2.0, 3.0]);

Implementations

impl BufferData

pub fn new(channel_layout: ChannelLayout, num_frames: usize) -> Self

Create a new buffer with the given channel layout and number of frames.

The buffer will be filled with zeros.

Examples

let buffer = BufferData::new(ChannelLayout::Mono, 3);
assert_eq!(buffer.channel_layout(), ChannelLayout::Mono);
assert_eq!(buffer.channel(0), [0.0, 0.0, 0.0]);

pub fn new_mono(data: Vec<f32>) -> BufferData

Create a new mono buffer with the given data.

Examples

let buffer = BufferData::new_mono(vec![1.0, 2.0, 3.0]);
assert_eq!(buffer.channel_layout(), ChannelLayout::Mono);
assert_eq!(buffer.channel(0), [1.0, 2.0, 3.0]);

pub fn new_stereo<L: IntoIterator<Item = f32>, R: IntoIterator<Item = f32>>( left: L, right: R, ) -> BufferData

Create a new stereo buffer with the given data.

Examples

let buffer = BufferData::new_stereo([1.0, 2.0], [3.0, 4.0]);
assert_eq!(buffer.channel_layout(), ChannelLayout::Stereo);
assert!(channels(&buffer).eq([[1.0, 2.0], [3.0, 4.0]]));

Panics

Panics if the length of left and right are not equal.

let buffer = BufferData::new_stereo([1.0, 2.0], [3.0]);

Trait Implementations

impl Buffer for BufferData

fn channel_layout(&self) -> ChannelLayout

The layout of the channels in the buffer.

fn num_frames(&self) -> usize

The number of frames in the buffer.

fn channel(&self, channel: usize) -> &[f32]

Get a channel from the buffer.

fn num_channels(&self) -> usize

The number of channels in the buffer.

impl BufferMut for BufferData

fn channel_mut(&mut self, channel: usize) -> &mut [f32]

Get a channel from the buffer as a mutable slice

impl Clone for BufferData

fn clone(&self) -> BufferData

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BufferData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.