#include <juce_IIRFilter.h>

Inheritance diagram for juce::dsp::IIR::Coefficients< NumericType >:

Public Types
using	Ptr = ReferenceCountedObjectPtr<Coefficients>
Public Types inherited from juce::dsp::ProcessorState
using	Ptr = ReferenceCountedObjectPtr<ProcessorState>

Public Member Functions
	Coefficients ()
	Coefficients (NumericType b0, NumericType b1, NumericType a0, NumericType a1)
	Coefficients (NumericType b0, NumericType b1, NumericType b2, NumericType a0, NumericType a1, NumericType a2)
	Coefficients (NumericType b0, NumericType b1, NumericType b2, NumericType b3, NumericType a0, NumericType a1, NumericType a2, NumericType a3)
	Coefficients (const Coefficients &)=default
	Coefficients (Coefficients &&)=default
Coefficients &	operator= (const Coefficients &)=default
Coefficients &	operator= (Coefficients &&)=default
template<size_t Num>
	Coefficients (const std::array< NumericType, Num > &values)
template<size_t Num>
Coefficients &	operator= (const std::array< NumericType, Num > &values)
size_t	getFilterOrder () const noexcept
double	getMagnitudeForFrequency (double frequency, double sampleRate) const noexcept
void	getMagnitudeForFrequencyArray (const double frequencies, double magnitudes, size_t numSamples, double sampleRate) const noexcept
double	getPhaseForFrequency (double frequency, double sampleRate) const noexcept
void	getPhaseForFrequencyArray (double frequencies, double phases, size_t numSamples, double sampleRate) const noexcept
NumericType *	getRawCoefficients () noexcept
const NumericType *	getRawCoefficients () const noexcept
template<size_t Num>
Coefficients< NumericType > &	assignImpl (const NumericType *values)
Public Member Functions inherited from juce::ReferenceCountedObject
void	incReferenceCount () noexcept
void	decReferenceCount () noexcept
bool	decReferenceCountWithoutDeleting () noexcept
int	getReferenceCount () const noexcept

Static Public Member Functions
static Ptr	makeFirstOrderLowPass (double sampleRate, NumericType frequency)
static Ptr	makeFirstOrderHighPass (double sampleRate, NumericType frequency)
static Ptr	makeFirstOrderAllPass (double sampleRate, NumericType frequency)
static Ptr	makeLowPass (double sampleRate, NumericType frequency)
static Ptr	makeLowPass (double sampleRate, NumericType frequency, NumericType Q)
static Ptr	makeHighPass (double sampleRate, NumericType frequency)
static Ptr	makeHighPass (double sampleRate, NumericType frequency, NumericType Q)
static Ptr	makeBandPass (double sampleRate, NumericType frequency)
static Ptr	makeBandPass (double sampleRate, NumericType frequency, NumericType Q)
static Ptr	makeNotch (double sampleRate, NumericType frequency)
static Ptr	makeNotch (double sampleRate, NumericType frequency, NumericType Q)
static Ptr	makeAllPass (double sampleRate, NumericType frequency)
static Ptr	makeAllPass (double sampleRate, NumericType frequency, NumericType Q)
static Ptr	makeLowShelf (double sampleRate, NumericType cutOffFrequency, NumericType Q, NumericType gainFactor)
static Ptr	makeHighShelf (double sampleRate, NumericType cutOffFrequency, NumericType Q, NumericType gainFactor)
static Ptr	makePeakFilter (double sampleRate, NumericType centreFrequency, NumericType Q, NumericType gainFactor)

Public Attributes
Array< NumericType >	coefficients

Private Types
using	ArrayCoeffs = ArrayCoefficients<NumericType>

Private Member Functions
template<size_t Num>
Coefficients &	assignImpl (const NumericType *values)
template<size_t Num>
Coefficients &	assign (const NumericType(&values)[Num])

