be.tarsos.dsp

Class AudioDispatcher

java.lang.Object

be.tarsos.dsp.AudioDispatcher

All Implemented Interfaces:

java.lang.Runnable

public class AudioDispatcher
extends java.lang.Object
implements java.lang.Runnable

This class plays a file and sends float arrays to registered AudioProcessor implementors. This class can be used to feed FFT's, pitch detectors, audio players, ... Using a (blocking) audio player it is even possible to synchronize execution of AudioProcessors and sound. This behavior can be used for visualization.

Author:

Joren Six

Constructor Summary

Constructors

Constructor and Description
AudioDispatcher(TarsosDSPAudioInputStream stream, int audioBufferSize, int bufferOverlap) Create a new dispatcher from a stream.

Method Summary

Modifier and Type	Method and Description
void	addAudioProcessor(AudioProcessor audioProcessor) Adds an AudioProcessor to the chain of processors.
TarsosDSPAudioFormat	getFormat()
boolean	isStopped()
void	removeAudioProcessor(AudioProcessor audioProcessor) Removes an AudioProcessor to the chain of processors and calls its processingFinished method.
void	run()
float	secondsProcessed()
void	setAudioFloatBuffer(float[] audioBuffer)
void	setStepSizeAndOverlap(int audioBufferSize, int bufferOverlap) Set a new step size and overlap size.
void	setZeroPadFirstBuffer(boolean zeroPadFirstBuffer) if zero pad is true then the first buffer is only filled up to buffer size - hop size E.g.
void	setZeroPadLastBuffer(boolean zeroPadLastBuffer) If zero pad last buffer is true then the last buffer is filled with zeros until the normal amount of elements are present in the buffer.
void	skip(double seconds) Skip a number of seconds before processing the stream.
void	stop() Stops dispatching audio data.

Methods inherited from class java.lang.Object

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

Constructor Detail

AudioDispatcher

public AudioDispatcher(TarsosDSPAudioInputStream stream,
                       int audioBufferSize,
                       int bufferOverlap)

Create a new dispatcher from a stream.

Parameters:

stream - The stream to read data from.

audioBufferSize - The size of the buffer defines how much samples are processed in one step. Common values are 1024,2048.

bufferOverlap - How much consecutive buffers overlap (in samples). Half of the AudioBufferSize is common (512, 1024) for an FFT.

Method Detail

skip

public void skip(double seconds)

Skip a number of seconds before processing the stream.

Parameters:

seconds -

setStepSizeAndOverlap

public void setStepSizeAndOverlap(int audioBufferSize,
                                  int bufferOverlap)

Set a new step size and overlap size. Both in number of samples. Watch out with this method: it should be called after a batch of samples is processed, not during.

Parameters:

audioBufferSize - The size of the buffer defines how much samples are processed in one step. Common values are 1024,2048.

bufferOverlap - How much consecutive buffers overlap (in samples). Half of the AudioBufferSize is common (512, 1024) for an FFT.

setZeroPadFirstBuffer

public void setZeroPadFirstBuffer(boolean zeroPadFirstBuffer)

if zero pad is true then the first buffer is only filled up to buffer size - hop size E.g. if the buffer is 2048 and the hop size is 48 then you get 2000x0 and 48 filled audio samples

Parameters:

zeroPadFirstBuffer - true if the buffer should be zeroPadFirstBuffer, false otherwise.

setZeroPadLastBuffer

public void setZeroPadLastBuffer(boolean zeroPadLastBuffer)

If zero pad last buffer is true then the last buffer is filled with zeros until the normal amount of elements are present in the buffer. Otherwise the buffer only contains the last elements and no zeros. By default it is set to true.

Parameters:

zeroPadLastBuffer -

addAudioProcessor

public void addAudioProcessor(AudioProcessor audioProcessor)

Adds an AudioProcessor to the chain of processors.

Parameters:

audioProcessor - The AudioProcessor to add.

removeAudioProcessor

public void removeAudioProcessor(AudioProcessor audioProcessor)

Removes an AudioProcessor to the chain of processors and calls its processingFinished method.

Parameters:

audioProcessor - The AudioProcessor to remove.

run

public void run()

Specified by:

run in interface java.lang.Runnable

stop

public void stop()

Stops dispatching audio data.

getFormat

public TarsosDSPAudioFormat getFormat()

secondsProcessed

public float secondsProcessed()

Returns:

The currently processed number of seconds.

setAudioFloatBuffer

public void setAudioFloatBuffer(float[] audioBuffer)

isStopped

public boolean isStopped()

Returns:

True if the dispatcher is stopped or the end of stream has been reached.