org.intellimate.izou.system.sound

Class IzouSoundDataLine

java.lang.Object

org.intellimate.izou.util.IzouModule

org.intellimate.izou.system.sound.IzouSoundLineBaseClass

org.intellimate.izou.system.sound.IzouSoundDataLine

All Implemented Interfaces:

AutoCloseable, DataLine, Line, Identifiable, IzouSoundLine, MainProvider

Direct Known Subclasses:

IzouSoundLineClip, IzouSoundLineClipAndSDLine, IzouSoundSourceDataLine

public class IzouSoundDataLine
extends IzouSoundLineBaseClass
implements DataLine

the delegation to DataLine.

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

Constructor Summary

Constructors

Constructor and Description
IzouSoundDataLine(DataLine dataLine, Main main, boolean isPermanent, AddOnModel addOnModel)

Method Summary

Modifier and Type	Method and Description
int	available() Obtains the number of bytes of data currently available to the application for processing in the data line's internal buffer.
void	drain() Drains queued data from the line by continuing data I/O until the data line's internal buffer has been emptied.
void	flush() Flushes queued data from the line.
int	getBufferSize() Obtains the maximum number of bytes of data that will fit in the data line's internal buffer.
AudioFormat	getFormat() Obtains the current format (encoding, sample rate, number of channels, etc.) of the data line's audio data.
int	getFramePosition() Obtains the current position in the audio data, in sample frames.
float	getLevel() Obtains the current volume level for the line.
long	getLongFramePosition() Obtains the current position in the audio data, in sample frames.
long	getMicrosecondPosition() Obtains the current position in the audio data, in microseconds.
boolean	isActive() Indicates whether the line is engaging in active I/O (such as playback or capture).
boolean	isRunning() Indicates whether the line is running.
void	start() Allows a line to engage in data I/O.
void	stop() Stops the line.

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.Line

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

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

isOwner

Constructor Detail

IzouSoundDataLine

public IzouSoundDataLine(DataLine dataLine,
                         Main main,
                         boolean isPermanent,
                         AddOnModel addOnModel)

Method Detail

drain

public void drain()

Drains queued data from the line by continuing data I/O until the data line's internal buffer has been emptied. This method blocks until the draining is complete. Because this is a blocking method, it should be used with care. If drain() is invoked on a stopped line that has data in its queue, the method will block until the line is running and the data queue becomes empty. If drain() is invoked by one thread, and another continues to fill the data queue, the operation will not complete. This method always returns when the data line is closed.

Specified by:

drain in interface DataLine

See Also:

flush()

flush

public void flush()

Flushes queued data from the line. The flushed data is discarded. In some cases, not all queued data can be discarded. For example, a mixer can flush data from the buffer for a specific input line, but any unplayed data already in the output buffer (the result of the mix) will still be played. You can invoke this method after pausing a line (the normal case) if you want to skip the "stale" data when you restart playback or capture. (It is legal to flush a line that is not stopped, but doing so on an active line is likely to cause a discontinuity in the data, resulting in a perceptible click.)

Specified by:

flush in interface DataLine

See Also:

stop(), drain()

start

public void start()

Allows a line to engage in data I/O. If invoked on a line that is already running, this method does nothing. Unless the data in the buffer has been flushed, the line resumes I/O starting with the first frame that was unprocessed at the time the line was stopped. When audio capture or playback starts, a LineEvent.Type#START START event is generated.

Specified by:

start in interface DataLine

See Also:

stop(), isRunning()

stop

public void stop()

