Struct AudioBlockInterleaved 

pub struct AudioBlockInterleaved<S: Sample> { /* private fields */ }

An interleaved audio block that owns its data.

• Layout: [ch0, ch1, ch0, ch1, ch0, ch1]
• Interpretation: Each group of channel samples represents a frame. So, this layout stores frames one after another.
• Terminology: Described as “packed” or “frames first” because each time step is grouped and processed as a unit (a frame).
• Usage: Often used in APIs or hardware-level interfaces, where synchronized playback across channels is crucial.

Example

use audio_blocks::*;

let block = AudioBlockInterleaved::new(2, 3);
let mut block = AudioBlockInterleaved::from_block(&block);

block.frame_mut(0).fill(0.0);
block.frame_mut(1).fill(1.0);
block.frame_mut(2).fill(2.0);

assert_eq!(block.raw_data(), &[0.0, 0.0, 1.0, 1.0, 2.0, 2.0]);

Implementations

impl<S: Sample + Default> AudioBlockInterleaved<S>

pub fn new(num_channels: u16, num_frames: usize) -> Self

Creates a new interleaved audio block with the specified dimensions.

Allocates memory for a new interleaved audio block with exactly the specified number of channels and frames. The block is initialized with the default value for the sample type.

Do not use in real-time processes!

Arguments

• num_channels - The number of audio channels
• num_frames - The number of frames per channel

Panics

Panics if the multiplication of num_channels and num_frames would overflow a usize.

impl<S: Sample> AudioBlockInterleaved<S>

pub fn from_slice(data: &[S], num_channels: u16) -> Self

Creates a new interleaved audio block by copying the data from a slice of interleaved audio data.

Parameters

• data - The slice containing interleaved audio samples
• num_channels - Number of audio channels in the data

Panics

Panics if the length of data is not evenly divisible by num_channels.

pub fn from_slice_limited( data: &[S], num_channels_visible: u16, num_frames_visible: usize, num_channels_allocated: u16, num_frames_allocated: usize, ) -> Self

Creates a new interleaved audio block by copying the data from a slice of interleaved audio data with limited visibility.

This function allows creating a block that exposes only a subset of the allocated channels and frames, which is useful for working with a logical section of a larger buffer.

Parameters

• data - The slice containing interleaved audio samples
• num_channels_visible - Number of audio channels to expose
• num_frames_visible - Number of audio frames to expose
• num_channels_allocated - Total number of channels allocated in the data buffer
• num_frames_allocated - Total number of frames allocated in the data buffer

Panics

• Panics if the length of data doesn’t equal num_channels_allocated * num_frames_allocated
• Panics if num_channels_visible exceeds num_channels_allocated
• Panics if num_frames_visible exceeds num_frames_allocated

pub fn from_block(block: &impl AudioBlock<S>) -> Self

Creates a new audio block by copying data from another AudioBlock.

Converts any AudioBlock implementation to an interleaved format by iterating through each frame of the source block and copying its samples. The new block will have the same dimensions as the source block.

Warning

This function allocates memory and should not be used in real-time audio processing contexts.

Arguments

• block - The source audio block to copy data from

pub fn frame(&self, frame: usize) -> &[S]

Returns a slice for a single frame.

Panics

Panics if frame index is out of bounds.

pub fn frame_mut(&mut self, frame: usize) -> &mut [S]

Returns a mutable slice for a single frame.

Panics

Panics if frame index is out of bounds.

pub fn frames(&self) -> impl Iterator<Item = &[S]>

Returns an iterator over all frames in the block.

Each frame is represented as a slice of samples.

pub fn frames_mut(&mut self) -> impl Iterator<Item = &mut [S]>

Returns a mutable iterator over all frames in the block.

Each frame is represented as a mutable slice of samples.

pub fn raw_data(&self) -> &[S]

Provides direct access to the underlying memory as an interleaved slice.

This function gives access to all allocated data, including any reserved capacity beyond the visible range.

pub fn raw_data_mut(&mut self) -> &mut [S]

Provides direct mutable access to the underlying memory as an interleaved slice.

This function gives mutable access to all allocated data, including any reserved capacity beyond the visible range.

pub fn view(&self) -> AudioBlockInterleavedView<'_, S>

pub fn view_mut(&mut self) -> AudioBlockInterleavedViewMut<'_, S>

Trait Implementations

