Audio::IFilter Class Reference

#include <Filter.h>

Inheritance diagram for Audio::IFilter:

Public Member Functions
SIGNALPROCESSING_API	IFilter ()
SIGNALPROCESSING_API	IFilter (const IFilter &)
virtual SIGNALPROCESSING_API	~IFilter ()
virtual SIGNALPROCESSING_API void	Init (const float InSampleRate, const int32 InNumChannels, const int32 InVoiceId, FModulationMatrix *InModMatrix=nullptr)
virtual SIGNALPROCESSING_API void	SetFrequency (const float InCutoffFrequency)
virtual SIGNALPROCESSING_API void	SetFrequencyMod (const float InModFrequency)
virtual SIGNALPROCESSING_API void	SetQ (const float InQ)
virtual SIGNALPROCESSING_API void	SetQMod (const float InModQ)
virtual void	SetSaturation (const float InSaturation)
virtual void	SetBandStopControl (const float InBandStop)
virtual void	SetPassBandGainCompensation (const float InPassBandGainCompensation)
virtual SIGNALPROCESSING_API void	SetFilterType (const EFilter::Type InFilterType)
virtual SIGNALPROCESSING_API void	Reset ()
virtual SIGNALPROCESSING_API void	Update ()
virtual void	ProcessAudioFrame (const float *InFrame, float *OutFrame)
virtual void	ProcessAudio (const float *InBuffer, const int32 InNumSamples, float *OutBuffer)=0
virtual void	ProcessAudio (const float *const *InBuffers, const int32 InNumSamples, float *const *OutBuffers)=0
FPatchDestination	GetModDestCutoffFrequency () const
FPatchDestination	GetModDestQ () const

Protected Member Functions
float	GetGCoefficient () const

Protected Attributes
int32	VoiceId
float	SampleRate
int32	NumChannels
float	Frequency
float	BaseFrequency
float	ModFrequency
float	ExternalModFrequency
float	Q
float	ModQ
float	BaseQ
float	ExternalModQ
EFilter::Type	FilterType
FModulationMatrix *	ModMatrix
FPatchDestination	ModCutoffFrequencyDest
FPatchDestination	ModQDest
bool	bChanged

Constructor & Destructor Documentation

IFilter() [1/2]

IFilter< TItemType >::IFilter

(

)

IFilter() [2/2]

IFilter< TItemType >::IFilter ( const IFilter &  )

default

~IFilter()

IFilter< TItemType >::~IFilter ( )

virtualdefault

Member Function Documentation

GetGCoefficient()

float Audio::IFilter::GetGCoefficient ( ) const

inlineprotected

GetModDestCutoffFrequency()

FPatchDestination Audio::IFilter::GetModDestCutoffFrequency ( ) const

inline

GetModDestQ()

FPatchDestination Audio::IFilter::GetModDestQ ( ) const

inline

Init()

void IFilter< TItemType >::Init ( const float  InSampleRate, const int32  InNumChannels, const int32  InVoiceId, FModulationMatrix *  InModMatrix = nullptr  )

virtual

Reimplemented in Audio::FOnePoleFilter, Audio::FStateVariableFilter, and Audio::FLadderFilter.

ProcessAudio() [1/2]

virtual void Audio::IFilter::ProcessAudio ( const float *const *  InBuffers, const int32  InNumSamples, float *const *  OutBuffers  )

pure virtual

Implemented in Audio::FOnePoleFilter, Audio::FStateVariableFilter, and Audio::FLadderFilter.

ProcessAudio() [2/2]

virtual void Audio::IFilter::ProcessAudio ( const float *  InBuffer, const int32  InNumSamples, float *  OutBuffer  )

pure virtual

Implemented in Audio::FOnePoleFilter, Audio::FStateVariableFilter, and Audio::FLadderFilter.

ProcessAudioFrame()

virtual void Audio::IFilter::ProcessAudioFrame ( const float *  InFrame, float *  OutFrame  )

inlinevirtual

Reimplemented in Audio::FOnePoleFilter.

Reset()

void IFilter< TItemType >::Reset ( )

virtual

Reimplemented in Audio::FOnePoleFilter, Audio::FStateVariableFilter, and Audio::FLadderFilter.

SetBandStopControl()

virtual void Audio::IFilter::SetBandStopControl ( const float  InBandStop )

inlinevirtual

Reimplemented in Audio::FStateVariableFilter.

SetFilterType()

void IFilter< TItemType >::SetFilterType ( const EFilter::Type  InFilterType )

virtual

SetFrequency()

void IFilter< TItemType >::SetFrequency ( const float  InCutoffFrequency )

virtual

SetFrequencyMod()

void IFilter< TItemType >::SetFrequencyMod ( const float  InModFrequency )

virtual

SetPassBandGainCompensation()

virtual void Audio::IFilter::SetPassBandGainCompensation ( const float  InPassBandGainCompensation )

inlinevirtual

Reimplemented in Audio::FLadderFilter.

SetQ()

void IFilter< TItemType >::SetQ ( const float  InQ )

virtual

Reimplemented in Audio::FLadderFilter.

SetQMod()

void IFilter< TItemType >::SetQMod ( const float  InModQ )

virtual

SetSaturation()

virtual void Audio::IFilter::SetSaturation ( const float  InSaturation )

inlinevirtual

Update()

void IFilter< TItemType >::Update ( )

virtual

Reimplemented in Audio::FOnePoleFilter, Audio::FStateVariableFilter, and Audio::FLadderFilter.

Member Data Documentation

BaseFrequency

float Audio::IFilter::BaseFrequency

protected

BaseQ

float Audio::IFilter::BaseQ

protected

bChanged

bool Audio::IFilter::bChanged

protected

ExternalModFrequency

float Audio::IFilter::ExternalModFrequency

protected

ExternalModQ

float Audio::IFilter::ExternalModQ

protected

FilterType

EFilter::Type Audio::IFilter::FilterType

protected

Frequency

float Audio::IFilter::Frequency

protected

ModCutoffFrequencyDest

FPatchDestination Audio::IFilter::ModCutoffFrequencyDest

protected

ModFrequency

float Audio::IFilter::ModFrequency

protected

ModMatrix

FModulationMatrix* Audio::IFilter::ModMatrix

protected

ModQ

float Audio::IFilter::ModQ

protected

ModQDest

FPatchDestination Audio::IFilter::ModQDest

protected

NumChannels

int32 Audio::IFilter::NumChannels

protected

Q

float Audio::IFilter::Q

protected

SampleRate

float Audio::IFilter::SampleRate

protected

VoiceId

int32 Audio::IFilter::VoiceId

protected

---

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

• Engine/Source/Runtime/SignalProcessing/Public/DSP/Filter.h
• Engine/Source/Runtime/SignalProcessing/Private/Filter.cpp