Trait audio::InterleavedBufMut

source ·

pub trait InterleavedBufMut: InterleavedBuf {
    // Required methods
    fn as_interleaved_mut(&mut self) -> &mut [Self::Sample];
    fn as_interleaved_mut_ptr(&mut self) -> NonNull<Self::Sample>;
    unsafe fn set_interleaved_topology(
        &mut self,
        channels: usize,
        frames: usize
    );
}

Expand description

A trait describing a buffer that is interleaved and mutable.

This allows for accessing the raw underlying interleaved buffer.

Required Methods§

source

fn as_interleaved_mut(&mut self) -> &mut [Self::Sample]

Access the underlying interleaved mutable buffer.

Examples

use audio::{InterleavedBuf, InterleavedBufMut, Buf, Channel};
use audio::wrap;

fn test(mut buffer: impl Buf<Sample = i16> + InterleavedBufMut<Sample = i16>) {
    buffer.as_interleaved_mut().copy_from_slice(&[1, 1, 2, 2, 3, 3, 4, 4]);

    assert_eq! {
        buffer.get_channel(0).unwrap().iter().collect::<Vec<_>>(),
        &[1, 2, 3, 4],
    };

    assert_eq! {
        buffer.get_channel(1).unwrap().iter().collect::<Vec<_>>(),
        &[1, 2, 3, 4],
    };

    assert_eq!(buffer.as_interleaved(), &[1, 1, 2, 2, 3, 3, 4, 4]);
}

test(audio::interleaved![[0; 4]; 2]);
let mut buf = [0; 8];
test(wrap::interleaved(&mut buf, 2));

source

fn as_interleaved_mut_ptr(&mut self) -> NonNull<Self::Sample>

Access a pointer to the underlying interleaved mutable buffer.

The length of the buffer is unspecified, unless preceded by a call to try_reserve. Assuming the call doesn’t panic, the pointed to buffer is guaranteed to be both allocated and initialized up until the number of frames as specified as argument to try_reserve.

Examples

use audio::{Buf, Channel, ResizableBuf, InterleavedBufMut};

fn test(mut buffer: impl InterleavedBufMut<Sample = i16> + ResizableBuf) {
    assert!(buffer.try_reserve(16));
    // Note: call fills the buffer with ones.
    // Safety: We've initialized exactly 16 frames before calling this
    // function.
    unsafe {
        let (channels, frames) = fill_with_ones(buffer.as_interleaved_mut_ptr(), 16);
        buffer.set_interleaved_topology(channels, frames);
    }
}

let mut buf = audio::buf::Interleaved::new();
test(&mut buf);

assert_eq! {
    buf.get_channel(0).unwrap().iter().collect::<Vec<_>>(),
    &[1, 1, 1, 1, 1, 1, 1, 1],
};
assert_eq! {
    buf.get_channel(1).unwrap().iter().collect::<Vec<_>>(),
    &[1, 1, 1, 1, 1, 1, 1, 1],
};

source

unsafe fn set_interleaved_topology(&mut self, channels: usize, frames: usize)

Specify the topology of the underlying interleaved buffer.

Safety

The caller must ensure that the topology of the underlying buffer has been updated to match the specified parameters.

Examples

use audio::{Buf, Channel, ResizableBuf, InterleavedBufMut};

fn test(mut buffer: impl InterleavedBufMut<Sample = i16> + ResizableBuf) {
    assert!(buffer.try_reserve(16));
    // Note: call fills the buffer with ones.
    // Safety: We've initialized exactly 16 frames before calling this
    // function.
    unsafe {
        let (channels, frames) = fill_with_ones(buffer.as_interleaved_mut_ptr(), 16);
        buffer.set_interleaved_topology(channels, frames);
    };
}

let mut buf = audio::buf::Interleaved::new();
test(&mut buf);

assert_eq! {
    buf.get_channel(0).unwrap().iter().collect::<Vec<_>>(),
    &[1, 1, 1, 1, 1, 1, 1, 1],
};
assert_eq! {
    buf.get_channel(1).unwrap().iter().collect::<Vec<_>>(),
    &[1, 1, 1, 1, 1, 1, 1, 1],
};