CAudioEffectDistortion Class Reference

audio effect class for distortion More...

#include <AudioEffectDistortion.h>

Inheritance diagram for CAudioEffectDistortion:

Collaboration diagram for CAudioEffectDistortion:

Public Member Functions
	CAudioEffectDistortion ()
	CAudioEffectDistortion (float fSampleRateInHz, int iNumChannels, EffectParam_t params[]=NULL, float values[]=NULL, int iNumParams=0)
	~CAudioEffectDistortion ()
Error_t	init (float fSampleRateInHz, int iNumChannels, EffectParam_t params[]=NULL, float values[]=NULL, int iNumParams=0)
Error_t	reset ()
Error_t	setParam (EffectParam_t eParam, float fValue)
float	getParam (EffectParam_t eParam)
Error_t	process (float **ppfInputBuffer, float **ppfOutputBuffer, int iNumberOfFrames)
Public Member Functions inherited from CAudioEffect
	CAudioEffect ()
	~CAudioEffect ()
Effect_t	getEffectType ()

Protected Attributes
float	m_fGain
	amount of distortion, >0 More...
float	m_fDryWetMix
	mix of original and distorted sound, 1=only distorted, 0=only dry More...
Protected Attributes inherited from CAudioEffect
bool	m_bIsInitialized
	true if initialized More...
Effect_t	m_eEffectType
	audio effect type More...
float	m_fSampleRateInHz
	sample rate in Hz More...
int	m_iNumChannels
	number of channels More...

Additional Inherited Members
Public Types inherited from CAudioEffect
enum	EffectParam_t {   kParamGain, kParamPan, kParamDelayInSecs, kParamFeedback,   kParamModRateInHz, kParamModWidthInSecs, kParamTremoloAmount, kParamCenterFrequency,   kParamQ, kParamThreshold, kParamSlope, kParamDryWetMix,   kParamNumFilters, kParamFilterGains, kParamFilterDelays }

Detailed Description

audio effect class for distortion

Constructor & Destructor Documentation

CAudioEffectDistortion() [1/2]

CAudioEffectDistortion::CAudioEffectDistortion

(

)

CAudioEffectDistortion() [2/2]

CAudioEffectDistortion::CAudioEffectDistortion	(	float	fSampleRateInHz,
		int	iNumChannels,
		EffectParam_t	params[] = NULL,
		float	values[] = NULL,
		int	iNumParams = 0
	)

~CAudioEffectDistortion()

CAudioEffectDistortion::~CAudioEffectDistortion

(

)

Member Function Documentation

getParam()

float CAudioEffectDistortion::getParam

(

EffectParam_t

eParam

)

return the value of the specified parameter

Parameters

eParam

Returns

float

init()

Error_t CAudioEffectDistortion::init	(	float	fSampleRateInHz,
		int	iNumChannels,
		EffectParam_t	params[] = NULL,
		float	values[] = NULL,
		int	iNumParams = 0
	)

initializes a distortion instance

Parameters

fSampleRateInHz	sample rate in Hz
iNumChannels	number of audio channels
params[]	list of parameter types
values[]	list of parameter values
iNumParams	number of parameters

Returns

Error_t

process()

Error_t CAudioEffectDistortion::process	(	float **	ppfInputBuffer,
		float **	ppfOutputBuffer,
		int	iNumberOfFrames
	)

processes one block of audio

Parameters

ppfInputBuffer	input buffer [numChannels][iNumberOfFrames]
ppfOutputBuffer	output buffer [numChannels][iNumberOfFrames]
iNumberOfFrames	buffer length (per channel)

Returns

Error_t

reset()

Error_t CAudioEffectDistortion::reset

(

)

resets the internal variables (requires new call of init)

Returns

Error_t

setParam()

Error_t CAudioEffectDistortion::setParam	(	EffectParam_t	eParam,
		float	fValue
	)

sets a distortion parameter

Parameters

eParam	what parameter
fValue	value of the parameter

Returns

Error_t

Member Data Documentation

m_fDryWetMix

float CAudioEffectDistortion::m_fDryWetMix

protected

mix of original and distorted sound, 1=only distorted, 0=only dry

m_fGain

float CAudioEffectDistortion::m_fGain

protected

amount of distortion, >0

---

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

• src/inc/AudioEffectDistortion.h
• src/AudioEffect/AudioEffectDistortion.cpp