A processing class that can perform FIR filtering on an audio signal, in the time domain. More...

#include <juce_FIRFilter.h>

Collaboration diagram for juce::dsp::FIR::Filter< SampleType >:

[legend]

Public Types
using	CoefficientsPtr = typename Coefficients< NumericType >::Ptr
	A typedef for a ref-counted pointer to the coefficients object. More...

using	NumericType = typename SampleTypeHelpers::ElementType< SampleType >::Type
	The NumericType is the underlying primitive type used by the SampleType (which could be either a primitive or vector) More...

Public Member Functions
	Filter ()
	This will create a filter which will produce silence. More...

	Filter (CoefficientsPtr coefficientsToUse)
	Creates a filter with a given set of coefficients. More...

	Filter (const Filter &)=default

	Filter (Filter &&)=default

Filter &	operator= (const Filter &)=default

Filter &	operator= (Filter &&)=default

void	prepare (const ProcessSpec &spec) noexcept
	Prepare this filter for processing. More...

template<typename ProcessContext >
void	process (const ProcessContext &context) noexcept
	Processes a block of samples. More...

SampleType JUCE_VECTOR_CALLTYPE	processSample (SampleType sample) noexcept
	Processes a single sample, without any locking. More...

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

Public Attributes
Coefficients< NumericType >::Ptr	coefficients
	The coefficients of the FIR filter. More...

Private Member Functions
void	check ()

Static Private Member Functions
static SampleType JUCE_VECTOR_CALLTYPE	processSingleSample (SampleType sample, SampleType buf, const NumericType fir, size_t m, size_t &p) noexcept

Private Attributes
SampleType *	fifo = nullptr

HeapBlock< SampleType >	memory

size_t	pos = 0

size_t	size = 0

Detailed Description

template<typename SampleType>
class juce::dsp::FIR::Filter< SampleType >

A processing class that can perform FIR filtering on an audio signal, in the time domain.

Using FIRFilter is fast enough for FIRCoefficients with a size lower than 128 samples. For longer filters, it might be more efficient to use the class Convolution instead, which does the same processing in the frequency domain thanks to FFT.

See also: FIRFilter::Coefficients, Convolution, FFT

@tags{DSP}

Member Typedef Documentation

◆ CoefficientsPtr

template<typename SampleType >

using juce::dsp::FIR::Filter< SampleType >::CoefficientsPtr = typename Coefficients<NumericType>::Ptr

A typedef for a ref-counted pointer to the coefficients object.

◆ NumericType

template<typename SampleType >

using juce::dsp::FIR::Filter< SampleType >::NumericType = typename SampleTypeHelpers::ElementType<SampleType>::Type

The NumericType is the underlying primitive type used by the SampleType (which could be either a primitive or vector)

Constructor & Destructor Documentation

◆ Filter() [1/4]

template<typename SampleType >

juce::dsp::FIR::Filter< SampleType >::Filter ( )

inline

This will create a filter which will produce silence.

References juce::dsp::FIR::Filter< SampleType >::reset().

◆ Filter() [2/4]

template<typename SampleType >

juce::dsp::FIR::Filter< SampleType >::Filter ( CoefficientsPtr coefficientsToUse )

inline

Creates a filter with a given set of coefficients.

References juce::dsp::FIR::Filter< SampleType >::reset().

◆ Filter() [3/4]

template<typename SampleType >

juce::dsp::FIR::Filter< SampleType >::Filter ( const Filter< SampleType > & )

default

◆ Filter() [4/4]

template<typename SampleType >

juce::dsp::FIR::Filter< SampleType >::Filter ( Filter< SampleType > && )

default

Member Function Documentation

◆ check()

template<typename SampleType >

void juce::dsp::FIR::Filter< SampleType >::check ( )

inlineprivate

References juce::dsp::FIR::Filter< SampleType >::coefficients, jassert, juce::dsp::FIR::Filter< SampleType >::reset(), and juce::dsp::FIR::Filter< SampleType >::size.

Referenced by juce::dsp::FIR::Filter< SampleType >::process(), and juce::dsp::FIR::Filter< SampleType >::processSample().

◆ operator=() [1/2]

template<typename SampleType >

Filter& juce::dsp::FIR::Filter< SampleType >::operator= ( const Filter< SampleType > & )

default

◆ operator=() [2/2]

template<typename SampleType >

Filter& juce::dsp::FIR::Filter< SampleType >::operator= ( Filter< SampleType > && )

default

◆ prepare()

template<typename SampleType >

void juce::dsp::FIR::Filter< SampleType >::prepare ( const ProcessSpec & spec )

inlinenoexcept

Prepare this filter for processing.

References jassertquiet, and juce::dsp::FIR::Filter< SampleType >::reset().

◆ process()

template<typename SampleType >

template<typename ProcessContext >

void juce::dsp::FIR::Filter< SampleType >::process ( const ProcessContext & context )

inlinenoexcept

Processes a block of samples.

