be.tarsos.dsp.effects

Class FlangerEffect

java.lang.Object

be.tarsos.dsp.effects.FlangerEffect

All Implemented Interfaces:

AudioProcessor

public class FlangerEffect
extends java.lang.Object
implements AudioProcessor

Adds a flanger effect to a signal. The implementation is done with a delay buffer and an LFO in the form of a sine wave. It is probably the most straightforward flanger implementation possible.

Author:

Joren Six

Constructor Summary

Constructors

Constructor and Description
FlangerEffect(double maxFlangerLength, double wet, double sampleRate, double lfoFrequency)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	process(AudioEvent audioEvent) Process the audio event.
void	processingFinished() Notify the AudioProcessor that no more data is available and processing has finished.
void	setDry(double dry) Sets the wetness and wetness of the effect.
void	setFlangerLength(double flangerLength) Set the new length of the delay LineWavelet.
void	setLFOFrequency(double lfoFrequency) Sets the frequency of the LFO (sine wave), in Hertz.
void	setWet(double wet) Sets the wetness and dryness of the effect.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlangerEffect

public FlangerEffect(double maxFlangerLength,
             double wet,
             double sampleRate,
             double lfoFrequency)

Parameters:

maxFlangerLength - in seconds

wet - The 'wetness' of the flanging effect. A value between 0 and 1. Zero meaning no flanging effect in the resulting signal, one means total flanging effect and no original signal left. The dryness of the signal is determined by dry = "1-wet".

sampleRate - the sample rate in Hz.

lfoFrequency - in Hertz

Method Detail

process

public boolean process(AudioEvent audioEvent)

Description copied from interface: AudioProcessor

Process the audio event. Do the actual signal processing on an (optionally) overlapping buffer.

Specified by:

process in interface AudioProcessor

Parameters:

audioEvent - The audio event that contains audio data.

Returns:

False if the chain needs to stop here, true otherwise. This can be used to implement e.g. a silence detector.

processingFinished

public void processingFinished()

Description copied from interface: AudioProcessor

Notify the AudioProcessor that no more data is available and processing has finished. Can be used to deallocate resources or cleanup.

Specified by:

processingFinished in interface AudioProcessor

setFlangerLength

public void setFlangerLength(double flangerLength)

Set the new length of the delay LineWavelet.

Parameters:

flangerLength - The new length of the delay LineWavelet, in seconds.

setLFOFrequency

public void setLFOFrequency(double lfoFrequency)

Sets the frequency of the LFO (sine wave), in Hertz.

Parameters:

lfoFrequency - The new LFO frequency in Hertz.

setWet

public void setWet(double wet)

Sets the wetness and dryness of the effect. Should be a value between zero and one (inclusive), the dryness is determined by 1-wet.

Parameters:

wet - A value between zero and one (inclusive) that determines the wet and dryness of the resulting mix.

setDry

public void setDry(double dry)

Sets the wetness and wetness of the effect. Should be a value between zero and one (inclusive), the wetness is determined by 1-dry.

Parameters:

dry - A value between zero and one (inclusive) that determines the wet and dryness of the resulting mix.