Class PcmFormat

java.lang.Object

javax.sound.sampled.AudioFormat

net.avadeaux.klipspringer.codec.PcmFormat

public class PcmFormat
extends AudioFormat

Audio format specification that extends AudioFormat with some convenience functions and restrictions. The sample size (frame size divided by number of channels) must be 1 or 2 for bit depth 8 or smaller, 2 for bit depth 9 to 16, 3 or 4 for bit depth 17 to 24, and 4 for bit depth 25 to 32. Bit depth larger than 32 is not allowed. Attempting to construct a PCM format that does not conform to these rules results in exception. The additional field for significant bits per sample should normally be equal to bits per sample, but may be smaller if the bit depth has been scaled up by left shifting, in which case the significant number of bits should be displayed as the actual quality.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PcmFormat.Selector	Interface for selecting a quality-compatible audio format.

Nested classes/interfaces inherited from class javax.sound.sampled.AudioFormat

AudioFormat.Encoding

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_FS	Maximum accepted frame size.

Fields inherited from class javax.sound.sampled.AudioFormat

bigEndian, channels, encoding, frameRate, frameSize, sampleRate, sampleSizeInBits

Constructor Summary

Constructors

Constructor	Description
PcmFormat(int rate, int bips, int channels)	Constructor that specifies sound quality and sets other parameters to standard values.
PcmFormat(int rate, int bips, int channels, boolean signed, int fs, ByteOrder order, int significantBips)	Constructor that specifies all fields.

Method Summary

Modifier and Type	Method	Description
int	alignment()	Desired byte-alignment for data of this format.
boolean	bigend()	Is big-endian, alias for AudioFormat.isBigEndian().
int	bips()	Bits per sample, alias for AudioFormat.getSampleSizeInBits().
int	byps()	Bytes per sample, ceiling of bips()/8.
int	channels()	Number of channels, alias for AudioFormat.getChannels().
int	fs()	Frame size, alias for AudioFormat.getFrameSize().
boolean	matchesQuality(PcmFormat that)	Checks if formats match in sample rate, bits per channel, and number of channels.
static PcmFormat	of(AudioFormat format)	Gets a PCM format specified by standard AudioFormat
static PcmFormat	of(AudioFormat format, int rate)	Gets a PCM format specified by standard AudioFormat, with specified sample rate in case it is unspecified in the given format.
ByteOrder	order()	ByteOrder alternative to bigend().
int	rate()	Same value as AudioFormat.getSampleRate() but cast to int.
boolean	signed()	Boolean alternative to AudioFormat.getEncoding().
int	significantBips()	Significant bits per sample.
int	ss()	Number of bytes allocated per sample, fs divided by channels.

Methods inherited from class javax.sound.sampled.AudioFormat

getChannels, getEncoding, getFrameRate, getFrameSize, getProperty, getSampleRate, getSampleSizeInBits, isBigEndian, matches, properties, toString

Methods inherited from class java.lang.Object

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

Field Details

MAX_FS

public static final int MAX_FS

Maximum accepted frame size.

See Also:

• Constant Field Values

Constructor Details

PcmFormat

public PcmFormat(int rate,
 int bips,
 int channels,
 boolean signed,
 int fs,
 ByteOrder order,
 int significantBips)

Constructor that specifies all fields.

PcmFormat

public PcmFormat(int rate,
 int bips,
 int channels)

Constructor that specifies sound quality and sets other parameters to standard values.

Method Details

rate

public int rate()

Same value as AudioFormat.getSampleRate() but cast to int.

bips

public int bips()

Bits per sample, alias for AudioFormat.getSampleSizeInBits().

significantBips

public int significantBips()

Significant bits per sample. Returns the same value as bips() unless the sample values have been scaled up from a smaller bit depth, in which case this is the original bit depth.

byps

public int byps()

Bytes per sample, ceiling of bips()/8.

alignment

public int alignment()

Desired byte-alignment for data of this format. The lowest set bit of byps().

channels

public int channels()

Number of channels, alias for AudioFormat.getChannels().

signed

public boolean signed()

Boolean alternative to AudioFormat.getEncoding().

ss

public int ss()

Number of bytes allocated per sample, fs divided by channels.

fs

public int fs()

Frame size, alias for AudioFormat.getFrameSize().

bigend

public boolean bigend()

Is big-endian, alias for AudioFormat.isBigEndian().

order

public ByteOrder order()

ByteOrder alternative to bigend().

matchesQuality

public boolean matchesQuality(PcmFormat that)

Checks if formats match in sample rate, bits per channel, and number of channels.

of

public static PcmFormat of(AudioFormat format,
 int rate)
                    throws UnsupportedFormatException

Gets a PCM format specified by standard AudioFormat, with specified sample rate in case it is unspecified in the given format.

Throws:

UnsupportedFormatException

of

public static PcmFormat of(AudioFormat format)
                    throws UnsupportedFormatException

Gets a PCM format specified by standard AudioFormat

Throws:

UnsupportedFormatException