Multi-mode filter based on the Moog ladder filter. More...

#include <juce_LadderFilter.h>

Collaboration diagram for juce::dsp::LadderFilter< SampleType >:

[legend]

Public Types
using	Mode = LadderFilterMode

Public Member Functions
	LadderFilter ()
	Creates an uninitialised filter. More...

size_t	getNumChannels () const noexcept
	Returns the current number of channels. More...

void	prepare (const ProcessSpec &spec)
	Initialises the filter. More...

template<typename ProcessContext >
void	process (const ProcessContext &context) noexcept

void	reset () noexcept
	Resets the internal state variables of the filter. More...

void	setCutoffFrequencyHz (SampleType newCutoff) noexcept
	Sets the cutoff frequency of the filter. More...

void	setDrive (SampleType newDrive) noexcept
	Sets the amount of saturation in the filter. More...

void	setEnabled (bool isEnabled) noexcept
	Enables or disables the filter. More...

void	setMode (Mode newMode) noexcept
	Sets filter mode. More...

void	setResonance (SampleType newResonance) noexcept
	Sets the resonance of the filter. More...

Protected Member Functions
SampleType	processSample (SampleType inputValue, size_t channelToUse) noexcept

void	updateSmoothers () noexcept

Private Member Functions
void	setNumChannels (size_t newValue)

void	setSampleRate (SampleType newValue) noexcept

void	updateCutoffFreq () noexcept

void	updateResonance () noexcept

Private Attributes
std::array< SampleType, numStates >	A

SampleType	comp

SampleType	cutoffFreqHz { SampleType (200) }

SampleType	cutoffFreqScaler

SmoothedValue< SampleType >	cutoffTransformSmoother

SampleType	cutoffTransformValue

SampleType	drive

SampleType	drive2

bool	enabled = true

SampleType	gain

SampleType	gain2

Mode	mode

SampleType	resonance

LookupTableTransform< SampleType >	saturationLUT

SmoothedValue< SampleType >	scaledResonanceSmoother

SampleType	scaledResonanceValue

std::vector< std::array< SampleType, numStates > >	state

Static Private Attributes
static constexpr size_t	numStates = 5

Detailed Description

template<typename SampleType>
class juce::dsp::LadderFilter< SampleType >

Multi-mode filter based on the Moog ladder filter.

@tags{DSP}

Member Typedef Documentation

◆ Mode

template<typename SampleType >

using juce::dsp::LadderFilter< SampleType >::Mode = LadderFilterMode

Constructor & Destructor Documentation

◆ LadderFilter()

template<typename SampleType >

juce::dsp::LadderFilter< SampleType >::LadderFilter ( )

Creates an uninitialised filter.

Call prepare() before first use.

Member Function Documentation

◆ getNumChannels()

template<typename SampleType >

size_t juce::dsp::LadderFilter< SampleType >::getNumChannels ( ) const

inlinenoexcept

Returns the current number of channels.

References juce::dsp::LadderFilter< SampleType >::state.

Referenced by juce::dsp::LadderFilter< SampleType >::process().

◆ prepare()

template<typename SampleType >

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

Initialises the filter.

◆ process()

template<typename SampleType >

template<typename ProcessContext >

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

inlinenoexcept

References juce::dsp::LadderFilter< SampleType >::enabled, juce::dsp::LadderFilter< SampleType >::getNumChannels(), jassert, juce::gl::n, juce::dsp::LadderFilter< SampleType >::processSample(), and juce::dsp::LadderFilter< SampleType >::updateSmoothers().

◆ processSample()

template<typename SampleType >

SampleType juce::dsp::LadderFilter< SampleType >::processSample	(	SampleType	inputValue,
		size_t	channelToUse
	)

protectednoexcept

Referenced by juce::dsp::LadderFilter< SampleType >::process().

◆ reset()

template<typename SampleType >

void juce::dsp::LadderFilter< SampleType >::reset ( )

noexcept

Resets the internal state variables of the filter.

◆ setCutoffFrequencyHz()

template<typename SampleType >

void juce::dsp::LadderFilter< SampleType >::setCutoffFrequencyHz ( SampleType newCutoff )

noexcept

Sets the cutoff frequency of the filter.

Parameters

newCutoff cutoff frequency in Hz

◆ setDrive()

template<typename SampleType >

void juce::dsp::LadderFilter< SampleType >::setDrive ( SampleType newDrive )

noexcept

Sets the amount of saturation in the filter.

Parameters

newDrive saturation amount; it can be any number greater than or equal to one. Higher values result in more distortion.

◆ setEnabled()

template<typename SampleType >

void juce::dsp::LadderFilter< SampleType >::setEnabled ( bool isEnabled )

inlinenoexcept

Enables or disables the filter.

If disabled it will simply pass through the input signal.

References juce::dsp::LadderFilter< SampleType >::enabled.

◆ setMode()

template<typename SampleType >

void juce::dsp::LadderFilter< SampleType >::setMode ( Mode newMode )

noexcept

Sets filter mode.

◆ setNumChannels()

template<typename SampleType >

void juce::dsp::LadderFilter< SampleType >::setNumChannels ( size_t newValue )

inlineprivate

References juce::dsp::LadderFilter< SampleType >::state.

◆ setResonance()

template<typename SampleType >

void juce::dsp::LadderFilter< SampleType >::setResonance ( SampleType newResonance )

noexcept

Sets the resonance of the filter.

Parameters

newResonance a value between 0 and 1; higher values increase the resonance and can result in self oscillation!

◆ setSampleRate()

template<typename SampleType >

void juce::dsp::LadderFilter< SampleType >::setSampleRate ( SampleType newValue )

