be.tarsos.dsp.writer

Class WaveHeader

java.lang.Object

be.tarsos.dsp.writer.WaveHeader

public class WaveHeader
extends java.lang.Object

This class represents the header of a WAVE format audio file, which usually have a .wav suffix. The following integer valued fields are contained:

• format - usually PCM, ALAW or ULAW.
• numChannels - 1 for mono, 2 for stereo.
• sampleRate - usually 8000, 11025, 16000, 22050, or 44100 hz.
• bitsPerSample - usually 16 for PCM, 8 for ALAW, or 8 for ULAW.
• numBytes - size of audio data after this header, in bytes.

Not yet ready to be supported, so

Field Summary

Fields

Modifier and Type	Field and Description
static short	FORMAT_ALAW Indicates ALAW format.
static short	FORMAT_PCM Indicates PCM format.
static short	FORMAT_ULAW Indicates ULAW format.

Constructor Summary

Constructors

Constructor and Description
WaveHeader() Construct a WaveHeader, with all fields defaulting to zero.
WaveHeader(short format, short numChannels, int sampleRate, short bitsPerSample, int numBytes) Construct a WaveHeader, with fields initialized.

Method Summary

Modifier and Type	Method and Description
short	getBitsPerSample() Get the number of bits per sample.
short	getFormat() Get the format field.
int	getNumBytes() Get the size of audio data after this header, in bytes.
short	getNumChannels() Get the number of channels.
int	getSampleRate() Get the sample rate.
int	read(java.io.InputStream in) Read and initialize a WaveHeader.
WaveHeader	setBitsPerSample(short bitsPerSample) Set the number of bits per sample.
WaveHeader	setFormat(short format) Set the format field.
WaveHeader	setNumBytes(int numBytes) Set the size of audio data after this header, in bytes.
WaveHeader	setNumChannels(short numChannels) Set the number of channels.
WaveHeader	setSampleRate(int sampleRate) Set the sample rate.
java.lang.String	toString()
int	write(java.io.OutputStream out) Write a WAVE file header.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FORMAT_PCM

public static final short FORMAT_PCM

Indicates PCM format.

See Also:

Constant Field Values

FORMAT_ALAW

public static final short FORMAT_ALAW

Indicates ALAW format.

See Also:

Constant Field Values

FORMAT_ULAW

public static final short FORMAT_ULAW

Indicates ULAW format.

See Also:

Constant Field Values

Constructor Detail

WaveHeader

public WaveHeader()

Construct a WaveHeader, with all fields defaulting to zero.

WaveHeader

public WaveHeader(short format,
                  short numChannels,
                  int sampleRate,
                  short bitsPerSample,
                  int numBytes)

Construct a WaveHeader, with fields initialized.

Parameters:

format - format of audio data, one of FORMAT_PCM, FORMAT_ULAW, or FORMAT_ALAW.

numChannels - 1 for mono, 2 for stereo.

sampleRate - typically 8000, 11025, 16000, 22050, or 44100 hz.

bitsPerSample - usually 16 for PCM, 8 for ULAW or 8 for ALAW.

numBytes - size of audio data after this header, in bytes.

Method Detail

getFormat

public short getFormat()

Get the format field.

Returns:

format field, one of FORMAT_PCM, FORMAT_ULAW, or FORMAT_ALAW.

setFormat

public WaveHeader setFormat(short format)

Set the format field.

Parameters:

format - one of FORMAT_PCM, FORMAT_ULAW, or FORMAT_ALAW.

Returns:

reference to this WaveHeader instance.

getNumChannels

public short getNumChannels()

Get the number of channels.

Returns:

number of channels, 1 for mono, 2 for stereo.

setNumChannels

public WaveHeader setNumChannels(short numChannels)

Set the number of channels.

Parameters:

numChannels - 1 for mono, 2 for stereo.

Returns:

reference to this WaveHeader instance.

getSampleRate

public int getSampleRate()

Get the sample rate.

Returns:

sample rate, typically 8000, 11025, 16000, 22050, or 44100 hz.

setSampleRate

public WaveHeader setSampleRate(int sampleRate)

Set the sample rate.

Parameters:

sampleRate - sample rate, typically 8000, 11025, 16000, 22050, or 44100 hz.

Returns:

reference to this WaveHeader instance.

getBitsPerSample

public short getBitsPerSample()

Get the number of bits per sample.

Returns:

number of bits per sample, usually 16 for PCM, 8 for ULAW or 8 for ALAW.

setBitsPerSample

public WaveHeader setBitsPerSample(short bitsPerSample)

Set the number of bits per sample.

Parameters:

bitsPerSample - number of bits per sample, usually 16 for PCM, 8 for ULAW or 8 for ALAW.

Returns:

reference to this WaveHeader instance.

getNumBytes

public int getNumBytes()

Get the size of audio data after this header, in bytes.

Returns:

size of audio data after this header, in bytes.

setNumBytes

public WaveHeader setNumBytes(int numBytes)

Set the size of audio data after this header, in bytes.

Parameters:

numBytes - size of audio data after this header, in bytes.

Returns:

reference to this WaveHeader instance.

read

public int read(java.io.InputStream in)
         throws java.io.IOException

Read and initialize a WaveHeader.

Parameters:

in - InputStream to read from.

Returns:

number of bytes consumed.

Throws:

java.io.IOException

write

public int write(java.io.OutputStream out)
          throws java.io.IOException

Write a WAVE file header.

Parameters:

out - OutputStream to receive the header.

Returns:

number of bytes written.

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object