com.github.psambit9791.wavfile

Class WavFile

java.lang.Object

com.github.psambit9791.wavfile.WavFile

public class WavFile
extends Object

Method Summary

Modifier and Type	Method and Description
void	close() Close the WavFile.
long	getFramesRemaining() Get the number of frames remaining.
int	getNumChannels() Gets the number of channels.
long	getNumFrames() Get the number of frames.
long	getSampleRate() Get the sample rate.
int	getValidBits() Get the number of valid bits.
static WavFile	newWavFile(File file, int numChannels, long numFrames, int validBits, long sampleRate) Initialize a new WavFile object for writing into the specified file.
static WavFile	openWavFile(File file) Read WAV contents from a provided file.
int	readFrames(double[][] sampleBuffer, int numFramesToRead) Read some number of frames from the buffer into a multi-dimensional double array.
int	readFrames(double[][] sampleBuffer, int offset, int numFramesToRead) Read some number of frames from a specific offset in the buffer into a multi-dimensional double array.
int	readFrames(double[] sampleBuffer, int numFramesToRead) Read some number of frames from the buffer into a flat double array.
int	readFrames(double[] sampleBuffer, int offset, int numFramesToRead) Read some number of frames from a specific offset in the buffer into a flat double array.
int	readFrames(int[][] sampleBuffer, int numFramesToRead) Read some number of frames from the buffer into a multi-dimensional int array.
int	readFrames(int[][] sampleBuffer, int offset, int numFramesToRead) Read some number of frames from a specific offset in the buffer into a multi-dimensional int array.
int	readFrames(int[] sampleBuffer, int numFramesToRead) Read some number of frames from the buffer into a flat int array.
int	readFrames(int[] sampleBuffer, int offset, int numFramesToRead) Read some number of frames from a specific offset in the buffer into a flat int array.
int	readFrames(long[][] sampleBuffer, int numFramesToRead) Read some number of frames from the buffer into a multi-dimensional long array.
int	readFrames(long[][] sampleBuffer, int offset, int numFramesToRead) Read some number of frames from a specific offset in the buffer into a multi-dimensional long array.
int	readFrames(long[] sampleBuffer, int numFramesToRead) Read some number of frames from the buffer into a flat long array.
int	readFrames(long[] sampleBuffer, int offset, int numFramesToRead) Read some number of frames from a specific offset in the buffer into a flat long array.
int	writeFrames(double[][] sampleBuffer, int numFramesToWrite) Write some number of frames into the buffer from a multi-dimensional double array.
int	writeFrames(double[][] sampleBuffer, int offset, int numFramesToWrite) Write some number of frames into the buffer at a specific offset from a multi-dimensional double array.
int	writeFrames(double[] sampleBuffer, int numFramesToWrite) Write some number of frames into the buffer from a flat double array.
int	writeFrames(double[] sampleBuffer, int offset, int numFramesToWrite) Write some number of frames into the buffer at a specific offset from a flat double array.
int	writeFrames(int[][] sampleBuffer, int numFramesToWrite) Write some number of frames into the buffer from a multi-dimensional int array.
int	writeFrames(int[][] sampleBuffer, int offset, int numFramesToWrite) Write some number of frames into the buffer at a specific offset from a multi-dimensional int array.
int	writeFrames(int[] sampleBuffer, int numFramesToWrite) Write some number of frames into the buffer from a flat int array.
int	writeFrames(int[] sampleBuffer, int offset, int numFramesToWrite) Write some number of frames into the buffer at a specific offset from a flat int array.
int	writeFrames(long[][] sampleBuffer, int numFramesToWrite) Write some number of frames into the buffer from a multi-dimensional long array.
int	writeFrames(long[][] sampleBuffer, int offset, int numFramesToWrite) Write some number of frames into the buffer at a specific offset from a multi-dimensional long array.
int	writeFrames(long[] sampleBuffer, int numFramesToWrite) Write some number of frames into the buffer from a flat long array.
int	writeFrames(long[] sampleBuffer, int offset, int numFramesToWrite) Write some number of frames into the buffer at a specific offset from a flat long array.

Methods inherited from class java.lang.Object

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

Method Detail

getNumChannels

public int getNumChannels()

Gets the number of channels.

Returns:

the number of channels

getNumFrames

public long getNumFrames()

Get the number of frames.

Returns:

the number of frames

getFramesRemaining

public long getFramesRemaining()

Get the number of frames remaining.

Returns:

the number of frames remaining

getSampleRate

public long getSampleRate()

Get the sample rate.

Returns:

the sample rate

getValidBits

public int getValidBits()

Get the number of valid bits.

Returns:

the number of valid bits

newWavFile

