com.jsyn.data

Class ShortSample

java.lang.Object

com.jsyn.data.SequentialDataCommon

com.jsyn.data.AudioSample

com.jsyn.data.ShortSample

All Implemented Interfaces:

SequentialData

public class ShortSample
extends AudioSample

Store multi-channel short audio data in an interleaved buffer.

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
ShortSample()
ShortSample(int numFrames, int channelsPerFrame)
ShortSample(short[] data) Constructor for mono samples with data.
ShortSample(short[] data, int channelsPerFrame) Constructor for multi-channel samples with data.

Method Summary

Modifier and Type	Method and Description
void	allocate(int numFrames, int channelsPerFrame)
void	read(int startFrame, short[] data, int startIndex, int numFrames) Note that in a stereo sample, a frame has two values.
void	read(short[] data)
double	readDouble(int index) Read a sample converted to a double in the range -1.0 to almost 1.0.
short	readShort(int index)
void	write(int startFrame, short[] data, int startIndex, int numFrames) Note that in a stereo sample, a frame has two values.
void	write(short[] data)
void	writeDouble(int index, double value) Write a double that will be clipped to the range -1.0 to almost 1.0 and converted to a short.
void	writeShort(int index, short value)

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

ShortSample

public ShortSample()

ShortSample

public ShortSample(int numFrames,
                   int channelsPerFrame)

ShortSample

public ShortSample(short[] data)

Constructor for mono samples with data.

ShortSample

public ShortSample(short[] data,
                   int channelsPerFrame)

Constructor for multi-channel samples with data.

Method Detail

allocate

public void allocate(int numFrames,
                     int channelsPerFrame)

Specified by:

allocate in class AudioSample

write

public void write(int startFrame,
                  short[] 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,
                 short[] 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(short[] data)

read

public void read(short[] data)

readShort

public short readShort(int index)

writeShort

public void writeShort(int index,
                       short value)

readDouble

public double readDouble(int index)

Read a sample converted to a double in the range -1.0 to almost 1.0.

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)

Write a double that will be clipped to the range -1.0 to almost 1.0 and converted to a short.

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