Struct AudioBlockMono 

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

A mono (single-channel) audio block that owns its data.

This is a simplified version of the multi-channel audio blocks, optimized for mono audio processing with a streamlined API that doesn’t require channel indexing.

• Layout: [sample0, sample1, sample2, ...]
• Interpretation: A simple sequence of samples representing a single audio channel.
• Usage: Ideal for mono audio processing, side-chain signals, or any single-channel audio data.

Example

use audio_blocks::*;

let mut block = AudioBlockMono::new(512);

// Fill with a simple ramp
for (i, sample) in block.samples_mut().iter_mut().enumerate() {
    *sample = i as f32;
}

assert_eq!(block.sample(0), 0.0);
assert_eq!(block.sample(511), 511.0);

Implementations

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

pub fn new(num_frames: usize) -> Self

Creates a new mono audio block with the specified number of frames.

Allocates memory for a new mono audio block with exactly the specified number of frames. The block is initialized with the default value (zero) for the sample type.

Do not use in real-time processes!

Arguments

• num_frames - The number of frames (samples)

Example

use audio_blocks::{mono::AudioBlockMono, AudioBlock};

let block = AudioBlockMono::<f32>::new(1024);
assert_eq!(block.num_frames(), 1024);

impl<S: Sample> AudioBlockMono<S>

pub fn from_slice(samples: &[S]) -> Self

Creates a new mono audio block from a slice of samples.

Copies the provided slice into a new owned mono block.

Warning

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

Arguments

• samples - The slice of samples to copy

pub fn from_slice_limited(samples: &[S], num_frames_visible: usize) -> Self

Creates a new mono audio block from a slice of samples.

Copies the provided slice into a new owned mono block.

Warning

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

Arguments

• samples - The slice of samples to copy
• num_frames_visible - Number of audio frames to expose

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

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

Extracts the first channel from any AudioBlock implementation. If the source block has no channels, creates an empty mono 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 (first channel will be used)

Panics

Panics if the source block has zero channels.

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

Returns the sample at the specified frame index.

Panics

Panics if frame index is out of bounds.

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

Returns a mutable reference to the sample at the specified frame index.

Panics

Panics if frame index is out of bounds.

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

Provides direct access to the underlying samples as a slice.

Returns only the visible samples (up to num_frames).

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

Provides direct mutable access to the underlying samples as a slice.

Returns only the visible samples (up to num_frames).

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

Provides direct access to all allocated memory, including reserved capacity.

This gives access to the full allocated buffer, including any frames beyond the visible range.

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

Provides direct mutable access to all allocated memory, including reserved capacity.

This gives mutable access to the full allocated buffer, including any frames beyond the visible range.

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

Creates a view of this mono audio block.

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

Creates a mutable view of this mono audio block.

Trait Implementations

impl<S: Sample> AudioBlock<S> for AudioBlockMono<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 AudioBlockMono<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 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_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 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 AudioBlockMono<S>

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

Formats the value using the given formatter.