Struct audio::buf::interleaved::Interleaved
source · pub struct Interleaved<T> { /* private fields */ }
Expand description
A dynamically sized, multi-channel interleaved audio buffer.
An audio buffer can only be resized if it contains a type which is sample-apt. For more information of what this means, see Sample.
An interleaved audio buffer stores all audio data interleaved in memory, one sample from each channel in sequence until we’re out of samples. This naturally makes the buffer a bit harder to work with, and we have to rely on iterators to access logical channels.
Resized regions aren’t zeroed, so certain operations might cause stale data to be visible after a resize.
let mut buf = audio::buf::Interleaved::<f32>::with_topology(2, 4);
for (c, s) in buf
.get_mut(0)
.unwrap()
.iter_mut()
.zip(&[1.0, 2.0, 3.0, 4.0])
{
*c = *s;
}
for (c, s) in buf
.get_mut(1)
.unwrap()
.iter_mut()
.zip(&[5.0, 6.0, 7.0, 8.0])
{
*c = *s;
}
assert_eq!(buf.as_slice(), &[1.0, 5.0, 2.0, 6.0, 3.0, 7.0, 4.0, 8.0]);
Implementations§
source§impl<T> Interleaved<T>
impl<T> Interleaved<T>
sourcepub fn new() -> Self
pub fn new() -> Self
Construct a new empty audio buffer.
Examples
let buf = audio::buf::Interleaved::<f32>::new();
assert_eq!(buf.frames(), 0);
sourcepub fn with_topology(channels: usize, frames: usize) -> Selfwhere
T: Sample,
pub fn with_topology(channels: usize, frames: usize) -> Selfwhere
T: Sample,
Allocate an audio buffer with the given topology. A “topology” is a
given number of channels
and the corresponding number of frames
in
their buffers.
Examples
let buf = audio::buf::Interleaved::<f32>::with_topology(4, 256);
assert_eq!(buf.frames(), 256);
assert_eq!(buf.channels(), 4);
sourcepub fn from_frames<const N: usize>(frames: [T; N], channels: usize) -> Selfwhere
T: Copy,
pub fn from_frames<const N: usize>(frames: [T; N], channels: usize) -> Selfwhere
T: Copy,
Allocate an interleaved audio buffer from a fixed-size array acting as a template for all the channels.
See sequential!.
Examples
let buf = audio::buf::Interleaved::from_frames([1.0, 2.0, 3.0, 4.0], 4);
assert_eq!(buf.frames(), 4);
assert_eq!(buf.channels(), 4);
sourcepub fn from_array<const F: usize, const C: usize>(channels: [[T; F]; C]) -> Selfwhere
T: Copy,
pub fn from_array<const F: usize, const C: usize>(channels: [[T; F]; C]) -> Selfwhere
T: Copy,
Allocate an interleaved audio buffer from a fixed-size array.
See interleaved!.
Examples
let buf = audio::buf::Interleaved::from_array([[1; 4]; 2]);
assert_eq!(buf.frames(), 4);
assert_eq!(buf.channels(), 2);
assert_eq! {
buf.as_slice(),
&[1, 1, 1, 1, 1, 1, 1, 1],
}
Using a specific array topology.
let buf = audio::buf::Interleaved::from_array([[1, 2, 3, 4], [5, 6, 7, 8]]);
assert_eq!(buf.frames(), 4);
assert_eq!(buf.channels(), 2);
assert_eq! {
buf.as_slice(),
&[1, 5, 2, 6, 3, 7, 4, 8],
}
sourcepub fn into_vec(self) -> Vec<T>
pub fn into_vec(self) -> Vec<T>
Take ownership of the backing vector.
Examples
let mut buf = audio::buf::Interleaved::<f32>::with_topology(2, 4);
for (c, s) in buf.get_mut(0).unwrap().iter_mut().zip(&[1.0, 2.0, 3.0, 4.0]) {
*c = *s;
}
for (c, s) in buf.get_mut(1).unwrap().iter_mut().zip(&[1.0, 2.0, 3.0, 4.0]) {
*c = *s;
}
buf.resize_frames(3);
assert_eq!(buf.into_vec(), vec![1.0, 1.0, 2.0, 2.0, 3.0, 3.0])
sourcepub fn as_slice(&self) -> &[T]
pub fn as_slice(&self) -> &[T]
Access the underlying vector as a slice.
Examples
let buf = audio::buf::Interleaved::<i16>::with_topology(2, 4);
assert_eq!(buf.as_slice(), &[0, 0, 0, 0, 0, 0, 0, 0]);
sourcepub fn as_slice_mut(&mut self) -> &mut [T]
pub fn as_slice_mut(&mut self) -> &mut [T]
Access the underlying vector as a mutable slice.
Examples
use audio::{Buf, Channel};
let mut buf = audio::buf::Interleaved::<u32>::with_topology(2, 4);
buf.as_slice_mut().copy_from_slice(&[1, 1, 2, 2, 3, 3, 4, 4]);
assert_eq! {
buf.get_channel(0).unwrap(),
[1u32, 2, 3, 4],
};
assert_eq! {
buf.get_channel(1).unwrap(),
[1u32, 2, 3, 4],
};
assert_eq!(buf.as_slice(), &[1, 1, 2, 2, 3, 3, 4, 4]);
sourcepub fn capacity(&self) -> usize
pub fn capacity(&self) -> usize
Get the capacity of the interleaved buffer in number of frames.
The underlying buffer over-allocates a bit, so this will report the exact capacity available in the interleaved buffer.
Examples
let mut buf = audio::buf::Interleaved::<f32>::new();
assert_eq!(buf.capacity(), 0);
buf.resize_frames(11);
assert_eq!(buf.capacity(), 0);
buf.resize_channels(2);
assert_eq!(buf.capacity(), 22);
buf.resize_frames(12);
assert_eq!(buf.capacity(), 44);
buf.resize_frames(24);
assert_eq!(buf.capacity(), 44);
sourcepub fn frames(&self) -> usize
pub fn frames(&self) -> usize
Get the number of frames in the buffer.
Examples
let mut buf = audio::buf::Interleaved::<f32>::new();
assert_eq!(buf.frames(), 0);
buf.resize_frames(4);
assert_eq!(buf.frames(), 4);
sourcepub fn channels(&self) -> usize
pub fn channels(&self) -> usize
Get the number of channels in the buffer.
Examples
let mut buf = audio::buf::Interleaved::<f32>::new();
assert_eq!(buf.channels(), 0);
buf.resize_channels(2);
assert_eq!(buf.channels(), 2);
sourcepub fn resize_channels(&mut self, channels: usize)where
T: Sample,
pub fn resize_channels(&mut self, channels: usize)where
T: Sample,
Resize to the given number of channels in use.
If the size of the buffer increases as a result, the new channels will be zeroed. If the size decreases, the channels that falls outside of the new size will be dropped.
Examples
let mut buf = audio::buf::Interleaved::<f32>::new();
assert_eq!(buf.channels(), 0);
assert_eq!(buf.frames(), 0);
buf.resize_channels(4);
buf.resize_frames(256);
assert_eq!(buf.channels(), 4);
assert_eq!(buf.frames(), 256);
sourcepub fn resize_frames(&mut self, frames: usize)where
T: Sample,
pub fn resize_frames(&mut self, frames: usize)where
T: Sample,
Set the size of the buffer. The size is the size of each channel’s buffer.
If the size of the buffer increases as a result, the new regions in the frames will be zeroed. If the size decreases, the region will be left untouched. So if followed by another increase, the data will be “dirty”.
Examples
let mut buf = audio::buf::Interleaved::<f32>::new();
assert_eq!(buf.channels(), 0);
assert_eq!(buf.frames(), 0);
buf.resize_channels(4);
buf.resize_frames(256);
assert_eq!(buf.channels(), 4);
assert_eq!(buf.frames(), 256);
{
let mut chan = buf.get_mut(1).unwrap();
assert_eq!(chan.get(127), Some(0.0));
*chan.get_mut(127).unwrap() = 42.0;
assert_eq!(chan.get(127), Some(42.0));
}
buf.resize_frames(128);
assert_eq!(buf.sample(1, 127), Some(42.0));
buf.resize_frames(256);
assert_eq!(buf.sample(1, 127), Some(42.0));
buf.resize_channels(2);
assert_eq!(buf.sample(1, 127), Some(42.0));
buf.resize_frames(64);
assert_eq!(buf.sample(1, 127), None);
sourcepub fn get_channel(&self, channel: usize) -> Option<InterleavedChannel<'_, T>>
pub fn get_channel(&self, channel: usize) -> Option<InterleavedChannel<'_, T>>
Get a reference to a channel.
Examples
let mut buf = audio::buf::Interleaved::<f32>::with_topology(2, 4);
for (c, s) in buf.get_mut(0).unwrap().iter_mut().zip(&[1.0, 2.0, 3.0, 4.0]) {
*c = *s;
}
for (c, s) in buf.get_mut(1).unwrap().iter_mut().zip(&[5.0, 6.0, 7.0, 8.0]) {
*c = *s;
}
assert_eq!(buf.get_channel(0).unwrap().iter().nth(2), Some(3.0));
assert_eq!(buf.get_channel(1).unwrap().iter().nth(2), Some(7.0));
sourcepub fn sample(&self, channel: usize, frame: usize) -> Option<T>where
T: Copy,
pub fn sample(&self, channel: usize, frame: usize) -> Option<T>where
T: Copy,
Helper to access a single frame in a single channel.
Examples
let mut buf = audio::buf::Interleaved::<f32>::with_topology(2, 256);
assert_eq!(buf.sample(1, 128), Some(0.0));
*buf.sample_mut(1, 128).unwrap() = 1.0;
assert_eq!(buf.sample(1, 128), Some(1.0));
sourcepub fn get_mut(
&mut self,
channel: usize
) -> Option<InterleavedChannelMut<'_, T>>
pub fn get_mut( &mut self, channel: usize ) -> Option<InterleavedChannelMut<'_, T>>
Get a mutable reference to a channel.
Examples
let mut buf = audio::buf::Interleaved::<f32>::with_topology(2, 4);
for (c, s) in buf.get_mut(0).unwrap().iter_mut().zip(&[1.0, 2.0, 3.0, 4.0]) {
*c = *s;
}
for (c, s) in buf.get_mut(1).unwrap().iter_mut().zip(&[5.0, 6.0, 7.0, 8.0]) {
*c = *s;
}
assert_eq!(buf.as_slice(), &[1.0, 5.0, 2.0, 6.0, 3.0, 7.0, 4.0, 8.0]);
sourcepub fn sample_mut(&mut self, channel: usize, frame: usize) -> Option<&mut T>
pub fn sample_mut(&mut self, channel: usize, frame: usize) -> Option<&mut T>
Helper to access a single sample in a single channel mutably.
Examples
let mut buf = audio::buf::Interleaved::<f32>::with_topology(2, 256);
assert_eq!(buf.sample(1, 128), Some(0.0));
*buf.sample_mut(1, 128).unwrap() = 1.0;
assert_eq!(buf.sample(1, 128), Some(1.0));
source§impl<T> Interleaved<T>where
T: Copy,
impl<T> Interleaved<T>where
T: Copy,
sourcepub fn iter_channels(&self) -> IterChannels<'_, T> ⓘ
pub fn iter_channels(&self) -> IterChannels<'_, T> ⓘ
Construct an iterator over all available channels.
Examples
let mut buf = audio::buf::Interleaved::<f32>::with_topology(2, 4);
let mut it = buf.iter_channels_mut();
for (c, f) in it.next().unwrap().iter_mut().zip(&[1.0, 2.0, 3.0, 4.0]) {
*c = *f;
}
for (c, f) in it.next().unwrap().iter_mut().zip(&[5.0, 6.0, 7.0, 8.0]) {
*c = *f;
}
let channels = buf.iter_channels().collect::<Vec<_>>();
let left = channels[0].iter().collect::<Vec<_>>();
let right = channels[1].iter().collect::<Vec<_>>();
assert_eq!(left, &[1.0, 2.0, 3.0, 4.0]);
assert_eq!(right, &[5.0, 6.0, 7.0, 8.0]);
sourcepub fn iter_channels_mut(&mut self) -> IterChannelsMut<'_, T> ⓘ
pub fn iter_channels_mut(&mut self) -> IterChannelsMut<'_, T> ⓘ
Construct a mutable iterator over all available channels.
Examples
let mut buf = audio::buf::Interleaved::<f32>::with_topology(2, 4);
let mut it = buf.iter_channels_mut();
for (c, f) in it.next().unwrap().iter_mut().zip(&[1.0, 2.0, 3.0, 4.0]) {
*c = *f;
}
for (c, f) in it.next().unwrap().iter_mut().zip(&[5.0, 6.0, 7.0, 8.0]) {
*c = *f;
}
let channels = buf.iter_channels().collect::<Vec<_>>();
let left = channels[0].iter().collect::<Vec<_>>();
let right = channels[1].iter().collect::<Vec<_>>();
assert_eq!(left, &[1.0, 2.0, 3.0, 4.0]);
assert_eq!(right, &[5.0, 6.0, 7.0, 8.0]);
Trait Implementations§
source§impl<T> Buf for Interleaved<T>where
T: Copy,
impl<T> Buf for Interleaved<T>where
T: Copy,
§type Channel<'this> = InterleavedChannel<'this, <Interleaved<T> as Buf>::Sample>
where
Self::Sample: 'this
type Channel<'this> = InterleavedChannel<'this, <Interleaved<T> as Buf>::Sample> where Self::Sample: 'this
§type IterChannels<'this> = IterChannels<'this, <Interleaved<T> as Buf>::Sample>
where
Self::Sample: 'this
type IterChannels<'this> = IterChannels<'this, <Interleaved<T> as Buf>::Sample> where Self::Sample: 'this
source§fn frames_hint(&self) -> Option<usize>
fn frames_hint(&self) -> Option<usize>
source§fn get_channel(&self, channel: usize) -> Option<Self::Channel<'_>>
fn get_channel(&self, channel: usize) -> Option<Self::Channel<'_>>
source§fn iter_channels(&self) -> Self::IterChannels<'_>
fn iter_channels(&self) -> Self::IterChannels<'_>
source§fn skip(self, n: usize) -> Skip<Self>where
Self: Sized,
fn skip(self, n: usize) -> Skip<Self>where
Self: Sized,
n
frames. Read moresource§impl<T> BufMut for Interleaved<T>where
T: Copy,
impl<T> BufMut for Interleaved<T>where
T: Copy,
§type ChannelMut<'this> = InterleavedChannelMut<'this, <Interleaved<T> as Buf>::Sample>
where
Self::Sample: 'this
type ChannelMut<'this> = InterleavedChannelMut<'this, <Interleaved<T> as Buf>::Sample> where Self::Sample: 'this
§type IterChannelsMut<'this> = IterChannelsMut<'this, <Interleaved<T> as Buf>::Sample>
where
Self::Sample: 'this
type IterChannelsMut<'this> = IterChannelsMut<'this, <Interleaved<T> as Buf>::Sample> where Self::Sample: 'this
source§fn get_channel_mut(&mut self, channel: usize) -> Option<Self::ChannelMut<'_>>
fn get_channel_mut(&mut self, channel: usize) -> Option<Self::ChannelMut<'_>>
source§fn iter_channels_mut(&mut self) -> Self::IterChannelsMut<'_>
fn iter_channels_mut(&mut self) -> Self::IterChannelsMut<'_>
source§impl<T> Debug for Interleaved<T>
impl<T> Debug for Interleaved<T>
source§impl<T: Default> Default for Interleaved<T>
impl<T: Default> Default for Interleaved<T>
source§fn default() -> Interleaved<T>
fn default() -> Interleaved<T>
source§impl<T> ExactSizeBuf for Interleaved<T>where
T: Copy,
impl<T> ExactSizeBuf for Interleaved<T>where
T: Copy,
source§impl<T> Hash for Interleaved<T>
impl<T> Hash for Interleaved<T>
source§impl<T> InterleavedBuf for Interleaved<T>where
T: Copy,
impl<T> InterleavedBuf for Interleaved<T>where
T: Copy,
source§impl<T> InterleavedBufMut for Interleaved<T>where
T: Copy,
impl<T> InterleavedBufMut for Interleaved<T>where
T: Copy,
source§impl<'a, T> IntoIterator for &'a Interleaved<T>where
T: Copy,
impl<'a, T> IntoIterator for &'a Interleaved<T>where
T: Copy,
§type IntoIter = IterChannels<'a, T>
type IntoIter = IterChannels<'a, T>
§type Item = <<&'a Interleaved<T> as IntoIterator>::IntoIter as Iterator>::Item
type Item = <<&'a Interleaved<T> as IntoIterator>::IntoIter as Iterator>::Item
source§impl<T> Ord for Interleaved<T>
impl<T> Ord for Interleaved<T>
source§impl<T> PartialEq for Interleaved<T>
impl<T> PartialEq for Interleaved<T>
source§impl<T> PartialOrd for Interleaved<T>where
T: Copy + PartialOrd,
impl<T> PartialOrd for Interleaved<T>where
T: Copy + PartialOrd,
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more