Language Guide / DSP and Analysis
Envelope::Follower
klang::Envelope::Follower
Tracks the level of an input signal.
Feed the follower an audio sample to estimate its level. Use Peak mode to track the magnitude or RMS mode to track the root-mean-square level. Attack and release times control how quickly the estimate responds when the input rises or falls.
Example ยท Track peak level
Declare Envelope::Follower follower; as a member and configure it during setup.
follower.set(0.01, 0.2);
follower = Peak;
In process(), use the configured object for each sample.
const signal level = in >> follower;
Envelope follower (Peak / RMS)
More...
#include <klang.h>
|
| struct | AR |
| | Attack / Release IIR Filter (~Butterworth when attack == release) More...
|
| |
| struct | Window |
| | Window-based envelope follower. More...
|
| |
|
| using | Process = void(Follower::*)() |
| |
Definition at line 7797 of file klang.h.
◆ Process
◆ Follower()
| klang::Envelope::Follower::Follower |
( |
| ) |
|
|
inline |
Definition at line 7822 of file klang.h.
7822{
set(0.01f, 0.1f); }
void set(param attack, param release)
◆ input() [1/3]
|
|
inlineprotectedvirtualinherited |
◆ input() [2/3]
◆ input() [3/3]
◆ operator const signal &() [1/2]
|
|
inlineoverridevirtualinherited |
◆ operator const signal &() [2/2]
|
|
inlineoverridevirtualinherited |
◆ operator()()
Definition at line 3098 of file klang.h.
3098 {
3099 set(std::forward<params>(p)...); return *this;
3100 }
◆ operator*()
◆ operator+()
◆ operator-()
◆ operator/()
◆ operator<<()
◆ operator=()
◆ operator>>()
◆ output()
◆ peak()
| void klang::Envelope::Follower::peak |
( |
| ) |
|
|
inline |
Definition at line 7837 of file klang.h.
klang::Envelope::Follower::AR ar
◆ process()
| void klang::Envelope::Follower::process |
( |
| ) |
|
|
inlinevirtual |
◆ reset()
◆ rms()
| void klang::Envelope::Follower::rms |
( |
| ) |
|
|
inline |
◆ set()
| void klang::Envelope::Follower::set |
( |
param | attack, |
|
|
param | release ) |
|
inline |
Definition at line 7823 of file klang.h.
7823 {
7825 }
virtual void release(float time, float level=0.f)
void set(param attack, param release)
◆ _process
◆ ar
◆ in
◆ out