Effect Class Reference

#include <Effect.h>

Inheritance diagram for Effect:

Public Member Functions
	Effect (bool insertion_, float *efxoutl_, float *efxoutr_, FilterParams *filterpars_, unsigned char Ppreset_, unsigned int srate, int bufsize)
virtual	~Effect ()
virtual void	setpreset (unsigned char npreset)=0
virtual void	changepar (int npar, unsigned char value)=0
virtual unsigned char	getpar (int npar) const =0
void	out (float *const smpsl, float *const smpsr)
virtual void	out (const Stereo< float * > &smp)=0
virtual void	cleanup (void)
virtual float	getfreqresponse (float freq)

Static Public Member Functions
static void	crossover (float &a, float &b, float crossover)

Public Attributes
unsigned char	Ppreset
float *const	efxoutl
float *const	efxoutr
float	outvolume
float	volume
FilterParams *	filterpars

Protected Member Functions
void	setpanning (char Ppanning_)
void	setlrcross (char Plrcross_)
void	alias ()

Protected Attributes
const bool	insertion
char	Ppanning
float	pangainL
float	pangainR
char	Plrcross
float	lrcross
unsigned int	samplerate
int	buffersize
float	samplerate_f
float	halfsamplerate_f
float	buffersize_f
int	bufferbytes

Detailed Description

this class is inherited by the all effects(Reverb, Echo, ..)

Constructor & Destructor Documentation

Effect()

Effect::Effect	(	bool	insertion_,
		float *	efxoutl_,
		float *	efxoutr_,
		FilterParams *	filterpars_,
		unsigned char	Ppreset_,
		unsigned int	srate,
		int	bufsize )

Effect Constructor

Parameters

insertion_	1 when it is an insertion Effect
efxoutl_	Effect output buffer Left channel
efxoutr_	Effect output buffer Right channel
filterpars_	pointer to FilterParams array
Ppreset_	chosen preset

Returns

Initialized Effect object

~Effect()

virtual Effect::~Effect ( )

inlinevirtual

Member Function Documentation

alias()

void Effect::alias ( )

inlineprotected

changepar()

virtual void Effect::changepar ( int npar, unsigned char value )

pure virtual

Change parameter npar to value

Parameters

npar	chosen parameter
value	chosen new value

Implemented in Alienwah, Chorus, Distorsion, DynamicFilter, Echo, EQ, Phaser, and Reverb.

cleanup()

virtual void Effect::cleanup ( void )

inlinevirtual

Reset the state of the effect

Reimplemented in Alienwah, Chorus, Distorsion, DynamicFilter, Echo, EQ, Phaser, and Reverb.

crossover()

void Effect::crossover ( float & a, float & b, float crossover )

static

getfreqresponse()

virtual float Effect::getfreqresponse ( float freq )

inlinevirtual

Reimplemented in EQ.

getpar()

virtual unsigned char Effect::getpar ( int npar ) const

pure virtual

Get the value of parameter npar

Parameters

npar	chosen parameter

Returns

the value of the parameter in an unsigned char or 0 if it does not exist

Implemented in Alienwah, Chorus, Distorsion, DynamicFilter, Echo, EQ, Phaser, and Reverb.

out() [1/2]

virtual void Effect::out ( const Stereo< float * > & smp )

pure virtual

Implemented in Alienwah, Chorus, Distorsion, DynamicFilter, Echo, EQ, Phaser, and Reverb.

out() [2/2]

void Effect::out	(	float *const	smpsl,
		float *const	smpsr )

Output result of effect based on the given buffers

This method should result in the effect generating its results and placing them into the efxoutl and efxoutr buffers. Every Effect should overide this method.

Parameters

smpsl	Input buffer for the Left channel
smpsr	Input buffer for the Right channel

setlrcross()

void Effect::setlrcross ( char Plrcross_ )

protected

setpanning()

void Effect::setpanning ( char Ppanning_ )

protected

setpreset()

virtual void Effect::setpreset ( unsigned char npreset )

pure virtual

Choose a preset

Parameters

npreset

number of chosen preset

Implemented in Alienwah, Chorus, Distorsion, DynamicFilter, Echo, EQ, Phaser, and Reverb.

Member Data Documentation

bufferbytes

int Effect::bufferbytes

protected

buffersize

int Effect::buffersize

protected

buffersize_f

float Effect::buffersize_f

protected

efxoutl

float* const Effect::efxoutl

Effect out Left Channel

efxoutr

float* const Effect::efxoutr

Effect out Right Channel

filterpars

FilterParams* Effect::filterpars

Parameters for filters used by Effect

halfsamplerate_f

float Effect::halfsamplerate_f

protected

insertion

const bool Effect::insertion

protected

lrcross

float Effect::lrcross

protected

outvolume

float Effect::outvolume

This is the volume of effect and is public because it is needed in system effects. The out volume of such effects are always 1.0f, so this setting tells me how is the volume to the Master Output only.

pangainL

float Effect::pangainL

protected

pangainR

float Effect::pangainR

protected

Plrcross

char Effect::Plrcross

protected

Ppanning

char Effect::Ppanning

protected

Ppreset

unsigned char Effect::Ppreset

Currently used preset

samplerate

unsigned int Effect::samplerate

protected

samplerate_f

float Effect::samplerate_f

protected

volume

float Effect::volume

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/ZynAddSubFx/zynaddsubfx/src/Effects/Effect.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/ZynAddSubFx/zynaddsubfx/src/Effects/Effect.cpp