org.intellimate.izou.system.sound

Class IzouSoundLineClipAndSDLine

java.lang.Object

org.intellimate.izou.util.IzouModule

org.intellimate.izou.system.sound.IzouSoundLineBaseClass

org.intellimate.izou.system.sound.IzouSoundDataLine

org.intellimate.izou.system.sound.IzouSoundLineClipAndSDLine

All Implemented Interfaces:

AutoCloseable, Clip, DataLine, Line, SourceDataLine, Identifiable, IzouSoundLine, MainProvider

public class IzouSoundLineClipAndSDLine
extends IzouSoundDataLine
implements Clip, SourceDataLine

the delegation to Clip and SourceDataLine.

Version:

1.0

Author:

LeanderK

Nested Class Summary

Nested classes/interfaces inherited from interface javax.sound.sampled.DataLine

DataLine.Info

Field Summary

Fields inherited from class org.intellimate.izou.system.sound.IzouSoundLineBaseClass

isMutable, isMutedFromSystem, line, soundManager

Fields inherited from class org.intellimate.izou.util.IzouModule

log, main

Fields inherited from interface javax.sound.sampled.Clip

LOOP_CONTINUOUSLY

Constructor Summary

Constructors

Constructor and Description
IzouSoundLineClipAndSDLine(Clip clip, SourceDataLine sourceDataLine, Main main, boolean isPermanent, AddOnModel addOnModel)

Method Summary

Modifier and Type	Method and Description
int	getFrameLength() Obtains the media length in sample frames.
long	getMicrosecondLength() Obtains the media duration in microseconds
void	loop(int count) Starts looping playback from the current position.
void	open(AudioFormat format) Opens the line with the specified format, causing the line to acquire any required system resources and become operational.
void	open(AudioFormat format, byte[] data, int offset, int bufferSize) Opens the clip, meaning that it should acquire any required system resources and become operational.
void	open(AudioFormat format, int bufferSize) Opens the line with the specified format and suggested buffer size, causing the line to acquire any required system resources and become operational.
void	open(AudioInputStream stream) Opens the clip with the format and audio data present in the provided audio input stream.
void	setFramePosition(int frames) Sets the media position in sample frames.
void	setLoopPoints(int start, int end) Sets the first and last sample frames that will be played in the loop.
void	setMicrosecondPosition(long microseconds) Sets the media position in microseconds.
int	write(byte[] b, int off, int len) Writes audio data to the mixer via this source data line.

Methods inherited from class org.intellimate.izou.system.sound.IzouSoundDataLine

available, drain, flush, getBufferSize, getFormat, getFramePosition, getLevel, getLongFramePosition, getMicrosecondPosition, isActive, isRunning, start, stop

Methods inherited from class org.intellimate.izou.system.sound.IzouSoundLineBaseClass

addLineListener, close, getAddOnModel, getControl, getControls, getLineInfo, getResponsibleID, isControlSupported, isMutedFromSystem, isMuteIfNonPermanent, isOpen, isPermanent, open, opening, removeLineListener, setMuteIfNonPermanent

Methods inherited from class org.intellimate.izou.util.IzouModule

debug, debug, error, error, fatal, fatal, getID, getMain

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.sound.sampled.DataLine

available, drain, flush, getBufferSize, getFormat, getFramePosition, getLevel, getLongFramePosition, getMicrosecondPosition, isActive, isRunning, start, stop

Methods inherited from interface javax.sound.sampled.Line

addLineListener, close, getControl, getControls, getLineInfo, isControlSupported, isOpen, open, removeLineListener

Methods inherited from interface org.intellimate.izou.identification.Identifiable

isOwner

Constructor Detail

IzouSoundLineClipAndSDLine

public IzouSoundLineClipAndSDLine(Clip clip,
                                  SourceDataLine sourceDataLine,
                                  Main main,
                                  boolean isPermanent,
                                  AddOnModel addOnModel)

Method Detail

open

public void open(AudioFormat format,
                 int bufferSize)
          throws LineUnavailableException

Opens the line with the specified format and suggested buffer size, causing the line to acquire any required system resources and become operational.

The buffer size is specified in bytes, but must represent an integral number of sample frames. Invoking this method with a requested buffer size that does not meet this requirement may result in an IllegalArgumentException. The actual buffer size for the open line may differ from the requested buffer size. The value actually set may be queried by subsequently calling DataLine.getBufferSize().