Additional Inherited Members
Protected Member Functions inherited from juce::ReferenceCountedObject
	ReferenceCountedObject ()=default
	ReferenceCountedObject (const ReferenceCountedObject &) noexcept
	ReferenceCountedObject (ReferenceCountedObject &&) noexcept
ReferenceCountedObject &	operator= (const ReferenceCountedObject &) noexcept
ReferenceCountedObject &	operator= (ReferenceCountedObject &&) noexcept
virtual	~ReferenceCountedObject ()
void	resetReferenceCount () noexcept

Detailed Description

template<typename NumericType>
struct juce::dsp::IIR::Coefficients< NumericType >

A set of coefficients for use in an Filter object.

See also: IIR::Filter

@tags{DSP}

Member Typedef Documentation

◆ ArrayCoeffs

template<typename NumericType>

using juce::dsp::IIR::Coefficients< NumericType >::ArrayCoeffs = ArrayCoefficients<NumericType>

private

◆ Ptr

template<typename NumericType>

using juce::dsp::IIR::Coefficients< NumericType >::Ptr = ReferenceCountedObjectPtr<Coefficients>

The Coefficients structure is ref-counted, so this is a handy type that can be used as a pointer to one.

Constructor & Destructor Documentation

◆ Coefficients() [1/7]

template<typename NumericType>

juce::dsp::IIR::Coefficients< NumericType >::Coefficients ( )

Creates a null set of coefficients (which will produce silence).

◆ Coefficients() [2/7]

template<typename NumericType>

juce::dsp::IIR::Coefficients< NumericType >::Coefficients	(	NumericType	b0,
		NumericType	b1,
		NumericType	a0,
		NumericType	a1 )

Directly constructs an object from the raw coefficients. Most people will want to use the static methods instead of this, but the constructor is public to allow tinkerers to create their own custom filters!

◆ Coefficients() [3/7]

template<typename NumericType>

juce::dsp::IIR::Coefficients< NumericType >::Coefficients	(	NumericType	b0,
		NumericType	b1,
		NumericType	b2,
		NumericType	a0,
		NumericType	a1,
		NumericType	a2 )

◆ Coefficients() [4/7]

template<typename NumericType>

juce::dsp::IIR::Coefficients< NumericType >::Coefficients	(	NumericType	b0,
		NumericType	b1,
		NumericType	b2,
		NumericType	b3,
		NumericType	a0,
		NumericType	a1,
		NumericType	a2,
		NumericType	a3 )

◆ Coefficients() [5/7]

template<typename NumericType>

juce::dsp::IIR::Coefficients< NumericType >::Coefficients ( const Coefficients< NumericType > & )

default

◆ Coefficients() [6/7]

template<typename NumericType>

juce::dsp::IIR::Coefficients< NumericType >::Coefficients ( Coefficients< NumericType > && )

default

◆ Coefficients() [7/7]

template<typename NumericType>

template<size_t Num>

juce::dsp::IIR::Coefficients< NumericType >::Coefficients ( const std::array< NumericType, Num > & values )

inlineexplicit

Constructs from an array.

Member Function Documentation

◆ assign()

template<typename NumericType>

template<size_t Num>

Coefficients & juce::dsp::IIR::Coefficients< NumericType >::assign ( const NumericType(&) values[Num] )

inlineprivate

◆ assignImpl() [1/2]

template<typename NumericType>

template<size_t Num>

Coefficients & juce::dsp::IIR::Coefficients< NumericType >::assignImpl ( const NumericType * values )

private

◆ assignImpl() [2/2]

template<typename NumericType>

template<size_t Num>

Coefficients< NumericType > & juce::dsp::IIR::Coefficients< NumericType >::assignImpl ( const NumericType * values )

◆ getFilterOrder()

template<typename NumericType>

size_t juce::dsp::IIR::Coefficients< NumericType >::getFilterOrder ( ) const

noexcept

Returns the filter order associated with the coefficients

◆ getMagnitudeForFrequency()

template<typename NumericType>