References juce::dsp::FIR::Filter< SampleType >::check(), juce::dsp::FIR::Filter< SampleType >::coefficients, juce::gl::dst, juce::dsp::FIR::Filter< SampleType >::fifo, jassert, juce::gl::p, juce::dsp::FIR::Filter< SampleType >::pos, juce::dsp::FIR::Filter< SampleType >::processSingleSample(), juce::dsp::FIR::Filter< SampleType >::size, juce::gl::src, and juce::gl::value.

◆ processSample()

template<typename SampleType >

SampleType JUCE_VECTOR_CALLTYPE juce::dsp::FIR::Filter< SampleType >::processSample ( SampleType sample )

inlinenoexcept

Processes a single sample, without any locking.

Use this if you need processing of a single value.

References juce::dsp::FIR::Filter< SampleType >::check(), juce::dsp::FIR::Filter< SampleType >::coefficients, juce::dsp::FIR::Filter< SampleType >::fifo, juce::dsp::FIR::Filter< SampleType >::pos, juce::dsp::FIR::Filter< SampleType >::processSingleSample(), and juce::dsp::FIR::Filter< SampleType >::size.

◆ processSingleSample()

template<typename SampleType >

static SampleType JUCE_VECTOR_CALLTYPE juce::dsp::FIR::Filter< SampleType >::processSingleSample	(	SampleType	sample,
		SampleType *	buf,
		const NumericType *	fir,
		size_t	m,
		size_t &	p
	)

inlinestaticprivatenoexcept

References juce::gl::buf, juce::gl::j, juce::gl::m, and juce::gl::p.

Referenced by juce::dsp::FIR::Filter< SampleType >::process(), and juce::dsp::FIR::Filter< SampleType >::processSample().

◆ reset()

template<typename SampleType >

void juce::dsp::FIR::Filter< SampleType >::reset ( )

inline

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 disable the filter, call setEnabled (false).

References juce::dsp::FIR::Filter< SampleType >::coefficients, juce::dsp::FIR::Filter< SampleType >::fifo, juce::HeapBlock< ElementType, throwOnFailure >::getData(), juce::jmax(), juce::HeapBlock< ElementType, throwOnFailure >::malloc(), juce::dsp::FIR::Filter< SampleType >::memory, juce::dsp::FIR::Filter< SampleType >::size, and juce::snapPointerToAlignment().

Referenced by juce::dsp::FIR::Filter< SampleType >::check(), juce::dsp::FIR::Filter< SampleType >::Filter(), and juce::dsp::FIR::Filter< SampleType >::prepare().

Member Data Documentation

◆ coefficients

template<typename SampleType >

Coefficients<NumericType>::Ptr juce::dsp::FIR::Filter< SampleType >::coefficients

The coefficients of the FIR filter.

It's up to the caller to ensure that these coefficients are modified in a thread-safe way.

If you change the order of the coefficients then you must call reset after modifying them.

Referenced by juce::dsp::FIR::Filter< SampleType >::check(), juce::dsp::FIR::Filter< SampleType >::process(), juce::dsp::FIR::Filter< SampleType >::processSample(), and juce::dsp::FIR::Filter< SampleType >::reset().

◆ fifo

template<typename SampleType >

SampleType* juce::dsp::FIR::Filter< SampleType >::fifo = nullptr

private

Referenced by juce::dsp::FIR::Filter< SampleType >::process(), juce::dsp::FIR::Filter< SampleType >::processSample(), and juce::dsp::FIR::Filter< SampleType >::reset().

◆ memory

template<typename SampleType >

HeapBlock<SampleType> juce::dsp::FIR::Filter< SampleType >::memory

private

Referenced by juce::dsp::FIR::Filter< SampleType >::reset().

◆ pos

template<typename SampleType >

size_t juce::dsp::FIR::Filter< SampleType >::pos = 0

private

Referenced by juce::dsp::FIR::Filter< SampleType >::process(), and juce::dsp::FIR::Filter< SampleType >::processSample().

◆ size

template<typename SampleType >

size_t juce::dsp::FIR::Filter< SampleType >::size = 0

private

Referenced by juce::dsp::FIR::Filter< SampleType >::check(), juce::dsp::FIR::Filter< SampleType >::process(), juce::dsp::FIR::Filter< SampleType >::processSample(), and juce::dsp::FIR::Filter< SampleType >::reset().

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

juce_FIRFilter.h

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

template<typename SampleType> class juce::dsp::FIR::Filter< SampleType >

Member Typedef Documentation

◆ CoefficientsPtr

◆ NumericType

Constructor & Destructor Documentation

◆ Filter() [1/4]

◆ Filter() [2/4]

◆ Filter() [3/4]

◆ Filter() [4/4]

Member Function Documentation

◆ check()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ prepare()

◆ process()

◆ processSample()

◆ processSingleSample()

◆ reset()

Member Data Documentation

◆ coefficients

◆ fifo

◆ memory

◆ pos

◆ size

template<typename SampleType>
class juce::dsp::FIR::Filter< SampleType >