Struct Chunk 

pub struct Chunk { /* private fields */ }

A buffer of audio samples with associated metadata.

Chunk is the unit of data that flows between DspNodes in a pipeline. It owns its sample buffer so that nodes can process in-place without extra allocations.

Samples are stored interleaved when channels > 1: [L0, R0, L1, R1, ...] for stereo.

Examples

use resonant_stream::Chunk;

let chunk = Chunk::new(vec![0.0_f32; 1024], 44100, 1);
assert_eq!(chunk.frames(), 1024);
assert_eq!(chunk.sample_rate(), 44100);

Implementations

impl Chunk

pub fn new(data: Vec<f32>, sample_rate: u32, channels: u16) -> Self

Creates a new chunk from interleaved sample data.

Panics

Panics if channels is zero or sample_rate is zero.

pub fn empty(sample_rate: u32, channels: u16) -> Self

Creates an empty chunk with the given format.

Panics

Panics if channels is zero or sample_rate is zero.

pub fn data(&self) -> &[f32]

Returns a reference to the interleaved sample data.

pub fn data_mut(&mut self) -> &mut [f32]

Returns a mutable reference to the interleaved sample data.

pub fn into_data(self) -> Vec<f32>

Consumes the chunk, returning the underlying sample buffer.

pub fn sample_rate(&self) -> u32

The sample rate in Hz.

pub fn channels(&self) -> u16

The number of interleaved channels.

pub fn frames(&self) -> usize

The number of sample frames (total samples / channels).

pub fn is_empty(&self) -> bool

Returns true if the chunk contains no samples.

pub fn len(&self) -> usize

The total number of samples (frames * channels).

Trait Implementations

impl Clone for Chunk

fn clone(&self) -> Chunk

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Chunk

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

Formats the value using the given formatter.

impl PartialEq for Chunk

fn eq(&self, other: &Chunk) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Chunk