double juce::dsp::IIR::Coefficients< NumericType >::getMagnitudeForFrequency	(	double	frequency,
		double	sampleRate ) const

noexcept

Returns the magnitude frequency response of the filter for a given frequency and sample rate

◆ getMagnitudeForFrequencyArray()

template<typename NumericType>

void juce::dsp::IIR::Coefficients< NumericType >::getMagnitudeForFrequencyArray	(	const double *	frequencies,
		double *	magnitudes,
		size_t	numSamples,
		double	sampleRate ) const

noexcept

Returns the magnitude frequency response of the filter for a given frequency array and sample rate.

◆ getPhaseForFrequency()

template<typename NumericType>

double juce::dsp::IIR::Coefficients< NumericType >::getPhaseForFrequency	(	double	frequency,
		double	sampleRate ) const

noexcept

Returns the phase frequency response of the filter for a given frequency and sample rate

◆ getPhaseForFrequencyArray()

template<typename NumericType>

void juce::dsp::IIR::Coefficients< NumericType >::getPhaseForFrequencyArray	(	double *	frequencies,
		double *	phases,
		size_t	numSamples,
		double	sampleRate ) const

noexcept

Returns the phase frequency response of the filter for a given frequency array and sample rate.

◆ getRawCoefficients() [1/2]

template<typename NumericType>

const NumericType * juce::dsp::IIR::Coefficients< NumericType >::getRawCoefficients ( ) const

inlinenoexcept

Returns a raw data pointer to the coefficients.

◆ getRawCoefficients() [2/2]

template<typename NumericType>

NumericType * juce::dsp::IIR::Coefficients< NumericType >::getRawCoefficients ( )

inlinenoexcept

Returns a raw data pointer to the coefficients.

◆ makeAllPass() [1/2]

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makeAllPass	(	double	sampleRate,
		NumericType	frequency )

static

Returns the coefficients for an all-pass filter.

◆ makeAllPass() [2/2]

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makeAllPass	(	double	sampleRate,
		NumericType	frequency,
		NumericType	Q )

static

Returns the coefficients for an all-pass filter with variable Q.

◆ makeBandPass() [1/2]

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makeBandPass	(	double	sampleRate,
		NumericType	frequency )

static

Returns the coefficients for a band-pass filter.

◆ makeBandPass() [2/2]

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makeBandPass	(	double	sampleRate,
		NumericType	frequency,
		NumericType	Q )

static

Returns the coefficients for a band-pass filter with variable Q.

◆ makeFirstOrderAllPass()

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makeFirstOrderAllPass	(	double	sampleRate,
		NumericType	frequency )

static

Returns the coefficients for a first order all-pass filter.

◆ makeFirstOrderHighPass()

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makeFirstOrderHighPass	(	double	sampleRate,
		NumericType	frequency )

static

Returns the coefficients for a first order high-pass filter.

◆ makeFirstOrderLowPass()

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makeFirstOrderLowPass	(	double	sampleRate,
		NumericType	frequency )

static

Returns the coefficients for a first order low-pass filter.

◆ makeHighPass() [1/2]

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makeHighPass	(	double	sampleRate,
		NumericType	frequency )

static

Returns the coefficients for a high-pass filter.

◆ makeHighPass() [2/2]

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makeHighPass	(	double	sampleRate,
		NumericType	frequency,
		NumericType	Q )

static

Returns the coefficients for a high-pass filter with variable Q.

◆ makeHighShelf()

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makeHighShelf	(	double	sampleRate,
		NumericType	cutOffFrequency,
		NumericType	Q,
		NumericType	gainFactor )

static

Returns the coefficients for a high-pass shelf filter with variable Q and gain.

The gain is a scale factor that the high frequencies are multiplied by, so values greater than 1.0 will boost the high frequencies, values less than 1.0 will attenuate them.

◆ makeLowPass() [1/2]

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makeLowPass	(	double	sampleRate,
		NumericType	frequency )

static

Returns the coefficients for a low-pass filter.

