Struct WaveformSummary 

pub struct WaveformSummary { /* private fields */ }

Builds a Waveform from planar samples streamed in blocks.

Implementations

impl WaveformSummary

pub fn new( channels: usize, base_bucket: usize, levels: usize, ) -> Result<Self, WaveformError>

A summary of channels channels whose finest buckets hold base_bucket samples, with levels zoom levels in all.

Errors

Returns WaveformError::InvalidShape for zero channels, a zero bucket, or a level count outside 1..=MAX_WAVEFORM_LEVELS.

pub fn push(&mut self, planes: &[&[f32]]) -> Result<(), WaveformError>

Adds one block of planar samples, one slice per channel, all of one length.

Errors

Returns WaveformError::MismatchedBlock for a block with another channel count or ragged planes.

pub fn finish(self) -> Waveform

Closes the partial buckets and returns the summary.

Trait Implementations

impl Clone for WaveformSummary

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WaveformSummary

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

Formats the value using the given formatter.