Audio Effects Framework
CAudioEffectBiquad Class Reference

audio effect class for biquad filter More...

#include <AudioEffectBiquad.h>

Inheritance diagram for CAudioEffectBiquad:
Collaboration diagram for CAudioEffectBiquad:

Public Types

enum  FilterType_t {
  kLowpass, kHighpass, kBandpass, kAllpass,
  kPeak, kNotch, kLowshelf, kHighshelf
}
 
- Public Types inherited from CAudioEffect
enum  EffectParam_t {
  kParamGain, kParamPan, kParamDelayInSecs, kParamFeedback,
  kParamModRateInHz, kParamModWidthInSecs, kParamTremoloAmount, kParamCenterFrequency,
  kParamQ, kParamThreshold, kParamSlope, kParamDryWetMix,
  kParamNumFilters, kParamFilterGains, kParamFilterDelays
}
 

Public Member Functions

 CAudioEffectBiquad ()
 
 CAudioEffectBiquad (float fSampleRateInHz, int iNumChannels, FilterType_t filterType=kLowpass, EffectParam_t params[]=NULL, float values[]=NULL, int iNumParams=0, float fMaxDelayInSec=5.f)
 
 ~CAudioEffectBiquad ()
 
Error_t init (float fSampleRateInHz, int iNumChannels, FilterType_t filterType=kLowpass, EffectParam_t params[]=NULL, float values[]=NULL, int iNumParams=0, float fMaxDelayInSec=5.f)
 
Error_t reset ()
 
Error_t setParam (EffectParam_t eParam, float fValue)
 
float getParam (EffectParam_t eParam)
 
Error_t setFilterType (FilterType_t eValue)
 
FilterType_t getFilterType ()
 
Error_t process (float **ppfInputBuffer, float **ppfOutputBuffer, int iNumberOfFrames)
 
- Public Member Functions inherited from CAudioEffect
 CAudioEffect ()
 
 ~CAudioEffect ()
 
Effect_t getEffectType ()
 

Additional Inherited Members

- 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...
 

Detailed Description

audio effect class for biquad filter

Member Enumeration Documentation

◆ FilterType_t

list of sub types for biquad filter

Enumerator
kLowpass 
kHighpass 
kBandpass 
kAllpass 
kPeak 
kNotch 
kLowshelf 
kHighshelf 

Constructor & Destructor Documentation

◆ CAudioEffectBiquad() [1/2]

CAudioEffectBiquad::CAudioEffectBiquad ( )

◆ CAudioEffectBiquad() [2/2]

CAudioEffectBiquad::CAudioEffectBiquad ( float  fSampleRateInHz,
int  iNumChannels,
FilterType_t  filterType = kLowpass,
EffectParam_t  params[] = NULL,
float  values[] = NULL,
int  iNumParams = 0,
float  fMaxDelayInSec = 5.f 
)

◆ ~CAudioEffectBiquad()

CAudioEffectBiquad::~CAudioEffectBiquad ( )

Member Function Documentation

◆ getFilterType()

CAudioEffectBiquad::FilterType_t CAudioEffectBiquad::getFilterType ( )

return the value of the specified sub type

Returns
Filtertype_t

◆ getParam()

float CAudioEffectBiquad::getParam ( EffectParam_t  eParam)

return the value of the specified parameter

Parameters
eParam
Returns
float

◆ init()

Error_t CAudioEffectBiquad::init ( float  fSampleRateInHz,
int  iNumChannels,
FilterType_t  filterType = kLowpass,
EffectParam_t  params[] = NULL,
float  values[] = NULL,
int  iNumParams = 0,
float  fMaxDelayInSec = 5.f 
)

initializes a distortion instance

Parameters
fSampleRateInHzsample rate in Hz
iNumChannelsnumber of audio channels
params[]list of parameter types
values[]list of parameter values
iNumParamsnumber of parameters
fMaxDelayInSecmax delay lenghth in seconds
Returns
Error_t

◆ process()

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

processes one block of audio

Parameters
ppfInputBufferinput buffer [numChannels][iNumberOfFrames]
ppfOutputBufferoutput buffer [numChannels][iNumberOfFrames]
iNumberOfFramesbuffer length (per channel)
Returns
Error_t

◆ reset()

Error_t CAudioEffectBiquad::reset ( )

resets the internal variables (requires new call of init)

Returns
Error_t

◆ setFilterType()

Error_t CAudioEffectBiquad::setFilterType ( FilterType_t  eValue)

sets a biquad filter sub type

Parameters
eValuevalue of the sub type
Returns
Error_t

◆ setParam()

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

sets a biquad filter parameter

Parameters
eParamwhat parameter
fValuevalue of the parameter
Returns
Error_t

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