Class FlacStream

java.lang.Object

net.avadeaux.klipspringer.codec.ExternalEncodedStream

net.avadeaux.klipspringer.codec.FlacStream

All Implemented Interfaces:

Closeable, AutoCloseable, AudioStream, Device.Player, PcmWriter

public class FlacStream
extends ExternalEncodedStream

Audio stream that sends FLAC 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 FLAC stream.
static final boolean	oggSupported	True if OGG FLAC is supported.

Constructor Summary

Constructors

Constructor	Description
FlacStream(PcmFormat format, boolean ogg, int comprLevel, int bufferFrames, double writeaheadSecs, double timeoutSecs, int holdingBytes, WritableByteChannel channel, Executor keepAlivePool, double keepAliveTimeoutSecs)	Creates a FLAC stream with the given specifications and destination channel.

Method Summary

Modifier and Type	Method	Description
static PcmWriter	fileEncoder(String fileName, PcmFormat dataFormat, int comprLevel)	Gets a player that encodes to a file rather than a stream.
Device.BitLayout	layout()	Gets the bit layout expected by the player.
static PcmFormat	selectFormat(AudioFormat fmt)	Selects format suitable for FLAC 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.AudioStream

quality

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 FLAC stream.

oggSupported

public static final boolean oggSupported

True if OGG FLAC is supported. This is set to false if libFLAC is subject to an issue that renders the number of samples in an encoding chunk unknown.

Constructor Details

FlacStream

public FlacStream(PcmFormat format,
 boolean ogg,
 int comprLevel,
 int bufferFrames,
 double writeaheadSecs,
 double timeoutSecs,
 int holdingBytes,
 WritableByteChannel channel,
 Executor keepAlivePool,
 double keepAliveTimeoutSecs)
           throws IOException

Creates a FLAC 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 FLAC streaming with the same semantics as PcmFormat.Selector.selectFormat(AudioFormat).

Throws:

UnsupportedFormatException

layout

public Device.BitLayout layout()

Description copied from interface: Device.Player

Gets the bit layout expected by the player. If the player is produced by a Factory, the layout should match the value returned by Device.Player.Factory.layout(PcmFormat), and if the player is associated with a device, this should match what is returned by Device.layout(PcmFormat). Default returns Device.BitLayout.LSB. Default returns Device.BitLayout.LSB.

fileEncoder

public static PcmWriter fileEncoder(String fileName,
 PcmFormat dataFormat,
 int comprLevel)
                             throws IOException

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

Throws:

IOException