org.openimaj.audio

Class AudioPlayer

java.lang.Object

org.openimaj.audio.AudioPlayer

All Implemented Interfaces:

Runnable, TimeKeeper<AudioTimecode>

public class AudioPlayer
extends Object
implements Runnable, TimeKeeper<AudioTimecode>

Wraps the Java Sound APIs into the OpenIMAJ audio core for playing sounds.

The AudioPlayer supports the TimeKeeper interface so that other methods can synchronise to the audio timestamps.

The Audio Player as a TimeKeeper supports seeking but it may be possible that the underlying stream does not support seeking so the seek method may not affect the time keeper as expected.

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

8 Jun 2011

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AudioPlayer.Mode Enumerator for the current state of the audio player.

Constructor Summary

Constructors

Constructor and Description
AudioPlayer(AudioStream a) Default constructor that takes an audio stream to play.
AudioPlayer(AudioStream a, String deviceName) Play the given stream to a specific device.

Method Summary

Modifier and Type	Method and Description
void	addAudioEventListener(AudioEventListener l) Add the given audio event listener to this player.
static AudioPlayer	createAudioPlayer(AudioStream as) Create a new audio player in a separate thread for playing audio.
static AudioPlayer	createAudioPlayer(AudioStream as, String device) Create a new audio player in a separate thread for playing audio.
protected void	fireAfterPlay(SampleChunk sc) Fires an event that says the samples have been played.
protected void	fireAudioEnded(AudioStream as) Fires the audio ended event to the listeners.
protected void	fireBeforePlay(SampleChunk sc) Fires an event that says the samples will be played.
AudioTimecode	getTime() Returns the current time.
Timecode	getTimecodeObject() Returns the current timecode.
void	pause() Pause the running of the timekeeper.
void	removeAudioEventListener(AudioEventListener l) Remove the given event from the listeners on this player.
void	reset() Reset the timekeeper.
void	run() Use this method to start the time keeper running.
void	seek(long timestamp) Seek to a given timestamp.
void	setMode(AudioPlayer.Mode m) Set the mode of the player.
void	setSoundLineBufferSize(double ms) Set the length of the sound line's buffer in milliseconds.
void	setTimecodeObject(AudioTimecode t) Set the timecode object that is updated as the audio is played.
void	stop() Use this method to stop the time keeper from running.
boolean	supportsPause() Returns whether the timekeeper supports pausing.
boolean	supportsSeek() Returns whether the timekeeper supports seeking.

Methods inherited from class java.lang.Object

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

Constructor Detail

AudioPlayer

public AudioPlayer(AudioStream a)

Default constructor that takes an audio stream to play.

Parameters:

a - The audio stream to play

AudioPlayer

public AudioPlayer(AudioStream a,
                   String deviceName)

Play the given stream to a specific device.

Parameters:

a - The audio stream to play.

deviceName - The device to play the audio to.

Method Detail

setSoundLineBufferSize

public void setSoundLineBufferSize(double ms)

Set the length of the sound line's buffer in milliseconds. The longer the buffer the less likely the soundline will be to pop but the shorter the buffer the closer to real-time the sound output will be. This value must be set before the audio line is opened otherwise it will have no effect.

Parameters:

ms - The length of the sound line in milliseconds.

addAudioEventListener

public void addAudioEventListener(AudioEventListener l)

Add the given audio event listener to this player.

Parameters:

l - The listener to add.

removeAudioEventListener

public void removeAudioEventListener(AudioEventListener l)

Remove the given event from the listeners on this player.

Parameters:

l - The listener to remove.

fireAudioEnded

protected void fireAudioEnded(AudioStream as)

Fires the audio ended event to the listeners.

Parameters:

as - The audio stream that ended

fireBeforePlay

protected void fireBeforePlay(SampleChunk sc)

Fires an event that says the samples will be played.

Parameters:

sc - The samples to play

fireAfterPlay

protected void fireAfterPlay(SampleChunk sc)

Fires an event that says the samples have been played.

Parameters:

sc - The sampled have been played

setTimecodeObject

public void setTimecodeObject(AudioTimecode t)

Set the timecode object that is updated as the audio is played.

Parameters:

t - The timecode object.

getTimecodeObject

public Timecode getTimecodeObject()

Returns the current timecode.

Returns:

The timecode object.

run

public void run()

Use this method to start the time keeper running.

Specified by:

run in interface Runnable

Specified by:

run in interface TimeKeeper<AudioTimecode>

See Also:

Runnable.run()

createAudioPlayer

public static AudioPlayer createAudioPlayer(AudioStream as)

Create a new audio player in a separate thread for playing audio.

Parameters:

as - The audio stream to play.

Returns:

The audio player created.

createAudioPlayer

public static AudioPlayer createAudioPlayer(AudioStream as,
                                            String device)

Create a new audio player in a separate thread for playing audio. To find out device names, use AudioUtils.getDevices().

Parameters:

as - The audio stream to play.

device - The name of the device to use.

Returns:

The audio player created.

getTime

public AudioTimecode getTime()

Returns the current time.

Specified by:

getTime in interface TimeKeeper<AudioTimecode>

Returns:

the current time object.

See Also:

TimeKeeper.getTime()

stop

public void stop()

Use this method to stop the time keeper from running.

Specified by:

stop in interface TimeKeeper<AudioTimecode>

See Also:

TimeKeeper.stop()

setMode

public void setMode(AudioPlayer.Mode m)

Set the mode of the player.

Parameters:

m -

supportsPause

public boolean supportsPause()

Returns whether the timekeeper supports pausing. If the timekeeper supports pausing then a stop() followed by a run() will continue from where the timekeeper was paused. Use reset() inbetween to force the timekeeper to start from the beginning again.

Specified by:

supportsPause in interface TimeKeeper<AudioTimecode>

Returns:

TRUE if the timekeeper supports pausing.

See Also:

TimeKeeper.supportsPause()

supportsSeek

public boolean supportsSeek()

Returns whether the timekeeper supports seeking.

Specified by:

supportsSeek in interface TimeKeeper<AudioTimecode>

Returns:

TRUE if the timekeeper supports seeking.

See Also:

TimeKeeper.supportsSeek()

seek

public void seek(long timestamp)

Seek to a given timestamp.

Specified by:

seek in interface TimeKeeper<AudioTimecode>

Parameters:

timestamp - The timestamp to seek to

See Also:

TimeKeeper.seek(long)

reset

public void reset()

Reset the timekeeper.

Specified by:

reset in interface TimeKeeper<AudioTimecode>

See Also:

TimeKeeper.reset()

pause

public void pause()

Pause the running of the timekeeper.

Specified by:

pause in interface TimeKeeper<AudioTimecode>

See Also:

TimeKeeper.pause()