ASPiK SDK
Loading...
Searching...
No Matches
TwoBandShelvingFilter Class Reference

The TwoBandShelvingFilter object implements two shelving filters in series in the standard "Bass and Treble" configuration. More...

#include <fxobjects.h>

Inheritance diagram for TwoBandShelvingFilter:
IAudioSignalProcessor

Public Member Functions

virtual bool reset (double _sampleRate)
 
virtual bool canProcessAudioFrame ()
 
virtual double processAudioSample (double xn)
 
TwoBandShelvingFilterParameters getParameters ()
 
void setParameters (const TwoBandShelvingFilterParameters &params)
 
- Public Member Functions inherited from IAudioSignalProcessor
virtual bool reset (double _sampleRate)=0
 
virtual double processAudioSample (double xn)=0
 
virtual bool canProcessAudioFrame ()=0
 
virtual void setSampleRate (double _sampleRate)
 
virtual void enableAuxInput (bool enableAuxInput)
 
virtual double processAuxInputAudioSample (double xn)
 
virtual bool processAudioFrame (const float *inputFrame, float *outputFrame, uint32_t inputChannels, uint32_t outputChannels)
 

Detailed Description

The TwoBandShelvingFilter object implements two shelving filters in series in the standard "Bass and Treble" configuration.

Audio I/O:

  • Processes mono input to mono output.

Control I/F:

Author
Will Pirkle http://www.willpirkle.com
Remarks
This object is included in Designing Audio Effects Plugins in C++ 2nd Ed. by Will Pirkle
Version
Revision : 1.0
Date
Date : 2018 / 09 / 7

Member Function Documentation

◆ canProcessAudioFrame()

virtual bool TwoBandShelvingFilter::canProcessAudioFrame ( )
inlinevirtual

return false: this object only processes samples

Implements IAudioSignalProcessor.

◆ getParameters()

TwoBandShelvingFilterParameters TwoBandShelvingFilter::getParameters ( )
inline

get parameters: note use of custom structure for passing param data

Returns
TwoBandShelvingFilterParameters custom data structure

◆ processAudioSample()

virtual double TwoBandShelvingFilter::processAudioSample ( double  xn)
inlinevirtual

process a single input through the two filters in series

Parameters
xninput
Returns
the processed sample

Implements IAudioSignalProcessor.

◆ reset()

virtual bool TwoBandShelvingFilter::reset ( double  _sampleRate)
inlinevirtual

reset members to initialized state

Implements IAudioSignalProcessor.

◆ setParameters()

void TwoBandShelvingFilter::setParameters ( const TwoBandShelvingFilterParameters params)
inline

set parameters: note use of custom structure for passing param data

Parameters
TwoBandShelvingFilterParameterscustom data structure

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