juce::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>

Inheritance diagram for juce::IIRFilterBase< Mutex >:

Collaboration diagram for juce::IIRFilterBase< Mutex >:

Public Member Functions
	IIRFilterBase () noexcept
	Creates a filter. More...
	IIRFilterBase (const IIRFilterBase &) noexcept
	Creates a copy of another filter. More...
IIRCoefficients	getCoefficients () const noexcept
	Returns the coefficients that this filter is using. More...
void	makeInactive () noexcept
	Clears the filter so that any incoming data passes through unchanged. 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...
void	reset () noexcept
	Resets the filter's processing pipeline, ready to start a new stream of data. More...
void	setCoefficients (const IIRCoefficients &newCoefficients) noexcept
	Applies a set of coefficients to this filter. More...

Protected Member Functions
IIRFilter &	operator= (const IIRFilter &)=delete

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

Detailed Description

template<typename Mutex>
class juce::IIRFilterBase< Mutex >

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

See also

IIRCoefficient, IIRFilterAudioSource

@tags{Audio}

Constructor & Destructor Documentation

IIRFilterBase() [1/2]

template<typename Mutex >

juce::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 >

juce::IIRFilterBase< Mutex >::IIRFilterBase ( const IIRFilterBase< Mutex > &  )

noexcept

Creates a copy of another filter.

Member Function Documentation

getCoefficients()

template<typename Mutex >

IIRCoefficients juce::IIRFilterBase< Mutex >::getCoefficients ( ) const

inlinenoexcept

Returns the coefficients that this filter is using.

makeInactive()

template<typename Mutex >

void juce::IIRFilterBase< Mutex >::makeInactive ( )

noexcept

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

operator=()

template<typename Mutex >

IIRFilter& juce::IIRFilterBase< Mutex >::operator= ( const IIRFilter &  )

protecteddelete

processSamples()

template<typename Mutex >

void juce::IIRFilterBase< Mutex >::processSamples ( float *  samples, int  numSamples  )

noexcept

Performs the filter operation on the given set of samples.

processSingleSampleRaw()

template<typename Mutex >

float juce::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.

reset()

template<typename Mutex >

void juce::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.

setCoefficients()

template<typename Mutex >

void juce::IIRFilterBase< Mutex >::setCoefficients ( const IIRCoefficients &  newCoefficients )

noexcept

Applies a set of coefficients to this filter.

Member Data Documentation

active

template<typename Mutex >

bool juce::IIRFilterBase< Mutex >::active = false

protected

coefficients

template<typename Mutex >

IIRCoefficients juce::IIRFilterBase< Mutex >::coefficients

protected

processLock

template<typename Mutex >

Mutex juce::IIRFilterBase< Mutex >::processLock

protected

v1

template<typename Mutex >

float juce::IIRFilterBase< Mutex >::v1 = 0

protected

v2

template<typename Mutex >

float juce::IIRFilterBase< Mutex >::v2 = 0

protected

---

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

• juce_audio_basics/utilities/juce_IIRFilter.h