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"

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
IIRFilter &	operator= (const IIRFilter &)=delete

Protected Attributes
Mutex	processLock
IIRCoefficients	coefficients
float	v1
float	v2
bool	active

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}

Definition at line 157 of file juce_IIRFilter.h.

Constructor & Destructor Documentation

IIRFilterBase() [1/2]

template<typename Mutex >

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

defaultnoexcept

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 > &  other )

noexcept

Creates a copy of another filter.

Definition at line 267 of file juce_IIRFilter.cpp.

Member Function Documentation

getCoefficients()

template<typename Mutex >

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

noexcept

Returns the coefficients that this filter is using.

Definition at line 180 of file juce_IIRFilter.h.

makeInactive()

template<typename Mutex >

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

noexcept

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

Definition at line 275 of file juce_IIRFilter.cpp.

processSamples()

template<typename Mutex >

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

noexcept

Performs the filter operation on the given set of samples.

Definition at line 311 of file juce_IIRFilter.cpp.

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.

Definition at line 298 of file juce_IIRFilter.cpp.

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.

Definition at line 291 of file juce_IIRFilter.cpp.

setCoefficients()

template<typename Mutex >

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

noexcept

Applies a set of coefficients to this filter.

Definition at line 282 of file juce_IIRFilter.cpp.

Member Data Documentation

active

template<typename Mutex >

bool juce::IIRFilterBase< Mutex >::active

protected

Definition at line 206 of file juce_IIRFilter.h.

coefficients

template<typename Mutex >

IIRCoefficients juce::IIRFilterBase< Mutex >::coefficients

protected

Definition at line 204 of file juce_IIRFilter.h.

processLock

template<typename Mutex >

Mutex juce::IIRFilterBase< Mutex >::processLock

protected

Definition at line 203 of file juce_IIRFilter.h.

v1

template<typename Mutex >

float juce::IIRFilterBase< Mutex >::v1

protected

Definition at line 205 of file juce_IIRFilter.h.

v2

template<typename Mutex >

float juce::IIRFilterBase< Mutex >::v2

protected

Definition at line 205 of file juce_IIRFilter.h.

---

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

• juce_audio_basics/utilities/juce_IIRFilter.h
• juce_audio_basics/utilities/juce_IIRFilter.cpp