Struct InterleavedView 

pub struct InterleavedView<'a, S: Sample> { /* private fields */ }

A read-only view of interleaved audio 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 data = vec![0.0, 1.0, 0.0, 1.0, 0.0, 1.0];

let block = InterleavedView::from_slice(&data, 2);

assert_eq!(block.frame(0), &[0.0, 1.0]);
assert_eq!(block.frame(1), &[0.0, 1.0]);
assert_eq!(block.frame(2), &[0.0, 1.0]);

Implementations

impl<'a, S: Sample> InterleavedView<'a, S>

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

Creates a new interleaved audio block 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: &'a [S], num_channels_visible: u16, num_frames_visible: usize, num_channels_allocated: u16, num_frames_allocated: usize, ) -> Self

Creates a new interleaved audio block from a slice with limited visibility.

This function allows creating a view 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 in the view
• num_frames_visible - Number of audio frames to expose in the view
• 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 unsafe fn from_ptr( ptr: *const S, num_channels: u16, num_frames: usize, ) -> Self

Creates a new interleaved audio block from a pointer.

Safety

The caller must ensure that:

• ptr points to valid memory containing at least num_channels_allocated * num_frames_allocated elements
• The memory referenced by ptr must be valid for the lifetime of the returned SequentialView
• The memory must not be mutated through other pointers while this view exists

pub unsafe fn from_ptr_limited( ptr: *const S, num_channels_visible: u16, num_frames_visible: usize, num_channels_allocated: u16, num_frames_allocated: usize, ) -> Self

Creates a new audio block from a pointer with a limited amount of channels and/or frames.

Safety

The caller must ensure that:

• ptr points to valid memory containing at least num_channels_allocated * num_frames_allocated elements
• The memory referenced by ptr must be valid for the lifetime of the returned SequentialView
• The memory must not be mutated through other pointers while this view exists

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 frames(&self) -> impl ExactSizeIterator<Item = &[S]>

Returns an iterator over all frames in the block.

Each frame is represented as a 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 view(&self) -> InterleavedView<'_, S>

Trait Implementations

impl<S: Sample> AudioBlock<S> for InterleavedView<'_, 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 ExactSizeIterator<Item = &S>

Returns an iterator over all samples in the specified channel.

fn channels_iter( &self, ) -> impl ExactSizeIterator<Item = impl ExactSizeIterator<Item = &S>>

Returns an iterator that yields an iterator for each channel.

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

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

fn frames_iter( &self, ) -> impl ExactSizeIterator<Item = impl ExactSizeIterator<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<InterleavedView<'_, 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<PlanarView<'_, 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<SequentialView<'_, 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 InterleavedView<'_, S>

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

Formats the value using the given formatter.