public static WavFile newWavFile(File file,
                                 int numChannels,
                                 long numFrames,
                                 int validBits,
                                 long sampleRate)
                          throws IOException,
                                 WavFileException

Initialize a new WavFile object for writing into the specified file.

Parameters:

file - the file to write to

numChannels - the number of channels to use

numFrames - the number of frames to use

validBits - the number of alid bits to use

sampleRate - the sample rate for the new file

Returns:

the WavFile object

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

openWavFile

public static WavFile openWavFile(File file)
                           throws IOException,
                                  WavFileException

Read WAV contents from a provided file.

Parameters:

file - the file

Returns:

the wav file

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

readFrames

public int readFrames(int[] sampleBuffer,
                      int numFramesToRead)
               throws IOException,
                      WavFileException

Read some number of frames from the buffer into a flat int array.

Parameters:

sampleBuffer - the buffer to read samples into

numFramesToRead - the number of frames to read

Returns:

the number of frames read

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

readFrames

public int readFrames(int[] sampleBuffer,
                      int offset,
                      int numFramesToRead)
               throws IOException,
                      WavFileException

Read some number of frames from a specific offset in the buffer into a flat int array.

Parameters:

sampleBuffer - the buffer to read samples into

offset - the buffer offset to read from

numFramesToRead - the number of frames to read

Returns:

the number of frames read

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

readFrames

public int readFrames(int[][] sampleBuffer,
                      int numFramesToRead)
               throws IOException,
                      WavFileException

Read some number of frames from the buffer into a multi-dimensional int array.

Parameters:

sampleBuffer - the buffer to read samples into

numFramesToRead - the number of frames to read

Returns:

the number of frames read

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

readFrames

public int readFrames(int[][] sampleBuffer,
                      int offset,
                      int numFramesToRead)
               throws IOException,
                      WavFileException

Read some number of frames from a specific offset in the buffer into a multi-dimensional int array. s

Parameters:

sampleBuffer - the buffer to read samples into

offset - the buffer offset to read from

numFramesToRead - the number of frames to read

Returns:

the number of frames read

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

writeFrames

public int writeFrames(int[] sampleBuffer,
                       int numFramesToWrite)
                throws IOException,
                       WavFileException

Write some number of frames into the buffer from a flat int array.

Parameters:

sampleBuffer - the buffer to read samples from

numFramesToWrite - the number of frames to write

Returns:

the number of frames written

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

writeFrames

public int writeFrames(int[] sampleBuffer,
                       int offset,
                       int numFramesToWrite)
                throws IOException,
                       WavFileException

Write some number of frames into the buffer at a specific offset from a flat int array.

Parameters:

sampleBuffer - the buffer to read samples from

offset - the buffer offset to write into

numFramesToWrite - the number of frames to write

Returns:

the number of frames written

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

writeFrames

public int writeFrames(int[][] sampleBuffer,
                       int numFramesToWrite)
                throws IOException,
                       WavFileException

Write some number of frames into the buffer from a multi-dimensional int array.

Parameters:

sampleBuffer - the buffer to read samples from

numFramesToWrite - the number of frames to write

Returns:

the number of frames written

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

writeFrames

public int writeFrames(int[][] sampleBuffer,
                       int offset,
                       int numFramesToWrite)
                throws IOException,
                       WavFileException

Write some number of frames into the buffer at a specific offset from a multi-dimensional int array.

Parameters:

sampleBuffer - the buffer to read samples from

offset - the buffer offset to write into

numFramesToWrite - the number of frames to write

Returns:

the number of frames written

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

readFrames

public int readFrames(long[] sampleBuffer,
                      int numFramesToRead)
               throws IOException,
                      WavFileException

Read some number of frames from the buffer into a flat long array.

Parameters:

sampleBuffer - the buffer to read samples into

numFramesToRead - the number of frames to read

Returns:

the number of frames read

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

readFrames

public int readFrames(long[] sampleBuffer,
                      int offset,
                      int numFramesToRead)
               throws IOException,
                      WavFileException

Read some number of frames from a specific offset in the buffer into a flat long array.

Parameters:

sampleBuffer - the buffer to read samples into

offset - the buffer offset to read from

numFramesToRead - the number of frames to read

Returns:

the number of frames read

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

readFrames

public int readFrames(long[][] sampleBuffer,
                      int numFramesToRead)
               throws IOException,
                      WavFileException

Read some number of frames from the buffer into a multi-dimensional long array.

Parameters:

sampleBuffer - the buffer to read samples into

numFramesToRead - the number of frames to read

Returns:

the number of frames read

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

readFrames

public int readFrames(long[][] sampleBuffer,
                      int offset,
                      int numFramesToRead)
               throws IOException,
                      WavFileException

Read some number of frames from a specific offset in the buffer into a multi-dimensional long array.

Parameters:

