com.jsyn.data

Class FloatSample

java.lang.Object

com.jsyn.data.SequentialDataCommon

com.jsyn.data.AudioSample

com.jsyn.data.FloatSample

All Implemented Interfaces:

Function, SequentialData

public class FloatSample
extends AudioSample
implements Function

Store multi-channel floating point audio data in an interleaved buffer. The values are stored as 32-bit floats. You can play samples using one of the readers, for example VariableRateMonoReader.

Author:

Phil Burk (C) 2010 Mobileer Inc

See Also:

SampleLoader, FixedRateMonoReader, FixedRateStereoReader, VariableRateMonoReader, VariableRateStereoReader

Field Summary

Fields inherited from class com.jsyn.data.AudioSample

channelsPerFrame, numFrames

Fields inherited from class com.jsyn.data.SequentialDataCommon

maxFrames

Constructor Summary

Constructors

Constructor and Description
FloatSample()
FloatSample(float[] data) Constructor for mono samples with data.
FloatSample(float[] data, int channelsPerFrame) Constructor for multi-channel samples with data.
FloatSample(int numFrames) Constructor for mono samples.
FloatSample(int numFrames, int channelsPerFrame) Create an silent sample with enough memory to hold the audio data.

Method Summary

Modifier and Type	Method and Description
void	allocate(int numFrames, int channelsPerFrame) Allocate memory to hold the audio data.
double	evaluate(double input) Convert an input value to an output value.
double	interpolate(double fractionalIndex)
void	read(float[] data)
void	read(int startFrame, float[] data, int startIndex, int numFrames) Note that in a stereo sample, a frame has two values.
double	readDouble(int index) Read a value from the sample independently from the internal storage format.
void	write(float[] data) Write the entire array to the sample.
void	write(int startFrame, float[] data, int startIndex, int numFrames) Note that in a stereo sample, a frame has two values.
void	writeDouble(int index, double value) Write a value at the given index.

Methods inherited from class com.jsyn.data.AudioSample

addMarker, getChannelsPerFrame, getFrameRate, getMarker, getMarkerCount, getNumFrames, getPitch, getRateScaler, setChannelsPerFrame, setFrameRate, setPitch

Methods inherited from class com.jsyn.data.SequentialDataCommon

getMaxFrames, getReleaseBegin, getReleaseEnd, getSustainBegin, getSustainEnd, setNumFrames, setReleaseBegin, setReleaseEnd, setSustainBegin, setSustainEnd

Methods inherited from class java.lang.Object

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

Constructor Detail

FloatSample

public FloatSample()

FloatSample

public FloatSample(int numFrames)

Constructor for mono samples.

FloatSample

public FloatSample(float[] data)

Constructor for mono samples with data.

FloatSample

public FloatSample(float[] data,
                   int channelsPerFrame)

Constructor for multi-channel samples with data.

FloatSample

public FloatSample(int numFrames,
                   int channelsPerFrame)

Create an silent sample with enough memory to hold the audio data. The number of sample numbers in the array will be numFrames*channelsPerFrame.

Parameters:

numFrames - number of sample groups. A stereo frame contains 2 samples.

channelsPerFrame - 1 for mono, 2 for stereo

Method Detail

allocate

public void allocate(int numFrames,
                     int channelsPerFrame)

Allocate memory to hold the audio data. The number of sample numbers in the array will be numFrames*channelsPerFrame.

Specified by:

allocate in class AudioSample

Parameters:

numFrames - number of sample groups. A stereo frame contains 2 samples.

channelsPerFrame - 1 for mono, 2 for stereo

write

public void write(int startFrame,
                  float[] data,
                  int startIndex,
                  int numFrames)

Note that in a stereo sample, a frame has two values.

Parameters:

startFrame - index of frame in the sample

data - data to be written

startIndex - index of first value in array

numFrames -

read

public void read(int startFrame,
                 float[] data,
                 int startIndex,
                 int numFrames)

Note that in a stereo sample, a frame has two values.

Parameters:

startFrame - index of frame in the sample

data - array to receive the data from the sample

startIndex - index of first location in array to start filling

numFrames -

write

public void write(float[] data)

Write the entire array to the sample. The sample data must have already been allocated with enough room to contain the data.

Parameters:

data -

read

public void read(float[] data)

readDouble

public double readDouble(int index)

Description copied from interface: SequentialData

Read a value from the sample independently from the internal storage format.

Specified by:

readDouble in interface SequentialData

Specified by:

readDouble in class SequentialDataCommon

Parameters:

index - sample index is ((frameIndex * channelsPerFrame) + channelIndex)

writeDouble

public void writeDouble(int index,
                        double value)

Description copied from interface: SequentialData

Write a value at the given index.

Specified by:

writeDouble in interface SequentialData

Specified by:

writeDouble in class SequentialDataCommon

Parameters:

index - sample index is ((frameIndex * channelsPerFrame) + channelIndex)

value - the value to be written

interpolate

public double interpolate(double fractionalIndex)

evaluate

public double evaluate(double input)

Description copied from interface: Function

Convert an input value to an output value.

Specified by:

evaluate in interface Function

Returns:

generated value