Struct NoteEnvelope 

pub struct NoteEnvelope {

    pub onset: Seconds,
    pub end: Seconds,
    pub pitch: MidiPitch,
    pub peak_db: Decibels,
    pub attack: Option<Seconds>,
    pub attack_upper_bound: bool,
    pub hold: Seconds,
    pub decay: Option<Seconds>,
    pub sustain: Option<Decibels>,
    pub knee: Option<Seconds>,
    pub ripple: Option<Decibels>,
    pub residual: Option<Decibels>,
    pub overlap: bool,
    pub tail: Option<TailFit>,
}

The envelope of one note.

Fields

onset: Seconds

The note’s onset.

end: Seconds

The note’s end in the note list, or the stem’s end when that comes first.

pitch: MidiPitch

The note’s pitch.

peak_db: Decibels

The peak of the amp proxy, in dB of the harmonic’s power.

attack: Option<Seconds>

The 10-90 % rise times RAMP_FACTOR; None when the level does not start below 10 % of its peak.

attack_upper_bound: bool

The rise is shorter than ATTACK_PERIODS_MIN RMS windows, or for an overlapping note BAND_STEPS_MIN times its band’s rise for an instant step, so attack is an upper bound.

hold: Seconds

The plateau after the attack; 0 when none lasts HOLD_MIN.

decay: Option<Seconds>

The time from the peak to the sustain level, read between 10 % and 90 % of the fall in dB; None when not observable or when the level holds at the peak.

sustain: Option<Decibels>

The sustain level from the peak; None when not observable.

knee: Option<Seconds>

The note-off knee; None when no knee shows.

ripple: Option<Decibels>

The swing of the level over the sustain window, the 90th minus the 10th percentile after its line; None when the sustain is not observable.

residual: Option<Decibels>

The RMS of the held part, in dB, against the model of the hold, the decay line and the sustain level; None when not observable.

overlap: bool

Another note sounds during this one, so the attack reads the amp proxy, not the full band.

tail: Option<TailFit>

The tail model after the knee; None without a knee or enough frames.

Trait Implementations

impl Clone for NoteEnvelope

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 NoteEnvelope

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

Formats the value using the given formatter.

impl PartialEq for NoteEnvelope

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for NoteEnvelope