Skip to main content

Module envelope

Module envelope 

Source
Expand description

Envelope / SFX temporal descriptors (caller-buffered, zero-heap hot path).

Amplitude-envelope tracking plus a family of temporal / sound-effect (SFX) shape descriptors (Essentia-style): attack time, temporal-centroid ratios, decay characterisation and flatness. Each leaf module holds exactly one public function.

Re-exports§

pub use centroid_time::centroid_time;
pub use derivative_sfx::derivative_sfx;
pub use flatness_sfx::flatness_sfx;
pub use follower::envelope_follow;
pub use log_attack_time::log_attack_time;
pub use max_to_total::max_to_total;
pub use min_to_total::min_to_total;
pub use strong_decay::strong_decay;
pub use tc_to_total::tc_to_total;

Modules§

centroid_time
Time-domain temporal centroid (energy-weighted mean time of a signal).
derivative_sfx
DerivativeSFX — mean first difference of the envelope after its maximum.
flatness_sfx
FlatnessSFX — flatness of the envelope (geometric / arithmetic mean).
follower
Asymmetric one-pole envelope follower (fast attack / slow release).
log_attack_time
LogAttackTime — Essentia-style log10 of the attack duration.
max_to_total
MaxToTotal — position of the envelope maximum, normalised to length.
min_to_total
MinToTotal — position of the envelope minimum, normalised to length.
strong_decay
StrongDecay — non-linear combination of energy and temporal centroid.
tc_to_total
TCToTotal — temporal centroid of the envelope, normalised to length.