Class VorbisStream

java.lang.Object

net.avadeaux.klipspringer.codec.ExternalEncodedStream

net.avadeaux.klipspringer.codec.VorbisStream

All Implemented Interfaces:

Closeable, AutoCloseable, AudioStream, Device.Player, PcmWriter

public class VorbisStream
extends ExternalEncodedStream

Audio stream that sends Vorbis encoded data to a channel. Also doubles as file encoder class when created via fileEncoder.

Nested Class Summary

Nested classes/interfaces inherited from interface net.avadeaux.klipspringer.codec.AudioStream

AudioStream.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static final Device.BitLayout	BIT_LAYOUT	The bit layout for PCM data sent to a Vorbis stream.

Constructor Summary

Constructors

Constructor	Description
VorbisStream(PcmFormat format, float quality, double writeaheadSecs, double timeoutSecs, int holdingBytes, WritableByteChannel channel, Executor keepAlivePool, double keepAliveTimeoutSecs)	Creates an Ogg Vorbis stream with the given specifications and destination channel.

Method Summary

Modifier and Type	Method	Description
static PcmWriter	fileEncoder(String fileName, PcmFormat dataFormat, float quality)	Gets a player that encodes to a file rather than a stream.
Device.BitLayout	layout()	The bit layout for PCM data sent to a Vorbis stream.
String	quality()	gets the VBR quality specified for this stream.
static PcmFormat	selectFormat(AudioFormat fmt)	Selects format suitable for Vorbis streaming with the same semantics as PcmFormat.Selector.selectFormat(AudioFormat).

Methods inherited from class net.avadeaux.klipspringer.codec.ExternalEncodedStream

close, drain, format, playedMillis, streaming, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.avadeaux.klipspringer.codec.Device.Player

bufferedFrames, canPause, pause, unpause

Field Details

BIT_LAYOUT

public static final Device.BitLayout BIT_LAYOUT

The bit layout for PCM data sent to a Vorbis stream.

Constructor Details

VorbisStream

public VorbisStream(PcmFormat format,
 float quality,
 double writeaheadSecs,
 double timeoutSecs,
 int holdingBytes,
 WritableByteChannel channel,
 Executor keepAlivePool,
 double keepAliveTimeoutSecs)
             throws IOException

Creates an Ogg Vorbis stream with the given specifications and destination channel.

The holdingBytes parameter is used when streaming to recipient that does not begin to process the input until it has accumulated a certain amount of compressed data, causing the recipient to potentially stall when receiving highly compressible sound (such as silence). In particular, web browsers sometimes do this. When streaming to a web browser, a reasonable value to prevent stalling is 49152. When the destination is a file or something else that does not process audio in real time, it can be set to 0.

If keepAliveExec is non-null, it is used by ExternalEncodedStream.close() to execute a wait loop that terminates when either the recipient has sent callback notification of having played (almost) all the data it has been sent, or no callback is made for keepAliveTimeoutSecs seconds. (See also ExternalEncodedStream.drain().)

Throws:

IOException

Method Details

selectFormat

public static PcmFormat selectFormat(AudioFormat fmt)
                              throws UnsupportedFormatException

Selects format suitable for Vorbis streaming with the same semantics as PcmFormat.Selector.selectFormat(AudioFormat).

Throws:

UnsupportedFormatException

layout

public Device.BitLayout layout()

The bit layout for PCM data sent to a Vorbis stream.

quality

public String quality()

gets the VBR quality specified for this stream.

fileEncoder

public static PcmWriter fileEncoder(String fileName,
 PcmFormat dataFormat,
 float quality)
                             throws IOException

Gets a player that encodes to a file rather than a stream.

Throws:

IOException