privatenoexcept

◆ updateCutoffFreq()

template<typename SampleType >

void juce::dsp::LadderFilter< SampleType >::updateCutoffFreq ( )

inlineprivatenoexcept

References juce::dsp::LadderFilter< SampleType >::cutoffFreqHz, juce::dsp::LadderFilter< SampleType >::cutoffFreqScaler, juce::dsp::LadderFilter< SampleType >::cutoffTransformSmoother, and juce::SmoothedValue< FloatType, SmoothingType >::setTargetValue().

◆ updateResonance()

template<typename SampleType >

void juce::dsp::LadderFilter< SampleType >::updateResonance ( )

inlineprivatenoexcept

References juce::jmap(), juce::dsp::LadderFilter< SampleType >::resonance, juce::dsp::LadderFilter< SampleType >::scaledResonanceSmoother, and juce::SmoothedValue< FloatType, SmoothingType >::setTargetValue().

◆ updateSmoothers()

template<typename SampleType >

void juce::dsp::LadderFilter< SampleType >::updateSmoothers ( )

protectednoexcept

Referenced by juce::dsp::LadderFilter< SampleType >::process().

Member Data Documentation

◆ A

template<typename SampleType >

std::array<SampleType, numStates> juce::dsp::LadderFilter< SampleType >::A

private

◆ comp

template<typename SampleType >

SampleType juce::dsp::LadderFilter< SampleType >::comp

private

◆ cutoffFreqHz

template<typename SampleType >

SampleType juce::dsp::LadderFilter< SampleType >::cutoffFreqHz { SampleType (200) }

private

Referenced by juce::dsp::LadderFilter< SampleType >::updateCutoffFreq().

◆ cutoffFreqScaler

template<typename SampleType >

SampleType juce::dsp::LadderFilter< SampleType >::cutoffFreqScaler

private

Referenced by juce::dsp::LadderFilter< SampleType >::updateCutoffFreq().

◆ cutoffTransformSmoother

template<typename SampleType >

SmoothedValue<SampleType> juce::dsp::LadderFilter< SampleType >::cutoffTransformSmoother

private

Referenced by juce::dsp::LadderFilter< SampleType >::updateCutoffFreq().

◆ cutoffTransformValue

template<typename SampleType >

SampleType juce::dsp::LadderFilter< SampleType >::cutoffTransformValue

private

◆ drive

template<typename SampleType >

SampleType juce::dsp::LadderFilter< SampleType >::drive

private

◆ drive2

template<typename SampleType >

SampleType juce::dsp::LadderFilter< SampleType >::drive2

private

◆ enabled

template<typename SampleType >

bool juce::dsp::LadderFilter< SampleType >::enabled = true

private

Referenced by juce::dsp::LadderFilter< SampleType >::process(), and juce::dsp::LadderFilter< SampleType >::setEnabled().

◆ gain

template<typename SampleType >

SampleType juce::dsp::LadderFilter< SampleType >::gain

private

◆ gain2

template<typename SampleType >

SampleType juce::dsp::LadderFilter< SampleType >::gain2

private

◆ mode

template<typename SampleType >

Mode juce::dsp::LadderFilter< SampleType >::mode

private

◆ numStates

template<typename SampleType >

constexpr size_t juce::dsp::LadderFilter< SampleType >::numStates = 5

staticconstexprprivate

◆ resonance

template<typename SampleType >

SampleType juce::dsp::LadderFilter< SampleType >::resonance

private

Referenced by juce::dsp::LadderFilter< SampleType >::updateResonance().

◆ saturationLUT

template<typename SampleType >

LookupTableTransform<SampleType> juce::dsp::LadderFilter< SampleType >::saturationLUT

private

Initial value:

{ [] (SampleType x) { return std::tanh (x); },

SampleType (-5), SampleType (5), 128 }

◆ scaledResonanceSmoother

template<typename SampleType >

SmoothedValue<SampleType> juce::dsp::LadderFilter< SampleType >::scaledResonanceSmoother

private

Referenced by juce::dsp::LadderFilter< SampleType >::updateResonance().

◆ scaledResonanceValue

template<typename SampleType >

SampleType juce::dsp::LadderFilter< SampleType >::scaledResonanceValue

private

◆ state

template<typename SampleType >

std::vector<std::array<SampleType, numStates> > juce::dsp::LadderFilter< SampleType >::state

private

Referenced by juce::dsp::LadderFilter< SampleType >::getNumChannels(), and juce::dsp::LadderFilter< SampleType >::setNumChannels().

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

juce_LadderFilter.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

template<typename SampleType> class juce::dsp::LadderFilter< SampleType >

Member Typedef Documentation

◆ Mode

Constructor & Destructor Documentation

◆ LadderFilter()

Member Function Documentation

◆ getNumChannels()

◆ prepare()

◆ process()

◆ processSample()

◆ reset()

◆ setCutoffFrequencyHz()

◆ setDrive()

◆ setEnabled()

◆ setMode()

◆ setNumChannels()

◆ setResonance()

◆ setSampleRate()

◆ updateCutoffFreq()

◆ updateResonance()

◆ updateSmoothers()

Member Data Documentation

◆ A

◆ comp

◆ cutoffFreqHz

◆ cutoffFreqScaler

◆ cutoffTransformSmoother

◆ cutoffTransformValue

◆ drive

◆ drive2

◆ enabled

◆ gain

◆ gain2

◆ mode

◆ numStates

◆ resonance

◆ saturationLUT

◆ scaledResonanceSmoother

◆ scaledResonanceValue

◆ state

template<typename SampleType>
class juce::dsp::LadderFilter< SampleType >