IAudioSignalProcessor Class Reference

Use this interface for objects that process audio input samples to produce audio output samples. A derived class must implement the three abstract methods. The others are optional. More...

#include <fxobjects.h>

Inheritance diagram for IAudioSignalProcessor:

Public Member Functions
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

Use this interface for objects that process audio input samples to produce audio output samples. A derived class must implement the three abstract methods. The others are optional.

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 IAudioSignalProcessor::canProcessAudioFrame ( )

pure virtual

return true if the derived object can process a frame, false otherwise

Implemented in Biquad, AudioFilter, LRFilterBank, AudioDetector, DynamicsProcessor, ImpulseConvolver, AnalogFIRFilter, AudioDelay, ModulatedDelay, PhaseShifter, SimpleLPF, SimpleDelay, CombFilter, DelayAPF, TwoBandShelvingFilter, ReverbTank, PeakLimiter, ZVAFilter, EnvelopeFollower, TriodeClassA, ClassATubePre, BitCrusher, WDFButterLPF3, WDFTunableButterLPF3, WDFBesselBSF3, WDFConstKBPF6, WDFIdealRLCLPF, WDFIdealRLCHPF, WDFIdealRLCBPF, WDFIdealRLCBSF, and PSMVocoder.

enableAuxInput()

virtual void IAudioSignalProcessor::enableAuxInput ( bool  enableAuxInput )

inlinevirtual

switch to enable/disable the aux input

Reimplemented in DynamicsProcessor.

processAudioFrame()

virtual bool IAudioSignalProcessor::processAudioFrame ( const float *  inputFrame, float *  outputFrame, uint32_t  inputChannels, uint32_t  outputChannels  )

inlinevirtual

for processing objects with a sidechain input or other necessary aux input — optional processing function e.g. does not make sense for some objects to implement this such as inherently mono objects like Biquad BUT a processor that must use both left and right channels (ping-pong delay) would require it

Reimplemented in AudioDelay, ModulatedDelay, and ReverbTank.

processAudioSample()

virtual double IAudioSignalProcessor::processAudioSample ( double  xn )

pure virtual

process one sample in and out

Implemented in PSMVocoder, Biquad, AudioFilter, LRFilterBank, AudioDetector, DynamicsProcessor, ImpulseConvolver, AnalogFIRFilter, AudioDelay, ModulatedDelay, PhaseShifter, SimpleLPF, SimpleDelay, CombFilter, DelayAPF, NestedDelayAPF, TwoBandShelvingFilter, ReverbTank, PeakLimiter, ZVAFilter, EnvelopeFollower, TriodeClassA, ClassATubePre, BitCrusher, WDFButterLPF3, WDFTunableButterLPF3, WDFBesselBSF3, WDFConstKBPF6, WDFIdealRLCLPF, WDFIdealRLCHPF, WDFIdealRLCBPF, and WDFIdealRLCBSF.

processAuxInputAudioSample()

virtual double IAudioSignalProcessor::processAuxInputAudioSample ( double  xn )

inlinevirtual

for processing objects with a sidechain input or other necessary aux input the return value is optional and will depend on the subclassed object

Reimplemented in DynamicsProcessor.

reset()

virtual bool IAudioSignalProcessor::reset ( double  _sampleRate )

pure virtual

initialize the object with the new sample rate

Implemented in Biquad, AudioFilter, LRFilterBank, AudioDetector, DynamicsProcessor, ImpulseConvolver, AnalogFIRFilter, AudioDelay, ModulatedDelay, PhaseShifter, SimpleLPF, SimpleDelay, CombFilter, DelayAPF, NestedDelayAPF, TwoBandShelvingFilter, ReverbTank, PeakLimiter, ZVAFilter, EnvelopeFollower, TriodeClassA, ClassATubePre, BitCrusher, WDFButterLPF3, WDFTunableButterLPF3, WDFBesselBSF3, WDFConstKBPF6, WDFIdealRLCLPF, WDFIdealRLCHPF, WDFIdealRLCBPF, WDFIdealRLCBSF, and PSMVocoder.

setSampleRate()

virtual void IAudioSignalProcessor::setSampleRate ( double  _sampleRate )

inlinevirtual

set or change the sample rate; normally this is done during reset( ) but may be needed outside of initialzation

Reimplemented in AudioFilter, and AudioDetector.

---

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

• C:/RackAFX_v7/ASPIK_Doxygen/PluginObjects/fxobjects.h