BiquadFilter

java.lang.Object
- net.beadsproject.beads.core.Bead
- - net.beadsproject.beads.core.UGen
  - - net.beadsproject.beads.ugens.IIRFilter
    - - net.beadsproject.beads.ugens.BiquadFilter

All Implemented Interfaces:

DataBeadReceiver
```
public class BiquadFilter
extends IIRFilter
implements DataBeadReceiver
```
A simple implementation of a multi-channel biquad filter. It calculates coefficients based on three parameters (frequency, Q, and gain - the latter only relevant for EQ and shelving filters), each of which may be specified by a static float or by the output of a UGen.
Filter parameters may be set with individual setter functions ( setFreq, setQ, and setGain), or by passing a DataBead with the appropriate properties to setParams. (Messaging the filter with a DataBead is equivalent to calling setParams.) Setter methods return the instance, so they may be strung together:
filt.setFreq(200).setQ(30).setGain(.4);
BiquadFilterMulti can be used with pre-programmed algorithms that calculate coefficients for various filter types. (See setType(int) for a list of available types.)
BiquadFilterMulti can also implement a user-defined filter algorithm by calling setCustomType(CustomCoeffCalculator).

Version:

0.9.6

Author:

Benito Crawford

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`BiquadFilter.CustomCoeffCalculator` CustomCoeffCalculator provides a mechanism to define custom filter coefficients for a biquad filter based on frequency and Q.
`static class`	`BiquadFilter.Type`
`protected class`	`BiquadFilter.ValCalculator`

Nested classes/interfaces inherited from class net.beadsproject.beads.ugens.IIRFilter
IIRFilter.IIRFilterAnalysis

Nested classes/interfaces inherited from class net.beadsproject.beads.core.UGen
UGen.OutputInitializationRegime, UGen.OutputPauseRegime

Field Summary

Fields
Modifier and Type	Field and Description
`protected float`	`a0`
`protected float`	`a1`
`protected float`	`a2`
`protected double`	`ampResponse`
`static BiquadFilter.Type`	`AP` Indicates an all-pass filter; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
`protected boolean`	`areAllStatic`
`protected float`	`b0`
`protected float`	`b1`
`protected float`	`b2`
`static BiquadFilter.Type`	`BESSEL_HP` Indicates a Bessel high-pass filter; only frequency is relevant.
`static BiquadFilter.Type`	`BESSEL_LP` Indicates a Bessel low-pass filter; only frequency is relevant.
`protected float`	`bi1`
`protected float[]`	`bi1m`
`protected float`	`bi2`
`protected float[]`	`bi2m`
`protected float`	`bo1`
`protected float[]`	`bo1m`
`protected float`	`bo2`
`protected float[]`	`bo2m`
`static BiquadFilter.Type`	`BP_PEAK` Indicates a band-pass filter with constant peak gain; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
`static BiquadFilter.Type`	`BP_SKIRT` Indicates a band-pass filter with constant skirt gain; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
`static BiquadFilter.Type`	`BUTTERWORTH_HP` Indicates a Butterworth high-pass filter; only the frequency parameter is relevant.
`static BiquadFilter.Type`	`BUTTERWORTH_LP` Indicates a Butterworth low-pass filter; only the frequency parameter is relevant.
`protected float`	`cbi1`
`protected float[]`	`cbi1m`
`protected float`	`cbi2`
`protected float[]`	`cbi2m`
`protected float`	`cbo1`
`protected float[]`	`cbo1m`
`protected float`	`cbo2`
`protected float[]`	`cbo2m`
`protected int`	`channels`
`protected boolean`	`cuedInputMemory`
`protected boolean`	`cuedOutputMemory`
`static BiquadFilter.Type`	`CUSTOM_FILTER` Indicates a user-defined filter; see `setCustomType`.
`protected float`	`freq`
`protected UGen`	`freqUGen`
`protected double`	`frImag`
`protected double`	`frReal`
`protected float`	`gain`
`protected UGen`	`gainUGen`
`static BiquadFilter.Type`	`HIGH_SHELF` Indicates a high-shelf filter; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
`static BiquadFilter.Type`	`HP` Indicates a high-pass filter; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
`protected boolean`	`isFreqStatic`
`protected boolean`	`isGainStatic`
`protected boolean`	`isQStatic`
`static BiquadFilter.Type`	`LOW_SHELF` Indicates a low-shelf filter; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
`static BiquadFilter.Type`	`LP` Indicates a low-pass filter; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
`static BiquadFilter.Type`	`NOTCH` Indicates a notch (band-reject) filter; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
`static BiquadFilter.Type`	`PEAKING_EQ` Indicates a peaking-EQ filter; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
`protected double`	`phaseDelay`
`protected double`	`phaseResponse`
`protected float`	`pi_over_sf`
`protected float`	`q`
`protected UGen`	`qUGen`
`protected float`	`samplingfreq`
`static float`	`SQRT2`
`protected float`	`two_pi_over_sf`
`protected BiquadFilter.Type`	`type`
`protected BiquadFilter.ValCalculator`	`vc`
`protected double`	`w`

