Package net.avadeaux.klipspringer.encoder

Class ChannelStreamLine

java.lang.Object

net.avadeaux.klipspringer.encoder.PlayerState

net.avadeaux.klipspringer.encoder.ChannelStreamLine

All Implemented Interfaces:

AutoCloseable, DataLine, Line, SourceDataLine

Direct Known Subclasses:

AuChannelStreamLine, EncoderChannelStreamLine

public abstract class ChannelStreamLine
extends PlayerState
implements SourceDataLine

Line for streaming audio to a channel. Data should be written in sequence from a single thread. Extends the SourceDataLine contract with the finish mehod, which should be called to make sure that no data is retained in an internal encoder buffer before at the end of playback.

Nested Class Summary

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

DataLine.Info

Field Summary

Fields

Modifier and Type	Field	Description
protected final WritableByteChannel	bc
protected final int	bips
protected final int	bsam
protected final int	byps
protected final int	dsam
protected final int	esam
protected final int	fs

Constructor Summary

Constructors

Constructor	Description
ChannelStreamLine(WritableByteChannel bc, AudioFormat format, long writeAheadMillis, long timeoutMillis)	Creates a line for streaming to a channel.

Method Summary

Modifier and Type	Method	Description
void	addLineListener(LineListener listener)
protected abstract int	bufferedSamples()	Number of bytes received by the line but not yet sent to the channel.
void	close()	Closes the line and the destination channel, without writing anything.
void	drain()	Emits data buffered on the line to the channel before returning.
void	finish()	Emits buffered data and any data buffered in encoder.
Control	getControl(Control.Type control)
Control[]	getControls()
AudioFormat	getFormat()
int	getFramePosition()
float	getLevel()
Line.Info	getLineInfo()
long	getLongFramePosition()
long	getMicrosecondPosition()
boolean	isActive()
boolean	isControlSupported(Control.Type control)
boolean	isRunning()
void	open()
void	open(AudioFormat fmt)
void	open(AudioFormat fmt, int bufferSize)
protected long	outputSamples()	Number of samples known to have been sent to the client endpoint for playing.
void	removeLineListener(LineListener listener)
void	start()
void	stop()
protected abstract void	writeBuffer()	Writes data buffered on the line to the channel.

Methods inherited from class net.avadeaux.klipspringer.encoder.PlayerState

isOpen, onClose, playedMillis, playedMillis, waitForPlayed

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, flush, getBufferSize

Methods inherited from interface javax.sound.sampled.Line

isOpen

Methods inherited from interface javax.sound.sampled.SourceDataLine

write

Field Details

bc

protected final WritableByteChannel bc

fs

protected final int fs

bips

protected final int bips

byps

protected final int byps

bsam

protected final int bsam

esam

protected final int esam

dsam

protected final int dsam

Constructor Details

ChannelStreamLine

public ChannelStreamLine(WritableByteChannel bc,
 AudioFormat format,
 long writeAheadMillis,
 long timeoutMillis)
                  throws UnsupportedAudioFileException

Creates a line for streaming to a channel.

Parameters:

bc - the channel to stream to, which must be non-blocking

format - audio format of the PCM data written to this line

writeAheadMillis - limit for how much to write ahead of what receiver has played, Long.MAX_VALUE for unlimited

timeoutMillis - time to wait when when write-ahead limit is reached

Throws:

UnsupportedAudioFileException

Method Details

getLineInfo

public Line.Info getLineInfo()

Specified by:

getLineInfo in interface Line

open

public void open()
          throws LineUnavailableException

Specified by:

open in interface Line

Throws:

LineUnavailableException

finish

public void finish()

Emits buffered data and any data buffered in encoder. Default implementation just calls drain.

close

public void close()

Closes the line and the destination channel, without writing anything. In order for all data to be emitted, finish should be called before close.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Line

Overrides:

close in class PlayerState

getControls

public Control[] getControls()

Specified by:

getControls in interface Line

isControlSupported

public boolean isControlSupported(Control.Type control)

Specified by:

isControlSupported in interface Line

getControl

public Control getControl(Control.Type control)

Specified by:

getControl in interface Line

addLineListener

public void addLineListener(LineListener listener)

Specified by:

addLineListener in interface Line

removeLineListener

public void removeLineListener(LineListener listener)

Specified by:

removeLineListener in interface Line

drain

public void drain()

Emits data buffered on the line to the channel before returning.

Specified by:

drain in interface DataLine

start

public void start()

Specified by:

start in interface DataLine

stop

public void stop()

Specified by:

stop in interface DataLine

isRunning

public boolean isRunning()

Specified by:

isRunning in interface DataLine

isActive

public boolean isActive()

Specified by:

isActive in interface DataLine

getFormat

public AudioFormat getFormat()

Specified by:

getFormat in interface DataLine

getFramePosition

public int getFramePosition()

Specified by:

getFramePosition in interface DataLine

getLongFramePosition

public long getLongFramePosition()

Specified by:

getLongFramePosition in interface DataLine

getMicrosecondPosition

public long getMicrosecondPosition()

Specified by:

getMicrosecondPosition in interface DataLine

getLevel

public float getLevel()

Specified by:

getLevel in interface DataLine

open

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

Specified by:

open in interface SourceDataLine

Throws:

LineUnavailableException

open

public void open(AudioFormat fmt)
          throws LineUnavailableException

Specified by:

open in interface SourceDataLine

Throws:

LineUnavailableException

outputSamples

protected long outputSamples()

Number of samples known to have been sent to the client endpoint for playing. The default implementation returns the number of samples sent to the channel. Needs to be overridden if there is buffering/compression from this point that may cause a delay in the client playing. The number returned by this method may be slightly lower than the actual number output to the endpoint but must never be higher.

bufferedSamples

protected abstract int bufferedSamples()

Number of bytes received by the line but not yet sent to the channel.

writeBuffer

protected abstract void writeBuffer()
                             throws IOException

Writes data buffered on the line to the channel.

Throws:

IOException