If this operation succeeds, the line is marked as open, and an OPEN event is dispatched to the line's listeners.

Invoking this method on a line which is already open is illegal and may result in an IllegalStateException.

Note that some lines, once closed, cannot be reopened. Attempts to reopen such a line will always result in a LineUnavailableException.

Specified by:

open in interface SourceDataLine

Parameters:

format - the desired audio format

bufferSize - the desired buffer size

Throws:

LineUnavailableException - if the line cannot be opened due to resource restrictions

IllegalArgumentException - if the buffer size does not represent an integral number of sample frames, or if format is not fully specified or invalid

IllegalStateException - if the line is already open

SecurityException - if the line cannot be opened due to security restrictions

See Also:

open(AudioFormat), Line.open(), Line.close(), Line.isOpen(), LineEvent

open

public void open(AudioFormat format)
          throws LineUnavailableException

Opens the line with the specified format, causing the line to acquire any required system resources and become operational.

The implementation chooses a buffer size, which is measured in bytes but which encompasses an integral number of sample frames. The buffer size that the system has chosen may be queried by subsequently calling DataLine.getBufferSize().

If this operation succeeds, the line is marked as open, and an OPEN event is dispatched to the line's listeners.

Invoking this method on a line which is already open is illegal and may result in an IllegalStateException.

Note that some lines, once closed, cannot be reopened. Attempts to reopen such a line will always result in a LineUnavailableException.

Specified by:

open in interface SourceDataLine

Parameters:

format - the desired audio format

Throws:

LineUnavailableException - if the line cannot be opened due to resource restrictions

IllegalArgumentException - if format is not fully specified or invalid

IllegalStateException - if the line is already open

SecurityException - if the line cannot be opened due to security restrictions

See Also:

open(AudioFormat, int), Line.open(), Line.close(), Line.isOpen(), LineEvent

write

public int write(byte[] b,
                 int off,
                 int len)

Writes audio data to the mixer via this source data line. The requested number of bytes of data are read from the specified array, starting at the given offset into the array, and written to the data line's buffer. If the caller attempts to write more data than can currently be written (see available), this method blocks until the requested amount of data has been written. This applies even if the requested amount of data to write is greater than the data line's buffer size. However, if the data line is closed, stopped, or flushed before the requested amount has been written, the method no longer blocks, but returns the number of bytes written thus far.

The number of bytes that can be written without blocking can be ascertained using the available method of the DataLine interface. (While it is guaranteed that this number of bytes can be written without blocking, there is no guarantee that attempts to write additional data will block.)

The number of bytes to write must represent an integral number of sample frames, such that:

[ bytes written ] % [frame size in bytes ] == 0
The return value will always meet this requirement. A request to write a number of bytes representing a non-integral number of sample frames cannot be fulfilled and may result in an IllegalArgumentException.

Specified by:

write in interface SourceDataLine

Parameters:

b - a byte array containing data to be written to the data line

off - the offset from the beginning of the array, in bytes

len - the length, in bytes, of the valid data in the array (in other words, the requested amount of data to write, in bytes)

Returns:

the number of bytes actually written

Throws:

IllegalArgumentException - if the requested number of bytes does not represent an integral number of sample frames, or if len is negative

ArrayIndexOutOfBoundsException - if off is negative, or off+len is greater than the length of the array b.

See Also:

TargetDataLine.read(byte[], int, int), DataLine.available()

open

public void open(AudioFormat format,
                 byte[] data,
                 int offset,
                 int bufferSize)
          throws LineUnavailableException

Opens the clip, meaning that it should acquire any required system resources and become operational. The clip is opened with the format and audio data indicated. If this operation succeeds, the line is marked as open and an OPEN event is dispatched to the line's listeners.

Invoking this method on a line which is already open is illegal and may result in an IllegalStateException.

Note that some lines, once closed, cannot be reopened. Attempts to reopen such a line will always result in a LineUnavailableException.

Specified by:

open in interface Clip

Parameters:

format - the format of the supplied audio data

data - a byte array containing audio data to load into the clip

offset - the point at which to start copying, expressed in bytes from the beginning of the array

bufferSize - the number of bytes of data to load into the clip from the array.

Throws:

LineUnavailableException - if the line cannot be opened due to resource restrictions

