com.brackeen.javagamebook.sound
Class SoundManager

java.lang.Object
  java.lang.ThreadGroup
      com.brackeen.javagamebook.util.ThreadPool
          com.brackeen.javagamebook.sound.SoundManager

All Implemented Interfaces:

java.lang.Thread.UncaughtExceptionHandler

public class SoundManager
extends ThreadPool

The SoundManager class manages sound playback. The SoundManager is a ThreadPool, with each thread playing back one sound at a time. This allows the SoundManager to easily limit the number of simultaneous sounds being played.

Possible ideas to extend this class:

• add a setMasterVolume() method, which uses Controls to set the volume for each line.
• don't play a sound if more than, say, 500ms has passed since the request to play

Nested Class Summary

protected class

SoundManager.SoundPlayer The SoundPlayer class is a task for the PooledThreads to run.

Field Summary

private java.lang.ThreadLocal	localBuffer
private java.lang.ThreadLocal	localLine
private boolean	paused
private java.lang.Object	pausedLock
private javax.sound.sampled.AudioFormat	playbackFormat

Constructor Summary

SoundManager(javax.sound.sampled.AudioFormat playbackFormat)
Creates a new SoundManager using the maximum number of simultaneous sounds.

SoundManager(javax.sound.sampled.AudioFormat playbackFormat, int maxSimultaneousSounds)
Creates a new SoundManager with the specified maximum number of simultaneous sounds.

Method Summary

protected void	cleanUp() Does any clean up before closing.
void	close() Closes this ThreadPool and returns immediately.
javax.sound.sampled.AudioInputStream	getAudioInputStream(java.io.InputStream is) Creates an AudioInputStream from a sound from an input stream
javax.sound.sampled.AudioInputStream	getAudioInputStream(java.lang.String filename) Creates an AudioInputStream from a sound from the file system.
static int	getMaxSimultaneousSounds(javax.sound.sampled.AudioFormat playbackFormat) Gets the maximum number of simultaneous sounds with the specified AudioFormat that the default mixer can play.
Sound	getSound(javax.sound.sampled.AudioInputStream audioStream) Loads a Sound from an AudioInputStream.
Sound	getSound(java.io.InputStream is) Loads a Sound from an input stream.
Sound	getSound(java.lang.String filename) Loads a Sound from the file system.
boolean	isPaused() Returns the paused state.
void	join() Closes this ThreadPool and waits for all running threads to finish.
java.io.InputStream	play(java.io.InputStream is) Plays a sound from an InputStream.
java.io.InputStream	play(java.io.InputStream is, SoundFilter filter) Plays a sound from an InputStream with an optional sound filter.
java.io.InputStream	play(Sound sound) Plays a sound.
java.io.InputStream	play(Sound sound, SoundFilter filter, boolean loop) Plays a sound with an optional SoundFilter, and optionally looping.
void	setPaused(boolean paused) Sets the paused state.
protected void	threadStarted() Signals that a PooledThread has started.
protected void	threadStopped() Signals that a PooledThread has stopped.

Methods inherited from class com.brackeen.javagamebook.util.ThreadPool

getTask, runTask

Methods inherited from class java.lang.ThreadGroup

activeCount, activeGroupCount, allowThreadSuspension, checkAccess, destroy, enumerate, enumerate, enumerate, enumerate, getMaxPriority, getName, getParent, interrupt, isDaemon, isDestroyed, list, parentOf, resume, setDaemon, setMaxPriority, stop, suspend, toString, uncaughtException

Methods inherited from class java.lang.Object

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

Field Detail

playbackFormat

private javax.sound.sampled.AudioFormat playbackFormat

localLine

private java.lang.ThreadLocal localLine

localBuffer

private java.lang.ThreadLocal localBuffer

pausedLock

private java.lang.Object pausedLock

paused

private boolean paused

Constructor Detail

SoundManager

public SoundManager(javax.sound.sampled.AudioFormat playbackFormat)

Creates a new SoundManager using the maximum number of simultaneous sounds.

SoundManager

public SoundManager(javax.sound.sampled.AudioFormat playbackFormat,
                    int maxSimultaneousSounds)

Creates a new SoundManager with the specified maximum number of simultaneous sounds.

Method Detail

getMaxSimultaneousSounds

public static int getMaxSimultaneousSounds(javax.sound.sampled.AudioFormat playbackFormat)

Gets the maximum number of simultaneous sounds with the specified AudioFormat that the default mixer can play.

cleanUp

protected void cleanUp()

Does any clean up before closing.

close

public void close()

Description copied from class: ThreadPool

Closes this ThreadPool and returns immediately. All threads are stopped, and any waiting tasks are not executed. Once a ThreadPool is closed, no more tasks can be run on this ThreadPool.

Overrides:

close in class ThreadPool

join

public void join()

Description copied from class: ThreadPool

Closes this ThreadPool and waits for all running threads to finish. Any waiting tasks are executed.

Overrides:

join in class ThreadPool

setPaused

public void setPaused(boolean paused)

Sets the paused state. Sounds may not pause immediately.

isPaused

public boolean isPaused()

Returns the paused state.

getSound

public Sound getSound(java.lang.String filename)

Loads a Sound from the file system. Returns null if an error occurs.

getSound

public Sound getSound(java.io.InputStream is)

Loads a Sound from an input stream. Returns null if an error occurs.

getSound

public Sound getSound(javax.sound.sampled.AudioInputStream audioStream)

Loads a Sound from an AudioInputStream.

getAudioInputStream

public javax.sound.sampled.AudioInputStream getAudioInputStream(java.lang.String filename)

Creates an AudioInputStream from a sound from the file system.

getAudioInputStream

public javax.sound.sampled.AudioInputStream getAudioInputStream(java.io.InputStream is)

Creates an AudioInputStream from a sound from an input stream

play

public java.io.InputStream play(Sound sound)

Plays a sound. This method returns immediately.

play

public java.io.InputStream play(Sound sound,
                                SoundFilter filter,
                                boolean loop)

Plays a sound with an optional SoundFilter, and optionally looping. This method returns immediately.

play

public java.io.InputStream play(java.io.InputStream is)

Plays a sound from an InputStream. This method returns immediately.

play

public java.io.InputStream play(java.io.InputStream is,
                                SoundFilter filter)

Plays a sound from an InputStream with an optional sound filter. This method returns immediately.

threadStarted

protected void threadStarted()

Signals that a PooledThread has started. Creates the Thread's line and buffer.

Overrides:

threadStarted in class ThreadPool

threadStopped

protected void threadStopped()

Signals that a PooledThread has stopped. Drains and closes the Thread's Line.

Overrides:

threadStopped in class ThreadPool