◆ makeLowPass() [2/2]

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makeLowPass	(	double	sampleRate,
		NumericType	frequency,
		NumericType	Q )

static

Returns the coefficients for a low-pass filter with variable Q.

◆ makeLowShelf()

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makeLowShelf	(	double	sampleRate,
		NumericType	cutOffFrequency,
		NumericType	Q,
		NumericType	gainFactor )

static

Returns the coefficients for a low-pass shelf filter with variable Q and gain.

The gain is a scale factor that the low frequencies are multiplied by, so values greater than 1.0 will boost the low frequencies, values less than 1.0 will attenuate them.

◆ makeNotch() [1/2]

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makeNotch	(	double	sampleRate,
		NumericType	frequency )

static

Returns the coefficients for a notch filter.

◆ makeNotch() [2/2]

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makeNotch	(	double	sampleRate,
		NumericType	frequency,
		NumericType	Q )

static

Returns the coefficients for a notch filter with variable Q.

◆ makePeakFilter()

template<typename NumericType>

Coefficients< NumericType >::Ptr juce::dsp::IIR::Coefficients< NumericType >::makePeakFilter	(	double	sampleRate,
		NumericType	centreFrequency,
		NumericType	Q,
		NumericType	gainFactor )

static

Returns the coefficients for a peak filter centred around a given frequency, with a variable Q and gain.

The gain is a scale factor that the centre frequencies are multiplied by, so values greater than 1.0 will boost the centre frequencies, values less than 1.0 will attenuate them.

◆ operator=() [1/3]

template<typename NumericType>

Coefficients & juce::dsp::IIR::Coefficients< NumericType >::operator= ( Coefficients< NumericType > && )

default

◆ operator=() [2/3]

template<typename NumericType>

Coefficients & juce::dsp::IIR::Coefficients< NumericType >::operator= ( const Coefficients< NumericType > & )

default

◆ operator=() [3/3]

template<typename NumericType>

template<size_t Num>

Coefficients & juce::dsp::IIR::Coefficients< NumericType >::operator= ( const std::array< NumericType, Num > & values )

inline

Assigns contents from an array.

Member Data Documentation

◆ coefficients

template<typename NumericType>

Array<NumericType> juce::dsp::IIR::Coefficients< NumericType >::coefficients

The raw coefficients. You should leave these numbers alone unless you really know what you're doing.

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

/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_dsp/processors/juce_IIRFilter.h
/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_dsp/processors/juce_IIRFilter.cpp
/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_dsp/processors/juce_IIRFilter_Impl.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ArrayCoeffs

◆ Ptr

Constructor & Destructor Documentation

◆ Coefficients() [1/7]

◆ Coefficients() [2/7]

◆ Coefficients() [3/7]

◆ Coefficients() [4/7]

◆ Coefficients() [5/7]

◆ Coefficients() [6/7]

◆ Coefficients() [7/7]

Member Function Documentation

◆ assign()

◆ assignImpl() [1/2]

◆ assignImpl() [2/2]

◆ getFilterOrder()

◆ getMagnitudeForFrequency()

◆ getMagnitudeForFrequencyArray()

◆ getPhaseForFrequency()

◆ getPhaseForFrequencyArray()

◆ getRawCoefficients() [1/2]

◆ getRawCoefficients() [2/2]

◆ makeAllPass() [1/2]

◆ makeAllPass() [2/2]

◆ makeBandPass() [1/2]

◆ makeBandPass() [2/2]

◆ makeFirstOrderAllPass()

◆ makeFirstOrderHighPass()

◆ makeFirstOrderLowPass()

◆ makeHighPass() [1/2]

◆ makeHighPass() [2/2]

◆ makeHighShelf()

◆ makeLowPass() [1/2]

◆ makeLowPass() [2/2]

◆ makeLowShelf()

◆ makeNotch() [1/2]

◆ makeNotch() [2/2]

◆ makePeakFilter()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

Member Data Documentation

◆ coefficients