IllegalArgumentException - if the buffer size does not represent an integral number of sample frames, or if format is not fully specified or invalid

IllegalStateException - if the line is already open

SecurityException - if the line cannot be opened due to security restrictions

See Also:

IzouSoundLineBaseClass.close(), IzouSoundLineBaseClass.isOpen(), LineListener

open

public void open(AudioInputStream stream)
          throws LineUnavailableException,
                 IOException

Opens the clip with the format and audio data present in the provided audio input stream. Opening a clip means that it should acquire any required system resources and become operational. If this operation input stream. If this operation succeeds, the line is marked open and an OPEN event is dispatched to the line's listeners.

Invoking this method on a line which is already open is illegal and may result in an IllegalStateException.

Note that some lines, once closed, cannot be reopened. Attempts to reopen such a line will always result in a LineUnavailableException.

Specified by:

open in interface Clip

Parameters:

stream - an audio input stream from which audio data will be read into the clip

Throws:

LineUnavailableException - if the line cannot be opened due to resource restrictions

IOException - if an I/O exception occurs during reading of the stream

IllegalArgumentException - if the stream's audio format is not fully specified or invalid

IllegalStateException - if the line is already open

SecurityException - if the line cannot be opened due to security restrictions

See Also:

IzouSoundLineBaseClass.close(), IzouSoundLineBaseClass.isOpen(), LineListener

getFrameLength

public int getFrameLength()

Obtains the media length in sample frames.

Specified by:

getFrameLength in interface Clip

Returns:

the media length, expressed in sample frames, or AudioSystem.NOT_SPECIFIED if the line is not open.

See Also:

AudioSystem.NOT_SPECIFIED

getMicrosecondLength

public long getMicrosecondLength()

Obtains the media duration in microseconds

Specified by:

getMicrosecondLength in interface Clip

Returns:

the media duration, expressed in microseconds, or AudioSystem.NOT_SPECIFIED if the line is not open.

See Also:

AudioSystem.NOT_SPECIFIED

setFramePosition

public void setFramePosition(int frames)

Sets the media position in sample frames. The position is zero-based; the first frame is frame number zero. When the clip begins playing the next time, it will start by playing the frame at this position.

To obtain the current position in sample frames, use the getFramePosition method of DataLine.

Specified by:

setFramePosition in interface Clip

Parameters:

frames - the desired new media position, expressed in sample frames

setMicrosecondPosition

public void setMicrosecondPosition(long microseconds)

Sets the media position in microseconds. When the clip begins playing the next time, it will start at this position. The level of precision is not guaranteed. For example, an implementation might calculate the microsecond position from the current frame position and the audio sample frame rate. The precision in microseconds would then be limited to the number of microseconds per sample frame.

To obtain the current position in microseconds, use the getMicrosecondPosition method of DataLine.

Specified by:

setMicrosecondPosition in interface Clip

Parameters:

microseconds - the desired new media position, expressed in microseconds

setLoopPoints

public void setLoopPoints(int start,
                          int end)

Sets the first and last sample frames that will be played in the loop. The ending point must be greater than or equal to the starting point, and both must fall within the the size of the loaded media. A value of 0 for the starting point means the beginning of the loaded media. Similarly, a value of -1 for the ending point indicates the last frame of the media.

Specified by:

setLoopPoints in interface Clip

Parameters:

start - the loop's starting position, in sample frames (zero-based)

end - the loop's ending position, in sample frames (zero-based), or -1 to indicate the final frame

Throws:

IllegalArgumentException - if the requested loop points cannot be set, usually because one or both falls outside the media's duration or because the ending point is before the starting point

loop

public void loop(int count)

Starts looping playback from the current position. Playback will continue to the loop's end point, then loop back to the loop start point count times, and finally continue playback to the end of the clip.

If the current position when this method is invoked is greater than the loop end point, playback simply continues to the end of the clip without looping.

A count value of 0 indicates that any current looping should cease and playback should continue to the end of the clip. The behavior is undefined when this method is invoked with any other value during a loop operation.

If playback is stopped during looping, the current loop status is cleared; the behavior of subsequent loop and start requests is not affected by an interrupted loop operation.

Specified by:

loop in interface Clip

Parameters:

count - the number of times playback should loop back from the loop's end position to the loop's start position, or Clip.LOOP_CONTINUOUSLY to indicate that looping should continue until interrupted