org.jscience.media.audio.dsp.processors
Class Chorus

java.lang.Object
  extended by org.jscience.media.audio.dsp.AbstractAudio
      extended by org.jscience.media.audio.dsp.processors.Chorus
All Implemented Interfaces:
Named

public class Chorus
extends AbstractAudio

DOCUMENT ME!


Field Summary
 
Fields inherited from class org.jscience.media.audio.dsp.AbstractAudio
ALLTYPES, MONITOR, next, NOTYPE, previous, PROCESSOR, SAMPLEBUFFERSIZE, SINK, SOURCE
 
Constructor Summary
Chorus()
          Creates a new Chorus object.
 
Method Summary
 void doInitialization()
          DOCUMENT ME!
 int getSamples(short[] buffer, int length)
          DOCUMENT ME!
 void minMaxChannels(int min, int max, int preferred)
          DOCUMENT ME!
 void minMaxSamplingRate(int min, int max, int preferred)
          DOCUMENT ME!
protected  int processMonoSamples(short[] localBuffer, short[] buffer, int len)
          DOCUMENT ME!
protected  int processStereoSamples(short[] localBuffer, short[] buffer, int len)
          DOCUMENT ME!
 void setDelayInMs(int delayInMs)
          DOCUMENT ME!
 void setDepthLevel(double depthInMs)
          DOCUMENT ME!
 void setDryLevel(int dryLevel)
          DOCUMENT ME!
 void setFeedbackLevel(int feedbackLevel)
          DOCUMENT ME!
 void setFeedbackPhase(boolean invertPhase)
          DOCUMENT ME!
 void setLFOMode(boolean isSinLFO)
          DOCUMENT ME!
 void setRateInHz(double rateInHz)
          DOCUMENT ME!
 void setWetLevel(int wetLevel)
          DOCUMENT ME!
 
Methods inherited from class org.jscience.media.audio.dsp.AbstractAudio
doReset, equals, getByPass, getName, getNumberOfChannels, getSamplingRate, hexo, hexo, hexo, hexo, negotiateNumberOfChannels, negotiateSamplingRate, o, propagateReset, reset, setByPass, setChannelsRecursive, setNumberOfChannels, setSamplingRate, setSamplingRateRecursive, toString, typeString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Chorus

public Chorus()
Creates a new Chorus object.

Method Detail

getSamples

public int getSamples(short[] buffer,
                      int length)
DOCUMENT ME!

Specified by:
getSamples in class AbstractAudio
Parameters:
buffer - DOCUMENT ME!
length - DOCUMENT ME!
Returns:
DOCUMENT ME!

processMonoSamples

protected int processMonoSamples(short[] localBuffer,
                                 short[] buffer,
                                 int len)
DOCUMENT ME!

Parameters:
localBuffer - DOCUMENT ME!
buffer - DOCUMENT ME!
len - DOCUMENT ME!
Returns:
DOCUMENT ME!

processStereoSamples

protected int processStereoSamples(short[] localBuffer,
                                   short[] buffer,
                                   int len)
DOCUMENT ME!

Parameters:
localBuffer - DOCUMENT ME!
buffer - DOCUMENT ME!
len - DOCUMENT ME!
Returns:
DOCUMENT ME!

setDelayInMs

public void setDelayInMs(int delayInMs)
DOCUMENT ME!

Parameters:
delayInMs - DOCUMENT ME!

setRateInHz

public void setRateInHz(double rateInHz)
DOCUMENT ME!

Parameters:
rateInHz - DOCUMENT ME!

setLFOMode

public void setLFOMode(boolean isSinLFO)
DOCUMENT ME!

Parameters:
isSinLFO - DOCUMENT ME!

setDepthLevel

public void setDepthLevel(double depthInMs)
DOCUMENT ME!

Parameters:
depthInMs - DOCUMENT ME!

setDryLevel

public void setDryLevel(int dryLevel)
DOCUMENT ME!

Parameters:
dryLevel - DOCUMENT ME!

setWetLevel

public void setWetLevel(int wetLevel)
DOCUMENT ME!

Parameters:
wetLevel - DOCUMENT ME!

setFeedbackPhase

public void setFeedbackPhase(boolean invertPhase)
DOCUMENT ME!

Parameters:
invertPhase - DOCUMENT ME!

setFeedbackLevel

public void setFeedbackLevel(int feedbackLevel)
DOCUMENT ME!

Parameters:
feedbackLevel - DOCUMENT ME!

doInitialization

public void doInitialization()
DOCUMENT ME!


minMaxSamplingRate

public void minMaxSamplingRate(int min,
                               int max,
                               int preferred)
DOCUMENT ME!

Overrides:
minMaxSamplingRate in class AbstractAudio
Parameters:
min - DOCUMENT ME!
max - DOCUMENT ME!
preferred - DOCUMENT ME!

minMaxChannels

public void minMaxChannels(int min,
                           int max,
                           int preferred)
DOCUMENT ME!

Overrides:
minMaxChannels in class AbstractAudio
Parameters:
min - DOCUMENT ME!
max - DOCUMENT ME!
preferred - DOCUMENT ME!