Stops the line. A stopped line should cease I/O activity. If the line is open and running, however, it should retain the resources required to resume activity. A stopped line should retain any audio data in its buffer instead of discarding it, so that upon resumption the I/O can continue where it left off, if possible. (This doesn't guarantee that there will never be discontinuities beyond the current buffer, of course; if the stopped condition continues for too long, input or output samples might be dropped.) If desired, the retained data can be discarded by invoking the flush method. When audio capture or playback stops, a LineEvent.Type#STOP STOP event is generated.

Specified by:

stop in interface DataLine

See Also:

start(), isRunning(), flush()

isRunning

public boolean isRunning()

Indicates whether the line is running. The default is false. An open line begins running when the first data is presented in response to an invocation of the start method, and continues until presentation ceases in response to a call to stop or because playback completes.

Specified by:

isRunning in interface DataLine

Returns:

true if the line is running, otherwise false

See Also:

start(), stop()

isActive

public boolean isActive()

Indicates whether the line is engaging in active I/O (such as playback or capture). When an inactive line becomes active, it sends a LineEvent.Type#START START event to its listeners. Similarly, when an active line becomes inactive, it sends a LineEvent.Type#STOP STOP event.

Specified by:

isActive in interface DataLine

Returns:

true if the line is actively capturing or rendering sound, otherwise false

See Also:

IzouSoundLineBaseClass.isOpen(), IzouSoundLineBaseClass.addLineListener(javax.sound.sampled.LineListener), IzouSoundLineBaseClass.removeLineListener(javax.sound.sampled.LineListener)

getFormat

public AudioFormat getFormat()

Obtains the current format (encoding, sample rate, number of channels, etc.) of the data line's audio data.

If the line is not open and has never been opened, it returns the default format. The default format is an implementation specific audio format, or, if the DataLine.Info object, which was used to retrieve this DataLine, specifies at least one fully qualified audio format, the last one will be used as the default format. Opening the line with a specific audio format (e.g. SourceDataLine#open(AudioFormat)) will override the default format.

Specified by:

getFormat in interface DataLine

Returns:

current audio data format

See Also:

AudioFormat

getBufferSize

public int getBufferSize()

Obtains the maximum number of bytes of data that will fit in the data line's internal buffer. For a source data line, this is the size of the buffer to which data can be written. For a target data line, it is the size of the buffer from which data can be read. Note that the units used are bytes, but will always correspond to an integral number of sample frames of audio data.

Specified by:

getBufferSize in interface DataLine

Returns:

the size of the buffer in bytes

available

public int available()

Obtains the number of bytes of data currently available to the application for processing in the data line's internal buffer. For a source data line, this is the amount of data that can be written to the buffer without blocking. For a target data line, this is the amount of data available to be read by the application. For a clip, this value is always 0 because the audio data is loaded into the buffer when the clip is opened, and persists without modification until the clip is closed.

Note that the units used are bytes, but will always correspond to an integral number of sample frames of audio data.

An application is guaranteed that a read or write operation of up to the number of bytes returned from available() will not block; however, there is no guarantee that attempts to read or write more data will block.

Specified by:

available in interface DataLine

Returns:

the amount of data available, in bytes

getFramePosition

public int getFramePosition()

Obtains the current position in the audio data, in sample frames. The frame position measures the number of sample frames captured by, or rendered from, the line since it was opened. This return value will wrap around after 2^31 frames. It is recommended to use getLongFramePosition instead.

Specified by:

getFramePosition in interface DataLine

Returns:

the number of frames already processed since the line was opened

See Also:

getLongFramePosition()

getLongFramePosition

public long getLongFramePosition()

Obtains the current position in the audio data, in sample frames. The frame position measures the number of sample frames captured by, or rendered from, the line since it was opened.

Specified by:

getLongFramePosition in interface DataLine

Returns:

the number of frames already processed since the line was opened

Since:

1.5

getMicrosecondPosition

public long getMicrosecondPosition()

Obtains the current position in the audio data, in microseconds. The microsecond position measures the time corresponding to the number of sample frames captured by, or rendered from, the line since it was opened. 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.

Specified by:

getMicrosecondPosition in interface DataLine

Returns:

the number of microseconds of data processed since the line was opened

getLevel

public float getLevel()

Obtains the current volume level for the line. This level is a measure of the signal's current amplitude, and should not be confused with the current setting of a gain control. The range is from 0.0 (silence) to 1.0 (maximum possible amplitude for the sound waveform). The units measure linear amplitude, not decibels.

Specified by:

getLevel in interface DataLine

Returns:

the current amplitude of the signal in this line, or AudioSystem#NOT_SPECIFIED