triana.types.audio

Class AudioChannelFormat

java.lang.Object

triana.types.audio.AudioChannelFormat

All Implemented Interfaces:

java.io.Serializable, ChannelFormat

public class AudioChannelFormat
extends java.lang.Object
implements java.io.Serializable, ChannelFormat

The AudioChannelFormat includes aspects of the sound format other than the number of channels. This class consists of the following parameters :

1. sample rate : the sample rate, specified as an int
2. sample size : the number of bits used to store each sample
3. channel name : the name of this channel
4. audio encoding : the audio encoding used e.g. PCM, U_LAW, GSM etc

One ubiquitous type of audio encoding is pulse-code modulation (PCM), which is simply a linear (proportional) representation of the sound waveform. With PCM, the number stored in each sample is proportional to the instantaneous amplitude of the sound pressure at that point in time. The numbers are frequently signed or unsigned integers. Besides PCM, other encodings include mu-law and a-law, which are nonlinear mappings of the sound amplitude that are often used for recording speech.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	A_LAW The A_LAW format for audio.
java.lang.String	channelName The name for this channel
int	encoding The encoding for this piece of audio e.g.
static int	GSM The A_LAW format for audio.
static int	PCM The PCM (pulse-code modulation) format for audio.
static int	PCM_UNSIGNED The PCM (pulse-code modulation) format for audio.
short	sampleSize The sampling size specified in bits.
int	samplingRate The sampling rate specified as a integer.
static int	U_LAW The A_LAW format for audio.

Constructor Summary

Constructors

Constructor and Description
AudioChannelFormat() Creates an AudioChannelFormat Object with default values
AudioChannelFormat(AudioChannelFormat au) Creates an AudioChannelFormat from the given AudioChannelFormat Object.
AudioChannelFormat(javax.sound.sampled.AudioFormat au) Creates an AudioChannelFormat from the given javax.sound.sampled AudioFormat Object.
AudioChannelFormat(int srate, short sampSize) Creates an AudioChannelFormat Object with a given sampling rate and sample size (in bits) It formats the audio to the default PCM, names the chanel Audio.
AudioChannelFormat(int srate, short sampSize, int format) Creates an AudioChannelFormat Object with a given sampling rate, sample size and format for this audio.
AudioChannelFormat(int srate, short sampSize, int format, java.lang.String channelName) Creates an AudioChannelFormat Object with a given sampling rate, sample size, format for this audio and a name for this channel

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
javax.sound.sampled.AudioFormat	getAudioFormat() Gets a Javax.sound.sampled AudioFormat Object from this format
static javax.sound.sampled.AudioFormat.Encoding	getAudioFormatEncoding(int encoding) translates between the AudioChannelFormat (our format) and the AudioFormat Object in java sound.
java.lang.String	getChannelName()
int	getEncoding()
static int	getEncoding(javax.sound.sampled.AudioFormat.Encoding encoding) translates between the AudioChannelFormat (our format) and the AudioFormat Object in java sound.
short	getSampleSize()
int	getSampleSizeInBytes()
int	getSamplingRate()
void	setFromString(java.lang.String str) Initialises this AudioChannelFormat object from the given string
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PCM

public static final int PCM

The PCM (pulse-code modulation) format for audio.

See Also:

Constant Field Values

PCM_UNSIGNED

public static final int PCM_UNSIGNED

The PCM (pulse-code modulation) format for audio.

See Also:

Constant Field Values

U_LAW

public static final int U_LAW

The A_LAW format for audio.

See Also:

Constant Field Values

A_LAW

public static final int A_LAW

The A_LAW format for audio.

See Also:

Constant Field Values

GSM

public static final int GSM

The A_LAW format for audio.

See Also:

Constant Field Values

samplingRate

public int samplingRate

The sampling rate specified as a integer. Default is 44100, CD quality

sampleSize

public short sampleSize

The sampling size specified in bits. Default is 16, CD quality

channelName

public java.lang.String channelName

The name for this channel

encoding

public int encoding

The encoding for this piece of audio e.g. PCM, U_LAW, MP3 etc. Default is PCM.

Constructor Detail

AudioChannelFormat

public AudioChannelFormat()

Creates an AudioChannelFormat Object with default values

AudioChannelFormat

public AudioChannelFormat(int srate,
                  short sampSize)

Creates an AudioChannelFormat Object with a given sampling rate and sample size (in bits) It formats the audio to the default PCM, names the chanel Audio.

AudioChannelFormat

public AudioChannelFormat(int srate,
                  short sampSize,
                  int format)

Creates an AudioChannelFormat Object with a given sampling rate, sample size and format for this audio.

AudioChannelFormat

public AudioChannelFormat(int srate,
                  short sampSize,
                  int format,
                  java.lang.String channelName)

Creates an AudioChannelFormat Object with a given sampling rate, sample size, format for this audio and a name for this channel

AudioChannelFormat

public AudioChannelFormat(AudioChannelFormat au)

Creates an AudioChannelFormat from the given AudioChannelFormat Object.

AudioChannelFormat

public AudioChannelFormat(javax.sound.sampled.AudioFormat au)

Creates an AudioChannelFormat from the given javax.sound.sampled AudioFormat Object.

Method Detail

getAudioFormat

public javax.sound.sampled.AudioFormat getAudioFormat()

Gets a Javax.sound.sampled AudioFormat Object from this format

getAudioFormatEncoding

public static javax.sound.sampled.AudioFormat.Encoding getAudioFormatEncoding(int encoding)

translates between the AudioChannelFormat (our format) and the AudioFormat Object in java sound.

getEncoding

public static int getEncoding(javax.sound.sampled.AudioFormat.Encoding encoding)

translates between the AudioChannelFormat (our format) and the AudioFormat Object in java sound.

getChannelName

public java.lang.String getChannelName()

Specified by:

getChannelName in interface ChannelFormat

Returns:

the name for this channel

getSamplingRate

public int getSamplingRate()

Specified by:

getSamplingRate in interface ChannelFormat

Returns:

the sampling rate for this channel

getSampleSize

public short getSampleSize()

Returns:

the number of bits used to store each sample

getEncoding

public int getEncoding()

Returns:

the encoding for this chunk of audio

getSampleSizeInBytes

public int getSampleSizeInBytes()

Returns:

the number of bytes used to store each sample

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

Returns:

true if the given object has the same parameters as this object

toString

public java.lang.String toString()

Specified by:

toString in interface ChannelFormat

Overrides:

toString in class java.lang.Object

Returns:

a string representation for this AudioChannelFormat object

setFromString

public void setFromString(java.lang.String str)

Initialises this AudioChannelFormat object from the given string

Specified by:

setFromString in interface ChannelFormat