Struct SequentialView

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

A read-only view of sequential / planar audio data.

• Layout: [ch0, ch0, ch0, ch1, ch1, ch1]
• Interpretation: All samples from ch0 are stored first, followed by all from ch1, etc.
• Terminology: Described as “planar” or “channels first” in the sense that all data for one channel appears before any data for the next.
• Usage: Used in DSP pipelines where per-channel processing is easier and more efficient.

Example

use audio_blocks::*;

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

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

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> SequentialView<'a, S>

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

Creates a new SequentialView from a slice of sequential audio data.

Parameters

• data - The slice containing sequential audio samples
• num_channels - Number of audio channels in the data
• num_frames - Number of audio frames in the data

Panics

Panics if the length of data doesn’t equal num_channels * num_frames.

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 SequentialView 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 sequential 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 SequentialView from a raw pointers.

Safety

The caller must ensure that:

• ptr points to valid memory containing at least num_channels_available * num_frames_available 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 SequentialView 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_available * num_frames_available 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

Trait Implementations

impl<S: Sample> AudioBlock<S> for SequentialView<'_, S>

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 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, _: 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.