Public Member Functions | List of all members
IIRFilter Class Reference

An IIR filter that can perform low, high, or band-pass filtering on an audio signal, and which attempts to implement basic thread-safety. More...

Inheritance diagram for IIRFilter:

Public Member Functions

 IIRFilterBase () noexcept
 Creates a filter. More...
 
 IIRFilterBase (const IIRFilterBase &) noexcept
 Creates a copy of another filter. More...
 
- Public Member Functions inherited from IIRFilterBase< SpinLock >
 IIRFilterBase () noexcept
 Creates a filter. More...
 
 IIRFilterBase (const IIRFilterBase &) noexcept
 Creates a copy of another filter. More...
 
void makeInactive () noexcept
 Clears the filter so that any incoming data passes through unchanged. More...
 
void setCoefficients (const IIRCoefficients &newCoefficients) noexcept
 Applies a set of coefficients to this filter. More...
 
IIRCoefficients getCoefficients () const noexcept
 Returns the coefficients that this filter is using. More...
 
void reset () noexcept
 Resets the filter's processing pipeline, ready to start a new stream of data. More...
 
void processSamples (float *samples, int numSamples) noexcept
 Performs the filter operation on the given set of samples. More...
 
float processSingleSampleRaw (float sample) noexcept
 Processes a single sample, without any locking or checking. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IIRFilterBase< SpinLock >
IIRFilteroperator= (const IIRFilter &)=delete
 
- Protected Attributes inherited from IIRFilterBase< SpinLock >
SpinLock processLock
 
IIRCoefficients coefficients
 
float v1
 
float v2
 
bool active
 

Detailed Description

An IIR filter that can perform low, high, or band-pass filtering on an audio signal, and which attempts to implement basic thread-safety.

This class synchronises calls to some of its member functions, making it safe (although not necessarily real-time-safe) to reset the filter or apply new coefficients while the filter is processing on another thread. In most cases this style of internal locking should not be used, and you should attempt to provide thread-safety at a higher level in your program. If you can guarantee that calls to the filter will be synchronised externally, you could consider switching to SingleThreadedIIRFilter instead.

See also
SingleThreadedIIRFilter, IIRCoefficient, IIRFilterAudioSource

Member Function Documentation

◆ IIRFilterBase() [1/2]

IIRFilterBase< Mutex >::IIRFilterBase
noexcept

Creates a filter.

Initially the filter is inactive, so will have no effect on samples that you process with it. Use the setCoefficients() method to turn it into the type of filter needed.

◆ IIRFilterBase() [2/2]

IIRFilterBase< Mutex >::IIRFilterBase
noexcept

Creates a copy of another filter.


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