Klang C++ 0.7.15
Language Reference (draft)
Loading...
Searching...
No Matches
klang::Envelope::Follower

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>

+ Inheritance diagram for klang::Envelope::Follower:

Classes

struct  AR
 Attack / Release IIR Filter (~Butterworth when attack == release) More...
 
struct  Window
 Window-based envelope follower. More...
 

Public Types

using Process = void(Follower::*)()
 

Public Member Functions

 Follower ()
 
void set (param attack, param release)
 
Follower & operator= (klang::Mode mode)
 
void process ()
 
void peak ()
 
void rms ()
 
 operator const signal & () override
 
 operator const signal & () const override
 
Modifier< signal > & operator() (params &&... p)
 
virtual const signal & input () const
 
virtual void input (const signal &source)
 
virtual void operator<< (const signal &source)
 
virtual const signal & output () const
 
TYPE & operator>> (TYPE &destination)
 
signal operator+ (TYPE &other)
 
signal operator* (TYPE &other)
 
signal operator- (TYPE &other)
 
signal operator/ (TYPE &other)
 
void reset ()
 

Public Attributes

klang::Envelope::Follower::AR ar
 
Process _process = &Follower::rms
 
signal in
 
signal out
 

Detailed Description

Definition at line 7797 of file klang.h.

Member Typedef Documentation

◆ Process

using klang::Envelope::Follower::Process = void(Follower::*)()

Definition at line 7832 of file klang.h.

Constructor & Destructor Documentation

◆ 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)
Definition klang.h:7823

Member Function Documentation

◆ input() [1/3]

virtual void klang::Generic::Input< signal >::input ( )
inlineprotectedvirtualinherited

◆ input() [2/3]

virtual const signal & klang::Generic::Input< signal >::input ( ) const
inlinevirtualinherited

Reimplemented in klang::Generic::Graph< SIZE >::Series.

Definition at line 2947 of file klang.h.

2947{ return in; }

◆ input() [3/3]

virtual void klang::Generic::Input< signal >::input ( const signal & source)
inlinevirtualinherited

Reimplemented in klang::Debug.

Definition at line 2951 of file klang.h.

2951{ in = source; this->input(); }
virtual const signal & input() const
Definition klang.h:2947

◆ operator const signal &() [1/2]

klang::Generic::Modifier< signal >::operator const signal & ( ) const
inlineoverridevirtualinherited

Reimplemented from klang::Generic::Output< signal >.

Definition at line 3091 of file klang.h.

3091{ return out; } // return last output

◆ operator const signal &() [2/2]

klang::Generic::Modifier< signal >::operator const signal & ( )
inlineoverridevirtualinherited

Reimplemented from klang::Generic::Output< signal >.

Definition at line 3090 of file klang.h.

3090{ this->process(); return out; } // return processed output
virtual void process() override
Definition klang.h:3094

◆ operator()()

Modifier< signal > & klang::Generic::Modifier< signal >::operator() ( params &&... p)
inlineinherited

Definition at line 3098 of file klang.h.

3098 {
3099 set(std::forward<params>(p)...); return *this;
3100 }

◆ operator*()

signal klang::Generic::Output< signal >::operator* ( TYPE & other)
inlineinherited

Definition at line 2977 of file klang.h.

2977{ this->process(); return out * SIGNAL(other); }

◆ operator+()

signal klang::Generic::Output< signal >::operator+ ( TYPE & other)
inlineinherited

Definition at line 2976 of file klang.h.

2976{ this->process(); return out + SIGNAL(other); }

◆ operator-()

signal klang::Generic::Output< signal >::operator- ( TYPE & other)
inlineinherited

Definition at line 2978 of file klang.h.

2978{ this->process(); return out - SIGNAL(other); }

◆ operator/()

signal klang::Generic::Output< signal >::operator/ ( TYPE & other)
inlineinherited

Definition at line 2979 of file klang.h.

2979{ this->process(); return out / SIGNAL(other); }

◆ operator<<()

virtual void klang::Generic::Input< signal >::operator<< ( const signal & source)
inlinevirtualinherited

Reimplemented in klang::Debug.

Definition at line 2950 of file klang.h.

2950{ in = source; this->input(); }

◆ operator=()

Follower & klang::Envelope::Follower::operator= ( klang::Mode mode)
inline

Definition at line 7827 of file klang.h.

7827 {
7829 return *this;
7830 }
Mode mode() const
Definition klang.h:5395
@ RMS
Definition klang.h:149

References klang::RMS.

◆ operator>>()

TYPE & klang::Generic::Output< signal >::operator>> ( TYPE & destination)
inlineinherited

Definition at line 2969 of file klang.h.

2969{ this->process(); return destination = out; }

◆ output()

virtual const signal & klang::Generic::Output< signal >::output ( ) const
inlinevirtualinherited

Definition at line 2964 of file klang.h.

2964{ return out; }

◆ peak()

void klang::Envelope::Follower::peak ( )
inline

Definition at line 7837 of file klang.h.

7837{ abs(in) >> ar >> out; }
klang::Envelope::Follower::AR ar

◆ process()

void klang::Envelope::Follower::process ( )
inlinevirtual

Reimplemented from klang::Generic::Modifier< signal >.

Definition at line 7835 of file klang.h.

7835{ (this->*_process)(); }

◆ reset()

void klang::Generic::Output< signal >::reset ( )
inlineinherited

Definition at line 2981 of file klang.h.

2981{ out = 0; }

◆ rms()

void klang::Envelope::Follower::rms ( )
inline

Definition at line 7838 of file klang.h.

7838{ (in * in) >> ar >> sqrt >> out; }

◆ set()

void klang::Envelope::Follower::set ( param attack,
param release )
inline

Definition at line 7823 of file klang.h.

7823 {
7824 ar.set(attack, release);
7825 }
virtual void release(float time, float level=0.f)
Definition klang.h:5279
void set(param attack, param release)
Definition klang.h:7806

Member Data Documentation

◆ _process

Process klang::Envelope::Follower::_process = &Follower::rms

Definition at line 7833 of file klang.h.

◆ ar

klang::Envelope::Follower::AR klang::Envelope::Follower::ar

◆ in

◆ out

Definition at line 2961 of file klang.h.

2961{ 0.f };