Trait audio::InterleavedBuf

pub trait InterleavedBuf {
    pub fn reserve_frames(&mut self, frames: usize);
    pub fn set_topology(&mut self, channels: usize, frames: usize);
}

Trait implemented for buffers which are linearly stored in memory.

This allows us to reason about a specific number of frames, so that the buffer can safely make sure that a given required number of frames are available in the buffer, and it allows us to access the underlying buffer.

This is usually used in combination with other traits, such as AsInterleaved to allow for generically accessing a fixed linear buffer with a specific topology.

Required methods

pub fn reserve_frames(&mut self, frames: usize)

Make sure that the buffer has reserved exactly the given number of frames.

Panics

Panics if the underlying buffer cannot be grown to accomodate the given number of frames.

Examples

use audio::{Buf, ExactSizeBuf, InterleavedBuf};

fn test<B>(mut buffer: B) where B: InterleavedBuf {
    buffer.reserve_frames(4);
    buffer.set_topology(2, 2);
}

// Note: a zero-sized buffer.
let mut buffer = audio::interleaved![[0; 0]; 0];
test(&mut buffer);

assert_eq!(buffer.channels(), 2);
assert_eq!(buffer.frames(), 2);
assert_eq!(buffer.as_slice(), &[0, 0, 0, 0]);

let mut buffer = [1, 2, 3, 4, 5, 6, 7, 8];
let mut buffer = audio::wrap::interleaved(&mut buffer[..], 1);
test(&mut buffer);

assert_eq!(buffer.channels(), 2);
assert_eq!(buffer.frames(), 2);
assert_eq!(buffer.into_inner(), &[1, 2, 3, 4]);

pub fn set_topology(&mut self, channels: usize, frames: usize)

Set the buffer to have the given topology.

This function will never reallocate the underlying buffer.

Panics

Calling set_topology will fail if the underlying buffer doesn’t support the specified topology. Like if it’s too small.

If you want to use a growable buffer use ResizableBuf::resize_topology instead.

use audio::{Channels, ExactSizeBuf, InterleavedBuf};

fn test<B>(mut buffer: B) where B: InterleavedBuf {
    buffer.set_topology(2, 4); // panics because buffer is zero-sized.
}

test(audio::interleaved![[0; 0]; 4]);

Examples

use audio::{Channels, ExactSizeBuf, InterleavedBuf};

fn test<B>(mut buffer: B) where B: InterleavedBuf {
    buffer.set_topology(2, 4);
}

// Note: a zero-sized buffer.
let mut buffer = audio::interleaved![[4; 2]; 4];
assert_eq!(buffer.channels(), 4);
assert_eq!(buffer.frames(), 2);

test(&mut buffer);

assert_eq!(buffer.channels(), 2);
assert_eq!(buffer.frames(), 4);

Loading content...

Implementations on Foreign Types

impl<'_, B> InterleavedBuf for &'_ mut B where
    B: InterleavedBuf + ?Sized, 

pub fn reserve_frames(&mut self, frames: usize)

pub fn set_topology(&mut self, channels: usize, frames: usize)

Loading content...

Implementors

impl<T> InterleavedBuf for audio::interleaved::Interleaved<T> where
    T: Sample, 

fn reserve_frames(&mut self, frames: usize)

fn set_topology(&mut self, channels: usize, frames: usize)

impl<T> InterleavedBuf for audio::wrap::Interleaved<&mut [T]>

fn reserve_frames(&mut self, frames: usize)

fn set_topology(&mut self, channels: usize, frames: usize)

Loading content...