Fields inherited from class net.beadsproject.beads.core.UGen
bufferSize, bufIn, bufOut, context, ins, outputInitializationRegime, outputPauseRegime, outs

Constructor Summary

Constructors
Constructor and Description
`BiquadFilter(AudioContext context, BiquadFilter.Type itype, float ifreq, float iqval)` Constructor for frequency and Q as floats.
`BiquadFilter(AudioContext context, BiquadFilter.Type itype, float ifreq, UGen iqval)` Constructor for frequency as a float and Q as a UGen.
`BiquadFilter(AudioContext context, BiquadFilter.Type itype, UGen ifreq, float iqval)` Constructor for frequency as a UGen and Q as a float.
`BiquadFilter(AudioContext context, BiquadFilter.Type itype, UGen ifreq, UGen iqval)` Constructor for frequency and Q as UGens.
`BiquadFilter(AudioContext context, int channels)` Constructor for a multi-channel low-pass biquad filter UGen with the specified number of channels.
`BiquadFilter(AudioContext context, int channels, BiquadFilter.Type itype)` Constructor for a multi-channel biquad filter UGen of specified type with the specified number of channels.
`BiquadFilter(AudioContext context, int channels, BiquadFilter.Type itype, DataBead params)` Constructor for a multi-channel biquad filter UGen of specified type, with the specified number of channels, and with parameters specified by a DataBead.
`BiquadFilter(AudioContext context, int channels, DataBead params)` Constructor for a multi-channel biquad filter UGen with the specified number of channels and parameters specified by a DataBead.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`calculateBuffer()` Called by the signal chain to update this UGen's ouput data.
`float[]`	`getCoefficients()` Gets an array of the current filter coefficients: {a0, a1, a2, b0, b1, b2}.
`IIRFilter.IIRFilterAnalysis`	`getFilterResponse(float freq)` Gets an array filled with the filter response characteristics: {frequency response (real), frequency response (imaginary), amplitude response, phase response, phase delay, group delay}.
`float`	`getFreq()` Deprecated. Use `getFrequency()`.
`float`	`getFrequency()` Gets the current filter frequency.
`UGen`	`getFrequencyUGen()` Gets the frequency UGen, if there is one.
`UGen`	`getFreqUGen()` Deprecated. Use `getFrequencyUGen()`.
`float`	`getGain()` Gets the current gain in decibels for the filter.
`UGen`	`getGainUGen()` Gets the gain UGen, if there is one.
`DataBead`	`getParams()` Gets a DataBead with the filter's parameters (whether float or UGen), stored in the keys "frequency", "q", "gain", and "filterType".
`float`	`getQ()` Gets the current Q-value for the filter.
`UGen`	`getQUGen()` Gets the Q UGen, if there is one.
`DataBead`	`getStaticParams()` Gets a DataBead with properties "frequency", "q", and "gain" set to their current float values and "type" set appropriately.
`BiquadFilter.Type`	`getType()` Gets the type of the filter.
`BiquadFilter`	`loadInputMemory(float[] xm1, float[] xm2)`
`BiquadFilter`	`loadInputMemory(float xm1, float xm2)`
`BiquadFilter`	`loadMemory(float[] xm1, float[] xm2, float[] ym1, float[] ym2)`
`BiquadFilter`	`loadMemory(float xm1, float xm2, float ym1, float ym2)`
`BiquadFilter`	`loadOutputMemory(float[] ym1, float[] ym2)`
`BiquadFilter`	`loadOutputMemory(float ym1, float ym2)`
`void`	`messageReceived(Bead message)` Responds to an incoming message.
`void`	`reset()` Resets the filter in case it "explodes".
`DataBeadReceiver`	`sendData(DataBead db)` Equivalent to `setParams(DataBead)`.
`BiquadFilter`	`setCustomType(BiquadFilter.CustomCoeffCalculator cc)` Sets a user-defined coefficient calculation algorithm.
`BiquadFilter`	`setFreq(float freq)` Deprecated. Use `setFrequency(float)`.
`BiquadFilter`	`setFreq(UGen freqUGen)` Deprecated. Use `setFrequency(UGen)`.
`BiquadFilter`	`setFrequency(float freq)` Sets the filter frequency to a float value.
`BiquadFilter`	`setFrequency(UGen freqUGen)` Sets a UGen to determine the filter frequency.
`BiquadFilter`	`setGain(float ngain)` Sets the filter gain to a float.
`BiquadFilter`	`setGain(UGen ngain)` Sets a UGen to determine the filter Q-value.
`BiquadFilter`	`setParams(DataBead paramBead)` Sets the filter parameters with a DataBead.
`BiquadFilter`	`setQ(float nqval)` Sets the filter Q-value to a float.
`BiquadFilter`	`setQ(UGen nqval)` Sets a UGen to determine the filter Q-value.
`BiquadFilter`	`setType(BiquadFilter.Type ntype)` Sets the type of filter.
`BiquadFilter`	`setType(int ntype)` Deprecated. Use `setType(Type)`.

