Filter< T > Class Template Reference

Abstract filter interface definition. Subclasses implement process() to transform audio samples one at a time. Use reset() to clear internal state (e.g. delay lines) without changing the filter coefficients. More...

#include <Filter.h>

Inheritance diagram for Filter< T >:

Public Member Functions
	Filter ()=default
	Filter (Filter const &)=delete
virtual	~Filter ()=default
Filter &	operator= (Filter const &)=delete
virtual T	process (T in)=0
	Processes the input value and returns the filtered output value.
virtual void	reset ()

Detailed Description

template<typename T>
class audio_tools::Filter< T >

Abstract filter interface definition. Subclasses implement process() to transform audio samples one at a time. Use reset() to clear internal state (e.g. delay lines) without changing the filter coefficients.

Author

pschatzmann

Template Parameters

T	sample type (e.g. int16_t, float, double)

Constructor & Destructor Documentation

Filter() [1/2]

template<typename T >

Filter ( )

default

~Filter()

template<typename T >

virtual ~Filter ( )

virtualdefault

Filter() [2/2]

template<typename T >

Filter ( Filter< T > const &  )

delete

Member Function Documentation

operator=()

template<typename T >

Filter & operator= ( Filter< T > const &  )

delete

process()

template<typename T >

virtual T process ( T  in )

pure virtual

Processes the input value and returns the filtered output value.

Implemented in EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >::EQFIRFilter, NoFilter< T >, MedianFilter< T >, FIR< T >, IIR< T >, BiQuadDF1< T >, BiQuadDF2< T >, SOSFilter< T, N >, and FilterChain< T, N >.

reset()

template<typename T >

virtual void reset ( )

inlinevirtual

Clears the internal state (delay lines) without changing the coefficients. Call after reconfiguring filter parameters via begin() to avoid transients from stale state.

Reimplemented in FIR< T >, IIR< T >, BiQuadDF1< T >, BiQuadDF2< T >, BiQuadDF2< float >, SOSFilter< T, N >, and FilterChain< T, N >.

---

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

• src/AudioTools/CoreAudio/AudioFilter/Filter.h