ddf.minim.ugens

Class Flanger

java.lang.Object

ddf.minim.UGen

ddf.minim.ugens.Flanger

public class Flanger
extends UGen

A Flanger is a specialized kind of delay that uses an LFO (low frequency oscillator) to vary the amount of delay applied to each sample. This causes a sweeping frequency kind of sound as the signal reinforces or cancels itself in various ways. In particular the peaks and notches created in the frequency spectrum are related to each other in a linear harmonic series. This causes the spectrum to look like a comb.

Inputs for the Flanger are:

• delay (in milliseconds): the minimum amount of delay applied to an incoming sample
• rate (in Hz): the frequency of the LFO
• depth (in milliseconds): the maximum amount of delay added onto delay by the LFO
• feedback: how much of delayed signal should be fed back into the effect
• dry: how much of the uneffected input should be included in the output
• wet: how much of the effected signal should be included in the output

A more thorough description can be found on wikipedia: http://en.wikipedia.org/wiki/Flanging

Author:

Damien Di Fede

Nested Class Summary

Nested classes/interfaces inherited from class ddf.minim.UGen

UGen.InputType, UGen.UGenInput

Field Summary

Fields

Modifier and Type	Field and Description
UGen.UGenInput	audio Where the input goes.
UGen.UGenInput	delay How much does the flanger delay the incoming signal.
UGen.UGenInput	depth How many milliseconds the LFO increases the delay by at the maximum.
UGen.UGenInput	dry How much of the dry signal is added to the output.
UGen.UGenInput	feedback How much of the flanged signal is fed back into the effect.
UGen.UGenInput	rate The frequency of the LFO applied to the delay.
UGen.UGenInput	wet How much of the flanged signal is added to the output.

Constructor Summary

Constructors

Constructor and Description
Flanger(float delayLength, float lfoRate, float delayDepth, float feedbackAmplitude, float dryAmplitude, float wetAmplitude) Construct a Flanger by specifying all initial values.

Method Summary

Modifier and Type	Method and Description
protected void	channelCountChanged() This method is only called when setChannelCount results in the channel count of this UGen actually changing.
protected void	sampleRateChanged() Override this method in your derived class to receive a notification when the sample rate of your UGen has changed.
protected void	uGenerate(float[] out) Implement this method when you extend UGen.

Methods inherited from class ddf.minim.UGen

addAudio, addControl, addControl, addInput, channelCount, getLastValues, patch, patch, patch, printInputs, removeInput, sampleRate, setChannelCount, setSampleRate, tick, unpatch, unpatch

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

audio

public UGen.UGenInput audio

Where the input goes.

delay

public UGen.UGenInput delay

How much does the flanger delay the incoming signal. Used as the low value of the modulated delay amount.

rate

public UGen.UGenInput rate

The frequency of the LFO applied to the delay.

depth

public UGen.UGenInput depth

How many milliseconds the LFO increases the delay by at the maximum.

feedback

public UGen.UGenInput feedback

How much of the flanged signal is fed back into the effect.

dry

public UGen.UGenInput dry

How much of the dry signal is added to the output.

wet

public UGen.UGenInput wet

How much of the flanged signal is added to the output.

Constructor Detail

Flanger

public Flanger(float delayLength,
               float lfoRate,
               float delayDepth,
               float feedbackAmplitude,
               float dryAmplitude,
               float wetAmplitude)

Construct a Flanger by specifying all initial values.

Parameters:

delayLength - float: the minimum delay applied to incoming samples (in milliseconds)

lfoRate - float: the frequency of the the LFO

delayDepth - float: the maximum amount added to the delay by the LFO (in milliseconds)

feedbackAmplitude - float: the amount of the flanged signal fed back into the effect

dryAmplitude - float: the amount of incoming signal added to the output

wetAmplitude - float: the amount of the flanged signal added to the output

Method Detail

sampleRateChanged

protected void sampleRateChanged()

Description copied from class: UGen

Override this method in your derived class to receive a notification when the sample rate of your UGen has changed. You might need to do this to recalculate sample rate dependent values, such as the step size for an oscillator.

Overrides:

sampleRateChanged in class UGen

channelCountChanged

protected void channelCountChanged()

Description copied from class: UGen

This method is only called when setChannelCount results in the channel count of this UGen actually changing. Override this function in sub-classes of UGen if you need to reconfigure things when the channel count changes.

Overrides:

channelCountChanged in class UGen

uGenerate

protected void uGenerate(float[] out)

Description copied from class: UGen

Implement this method when you extend UGen. It will be called when your UGen needs to generate one sample frame of audio. It is expected that you will assign values to the array and not simply modify the existing values. In the case where you write a UGen that takes audio input and modifies it, the pattern to follow is to have the first UGenInput you create be your audio input and then in uGenerate you will use the getLastValues method of your audio UGenInput to retrieve the audio you want to modify, which you will then modify however you need to, assigning the result to the values in channels.

Specified by:

uGenerate in class UGen

Parameters:

out - an array representing one sample frame.