Methods inherited from class net.beadsproject.beads.ugens.IIRFilter
analyzeFilter, calculateFilterResponse, calculateGroupDelay, getAmplitudeResponse, getGroupDelay, getPhaseDelay, getPhaseResponse

Methods inherited from class net.beadsproject.beads.core.UGen
addDependent, addInput, addInput, clearDependents, clearInputConnections, containsInput, crossfadeInput, getConnectedInputs, getContext, getEnvelopes, getIns, getNumberOfConnectedUGens, getNumberOfDependents, getOutBuffer, getOuts, getTimeTakenLastUpdate, getValue, getValue, getValueDouble, getValueDouble, initializeOuts, isTimerMode, isUpdated, noInputs, pause, printInBuffers, printInputList, printOutBuffers, removeAllConnections, removeConnection, removeDependent, setOutsToPause, setTimerMode, setValue, update, zeroIns, zeroOuts

Methods inherited from class net.beadsproject.beads.core.Bead
getKillListener, getName, isDeleted, isPaused, kill, message, setKillListener, setName, start, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - LP
```
public static final BiquadFilter.Type LP
```
    Indicates a low-pass filter; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
  - HP
```
public static final BiquadFilter.Type HP
```
    Indicates a high-pass filter; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
  - BP_SKIRT
```
public static final BiquadFilter.Type BP_SKIRT
```
    Indicates a band-pass filter with constant skirt gain; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
  - BP_PEAK
```
public static final BiquadFilter.Type BP_PEAK
```
    Indicates a band-pass filter with constant peak gain; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
  - NOTCH
```
public static final BiquadFilter.Type NOTCH
```
    Indicates a notch (band-reject) filter; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
  - AP
```
public static final BiquadFilter.Type AP
```
    Indicates an all-pass filter; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
  - PEAKING_EQ
```
public static final BiquadFilter.Type PEAKING_EQ
```
    Indicates a peaking-EQ filter; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson. untested!
  - LOW_SHELF
```
public static final BiquadFilter.Type LOW_SHELF
```
    Indicates a low-shelf filter; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
  - HIGH_SHELF
```
public static final BiquadFilter.Type HIGH_SHELF
```
    Indicates a high-shelf filter; coefficients are calculated from equations given in "Cookbook formulae for audio EQ biquad filter coefficients" by Robert Bristow-Johnson.
  - BUTTERWORTH_LP
```
public static final BiquadFilter.Type BUTTERWORTH_LP
```
    Indicates a Butterworth low-pass filter; only the frequency parameter is relevant.
  - BUTTERWORTH_HP
```
public static final BiquadFilter.Type BUTTERWORTH_HP
```
    Indicates a Butterworth high-pass filter; only the frequency parameter is relevant.
  - BESSEL_LP
```
public static final BiquadFilter.Type BESSEL_LP
```
    Indicates a Bessel low-pass filter; only frequency is relevant.
  - BESSEL_HP
