uk.org.toot.audio.core
Interface AudioProcess

All Known Subinterfaces:
AudioInput, AudioOutput, AudioPort, IOAudioProcess
All Known Implementing Classes:
AbstractEQ, AbstractParallelEQ, AbstractSerialEQ, AudioMixerStrip, AudioProcessAdapter, AudioProcessChain, Compressor, CutEQ, DenormalProcess, DynamicsProcess, EQ, Example2SynthChannel, Example3SynthChannel, Expander, Gate, GraphicEQ, Limiter, MainMixProcess, MeterProcess, MixProcess, ModulatedDelayProcess, MultiBandCompressor, MultiTapDelayProcess, NullAudioProcess, ParametricEQ, PluckedSynth, PolyphonicSynthChannel, SilentInputAudioProcess, SimpleAudioProcess, StereoImageProcess, StereoModulatedDelayProcess, TempoDelayProcess

public interface AudioProcess

The simple contract for an AudioProcess, the fundamental unit of digital signal processing, separate from the concern of control. 'Inputs' should fill the buffer, 'Processes' should process the buffer, 'Outputs' should output the buffer, Something else provides the buffer. There is intentionally no support for routing, that's a separate concern. Inputs should also call buffer.setMetaInfo() and buffer.setChannelFormat().


Field Summary
static int AUDIO_DISCONNECT
          Returned from processAudio() to indicate the buffer has not been processed so that subsequent processing may be avoided.
static int AUDIO_OK
          Returned from processAudio() to indicate a valid processed buffer.
 
Method Summary
 void close()
          Close any resources opened by this AudioProcess.
 void open()
          Open any resources required by this AudioProcess.
 int processAudio(AudioBuffer buffer)
          Process the supplied buffer
 

Field Detail

AUDIO_OK

static final int AUDIO_OK
Returned from processAudio() to indicate a valid processed buffer.

See Also:
Constant Field Values

AUDIO_DISCONNECT

static final int AUDIO_DISCONNECT
Returned from processAudio() to indicate the buffer has not been processed so that subsequent processing may be avoided.

See Also:
Constant Field Values
Method Detail

open

void open()
          throws java.lang.Exception
Open any resources required by this AudioProcess.

Throws:
java.lang.Exception

processAudio

int processAudio(AudioBuffer buffer)
Process the supplied buffer

Parameters:
buffer - the AudioBuffer to process.
Returns:
int AUDIO_OK or AUDIO_DISCONNECT.

close

void close()
           throws java.lang.Exception
Close any resources opened by this AudioProcess.

Throws:
java.lang.Exception


Copyright © 2004, 2005, 2006, 2007 Steve Taylor. All Rights Reserved.