Struct WaveformData 

pub struct WaveformData { /* private fields */ }

An immutable Waveform Data snapshot.

Clones share storage and compare by snapshot identity. Independently constructed values compare unequal even when their buckets match.

Implementations

impl WaveformData

pub fn from_magnitudes( duration: Duration, channels: usize, levels: Vec<WaveformLevel<f32>>, ) -> Result<Self, WaveformError>

Construct Magnitude Waveform Data from normalized channel-major levels.

pub fn from_signed_envelopes( duration: Duration, channels: usize, levels: Vec<WaveformLevel<SignedEnvelope>>, ) -> Result<Self, WaveformError>

Construct Signed Envelope Waveform Data from channel-major levels.

pub fn from_peaks( duration: Duration, peaks: Vec<u8>, ) -> Result<Self, WaveformError>

Convert Peaks into one evenly spaced mono Magnitude resolution.

Peaks do not carry their original cadence, channel structure, or sign, so conversion cannot preserve those facts.

pub fn mode(&self) -> AmplitudeMode

pub fn duration(&self) -> Duration

pub fn channel_count(&self) -> usize

pub fn resolution_count(&self) -> usize

pub fn resolution(&self, index: usize) -> Option<ResolutionInfo>

pub fn select( &self, range: Range<Duration>, bucket_budget: usize, ) -> Result<WaveformView<'_>, WaveformError>

Borrow the finest resolution fitting a per-channel bucket budget.

range is a nonempty half-open source-time range. The coarsest resolution is returned when no stored resolution fits the budget.

Trait Implementations

impl Clone for WaveformData

fn clone(&self) -> WaveformData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WaveformData

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

Formats the value using the given formatter.

impl Eq for WaveformData

impl PartialEq for WaveformData

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

Equality operator ==.

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

Inequality operator !=.