Struct StackedView

pub struct StackedView<'a, S: Sample, V: AsRef<[S]>> { /* private fields */ }

A read-only view of stacked / separate-channel audio data.

• Layout: [[ch0, ch0, ch0], [ch1, ch1, ch1]]
• Interpretation: Each channel has its own separate buffer or array.
• Terminology: Also described as “planar” or “channels first” though more specifically it’s channel-isolated buffers.
• Usage: Very common in real-time DSP, as it simplifies memory access and can improve SIMD/vectorization efficiency.

Example

use audio_blocks::*;

let data = vec![[0.0, 0.0, 0.0], [1.0, 1.0, 1.0]];

let block = StackedView::from_slice(&data);

block.channel(0).for_each(|&v| assert_eq!(v, 0.0));
block.channel(1).for_each(|&v| assert_eq!(v, 1.0));

Implementations

impl<'a, S: Sample, V: AsRef<[S]>> StackedView<'a, S, V>

pub fn from_slice(data: &'a [V]) -> Self

Creates a new StackedView from a slice of stacked audio data.

Parameters

• data - The slice containing stacked audio samples (one slice per channel)

Panics

Panics if the channel slices have different lengths.

pub fn from_slice_limited( data: &'a [V], num_channels_visible: u16, num_frames_visible: usize, ) -> Self

Creates a new StackedView 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 stacked audio samples (one slice per channel)
• num_channels_visible - Number of audio channels to expose in the view
• num_frames_visible - Number of audio frames to expose in the view

Panics

• Panics if num_channels_visible exceeds the number of channels in data
• Panics if num_frames_visible exceeds the length of any channel buffer
• Panics if channel slices have different lengths

Trait Implementations

impl<S: Sample, V: AsRef<[S]>> AudioBlock<S> for StackedView<'_, S, V>

fn num_frames(&self) -> usize

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

fn num_channels(&self) -> u16

Returns the number of active audio channels.

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 sample(&self, channel: u16, frame: usize) -> S

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

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

Returns an iterator over all samples in the specified channel.

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

Returns an iterator that yields iterators for each channel.

fn channel_slice(&self, channel: u16) -> Option<&[S]>

Returns a slice of the data in case of sequential or stacked layout.

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

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

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

Returns an iterator that yields iterators for each frame.

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

Creates a non-owning view of this audio block.

fn layout(&self) -> BlockLayout

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

fn raw_data(&self, stacked_ch: Option<u16>) -> &[S]

Provides direct access to the underlying memory as a slice.

fn frame_slice(&self, frame: usize) -> Option<&[S]>

Returns a slice of the data in case of interleaved memory layout.