```
public static final BiquadFilter.Type BESSEL_HP
```
    Indicates a Bessel high-pass filter; only frequency is relevant.
  - CUSTOM_FILTER
```
public static final BiquadFilter.Type CUSTOM_FILTER
```
    Indicates a user-defined filter; see setCustomType. This constant is not recognized by setType.
  - a0
```
protected float a0
```
  - a1
```
protected float a1
```
  - a2
```
protected float a2
```
  - b0
```
protected float b0
```
  - b1
```
protected float b1
```
  - b2
```
protected float b2
```
  - channels
```
protected int channels
```
  - freq
```
protected float freq
```
  - q
```
protected float q
```
  - gain
```
protected float gain
```
  - type
```
protected BiquadFilter.Type type
```
  - samplingfreq
```
protected float samplingfreq
```
  - two_pi_over_sf
```
protected float two_pi_over_sf
```
  - pi_over_sf
```
protected float pi_over_sf
```
  - SQRT2
```
public static final float SQRT2
```
  - w
```
protected double w
```
  - ampResponse
```
protected double ampResponse
```
  - phaseResponse
```
protected double phaseResponse
```
  - phaseDelay
```
protected double phaseDelay
```
  - frReal
```
protected double frReal
```
  - frImag
```
protected double frImag
```
  - bo1m
```
protected float[] bo1m
```
  - bo2m
```
protected float[] bo2m
```
  - bi1m
```
protected float[] bi1m
```
  - bi2m
```
protected float[] bi2m
```
  - bo1
```
protected float bo1
```
  - bo2
```
protected float bo2
```
  - bi1
```
protected float bi1
```
  - bi2
```
protected float bi2
```
  - cuedInputMemory
```
protected boolean cuedInputMemory
```
  - cuedOutputMemory
```
protected boolean cuedOutputMemory
```
  - cbo1m
```
protected float[] cbo1m
```
  - cbo2m
```
protected float[] cbo2m
```
  - cbi1m
```
protected float[] cbi1m
```
  - cbi2m
```
protected float[] cbi2m
```
  - cbo1
```
protected float cbo1
```
  - cbo2
```
protected float cbo2
```
  - cbi1
```
protected float cbi1
```
  - cbi2
```
protected float cbi2
```
  - vc
```
protected BiquadFilter.ValCalculator vc
```
  - freqUGen
```
protected UGen freqUGen
```
  - qUGen
```
protected UGen qUGen
```
  - gainUGen
```
protected UGen gainUGen
```
  - isFreqStatic
```
protected boolean isFreqStatic
```
  - isQStatic
```
protected boolean isQStatic
```
  - isGainStatic
```
protected boolean isGainStatic
```
  - areAllStatic
```
protected boolean areAllStatic
```
- Constructor Detail
  - BiquadFilter
```
public BiquadFilter(AudioContext context,
                    int channels)
```
    Constructor for a multi-channel low-pass biquad filter UGen with the specified number of channels.
    
    Parameters:
    
    context - The audio context.
    
    channels - The number of channels.
  - BiquadFilter
```
public BiquadFilter(AudioContext context,
                    int channels,
                    BiquadFilter.Type itype)
```
    Constructor for a multi-channel biquad filter UGen of specified type with the specified number of channels. See setType for a list of supported filter types.
    
    Parameters:
    
    context - The AudioContext.
    
    channels - The number of channels.
    
    itype - The initial filter type, e.g. LP, HP, BP_SKIRT, etc.
  - BiquadFilter
```
public BiquadFilter(AudioContext context,
                    int channels,
                    DataBead params)
```
    Constructor for a multi-channel biquad filter UGen with the specified number of channels and parameters specified by a DataBead.
    
    Parameters:
    
    context - The audio context.
    
    channels - The number of channels.
    
    params - A DataBead specifying parameter values; see setParams(DataBead).
  - BiquadFilter
```
public BiquadFilter(AudioContext context,
                    int channels,
                    BiquadFilter.Type itype,
                    DataBead params)
```
    Constructor for a multi-channel biquad filter UGen of specified type, with the specified number of channels, and with parameters specified by a DataBead.
    
    Parameters:
    
    context - The audio context.
    
    channels - The number of channels.
    
    itype - The initial filter type, e.g. LP, HP, BP_SKIRT, etc.
    
    params - A DataBead specifying parameter values; see setParams(DataBead).
  - BiquadFilter
