EnvelopeFollower Class Reference

The EnvelopeFollower object implements a traditional envelope follower effect modulating a LPR fc value using the strength of the detected input. More...

#include <fxobjects.h>

Inheritance diagram for EnvelopeFollower:

Public Member Functions
virtual bool	reset (double _sampleRate)
EnvelopeFollowerParameters	getParameters ()
void	setParameters (const EnvelopeFollowerParameters &params)
virtual bool	canProcessAudioFrame ()
virtual double	processAudioSample (double xn)
Public Member Functions inherited from IAudioSignalProcessor
virtual bool	reset (double _sampleRate)=0
virtual double	processAudioSample (double xn)=0
virtual bool	canProcessAudioFrame ()=0
virtual void	setSampleRate (double _sampleRate)
virtual void	enableAuxInput (bool enableAuxInput)
virtual double	processAuxInputAudioSample (double xn)
virtual bool	processAudioFrame (const float *inputFrame, float *outputFrame, uint32_t inputChannels, uint32_t outputChannels)

Protected Attributes
EnvelopeFollowerParameters	parameters
	object parameters
ZVAFilter	filter
	filter to modulate
AudioDetector	detector
	detector to track input signal

Detailed Description

The EnvelopeFollower object implements a traditional envelope follower effect modulating a LPR fc value using the strength of the detected input.

Audio I/O:

• Processes mono input to mono output.

Control I/F:

• Use EnvelopeFollowerParameters structure to get/set object params.

Author

Will Pirkle http://www.willpirkle.com

Remarks

This object is included in Designing Audio Effects Plugins in C++ 2nd Ed. by Will Pirkle

Version

Revision : 1.0

Date

Date : 2018 / 09 / 7

Member Function Documentation

canProcessAudioFrame()

virtual bool EnvelopeFollower::canProcessAudioFrame ( )

inlinevirtual

return false: this object only processes samples

Implements IAudioSignalProcessor.

getParameters()

EnvelopeFollowerParameters EnvelopeFollower::getParameters ( )

inline

get parameters: note use of custom structure for passing param data

Returns

EnvelopeFollowerParameters custom data structure

processAudioSample()

virtual double EnvelopeFollower::processAudioSample ( double  xn )

inlinevirtual

process input x(n) through the envelope follower to produce return value y(n)

Parameters

xn

input

Returns

the processed sample

Implements IAudioSignalProcessor.

reset()

virtual bool EnvelopeFollower::reset ( double  _sampleRate )

inlinevirtual

reset members to initialized state

Implements IAudioSignalProcessor.

setParameters()

void EnvelopeFollower::setParameters ( const EnvelopeFollowerParameters &  params )

inline

set parameters: note use of custom structure for passing param data

Parameters

EnvelopeFollowerParameters

custom data structure

---

The documentation for this class was generated from the following file:

• C:/RackAFX_v7/ASPIK_Doxygen/PluginObjects/fxobjects.h