OpenShot Library | OpenShotAudio  0.2.1
juce::dsp::StateVariableFilter::Parameters< NumericType > Struct Template Reference

Structure used for the state variable filter parameters. More...

#include <juce_StateVariableFilter.h>

+ Inheritance diagram for juce::dsp::StateVariableFilter::Parameters< NumericType >:

Public Types

enum  Type { lowPass, bandPass, highPass }
 
using Ptr = ReferenceCountedObjectPtr< Parameters >
 The Coefficients structure is ref-counted, so this is a handy type that can be used as a pointer to one.
 
- Public Types inherited from juce::dsp::ProcessorState
using Ptr = ReferenceCountedObjectPtr< ProcessorState >
 The ProcessorState structure is ref-counted, so this is a handy type that can be used as a pointer to one.
 

Public Member Functions

void setCutOffFrequency (double sampleRate, NumericType frequency, NumericType resonance=static_cast< NumericType >(1.0/MathConstants< double >::sqrt2)) noexcept
 Sets the cutoff frequency and resonance of the IIR filter. More...
 
 Parameters (const Parameters &o)
 
Parametersoperator= (const Parameters &o) noexcept
 
- Public Member Functions inherited from juce::ReferenceCountedObject
void incReferenceCount () noexcept
 Increments the object's reference count. More...
 
void decReferenceCount () noexcept
 Decreases the object's reference count. More...
 
bool decReferenceCountWithoutDeleting () noexcept
 Decreases the object's reference count. More...
 
int getReferenceCount () const noexcept
 Returns the object's current reference count. More...
 

Public Attributes

Type type = Type::lowPass
 The type of the IIR filter.
 
NumericType g = static_cast<NumericType> (std::tan (MathConstants<double>::pi * 200.0 / 44100.0))
 
NumericType R2 = static_cast<NumericType> (MathConstants<double>::sqrt2)
 
NumericType h = static_cast<NumericType> (1.0 / (1.0 + R2 * g + g * g))
 

Additional Inherited Members

- Protected Member Functions inherited from juce::ReferenceCountedObject
 ReferenceCountedObject ()=default
 Creates the reference-counted object (with an initial ref count of zero). More...
 
 ReferenceCountedObject (const ReferenceCountedObject &) noexcept
 Copying from another object does not affect this one's reference-count. More...
 
 ReferenceCountedObject (ReferenceCountedObject &&) noexcept
 Copying from another object does not affect this one's reference-count. More...
 
ReferenceCountedObjectoperator= (const ReferenceCountedObject &) noexcept
 Copying from another object does not affect this one's reference-count. More...
 
ReferenceCountedObjectoperator= (ReferenceCountedObject &&) noexcept
 Copying from another object does not affect this one's reference-count. More...
 
virtual ~ReferenceCountedObject ()
 Destructor. More...
 
void resetReferenceCount () noexcept
 Resets the reference count to zero without deleting the object. More...
 

Detailed Description

template<typename NumericType>
struct juce::dsp::StateVariableFilter::Parameters< NumericType >

Structure used for the state variable filter parameters.

Definition at line 42 of file juce_StateVariableFilter.h.

Member Function Documentation

◆ setCutOffFrequency()

template<typename NumericType>
void juce::dsp::StateVariableFilter::Parameters< NumericType >::setCutOffFrequency ( double  sampleRate,
NumericType  frequency,
NumericType  resonance = static_cast<NumericType> (1.0 / MathConstants<double>::sqrt2) 
)
inlinenoexcept

Sets the cutoff frequency and resonance of the IIR filter.

Note: The bandwidth of the resonance increases with the value of the parameter. To have a standard 12 dB/octave filter, the value must be set at 1 / sqrt(2).

Definition at line 215 of file juce_StateVariableFilter.h.


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