#include <juce_LadderFilter.h>

Public Types
using	Mode = LadderFilterMode

Public Member Functions
	LadderFilter ()
void	setEnabled (bool isEnabled) noexcept
void	setMode (Mode newMode) noexcept
void	prepare (const ProcessSpec &spec)
size_t	getNumChannels () const noexcept
void	reset () noexcept
void	setCutoffFrequencyHz (SampleType newCutoff) noexcept
void	setResonance (SampleType newResonance) noexcept
void	setDrive (SampleType newDrive) noexcept
template<typename ProcessContext>
void	process (const ProcessContext &context) noexcept

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

Private Member Functions
void	setSampleRate (SampleType newValue) noexcept
void	setNumChannels (size_t newValue)
void	updateCutoffFreq () noexcept
void	updateResonance () noexcept

Private Attributes
SampleType	drive
SampleType	drive2
SampleType	gain
SampleType	gain2
SampleType	comp
std::vector< std::array< SampleType, numStates > >	state
std::array< SampleType, numStates >	A
SmoothedValue< SampleType >	cutoffTransformSmoother
SmoothedValue< SampleType >	scaledResonanceSmoother
SampleType	cutoffTransformValue
SampleType	scaledResonanceValue
LookupTableTransform< SampleType >	saturationLUT
SampleType	cutoffFreqHz { SampleType (200) }
SampleType	resonance
SampleType	cutoffFreqScaler
Mode	mode
bool	enabled = true

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.

◆ 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

◆ processSample()

template<typename SampleType>

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

protectednoexcept

◆ 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.

◆ 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

◆ 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

◆ updateResonance()

template<typename SampleType>

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

inlineprivatenoexcept

◆ updateSmoothers()

template<typename SampleType>

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

protectednoexcept

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

◆ cutoffFreqScaler

template<typename SampleType>

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

private

◆ cutoffTransformSmoother

template<typename SampleType>

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

private

◆ 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

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

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

staticconstexprprivate

◆ resonance

template<typename SampleType>

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

private

◆ 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 }

x

unsigned x[BMAX+1]

Definition inflate.c:1586

◆ scaledResonanceSmoother

template<typename SampleType>

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

private

◆ 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

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

/home/runner/work/lmms/lmms/plugins/CarlaBase/carla/source/modules/juce_dsp/widgets/juce_LadderFilter.h
/home/runner/work/lmms/lmms/plugins/CarlaBase/carla/source/modules/juce_dsp/widgets/juce_LadderFilter.cpp

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

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