Envelope Follower for dynamic processing and control. More...

#include <EnvelopeFollower.h>

Inheritance diagram for pdsp::EnvelopeFollower:

Public Member Functions
Patchable &	set (float attack_ms, float release_ms)
	sets the default attack and release values and return the unit ready to be patched. More...

Patchable &	in_signal ()
	Sets "signal" as selected input and returns this Unit ready to be patched. This is the default input. This input is the signal/value to slew.

Patchable &	in_attack ()
	Sets "attack" as selected input and returns this Unit ready to be patched. This input is the rise ( aka attack ) time of the envelope follower.

Patchable &	in_release ()
	Sets "release" as selected input and returns this Unit ready to be patched. This input is the decay ( aka release ) time of the envelope follower.

Patchable &	out_signal ()
	Sets "signal" as selected output and returns this Unit ready to be patched. This is the default output. This is enveloped output.

float	meter_output () const
	returns the first output value of the last processed buffer.

void	digital ()
	sets the envelope behavior digital (more responsive, default behavior).

void	analog ()
	sets the envelope behavior to analog (slower).

Public Member Functions inherited from pdsp::Unit
	Unit (const Unit &other)

Unit &	operator= (const Unit &other)

	Unit (Unit &&other)

Unit &	operator= (Unit &&other)

virtual void	setOversampleLevel (int newOversampleLevel)
	sets the unit oversample level More...

int	getOversampleLevel () const
	returns the Unit oversample level

Public Member Functions inherited from pdsp::Patchable
void	resetInputToDefault ()
	resets the selected input to the default.

void	resetOutputToDefault ()
	resets the selected output to the default.

Patchable &	in (const char *tag)
	sets the selected input to the one tagged with "tag", if tag is a valid string, and returns this Patchable ready to be patched. More...

Patchable &	out (const char *tag)
	sets the selected output to the one tagged with "tag", if tag is a valid string, and returns this Patchable ready to be patched. More...

void	disconnectIn ()
	disconnects all the outputs connected to the selected input, then resets the selected input to the default.

void	disconnectOut ()
	disconnects all the inputs connected to the selected output, then resets the selected output to the default.

void	disconnectAll ()
	disconnects all the inputs and outputs to their connected outputs and inputs. Also resets the selected input and output to the default.

InputNode &	getSelectedInput ()
	returns the selected input, you can patch a Patchable or OutputNode to it with the >> operator.

OutputNode &	getSelectedOutput ()
	returns the selected output, you can patch it to another Patchable or InputNode with the >> operator.

std::vector< std::string >	getInputsList ()
	returns a vector of the valid input tags

std::vector< std::string >	getOutputsList ()
	returns a vector of the valid input tags

Additional Inherited Members
Static Public Member Functions inherited from pdsp::Preparable
static double	getGlobalSampleRate ()

Protected Member Functions inherited from pdsp::Unit
void	prepareToPlay (int expectedBufferSize, double sampleRate) override
	you have to use this method only in the constructor, inside if(dynamicConstruction){ } More...

const float *	processInput (InputNode &node, int &stateNow)
	process the given input, gives you a pointer to the processed buffer as result and its state More...

float	processAndGetSingleValue (InputNode &input, int pos)
	process the given input, gives you a pointer to the processed buffer as result and its state More...

float *	getOutputBufferToFill (OutputNode &node)
	gets a pointer to the output buffer for rendering audio to it, and sets the OutputNode state to AudioRate More...

void	setControlRateOutput (OutputNode &node, float scalarValue)
	sets the OutputNode buffer to "Changed" and its first value to scalarValue More...

void	setOutputToZero (OutputNode &node)
	sets the OutputNode buffer to "Changed" and its first value to 0.0f More...

void	updateOutputNodes ()
	call this method in the Unit constructor after adding all the Outputs, this is mandatory for the inner working of the patching framework.

Protected Member Functions inherited from pdsp::Patchable
void	addOutput (const char *tag, OutputNode &output)
	method to add outputs when constructing a Unit More...

void	addInput (const char *tag, InputNode &input)
	method to add inputs when constructing a Unit More...

void	addModuleOutput (const char *tag, Patchable &unit)
	method to add outputs when constructing a module More...

void	addModuleInput (const char *tag, Patchable &unit)
	method to add outputs when constructing a module More...

Detailed Description

Envelope Follower for dynamic processing and control.

EnvelopeFollower slews the input signal with a variable rise ( in_attack() ) and decay ( in_release() ) times. Usually it is used after some kind of processing to make an audio signal unipolar, like HalfWavePeakDetector or RMSDetector . It essential to implement dynamic processing modules.

Member Function Documentation

◆ set()

pdsp::Patchable & pdsp::EnvelopeFollower::set	(	float	attack_ms,
		float	release_ms
	)

sets the default attack and release values and return the unit ready to be patched.

Parameters

[in]	attack_ms	attack time in milliseconds. Default before this call is 20ms.
[in]	release_ms	release time in milliseconds. Default before this call is 50ms.

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

EnvelopeFollower.h
EnvelopeFollower.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ set()