StateVariableFilter::Filter< SampleType > Class Template Reference

#include <juce_StateVariableFilter.h>

Collaboration diagram for StateVariableFilter::Filter< SampleType >:

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...
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...
void	reset () noexcept
	Resets the filter's processing pipeline. More...

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

Private Member Functions
template<typename Parameters< NumericType >::Type type>
void	processBlock (const SampleType *input, SampleType *output, size_t n) noexcept
template<typename Parameters< NumericType >::Type type>
SampleType JUCE_VECTOR_CALLTYPE	processLoop (SampleType sample, Parameters< NumericType > &state) noexcept

Private Attributes
SampleType	s1
SampleType	s2
std::array< SampleType, 3 >	y

Member Typedef Documentation

NumericType

template<typename SampleType >

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

StateVariableFilter::Filter< SampleType >::Filter ( )

inline

Creates a filter with default parameters.

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

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

Filter() [2/4]

template<typename SampleType >

StateVariableFilter::Filter< SampleType >::Filter ( Parameters< NumericType > *  paramtersToUse )

inline

References StateVariableFilter::Filter< SampleType >::Filter(), and StateVariableFilter::Filter< SampleType >::reset().

Filter() [3/4]

template<typename SampleType >

StateVariableFilter::Filter< SampleType >::Filter ( const Filter< SampleType > &  )

default

Creates a copy of another filter.

Filter() [4/4]

template<typename SampleType >

StateVariableFilter::Filter< SampleType >::Filter ( Filter< SampleType > &&  )

default

Move constructor.

Member Function Documentation

prepare()

template<typename SampleType >

void StateVariableFilter::Filter< SampleType >::prepare ( const ProcessSpec &  )

inlinenoexcept

Initialization of the filter.

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

process()

template<typename SampleType >

template<typename ProcessContext >

void StateVariableFilter::Filter< SampleType >::process ( const ProcessContext &  context )

inlinenoexcept

References jassert, and jassertfalse.

processBlock()

template<typename SampleType >

template<typename Parameters< NumericType >::Type type>

void StateVariableFilter::Filter< SampleType >::processBlock ( const SampleType *  input, SampleType *  output, size_t  n  )

inlineprivatenoexcept

References StateVariableFilter::Filter< SampleType >::parameters.

processLoop()

template<typename SampleType >

template<typename Parameters< NumericType >::Type type>

SampleType JUCE_VECTOR_CALLTYPE StateVariableFilter::Filter< SampleType >::processLoop ( SampleType  sample, Parameters< NumericType > &  state  )

inlineprivatenoexcept

References StateVariableFilter::Filter< SampleType >::s1, StateVariableFilter::Filter< SampleType >::s2, and StateVariableFilter::Filter< SampleType >::y.

processSample()

template<typename SampleType >

SampleType JUCE_VECTOR_CALLTYPE StateVariableFilter::Filter< SampleType >::processSample ( SampleType  sample )

inlinenoexcept

Processes a single sample, without any locking or checking.

Use this if you need processing of a single value.

References jassertfalse, and StateVariableFilter::Filter< SampleType >::parameters.

reset()

template<typename SampleType >

void StateVariableFilter::Filter< SampleType >::reset ( )

inlinenoexcept

Resets the filter's processing pipeline.

References StateVariableFilter::Filter< SampleType >::s1, and StateVariableFilter::Filter< SampleType >::s2.

Referenced by StateVariableFilter::Filter< SampleType >::Filter(), and StateVariableFilter::Filter< SampleType >::prepare().

Member Data Documentation

parameters

template<typename SampleType >

Parameters<NumericType>::Ptr 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 StateVariableFilter::Filter< SampleType >::processBlock(), and StateVariableFilter::Filter< SampleType >::processSample().

s1

template<typename SampleType >

SampleType StateVariableFilter::Filter< SampleType >::s1

private

Referenced by StateVariableFilter::Filter< SampleType >::processLoop(), and StateVariableFilter::Filter< SampleType >::reset().

s2

template<typename SampleType >

SampleType StateVariableFilter::Filter< SampleType >::s2

private

Referenced by StateVariableFilter::Filter< SampleType >::processLoop(), and StateVariableFilter::Filter< SampleType >::reset().

y

template<typename SampleType >

std::array<SampleType, 3> StateVariableFilter::Filter< SampleType >::y

private

Referenced by StateVariableFilter::Filter< SampleType >::processLoop().

---

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

• juce_StateVariableFilter.h