us.msoe.csse.taylor.audio

Class WavFile

java.lang.Object

us.msoe.csse.taylor.audio.WavFile

public class WavFile
extends java.lang.Object

A simple class for reading, writing, and accessing audio samples associated with a .wav file. The class is based on a similar class developed by A. Greensted. http://www.labbookpages.co.uk/audio/javaWavFiles.html

The file format is based on information from:

• http://www-mmsp.ece.mcgill.ca/Documents/AudioFormats/WAVE/WAVE.html

Version:

20191125

Author:

npǝ˙ǝosɯ@ɹolʎɐʇ and A.Greensted

Constructor Summary

Constructors

Constructor and Description
WavFile(java.lang.String filename) Constructor for creating a WavFile object to be read from a file. The argument must include the entire filename including the extension.
WavFile(java.lang.String filename, int numChannels, long numFrames, int validBits, long sampleRate) Constructor for creating a WavFile object to be written to a file. The argument must include the entire filename including the extension.

Method Summary

Modifier and Type	Method and Description
boolean	close() Frees up resources associated with the object and releases the file associated with the object
int	getNumChannels()
long	getNumFrames()
long	getSampleRate()
java.util.ArrayList<java.lang.Double>	getSamples() Gets all of the audio samples for the wav file
int	getValidBits()
boolean	setSamples(java.util.ArrayList<java.lang.Double> samples) Writes the audio samples passed to the wav file
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WavFile

public WavFile(java.lang.String filename)

Constructor for creating a WavFile object to be read from a file.

Parameters:

filename - The filename of the file to be read into this object. The argument must include the entire filename including the extension.

WavFile

public WavFile(java.lang.String filename,
               int numChannels,
               long numFrames,
               int validBits,
               long sampleRate)

Constructor for creating a WavFile object to be written to a file.

Parameters:

filename - The filename of the file this object should be written to. The argument must include the entire filename including the extension.

numChannels - The number of channels of audio. If more than one, the samples are interleaved.

numFrames - The number of frames of audio

validBits - The number of bits used to store each sample, that is, the number of bits used to specify the amplitude of each sample, e.g., 16

sampleRate - The sample rate for the audio samples in samples per second (Hz). Typical sample rates are 44,100 Hz, 32,000 Hz, 22,050 Hz, 11,025 Hz, and 8,000 Hz.

Method Detail

getNumChannels

public int getNumChannels()

getNumFrames

public long getNumFrames()

getSampleRate

public long getSampleRate()

getValidBits

public int getValidBits()

getSamples

public java.util.ArrayList<java.lang.Double> getSamples()

Gets all of the audio samples for the wav file

This method should only be called once.

Returns null if an IO exception was encountered.

Returns:

All of the audio samples for the wav file or null (if an IOException was thrown)

setSamples

public boolean setSamples(java.util.ArrayList<java.lang.Double> samples)

Writes the audio samples passed to the wav file

This method should only be called once.

Parameters:

samples - The audio samples for the wav file

Returns:

returns true if successful, false if not (IOException was encountered)

close

public boolean close()

Frees up resources associated with the object and releases the file associated with the object

Returns:

returns true if successful, false if not (IOException was encountered)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object