Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
IIRFilterBase< Mutex > Class Template Reference

An IIR filter that can perform low, high, or band-pass filtering on an audio signal. More...

#include <juce_IIRFilter.h>

Public Member Functions

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

Protected Member Functions

IIRFilteroperator= (const IIRFilter &)=delete
 

Protected Attributes

Mutex processLock
 
IIRCoefficients coefficients
 
float v1 = 0
 
float v2 = 0
 
bool active = false
 

Detailed Description

template<typename Mutex>
class IIRFilterBase< Mutex >

An IIR filter that can perform low, high, or band-pass filtering on an audio signal.

See also
IIRCoefficient, IIRFilterAudioSource

Constructor & Destructor Documentation

◆ IIRFilterBase() [1/2]

template<typename Mutex >
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]

template<typename Mutex >
IIRFilterBase< Mutex >::IIRFilterBase ( const IIRFilterBase< Mutex > & )
noexcept

Creates a copy of another filter.

Member Function Documentation

◆ makeInactive()

template<typename Mutex >
void IIRFilterBase< Mutex >::makeInactive ( )
noexcept

Clears the filter so that any incoming data passes through unchanged.

◆ setCoefficients()

template<typename Mutex >
void IIRFilterBase< Mutex >::setCoefficients ( const IIRCoefficients & newCoefficients)
noexcept

Applies a set of coefficients to this filter.

◆ getCoefficients()

template<typename Mutex >
IIRCoefficients IIRFilterBase< Mutex >::getCoefficients ( ) const
noexcept

Returns the coefficients that this filter is using.

◆ reset()

template<typename Mutex >
void IIRFilterBase< Mutex >::reset ( )
noexcept

Resets the filter's processing pipeline, ready to start a new stream of data.

Note that this clears the processing state, but the type of filter and its coefficients aren't changed. To put a filter into an inactive state, use the makeInactive() method.

◆ processSamples()

template<typename Mutex >
void IIRFilterBase< Mutex >::processSamples ( float * samples,
int numSamples )
noexcept

Performs the filter operation on the given set of samples.

◆ processSingleSampleRaw()

template<typename Mutex >
float IIRFilterBase< Mutex >::processSingleSampleRaw ( float sample)
noexcept

Processes a single sample, without any locking or checking.

Use this if you need fast processing of a single value, but be aware that this isn't thread-safe in the way that processSamples() is.

◆ operator=()

template<typename Mutex >
IIRFilter & IIRFilterBase< Mutex >::operator= ( const IIRFilter & )
protecteddelete

Member Data Documentation

◆ processLock

template<typename Mutex >
Mutex IIRFilterBase< Mutex >::processLock
protected

◆ coefficients

template<typename Mutex >
IIRCoefficients IIRFilterBase< Mutex >::coefficients
protected

◆ v1

template<typename Mutex >
float IIRFilterBase< Mutex >::v1 = 0
protected

◆ v2

template<typename Mutex >
float IIRFilterBase< Mutex >::v2 = 0
protected

◆ active

template<typename Mutex >
bool IIRFilterBase< Mutex >::active = false
protected

The documentation for this class was generated from the following file:
linkedin facebook pinterest youtube rss twitter instagram facebook-blank rss-blank linkedin-blank pinterest youtube twitter instagram