Enum ClipOutput 

pub enum ClipOutput {
    RmsDb,
    PeakDb,
    PeakToRmsDb,
    DurationS,
    EnvelopeDistanceDb,
}

An output of a clip that a spread covers.

Variants

RmsDb

The RMS level. Two clips compare over their common span, the shorter clip’s length from the onset, so a cut tail does not change the level.

PeakDb

ClipMetrics::peak_db.

PeakToRmsDb

The peak over the RMS level, in dB: the crest factor. Two clips compare with the RMS level over their common span, as ClipOutput::RmsDb does. A gain shifts the peak and the RMS level alike, so it moves the ratio only where it moves the clip’s end.

DurationS

ClipMetrics::duration_s.

EnvelopeDistanceDb

The envelope distance, envelope_distance.

Implementations

impl ClipOutput

pub const ALL: [Self; 5]

Every clip output.

pub const SHAPE: [Self; 3]

The outputs of the sound’s shape, which compare_fitted compares after a gain fit: the peak-to-RMS ratio, the duration to the tail floor and the envelope distance. The RMS level and the peak follow the level, so the fit takes them out. The duration and the envelope still depend on the level, which is why the fit comes first.

pub fn name(self) -> &'static str

The name of the output in a spread file.

pub fn unit(self) -> &'static str

The unit of the output.

pub fn value(self, clip: &ClipMetrics) -> Option<f64>

The value of the output for one clip; None for the envelope distance, which only two clips have. The RMS level is the one from onset to end, here and in the peak-to-RMS ratio.

pub fn distance(self, a: &ClipMetrics, b: &ClipMetrics) -> f64

The distance of two clips on the output.

pub fn floor(self, sample_rate: SampleRate) -> f64

The floor of the tolerance: LEVEL_FLOOR_DB for a level and one sample for the duration.

Trait Implementations

impl Clone for ClipOutput

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ClipOutput

impl Debug for ClipOutput

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

Formats the value using the given formatter.

impl Eq for ClipOutput

impl PartialEq for ClipOutput

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClipOutput