org.openimaj.audio

Class AudioFormat

java.lang.Object

org.openimaj.audio.AudioFormat

public class AudioFormat
extends Object

This class encapsulates the information that determines the format of audio data.

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

8 Jun 2011

Constructor Summary

Constructors

Constructor and Description
AudioFormat(int nBits, double sampleRate, int nChannels) Construct a new audio format object with the given number of bits and sample rate.

Method Summary

Modifier and Type	Method and Description
AudioFormat	clone()
boolean	equals(Object obj)
AudioFormat	getJavaAudioFormat() Get a Java Sound API AudioFormat object using this object's properties.
int	getNBits() Get the number of bits in each sample.
int	getNumChannels() Get the number of channels in this format.
double	getSampleRateKHz() Get the rate at which the audio should be replayed
boolean	isBigEndian() Returns whether the data is big or little endian.
boolean	isSigned() Returns whether the data is signed or unsigned.
AudioFormat	setBigEndian(boolean isBigEndian) Set whether the data is big-endian or not.
AudioFormat	setNBits(int nBits) Sets the number of bits in this audio format.
AudioFormat	setNumChannels(int nChannels) Set the number of channels in this format.
AudioFormat	setSampleRateKHz(double s) Set the sample rate at which the audio should be replayed
AudioFormat	setSigned(boolean isSigned) Set whether the data is signed or not.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AudioFormat

public AudioFormat(int nBits,
                   double sampleRate,
                   int nChannels)

Construct a new audio format object with the given number of bits and sample rate.

Parameters:

nBits - The number of bits in each sample

sampleRate - The sample rate in kilohertz

nChannels - The number of channels

Method Detail

getNBits

public int getNBits()

Get the number of bits in each sample.

Returns:

The number of bits in each sample.

setNBits

public AudioFormat setNBits(int nBits)

Sets the number of bits in this audio format. This is expected to be a multiple of 8, but can be -1 for a non-integer format.

Parameters:

nBits - The number of bits.

Returns:

this audio format

getSampleRateKHz

public double getSampleRateKHz()

Get the rate at which the audio should be replayed

Returns:

The audio sample rate in kilohertz.

setSampleRateKHz

public AudioFormat setSampleRateKHz(double s)

Set the sample rate at which the audio should be replayed

Parameters:

s - The sample rate

Returns:

this audio format

setNumChannels

public AudioFormat setNumChannels(int nChannels)

Set the number of channels in this format.

Parameters:

nChannels - the number of channels

Returns:

this audio format

getNumChannels

public int getNumChannels()

Get the number of channels in this format.

Returns:

the number of channels

setSigned

public AudioFormat setSigned(boolean isSigned)

Set whether the data is signed or not.

Parameters:

isSigned - Whether the data is signed.

Returns:

this audio format

isSigned

public boolean isSigned()

Returns whether the data is signed or unsigned.

Returns:

TRUE if the data is signed; FALSE otherwise;

setBigEndian

public AudioFormat setBigEndian(boolean isBigEndian)

Set whether the data is big-endian or not.

Parameters:

isBigEndian - Whether the data is big-endian

Returns:

this audio format

isBigEndian

public boolean isBigEndian()

Returns whether the data is big or little endian.

Returns:

TRUE if the data is big-endian; FALSE if little-endian

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

clone

public AudioFormat clone()

Overrides:

clone in class Object

getJavaAudioFormat

public AudioFormat getJavaAudioFormat()

Get a Java Sound API AudioFormat object using this object's properties.

Returns:

The Java Sound API Audio Format object.