com.soundhelix.component.lfo

Interface LFO

All Superinterfaces:

Component, RandomSeedable, XMLConfigurable

All Known Implementing Classes:

AbstractLFO, LFOSequenceLFO, LinearRandomLFO, RectangleLFO, SawtoothLFO, SineLFO, TriangleLFO

public interface LFO
extends Component

Represents a low frequency oscillator (LFO). The oscillator can run in one of five synchronization modes: synchronized to time (e.g, a full rotation every 5 seconds), synchronized to beat (e.g., a full rotation every 16 beats), synchronized to activity (e.g., a full rotation from activity start to activity end of an instrument), synchronized to the song length (e.g., 2 full rotations over the whole song) or synchronized to a segment pair (e.g., the first half a rotation in the active segment and the second half in the inactive segment). An LFO allows random access to its value given a tick. LFOs can be used for slowly changing certain settings, for example, for changing the filter cutoff frequency of a MIDI device. LFO implementation must be able to handle small values for their parameters and must return values correctly (i.e., without returning jumpy/glitchy values).

Author:

Thomas Schuerger (thomas@schuerger.com)

Method Summary

Methods

Modifier and Type	Method and Description
double	getRawTickValue(int tick) Returns the LFO's raw value (between 0 and 1) at the given tick, without any scaling or cut-off.
int	getTickValue(int tick) Returns the LFO's value at the given tick as an integer, taking scaling (via minAmplitude and maxAmplitude) and cut-off (via minValue and maxValue) into account.
void	setActivitySpeed(double rotationsPerActivity, int startTick, int endTick) Makes this LFO synchronized to a tick range and sets the parameters.
void	setBeatSpeed(double rotationsPerBeat, int ticksPerBeat) Makes this LFO synchronized to beats and sets the parameters.
void	setMaxAmplitude(int maxAmplitude) Sets the maximum value of the amplitude.
void	setMaxValue(int maxValue) Sets the maximum value to return.
void	setMinAmplitude(int minAmplitude) Sets the minimum value of the amplitude.
void	setMinValue(int minValue) Sets the minimum value to return.
void	setPhase(double phase) Set the starting phase (the phase to use for tick 0).
void	setSegmentPairSpeed(double rotationsPerSegmentPair, ActivityVector activityVector) Makes this LFO synchronized to an ActivityVector's activity and pause segments.
void	setSongContext(SongContext songContext) Sets the song context.
void	setSongSpeed(double rotationsPerSong, int ticksPerSong) Makes this LFO synchronized to the song length and sets the parameters.
void	setTimeSpeed(double rotationsPerSecond, int ticksPerBeat, double bpm) Makes this LFO synchronized to time and sets the parameters.

Methods inherited from interface com.soundhelix.component.XMLConfigurable

configure

Methods inherited from interface com.soundhelix.component.RandomSeedable

getRandomSeed, setRandomSeed

Method Detail

getTickValue

int getTickValue(int tick)

Returns the LFO's value at the given tick as an integer, taking scaling (via minAmplitude and maxAmplitude) and cut-off (via minValue and maxValue) into account.

Parameters:

tick - the tick (non-negative)

Returns:

the LFO's value

getRawTickValue

double getRawTickValue(int tick)

Returns the LFO's raw value (between 0 and 1) at the given tick, without any scaling or cut-off.

Parameters:

tick - the tick (non-negative)

Returns:

the LFO's value

setBeatSpeed

void setBeatSpeed(double rotationsPerBeat,
                int ticksPerBeat)

Makes this LFO synchronized to beats and sets the parameters.

Parameters:

rotationsPerBeat - the number of rotations per beat

ticksPerBeat - the number of ticks per beat

setSongSpeed

void setSongSpeed(double rotationsPerSong,
                int ticksPerSong)

Makes this LFO synchronized to the song length and sets the parameters.

Parameters:

rotationsPerSong - the number of rotations for the whole song

ticksPerSong - the ticks of the song

setActivitySpeed

void setActivitySpeed(double rotationsPerActivity,
                    int startTick,
                    int endTick)

Makes this LFO synchronized to a tick range and sets the parameters.

Parameters:

rotationsPerActivity - the number of rotations for the tick range

startTick - the start tick

endTick - the end tick

setSegmentPairSpeed

void setSegmentPairSpeed(double rotationsPerSegmentPair,
                       ActivityVector activityVector)

Makes this LFO synchronized to an ActivityVector's activity and pause segments.

Parameters:

rotationsPerSegmentPair - the number of rotations per segment pair

activityVector - the activity vector

setTimeSpeed

void setTimeSpeed(double rotationsPerSecond,
                int ticksPerBeat,
                double bpm)

Makes this LFO synchronized to time and sets the parameters.

Parameters:

rotationsPerSecond - the number of rotations per second

ticksPerBeat - the ticks per beat

bpm - the BPM

setPhase

void setPhase(double phase)

Set the starting phase (the phase to use for tick 0). If a phase should be set, it must be set before calling any of the set*Speed() methods.

Parameters:

phase - the number of rotations for the initial phase

setMinValue

void setMinValue(int minValue)

Sets the minimum value to return. If this value is greater than the amplitude minimum, this results in a cut-off at the given value.

Parameters:

minValue - the value minimum

setMaxValue

void setMaxValue(int maxValue)

Sets the maximum value to return. If this value is smaller than the amplitude maximum, this results in a cut-off at the given value.

Parameters:

maxValue - the value maximum

setMinAmplitude

void setMinAmplitude(int minAmplitude)

Sets the minimum value of the amplitude.

Parameters:

minAmplitude - the minimum amplitude value

setMaxAmplitude

void setMaxAmplitude(int maxAmplitude)

Sets the maximum value of the amplitude.

Parameters:

maxAmplitude - the maximum amplitude value

setSongContext

void setSongContext(SongContext songContext)

Sets the song context.

Parameters:

songContext - the song context