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

#include <juce_IIRFilter.h>

Inheritance diagram for juce::SingleThreadedIIRFilter:

[legend]

Collaboration diagram for juce::SingleThreadedIIRFilter:

[legend]

Public Member Functions
IIRCoefficients	getCoefficients () const noexcept
	Returns the coefficients that this filter is using.

	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	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.

void	reset () noexcept
	Resets the filter's processing pipeline, ready to start a new stream of data.

void	setCoefficients (const IIRCoefficients &newCoefficients) noexcept
	Applies a set of coefficients to this filter.

Protected Attributes
bool	active

IIRCoefficients	coefficients

DummyCriticalSection	processLock

float	v1

float	v2

Detailed Description

An IIR filter that can perform low, high, or band-pass filtering on an audio signal, with no thread-safety guarantees.

You should use this class if you need an IIR filter, and don't plan to call its member functions from multiple threads at once.

See also: IIRFilter, IIRCoefficient, IIRFilterAudioSource

@tags{Audio}

Member Function Documentation

◆ getCoefficients()

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

inlinenoexceptinherited

Returns the coefficients that this filter is using.

◆ IIRFilterBase() [1/2]

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]

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

noexcept

Creates a copy of another filter.

◆ makeInactive()

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

noexceptinherited

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

◆ processSamples()

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

noexceptinherited

Performs the filter operation on the given set of samples.

◆ processSingleSampleRaw()

float juce::IIRFilterBase< DummyCriticalSection >::processSingleSampleRaw ( float sample )

noexceptinherited

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()

void juce::IIRFilterBase< DummyCriticalSection >::reset ( )

noexceptinherited

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.