com.tagtraum.jipes.audio

Class AudioSignalSource

java.lang.Object

com.tagtraum.jipes.audio.AudioSignalSource

All Implemented Interfaces:

SignalSource<AudioBuffer>, Closeable, AutoCloseable

public class AudioSignalSource
extends Object
implements SignalSource<AudioBuffer>, Closeable

Encapsulates an AudioInputStream to serve as a SignalSource for a SignalPump or a SignalPullProcessor.

The provided stream/file is converted to float[] based RealAudioBuffers. This also implies a normalization to values between -1 and 1 (signed) or 0 and 1 (unsigned). Normalization can be turned off via setNormalize(boolean).

If the signal contains multiple channels, these channel signals are still in their original (potentially interleaved) layout.

As of Java 6, mp3 is unfortunately not supported out of the box by Java. You might need to install the free codec JLayer. Platform dependent alternatives are CASampledSP and MFSampledSP/

Author:

Hendrik Schreiber

See Also:

AudioSystem.getAudioInputStream(java.io.File), JLayer, CASampledSP, MFSampledSP

Constructor Summary

Constructors

Constructor and Description
AudioSignalSource(AudioInputStream in) Creates a normalized (see isNormalize()) SignalSource from the given stream, using a 16kb internal buffer.
AudioSignalSource(AudioInputStream in, int bufferSize) Creates a normalized (see isNormalize()) SignalSource from the given stream.
AudioSignalSource(File file) Creates a normalized (see isNormalize()) SignalSource from the given file, using a 16kb internal buffer.

Method Summary

Modifier and Type	Method and Description
void	close() Close this signal source and its underlying AudioInputStream.
boolean	equals(Object o)
protected void	finalize()
int	hashCode()
boolean	isNormalize() Indicates whether all values are normalized to -1 t0 1 (signed) or 0 to 1 (unsigned).
AudioBuffer	read() Provide the next chunk of output data.
void	reset() Since this source is stream-based it cannot be properly reset.
void	setNormalize(boolean normalize) Turns normalization to values between -1 and 1 (signed) or 0 and 1 (unsigned) on or off.
String	toString()

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AudioSignalSource

public AudioSignalSource(AudioInputStream in,
                         int bufferSize)
                  throws IllegalArgumentException

Creates a normalized (see isNormalize()) SignalSource from the given stream.

Parameters:

in - audio input stream with an associated AudioFormat that has at least sampleSizeInBits, channels, and frameSize set

bufferSize - buffer this must be a multiple of the audio format's framesize

Throws:

IllegalArgumentException - if the audio format is not specific enough

AudioSignalSource

public AudioSignalSource(AudioInputStream in)
                  throws IllegalArgumentException

Creates a normalized (see isNormalize()) SignalSource from the given stream, using a 16kb internal buffer.

Parameters:

in - audio input stream

Throws:

IllegalArgumentException - if the audio format is not specific enough

AudioSignalSource

public AudioSignalSource(File file)
                  throws UnsupportedAudioFileException,
                         IOException,
                         IllegalArgumentException

Creates a normalized (see isNormalize()) SignalSource from the given file, using a 16kb internal buffer.

Parameters:

file - audio file

Throws:

UnsupportedAudioFileException - if the file is not supported by AudioSystem.

IOException - if something goes wrong while opening the audio file

IllegalArgumentException - if the audio format extracted from the file is not specific enough

Method Detail

isNormalize

public boolean isNormalize()

Indicates whether all values are normalized to -1 t0 1 (signed) or 0 to 1 (unsigned).

Returns:

true if this source is normalizing all values

setNormalize

public void setNormalize(boolean normalize)

Turns normalization to values between -1 and 1 (signed) or 0 and 1 (unsigned) on or off.

Parameters:

normalize - true or off

reset

public void reset()

Since this source is stream-based it cannot be properly reset.

Specified by:

reset in interface SignalSource<AudioBuffer>

read

public AudioBuffer read()
                 throws IOException

Description copied from interface: SignalSource

Provide the next chunk of output data. This method is called by a consumer of SignalSource data, typically an SignalPullProcessor.

Specified by:

read in interface SignalSource<AudioBuffer>

Returns:

output data - perhaps a float[] or even a more complex object like a AudioBuffer, null if no more data is available

Throws:

IOException - if something goes wrong

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

close

public void close()
           throws IOException

Close this signal source and its underlying AudioInputStream.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object