```
public BiquadFilter(AudioContext context,
                    BiquadFilter.Type itype,
                    float ifreq,
                    float iqval)
```
    Constructor for frequency and Q as floats. See setType for a list of supported filter types.
    
    Parameters:
    
    context - The AudioContext.
    
    itype - The initial filter type, e.g. LP, HP, BP_SKIRT, etc.
    
    ifreq - The initial frequency.
    
    iqval - The initial Q-value.
  - BiquadFilter
```
public BiquadFilter(AudioContext context,
                    BiquadFilter.Type itype,
                    UGen ifreq,
                    float iqval)
```
    Constructor for frequency as a UGen and Q as a float. See setType for a list of supported filter types.
    
    Parameters:
    
    context - The AudioContext.
    
    itype - The initial filter type, LP, HP, BP_SKIRT, etc.
    
    ifreq - The frequency UGen.
    
    iqval - The initial Q-value.
  - BiquadFilter
```
public BiquadFilter(AudioContext context,
                    BiquadFilter.Type itype,
                    float ifreq,
                    UGen iqval)
```
    Constructor for frequency as a float and Q as a UGen. See setType for a list of supported filter types.
    
    Parameters:
    
    context - The AudioContext.
    
    itype - The initial filter type, e.g. LP, HP, BP_SKIRT, etc.
    
    ifreq - The initial frequency.
    
    iqval - The Q-value UGen.
  - BiquadFilter
```
public BiquadFilter(AudioContext context,
                    BiquadFilter.Type itype,
                    UGen ifreq,
                    UGen iqval)
```
    Constructor for frequency and Q as UGens. See setType for a list of supported filter types.
    
    Parameters:
    
    context - The AudioContext.
    
    itype - The initial filter type, e.g. LP, HP, BP_SKIRT, etc.
    
    ifreq - The frequency UGen.
    
    iqval - The Q-value UGen.
- Method Detail
  - calculateBuffer
```
public void calculateBuffer()
```
    Description copied from class: UGen
    
    Called by the signal chain to update this UGen's ouput data. Subclassses of UGen should implement the UGen's DSP perform routine here. In general this involves grabbing data from UGen.bufIn and putting data into UGen.bufOut in some way. UGen.bufIn and UGen.bufOut are 2D arrays of floats of the form float[numChannels][bufferSize]. The length of the buffers is given by UGen.bufferSize, and the number of channels of the input and output buffers are given by UGen.ins and UGen.outs respectively.
    
    Specified by:
    
    calculateBuffer in class UGen
  - reset
```
public void reset()
```
    Resets the filter in case it "explodes".
  - setParams
```
public BiquadFilter setParams(DataBead paramBead)
```
    Sets the filter parameters with a DataBead.
    Use the following properties to specify filter parameters:
    - "filterType": (int) The filter type.
    - "frequency": (float or UGen) The filter frequency.
    - "q": (float or UGen) The filter Q-value.
    - "gain": (float or UGen) The filter gain.
    Parameters:
    
    paramBead - The DataBead specifying parameters.
    
    Returns:
    
    This filter instance.
  - messageReceived
```
public void messageReceived(Bead message)
```
    Description copied from class: Bead
    
    Responds to an incoming message. Subclasses can override this in order to handle incoming messages. Typically a Bead would send a message to another Bead with itself as the arugment.
    
    Overrides:
    
    messageReceived in class Bead
    
    Parameters:
    
    message - the message
  - sendData
```
public DataBeadReceiver sendData(DataBead db)
```
    Equivalent to setParams(DataBead).
    
    Specified by:
    
    sendData in interface DataBeadReceiver
    
    Parameters:
    
    db - The DataBead message.
    
    Returns:
    
    This filter instance.
  - getParams
```
public DataBead getParams()
```
    Gets a DataBead with the filter's parameters (whether float or UGen), stored in the keys "frequency", "q", "gain", and "filterType".
    
    Returns:
    
    The DataBead with stored parameters.
  - getStaticParams
```
public DataBead getStaticParams()
```
    Gets a DataBead with properties "frequency", "q", and "gain" set to their current float values and "type" set appropriately.
    
    Returns:
    
    The DataBead with static float parameter values.
  - setType