sampleBuffer - the buffer to read samples into

offset - the buffer offset to read from

numFramesToRead - the number of frames to read

Returns:

the number of frames read

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

writeFrames

public int writeFrames(long[] sampleBuffer,
                       int numFramesToWrite)
                throws IOException,
                       WavFileException

Write some number of frames into the buffer from a flat long array.

Parameters:

sampleBuffer - the buffer to read samples from

numFramesToWrite - the number of frames to write

Returns:

the number of frames written

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

writeFrames

public int writeFrames(long[] sampleBuffer,
                       int offset,
                       int numFramesToWrite)
                throws IOException,
                       WavFileException

Write some number of frames into the buffer at a specific offset from a flat long array.

Parameters:

sampleBuffer - the buffer to read samples from

offset - the buffer offset to write into

numFramesToWrite - the number of frames to write

Returns:

the number of frames written

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

writeFrames

public int writeFrames(long[][] sampleBuffer,
                       int numFramesToWrite)
                throws IOException,
                       WavFileException

Write some number of frames into the buffer from a multi-dimensional long array.

Parameters:

sampleBuffer - the buffer to read samples from

numFramesToWrite - the number of frames to write

Returns:

the number of frames written

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

writeFrames

public int writeFrames(long[][] sampleBuffer,
                       int offset,
                       int numFramesToWrite)
                throws IOException,
                       WavFileException

Write some number of frames into the buffer at a specific offset from a multi-dimensional long array.

Parameters:

sampleBuffer - the buffer to read samples from

offset - the buffer offset to write into

numFramesToWrite - the number of frames to write

Returns:

the number of frames written

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

readFrames

public int readFrames(double[] sampleBuffer,
                      int numFramesToRead)
               throws IOException,
                      WavFileException

Read some number of frames from the buffer into a flat double array.

Parameters:

sampleBuffer - the buffer to read samples into

numFramesToRead - the number of frames to read

Returns:

the number of frames read

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

readFrames

public int readFrames(double[] sampleBuffer,
                      int offset,
                      int numFramesToRead)
               throws IOException,
                      WavFileException

Read some number of frames from a specific offset in the buffer into a flat double array.

Parameters:

sampleBuffer - the buffer to read samples into

offset - the buffer offset to read from

numFramesToRead - the number of frames to read

Returns:

the number of frames read

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

readFrames

public int readFrames(double[][] sampleBuffer,
                      int numFramesToRead)
               throws IOException,
                      WavFileException

Read some number of frames from the buffer into a multi-dimensional double array.

Parameters:

sampleBuffer - the buffer to read samples into

numFramesToRead - the number of frames to read

Returns:

the number of frames read

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

readFrames

public int readFrames(double[][] sampleBuffer,
                      int offset,
                      int numFramesToRead)
               throws IOException,
                      WavFileException

Read some number of frames from a specific offset in the buffer into a multi-dimensional double array.

Parameters:

sampleBuffer - the buffer to read samples into

offset - the buffer offset to read from

numFramesToRead - the number of frames to read

Returns:

the number of frames read

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

writeFrames

public int writeFrames(double[] sampleBuffer,
                       int numFramesToWrite)
                throws IOException,
                       WavFileException

Write some number of frames into the buffer from a flat double array.

Parameters:

sampleBuffer - the buffer to read samples from

numFramesToWrite - the number of frames to write

Returns:

the number of frames written

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

writeFrames

public int writeFrames(double[] sampleBuffer,
                       int offset,
                       int numFramesToWrite)
                throws IOException,
                       WavFileException

Write some number of frames into the buffer at a specific offset from a flat double array.

Parameters:

sampleBuffer - the buffer to read samples from

offset - the buffer offset to write into

numFramesToWrite - the number of frames to write

Returns:

the number of frames written

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

writeFrames

public int writeFrames(double[][] sampleBuffer,
                       int numFramesToWrite)
                throws IOException,
                       WavFileException

Write some number of frames into the buffer from a multi-dimensional double array.

Parameters:

sampleBuffer - the buffer to read samples from

numFramesToWrite - the number of frames to write

Returns:

the number of frames written

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

writeFrames

public int writeFrames(double[][] sampleBuffer,
                       int offset,
                       int numFramesToWrite)
                throws IOException,
                       WavFileException

Write some number of frames into the buffer at a specific offset from a multi-dimensional double array.

Parameters:

sampleBuffer - the buffer to read samples from

offset - the buffer offset to write into

numFramesToWrite - the number of frames to write

Returns:

the number of frames written

Throws:

IOException - Signals that an I/O exception has occurred

WavFileException - a WavFile-specific exception

close

public void close()
           throws IOException

Close the WavFile.

Throws:

IOException - Signals that an I/O exception has occurred