biz.source_code.dsp.sound

Class AudioStreamPump

java.lang.Object

biz.source_code.dsp.sound.AudioStreamPump

public class AudioStreamPump
extends Object

A data pump for audio streams.

This class maintains an internal thread to copy audio data from an input stream to an output stream. It is used for real-time audio i/o.

Constructor Summary

Constructors

Constructor and Description
AudioStreamPump(AudioInputStream inputStream, SourceDataLine outputLine) Creates a pump for non-real-time input.
AudioStreamPump(TargetDataLine inputLine, AudioInputStream inputStream, SourceDataLine outputLine, int pumpBufferTimeMs) Creates a pump for real-time input with filters.
AudioStreamPump(TargetDataLine inputLine, SourceDataLine outputLine, int pumpBufferTimeMs) Creates a pump for real-time input without filters.

Method Summary

Modifier and Type	Method and Description
void	start() Starts the pump.
void	stop() Stops the pump immediatelly.
void	waitForCompletion(long millis) Waits until the pump completes, e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

AudioStreamPump

public AudioStreamPump(TargetDataLine inputLine,
                       AudioInputStream inputStream,
                       SourceDataLine outputLine,
                       int pumpBufferTimeMs)

Creates a pump for real-time input with filters.

This constructor is used when a real-time data stream from an input line is piped through filters that provide an AudioInputStream. The data is read from the inputStream, but the inputLine is used to start and stop the input stream flow.

Parameters:

inputLine - A TargetDataLine that will be used to start/stop the input audio stream.

inputStream - A AudioInputStream that will be used to read the audio data.

outputLine - The output line.

pumpBufferTimeMs - Time in milliseconds, used to determine the size of the internal buffer. For a minimal real-time delay, the buffer should be as small as possible, but if the buffer is too small, performance will degrade.

AudioStreamPump

public AudioStreamPump(TargetDataLine inputLine,
                       SourceDataLine outputLine,
                       int pumpBufferTimeMs)

Creates a pump for real-time input without filters.

This constructor is used when a real-time input data stream comes directly from the input line.

Parameters:

inputLine - The input line.

outputLine - The output line.

pumpBufferTimeMs - Time in milliseconds, used to determine the size of the internal buffer. For a minimal real-time delay, the buffer should be as small as possible, but if the buffer is too small, performance will degrade.

AudioStreamPump

public AudioStreamPump(AudioInputStream inputStream,
                       SourceDataLine outputLine)

Creates a pump for non-real-time input.

This constructor is used with non-real-time input, e.g. input from a sound file.

Parameters:

inputStream - The input stream.

outputLine - The output line.

Method Detail

start

public void start()

Starts the pump.

waitForCompletion

public void waitForCompletion(long millis)
                       throws InterruptedException

Waits until the pump completes, e.g. because the end of the input stream has been reached or because of an error.

Parameters:

millis - The maximum number of milliseconds to wait.

Throws:

InterruptedException

stop

public void stop()
          throws Exception

Stops the pump immediatelly.

Throws:

Exception