impl<S: Sample> AudioBlock<S> for AudioBlockInterleaved<S>

type PlanarView = [S; 0]

fn num_channels(&self) -> u16

Returns the number of active audio channels.

fn num_frames(&self) -> usize

Returns the number of audio frames (samples per channel).

fn num_channels_allocated(&self) -> u16

Returns the total number of channels allocated in memory.

fn num_frames_allocated(&self) -> usize

Returns the total number of frames allocated in memory.

fn layout(&self) -> BlockLayout

Returns the memory layout of this audio block (interleaved, sequential, or planar).

fn sample(&self, channel: u16, frame: usize) -> S

Returns the sample value at the specified channel and frame position.

fn channel_iter(&self, channel: u16) -> impl Iterator<Item = &S>

Returns an iterator over all samples in the specified channel.

fn channels_iter( &self, ) -> impl Iterator<Item = impl Iterator<Item = &S> + '_> + '_

Returns an iterator that yields an iterator for each channel.

fn frame_iter(&self, frame: usize) -> impl Iterator<Item = &S>

Returns an iterator over all samples in the specified frame (across all channels).

fn frames_iter( &self, ) -> impl Iterator<Item = impl Iterator<Item = &S> + '_> + '_

Returns an iterator that yields an iterator for each frame.

fn as_view(&self) -> impl AudioBlock<S>

Creates a non-owning view of this audio block.

fn as_interleaved_view(&self) -> Option<AudioBlockInterleavedView<'_, S>>

Attempts to downcast this generic audio block to a concrete interleaved view. This enables access to frame slices and the underlying raw data.

fn as_planar_view( &self, ) -> Option<AudioBlockPlanarView<'_, S, Self::PlanarView>>

Attempts to downcast this generic audio block to a concrete planar view. This enables access to frame slices and the underlying raw data.

fn as_sequential_view(&self) -> Option<AudioBlockSequentialView<'_, S>>

Attempts to downcast this generic audio block to a concrete sequential view. This enables access to frame slices and the underlying raw data.

impl<S: Sample> AudioBlockMut<S> for AudioBlockInterleaved<S>

type PlanarViewMut = [S; 0]

fn set_num_channels_visible(&mut self, num_channels: u16)

Sets the visible size of the audio block to the specified number of channels.

fn set_num_frames_visible(&mut self, num_frames: usize)

Sets the visible size of the audio block to the specified number of frames.

fn sample_mut(&mut self, channel: u16, frame: usize) -> &mut S

Returns a mutable reference to the sample at the specified channel and frame position.

fn channel_iter_mut(&mut self, channel: u16) -> impl Iterator<Item = &mut S>

Returns a mutable iterator over all samples in the specified channel.

fn channels_iter_mut( &mut self, ) -> impl Iterator<Item = impl Iterator<Item = &mut S> + '_> + '_

Returns a mutable iterator that yields mutable iterators for each channel.

fn frame_iter_mut(&mut self, frame: usize) -> impl Iterator<Item = &mut S>

Returns a mutable iterator over all samples in the specified frame (across all channels).

fn frames_iter_mut( &mut self, ) -> impl Iterator<Item = impl Iterator<Item = &mut S> + '_> + '_

Returns a mutable iterator that yields mutable iterators for each frame.

fn as_view_mut(&mut self) -> impl AudioBlockMut<S>

Creates a non-owning mutable view of this audio block.

fn as_interleaved_view_mut( &mut self, ) -> Option<AudioBlockInterleavedViewMut<'_, S>>

Attempts to downcast this generic audio block to a concrete interleaved view. This enables access to frame slices and the underlying raw data.

fn set_visible(&mut self, num_channels: u16, num_frames: usize)

Sets the visible size of the audio block to the specified number of channels and frames.

fn as_planar_view_mut( &mut self, ) -> Option<AudioBlockPlanarViewMut<'_, S, Self::PlanarViewMut>>

Attempts to downcast this generic audio block to a concrete planar view. This enables access to frame slices and the underlying raw data.

fn as_sequential_view_mut( &mut self, ) -> Option<AudioBlockSequentialViewMut<'_, S>>

Attempts to downcast this generic audio block to a concrete sequential view. This enables access to frame slices and the underlying raw data.

impl<S: Sample + Debug> Debug for AudioBlockInterleaved<S>

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

Formats the value using the given formatter.