Abstract Base class for Sound Effects. More...

#include <AudioEffect.h>

Inheritance diagram for AudioEffect:

Public Member Functions
	AudioEffect ()=default

virtual	~AudioEffect ()=default

virtual bool	active ()
	determines if the effect is active

virtual AudioEffect *	clone ()=0

int	id ()
	Allows to identify an effect.

virtual effect_t	process (effect_t in)=0
	calculates the effect output from the input

virtual void	setActive (bool value)
	sets the effect active/inactive

void	setId (int id)
	Allows to identify an effect.

Protected Member Functions
int16_t	clip (int32_t in, int16_t clipLimit=32767, int16_t resultLimit=32767)
	generic clipping method

void	copyParent (AudioEffect *copy)

Protected Attributes
bool	active_flag = true

int	id_value = -1

Detailed Description

Abstract Base class for Sound Effects.

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ AudioEffect()

AudioEffect ( )

default

◆ ~AudioEffect()

virtual ~AudioEffect ( )

virtualdefault

Member Function Documentation

◆ active()

virtual bool active ( )

inlinevirtual

determines if the effect is active

◆ clip()

int16_t clip	(	int32_t	in,
		int16_t	clipLimit = `32767`,
		int16_t	resultLimit = `32767`
	)

inlineprotected

generic clipping method

◆ clone()

virtual AudioEffect * clone ( )

pure virtual

Implemented in SimpleLPF, Boost, Distortion, Fuzz, Tremolo, Delay, ADSRGain, PitchShift, Compressor, SimpleChorus, FilteredDelay, SimpleDelay, SimpleFlanger, STKChorus, STKEcho, STKFreeVerb, STKChowningReverb, STKNReverb, STKPerryReverb, STKLentPitShift, and STKPitShift.

◆ copyParent()

void copyParent ( AudioEffect * copy )

inlineprotected

◆ id()

int id ( )

inline

Allows to identify an effect.

◆ process()

virtual effect_t process ( effect_t in )

pure virtual

calculates the effect output from the input

Implemented in STKEffect, STKChorus, STKEcho, STKFreeVerb, STKChowningReverb, STKNReverb, STKPerryReverb, STKLentPitShift, STKPitShift, Boost, Distortion, Fuzz, Tremolo, Delay, ADSRGain, PitchShift, Compressor, FilterEffectBase, FilteredDelay, and SimpleDelay.

◆ setActive()

virtual void setActive ( bool value )

inlinevirtual

sets the effect active/inactive

◆ setId()

void setId ( int id )

inline

Allows to identify an effect.

Member Data Documentation

◆ active_flag

bool active_flag = true

protected

◆ id_value

int id_value = -1