net.beadsproject.beads.data.audiofile

Interface AudioFileReader

All Known Implementing Classes:

WavFileReaderWriter

public interface AudioFileReader

Implementing this interface indicates support for 'one-shot' reading of an audio file. That is, an entire audio file can be opened, read into a float[][] and then closed in a single blocking method.

Author:

aengus

Method Summary

Modifier and Type	Method and Description
SampleAudioFormat	getSampleAudioFormat() After reading, the SampleAudioFormat can be obtained.
java.util.HashSet<AudioFileType>	getSupportedFileTypesForReading() Get the supported file types.
float[][]	readAudioFile(java.lang.String filename) Single method to read an entire audio file in one go.

Method Detail

readAudioFile

float[][] readAudioFile(java.lang.String filename)
                 throws java.io.IOException,
                        OperationUnsupportedException,
                        FileFormatException

Single method to read an entire audio file in one go.

Parameters:

data - - upon return, this will point to a 2D array containing all the audio data. The first dimension (data.length) is the number of channels. The second dimension (data[0].length) is the number of frames.

filename - - the name of the file to be read

saf - - upon return, this will point to a SampleAudioFormat object containing the details of the sample data that was read.

Throws:

java.io.IOException

OperationUnsupportedException

FileFormatException

getSampleAudioFormat

SampleAudioFormat getSampleAudioFormat()

After reading, the SampleAudioFormat can be obtained.

Returns:

the SampleAudioFormat object describing the sample data that has been read in.

getSupportedFileTypesForReading

java.util.HashSet<AudioFileType> getSupportedFileTypesForReading()

Get the supported file types.

Returns:

- the supported file types.