com.jsyn.data

Class SequentialDataCommon

java.lang.Object

com.jsyn.data.SequentialDataCommon

All Implemented Interfaces:

SequentialData

Direct Known Subclasses:

AudioSample, SegmentedEnvelope

public abstract class SequentialDataCommon
extends java.lang.Object
implements SequentialData

Abstract base class for envelopes and samples that adds sustain and release loops.

Author:

Phil Burk (C) 2010 Mobileer Inc

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxFrames
protected int	numFrames

Constructor Summary

Constructors

Constructor and Description
SequentialDataCommon()

Method Summary

Modifier and Type	Method and Description
abstract int	getChannelsPerFrame()
int	getMaxFrames()
int	getNumFrames()
abstract double	getRateScaler(int index, double synthesisRate) Get rate to play the data.
int	getReleaseBegin()
int	getReleaseEnd()
int	getSustainBegin()
int	getSustainEnd() SustainEnd value is the frame index of the frame just past the end of the loop.
abstract double	readDouble(int index) Read a value from the sample independently from the internal storage format.
void	setNumFrames(int numFrames) Set number of frames of data.
void	setReleaseBegin(int releaseBegin)
void	setReleaseEnd(int releaseEnd) ReleaseEnd value is the frame index of the frame just past the end of the loop.
void	setSustainBegin(int sustainBegin)
void	setSustainEnd(int sustainEnd) SustainEnd value is the frame index of the frame just past the end of the loop.
abstract void	writeDouble(int index, double value) Write a value at the given index.

Methods inherited from class java.lang.Object

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

Field Detail

numFrames

protected int numFrames

maxFrames

protected int maxFrames

Constructor Detail

SequentialDataCommon

public SequentialDataCommon()

Method Detail

writeDouble

public abstract void writeDouble(int index,
                                 double value)

Description copied from interface: SequentialData

Write a value at the given index.

Specified by:

writeDouble in interface SequentialData

Parameters:

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

value - the value to be written

readDouble

public abstract 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

Parameters:

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

getRateScaler

public abstract double getRateScaler(int index,
                                     double synthesisRate)

Description copied from interface: SequentialData

Get rate to play the data. In an envelope this correspond to the inverse of the frame duration and would vary frame to frame. For an audio sample it is 1.0.

Specified by:

getRateScaler in interface SequentialData

Returns:

rate to scale the playback speed.

getChannelsPerFrame

public abstract int getChannelsPerFrame()

Specified by:

getChannelsPerFrame in interface SequentialData

Returns:

For a stereo sample, return 2.

getMaxFrames

public int getMaxFrames()

Returns:

Maximum number of frames of data.

setNumFrames

public void setNumFrames(int numFrames)

Set number of frames of data. Input will be clipped to maxFrames. This is useful when changing the contents of a sample or envelope.

getNumFrames

public int getNumFrames()

Specified by:

getNumFrames in interface SequentialData

Returns:

The number of valid frames that can be read.

getSustainBegin

public int getSustainBegin()

Specified by:

getSustainBegin in interface SequentialData

Returns:

Beginning of sustain loop or -1 if no loop.

getSustainEnd

public int getSustainEnd()

Description copied from interface: SequentialData

SustainEnd value is the frame index of the frame just past the end of the loop. The number of frames included in the loop is (SustainEnd - SustainBegin).

Specified by:

getSustainEnd in interface SequentialData

Returns:

End of sustain loop or -1 if no loop.

getReleaseBegin

public int getReleaseBegin()

Specified by:

getReleaseBegin in interface SequentialData

Returns:

Beginning of release loop or -1 if no loop.

getReleaseEnd

public int getReleaseEnd()

Specified by:

getReleaseEnd in interface SequentialData

Returns:

End of release loop or -1 if no loop.

setSustainBegin

public void setSustainBegin(int sustainBegin)

setSustainEnd

public void setSustainEnd(int sustainEnd)

SustainEnd value is the frame index of the frame just past the end of the loop. The number of frames included in the loop is (SustainEnd - SustainBegin).

Parameters:

sustainEnd -

setReleaseBegin

public void setReleaseBegin(int releaseBegin)

setReleaseEnd

public void setReleaseEnd(int releaseEnd)

ReleaseEnd value is the frame index of the frame just past the end of the loop. The number of frames included in the loop is (ReleaseEnd - ReleaseBegin).

Parameters:

releaseEnd -