Class PcmWaveWriter

java.lang.Object

javaforce.codec.speex.AudioFileWriter

javaforce.codec.speex.PcmWaveWriter

public class PcmWaveWriter
extends AudioFileWriter

Writes basic PCM wave files from binary audio data.

Here's an example that writes 2 seconds of silence

PcmWaveWriter s_wsw = new PcmWaveWriter(2, 44100);
byte[] silence = new byte[16*2*44100];
wsw.Open("C:\\out.wav");
wsw.WriteHeader();
wsw.WriteData(silence, 0, silence.length);
wsw.WriteData(silence, 0, silence.length);
wsw.Close();

Version:

$Revision$

Author:

Jim Lawrence, helloNetwork.com, Marc Gimpel, Wimba S.A. ([email protected])

Field Summary

Fields

Modifier and Type	Field	Description
static final int[][][]	WAVE_BITS_PER_FRAME	Table describing the number of bit per Speex frame, depending on its mode-1 (1=NB, 2=WB, 3=UWB), channels-1 (1=mono, 2=stereo) and the quality setting (0 to 10).
static final short	WAVE_FORMAT_PCM	Wave type code of PCM
static final short	WAVE_FORMAT_SPEEX	Wave type code of Speex
static final int[][][]	WAVE_FRAME_SIZES	Table describing the number of frames per packet in a Speex Wave file, depending on its mode-1 (1=NB, 2=WB, 3=UWB), channels-1 (1=mono, 2=stereo) and the quality setting (0 to 10).

Constructor Summary

Constructors

Constructor	Description
PcmWaveWriter()	Constructor.
PcmWaveWriter(int sampleRate, int channels)	Constructor.
PcmWaveWriter(int mode, int quality, int sampleRate, int channels, int nframes, boolean vbr)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the output file.
void	open(File file)	Open the output file.
void	open(String filename)	Open the output file.
void	writeHeader(String comment)	Writes the initial data chunks that start the wave file.
void	writePacket(byte[] data, int offset, int len)	Writes a packet of audio.

Methods inherited from class AudioFileWriter

buildOggPageHeader, buildSpeexComment, buildSpeexHeader, writeInt, writeInt, writeInt, writeLong, writeLong, writeOggPageHeader, writeShort, writeShort, writeShort, writeSpeexComment, writeSpeexHeader, writeString

Modifier and Type	Method	Description
static byte[]	buildOggPageHeader(int headerType, long granulepos, int streamSerialNumber, int pageCount, int packetCount, byte[] packetSizes)	Builds and returns an Ogg Page Header.
static byte[]	buildSpeexComment(String comment)	Builds and returns a Speex Comment.
static byte[]	buildSpeexHeader(int sampleRate, int mode, int channels, boolean vbr, int nframes)	Builds a Speex Header.
static void	writeInt(byte[] data, int offset, int v)	Writes a Little-endian int.
static void	writeInt(DataOutput out, int v)	Writes a Little-endian int.
static void	writeInt(OutputStream os, int v)	Writes a Little-endian int.
static void	writeLong(byte[] data, int offset, long v)	Writes a Little-endian long.
static void	writeLong(OutputStream os, long v)	Writes a Little-endian long.
static int	writeOggPageHeader(byte[] buf, int offset, int headerType, long granulepos, int streamSerialNumber, int pageCount, int packetCount, byte[] packetSizes)	Writes an Ogg Page Header to the given byte array.
static void	writeShort(byte[] data, int offset, int v)	Writes a Little-endian short.
static void	writeShort(DataOutput out, short v)	Writes a Little-endian short.
static void	writeShort(OutputStream os, short v)	Writes a Little-endian short.
static int	writeSpeexComment(byte[] buf, int offset, String comment)	Writes a Speex Comment to the given byte array.
static int	writeSpeexHeader(byte[] buf, int offset, int sampleRate, int mode, int channels, boolean vbr, int nframes)	Writes a Speex Header to the given byte array.
static void	writeString(byte[] data, int offset, String v)	Writes a String.

Methods inherited from class Object

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

Field Details

WAVE_FORMAT_PCM

public static final short WAVE_FORMAT_PCM

Wave type code of PCM

See Also:

• Constant Field Values

WAVE_FORMAT_SPEEX

public static final short WAVE_FORMAT_SPEEX

Wave type code of Speex

See Also:

• Constant Field Values

WAVE_FRAME_SIZES

public static final int[][][] WAVE_FRAME_SIZES

Table describing the number of frames per packet in a Speex Wave file, depending on its mode-1 (1=NB, 2=WB, 3=UWB), channels-1 (1=mono, 2=stereo) and the quality setting (0 to 10). See end of file for exerpt from SpeexACM code for more explanations.

WAVE_BITS_PER_FRAME

public static final int[][][] WAVE_BITS_PER_FRAME

Table describing the number of bit per Speex frame, depending on its mode-1 (1=NB, 2=WB, 3=UWB), channels-1 (1=mono, 2=stereo) and the quality setting (0 to 10). See end of file for exerpt from SpeexACM code for more explanations.

Constructor Details

PcmWaveWriter

public PcmWaveWriter()

Constructor.

PcmWaveWriter

public PcmWaveWriter(int sampleRate,
 int channels)

Constructor.

Parameters:

sampleRate - the number of samples per second.

channels - the number of audio channels (1=mono, 2=stereo, ...).

PcmWaveWriter

public PcmWaveWriter(int mode,
 int quality,
 int sampleRate,
 int channels,
 int nframes,
 boolean vbr)

Constructor.

Parameters:

mode - the mode of the encoder (0=NB, 1=WB, 2=UWB).

quality -

sampleRate - the number of samples per second.

channels - the number of audio channels (1=mono, 2=stereo, ...).

nframes - the number of frames per speex packet.

vbr -

Method Details

close

public void close()
           throws IOException

Closes the output file. MUST be called to have a correct stream.

Specified by:

close in class AudioFileWriter

Throws:

IOException - if there was an exception closing the Audio Writer.

open

public void open(File file)
          throws IOException

Open the output file.

Specified by:

open in class AudioFileWriter

Parameters:

file - - file to open.

Throws:

IOException - if there was an exception opening the Audio Writer.

open

public void open(String filename)
          throws IOException

Open the output file.

Specified by:

open in class AudioFileWriter

Parameters:

filename - filename to open.

Throws:

IOException - if there was an exception opening the Audio Writer.

writeHeader

public void writeHeader(String comment)
                 throws IOException

Writes the initial data chunks that start the wave file. Prepares file for data samples to written.

Specified by:

writeHeader in class AudioFileWriter

Parameters:

comment - ignored by the WAV header.

Throws:

IOException

writePacket

public void writePacket(byte[] data,
 int offset,
 int len)
                 throws IOException

Writes a packet of audio.

Specified by:

writePacket in class AudioFileWriter

Parameters:

data - audio data

offset - the offset from which to start reading the data.

len - the length of data to read.

Throws:

IOException