```
public BiquadFilter setType(BiquadFilter.Type ntype)
```
    Sets the type of filter. To set a custom type, use setCustomType. The following types are recognized:
    - LP - Low-pass filter.
    - HP - High-pass filter.
    - BP_SKIRT - Band-pass filter with constant skirt gain.
    - BP_PEAK - Band-pass filter with constant peak gain.
    - NOTCH - Notch (band-reject) filter.
    - AP - All-pass filter.
    - PEAKING_EQ - Peaking-EQ filter.
    - LOW_SHELF - Low-shelf filter.
    - HIGH_SHELF - High-shelf filter.
    - BUTTERWORTH_LP - Butterworth low-pass filter.
    - BUTTERWORTH_HP - Butterworth high-pass filter.
    - BESSEL_LP - Bessel low-pass filter.
    - BESSEL_HP - Bessel high-pass filter.
    Parameters:
    
    ntype - The type of filter.
  - setType
```
@Deprecated
public BiquadFilter setType(int ntype)
```
    Deprecated. Use setType(Type).
    Sets the type of filter with an integer. This method is deprecated and has been kept for backwards-compatibility reasons only. { setType(Type) should be used.
    - 0 - Low-pass filter.
    - 1 - High-pass filter.
    - 2 - Band-pass filter with constant skirt gain.
    - 3 - Band-pass filter with constant peak gain.
    - 4 - Notch (band-reject) filter.
    - 5 - All-pass filter.
    - 6 - Peaking-EQ filter.
    - 7 - Low-shelf filter.
    - 8 - High-shelf filter.
    - 9 - Butterworth low-pass filter.
    - 10 - Butterworth high-pass filter.
    - 11 - Bessel low-pass filter.
    - 12 - Bessel high-pass filter.
    Parameters:
    
    ntype - The type of filter.
  - getType
```
public BiquadFilter.Type getType()
```
    Gets the type of the filter.
    
    Returns:
    
    The filter type.
    
    See Also:
    
    setType(Type)
  - getFrequency
```
public float getFrequency()
```
    Gets the current filter frequency.
    
    Returns:
    
    The filter frequency.
  - setFrequency
```
public BiquadFilter setFrequency(float freq)
```
    Sets the filter frequency to a float value. This will remove the frequency UGen, if there is one.
    
    Parameters:
    
    freq - The frequency.
  - setFrequency
```
public BiquadFilter setFrequency(UGen freqUGen)
```
    Sets a UGen to determine the filter frequency.
    
    Parameters:
    
    freqUGen - The frequency UGen.
  - getFrequencyUGen
```
public UGen getFrequencyUGen()
```
    Gets the frequency UGen, if there is one.
    
    Returns:
    
    The frequency UGen.
  - getFreq
```
@Deprecated
public float getFreq()
```
    Deprecated. Use getFrequency().
    
    Gets the current filter frequency.
    
    Returns:
    
    The filter frequency.
  - setFreq
```
@Deprecated
public BiquadFilter setFreq(float freq)
```
    Deprecated. Use setFrequency(float).
    
    Sets the filter frequency to a float value. This will remove the frequency UGen, if there is one.
    
    Parameters:
    
    freq - The frequency.
  - setFreq
```
@Deprecated
public BiquadFilter setFreq(UGen freqUGen)
```
    Deprecated. Use setFrequency(UGen).
    
    Sets a UGen to determine the filter frequency.
    
    Parameters:
    
    freqUGen - The frequency UGen.
  - getFreqUGen
```
@Deprecated
public UGen getFreqUGen()
```
    Deprecated. Use getFrequencyUGen().
    
    Gets the frequency UGen, if there is one.
    
    Returns:
    
    The frequency UGen.
  - setQ
```
public BiquadFilter setQ(float nqval)
```
    Sets the filter Q-value to a float. This will remove the Q UGen if there is one.
    
    Parameters:
    
    nqval - The Q-value.
  - setQ
```
public BiquadFilter setQ(UGen nqval)
```
    Sets a UGen to determine the filter Q-value.
    
    Parameters:
    
    nqval - The Q-value UGen.
    
    Returns:
    
    This BiquadFilter instance.
  - getQ
```
public float getQ()
```
    Gets the current Q-value for the filter.
    
    Returns:
    
    The current Q-value.
  - getQUGen
```
public UGen getQUGen()
```
    Gets the Q UGen, if there is one.
    
    Returns:
    
    The Q UGen.
  - setGain
```
public BiquadFilter setGain(float ngain)
```
    Sets the filter gain to a float. This will remove the gain UGen if there is one. (Only relevant for PEAKING_EQ, LOW_SHELF, and HIGH_SHELF types.)
    
    Parameters:
    
    ngain - The gain in decibels (0 means no gain).
  - setGain
```
public BiquadFilter setGain(UGen ngain)
```
    Sets a UGen to determine the filter Q-value. (Only relevant for PEAKING_EQ, LOW_SHELF, and HIGH_SHELF types.)
    
    Parameters:
    
    ngain - The gain UGen, specifying the gain in decibels.
  - getGain
```
public float getGain()
```
    Gets the current gain in decibels for the filter. (Only relevant for PEAKING_EQ, LOW_SHELF, and HIGH_SHELF types.)
    
    Returns:
    
    The current gain.
  - getGainUGen
```
public UGen getGainUGen()
```
    Gets the gain UGen, if there is one.
    
    Returns:
    
    The gain UGen.
  - loadMemory
```
public BiquadFilter loadMemory(float xm1,
                               float xm2,
                               float ym1,
                               float ym2)
```
  - loadMemory
```
public BiquadFilter loadMemory(float[] xm1,
                               float[] xm2,
                               float[] ym1,
                               float[] ym2)
```
  - loadInputMemory
```
public BiquadFilter loadInputMemory(float xm1,
                                    float xm2)
```
  - loadInputMemory
```
public BiquadFilter loadInputMemory(float[] xm1,
                                    float[] xm2)
```
  - loadOutputMemory
```
public BiquadFilter loadOutputMemory(float ym1,
                                     float ym2)
```
  - loadOutputMemory
```
public BiquadFilter loadOutputMemory(float[] ym1,
                                     float[] ym2)
```
  - getCoefficients
```
public float[] getCoefficients()
```
    Gets an array of the current filter coefficients: {a0, a1, a2, b0, b1, b2}.
    
    Returns:
    
    The coefficient array.
  - getFilterResponse
```
public IIRFilter.IIRFilterAnalysis getFilterResponse(float freq)
```
    Gets an array filled with the filter response characteristics: {frequency response (real), frequency response (imaginary), amplitude response, phase response, phase delay, group delay}.
    
    Specified by:
    
    getFilterResponse in class IIRFilter
    
    Parameters:
    
    freq - The frequency to test.
    
    Returns:
    
    The array.
  - setCustomType
```
public BiquadFilter setCustomType(BiquadFilter.CustomCoeffCalculator cc)
```
    Sets a user-defined coefficient calculation algorithm. The algorithm is defined in a user-defined class that extends BiquadFilter.CustomCoeffCalculator.
    
    Parameters:
    
    cc - The custom coefficient calculator.

Class BiquadFilter

Nested Class Summary

Nested classes/interfaces inherited from class net.beadsproject.beads.ugens.IIRFilter

Nested classes/interfaces inherited from class net.beadsproject.beads.core.UGen

Field Summary

Fields inherited from class net.beadsproject.beads.core.UGen

Constructor Summary

Method Summary

Methods inherited from class net.beadsproject.beads.ugens.IIRFilter

Methods inherited from class net.beadsproject.beads.core.UGen

Methods inherited from class net.beadsproject.beads.core.Bead

Methods inherited from class java.lang.Object

Field Detail

LP

HP

BP_SKIRT

BP_PEAK

NOTCH

AP

PEAKING_EQ

LOW_SHELF

HIGH_SHELF

BUTTERWORTH_LP

BUTTERWORTH_HP

BESSEL_LP

BESSEL_HP

CUSTOM_FILTER

a0

a1

a2

b0

b1

b2

channels

freq

q

gain

type

samplingfreq

two_pi_over_sf

pi_over_sf

SQRT2

w

ampResponse

phaseResponse

phaseDelay

frReal

frImag

bo1m

bo2m

bi1m

bi2m

bo1

bo2

bi1

bi2

cuedInputMemory

cuedOutputMemory

cbo1m

cbo2m

cbi1m

cbi2m

cbo1

cbo2

cbi1

cbi2

vc

freqUGen

qUGen

gainUGen

isFreqStatic

isQStatic

isGainStatic

areAllStatic

Constructor Detail

BiquadFilter

BiquadFilter

BiquadFilter

BiquadFilter

BiquadFilter