dsp::StateVariableFilter::Filter< SampleType > Class Template Reference

Public Types

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 ()
 Creates a filter with default parameters. More...
 
 Filter (Parameters< NumericType > *paramtersToUse)
 
 Filter (const Filter &)=default
 Creates a copy of another filter. More...
 
 Filter (Filter &&)=default
 Move constructor. More...
 
void prepare (const ProcessSpec &) noexcept
 Initialization of the filter. More...
 
void reset () noexcept
 Resets the filter's processing pipeline. More...
 
void snapToZero () noexcept
 Ensure that the state variables are rounded to zero if the state variables are denormals. More...
 
template<typename ProcessContext >
void process (const ProcessContext &context) noexcept
 
SampleType JUCE_VECTOR_CALLTYPE processSample (SampleType sample) noexcept
 Processes a single sample, without any locking or checking. More...
 

Public Attributes

Parameters< NumericType >::Ptr parameters
 The parameters of the state variable filter. More...
 

Member Typedef Documentation

◆ NumericType

template<typename SampleType >
using dsp::StateVariableFilter::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 >
dsp::StateVariableFilter::Filter< SampleType >::Filter ( )

◆ Filter() [2/4]

◆ Filter() [3/4]

template<typename SampleType >
dsp::StateVariableFilter::Filter< SampleType >::Filter ( const Filter< SampleType > &  )
default

Creates a copy of another filter.

◆ Filter() [4/4]

template<typename SampleType >
dsp::StateVariableFilter::Filter< SampleType >::Filter ( Filter< SampleType > &&  )
default

Move constructor.

Member Function Documentation

◆ prepare()

template<typename SampleType >
void dsp::StateVariableFilter::Filter< SampleType >::prepare ( const ProcessSpec )
noexcept

Initialization of the filter.

References dsp::StateVariableFilter::Filter< SampleType >::reset().

◆ reset()

template<typename SampleType >
void dsp::StateVariableFilter::Filter< SampleType >::reset ( )
noexcept

◆ snapToZero()

template<typename SampleType >
void dsp::StateVariableFilter::Filter< SampleType >::snapToZero ( )
noexcept

Ensure that the state variables are rounded to zero if the state variables are denormals.

This is only needed if you are doing sample by sample processing.

Referenced by dsp::StateVariableFilter::Filter< SampleType >::processSample().

◆ process()

template<typename SampleType >
template<typename ProcessContext >
void dsp::StateVariableFilter::Filter< SampleType >::process ( const ProcessContext &  context)
noexcept

References jassert, and jassertfalse.

◆ processSample()

template<typename SampleType >
SampleType JUCE_VECTOR_CALLTYPE dsp::StateVariableFilter::Filter< SampleType >::processSample ( SampleType  sample)
noexcept

Member Data Documentation

◆ parameters

template<typename SampleType >
Parameters<NumericType>::Ptr dsp::StateVariableFilter::Filter< SampleType >::parameters

The parameters of the state variable filter.

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

Referenced by dsp::StateVariableFilter::Filter< SampleType >::processSample().


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