com.soundhelix.component.lfo.impl

Class AbstractLFO

java.lang.Object

com.soundhelix.component.lfo.impl.AbstractLFO

All Implemented Interfaces:

Component, LFO, RandomSeedable, XMLConfigurable

Direct Known Subclasses:

LFOSequenceLFO, LinearRandomLFO, RectangleLFO, SawtoothLFO, SineLFO, TriangleLFO

public abstract class AbstractLFO
extends Object
implements LFO

This class implements the basic methods for setting the mode and speed of the LFO as well as the minimum and maximum amplitude and value to return. In addition, the LFO's starting phase can be set. The type of LFO (e.g., sine, triangle, sawtooth or rectangle wave) must be implemented by subclasses. Subclasses can implement any type of waveform (for example, Bezier-spline interpolated random waveforms), but must return their results so that they depend on the selected speed in a natural way and that they are consistent (same method parameters must return same results for the same configuration of the same instance).

Author:

Thomas Schuerger (thomas@schuerger.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isConfigured True if one of the set...Speed() methods has been called.
protected long	randomSeed The random seed.
protected SongContext	songContext The song context.
protected static double	TWO_PI Two times Pi.

Constructor Summary

Constructors

Constructor and Description
AbstractLFO()

Method Summary

Methods

Modifier and Type	Method and Description
long	getRandomSeed() Returns the current random seed, which is the last seed set by setRandomSeed() or the initial random seed if setRandomSeed() hasn't been called before.
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.
protected abstract double	getValue(double angle) Returns the LFO's value of the given angle as a double.
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	setRandomSeed(long randomSeed) Sets the random seed to use.
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 class java.lang.Object

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

Methods inherited from interface com.soundhelix.component.XMLConfigurable

configure

Field Detail

TWO_PI

protected static final double TWO_PI

Two times Pi.

See Also:

Constant Field Values

songContext

protected SongContext songContext

The song context.

randomSeed

protected long randomSeed

The random seed.

isConfigured

protected boolean isConfigured

True if one of the set...Speed() methods has been called.

Constructor Detail

AbstractLFO

public AbstractLFO()

Method Detail

getValue

protected abstract double getValue(double angle)

Returns the LFO's value of the given angle as a double. The returned value must be between 0 and 1 (both inclusive).

Parameters:

angle - the angle in radians (non-negative)

Returns:

the LFO's value (between 0 and 1, both inclusive)

getTickValue

public int getTickValue(int tick)

Description copied from interface: LFO

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.

Specified by:

getTickValue in interface LFO

Parameters:

tick - the tick (non-negative)

Returns:

the LFO's value

getRawTickValue

public double getRawTickValue(int tick)

Description copied from interface: LFO

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

Specified by:

getRawTickValue in interface LFO

Parameters:

tick - the tick (non-negative)

Returns:

the LFO's value

setBeatSpeed

public void setBeatSpeed(double rotationsPerBeat,
                int ticksPerBeat)

Description copied from interface: LFO

Makes this LFO synchronized to beats and sets the parameters.

Specified by:

setBeatSpeed in interface LFO

Parameters:

rotationsPerBeat - the number of rotations per beat

ticksPerBeat - the number of ticks per beat

setSongSpeed

public void setSongSpeed(double rotationsPerSong,
                int ticksPerSong)

Description copied from interface: LFO

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

Specified by:

setSongSpeed in interface LFO

Parameters:

rotationsPerSong - the number of rotations for the whole song

ticksPerSong - the ticks of the song

setActivitySpeed

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

Description copied from interface: LFO

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

Specified by:

setActivitySpeed in interface LFO

Parameters:

rotationsPerActivity - the number of rotations for the tick range

startTick - the start tick

endTick - the end tick

setTimeSpeed

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

Description copied from interface: LFO

Makes this LFO synchronized to time and sets the parameters.

Specified by:

setTimeSpeed in interface LFO

Parameters:

rotationsPerSecond - the number of rotations per second

ticksPerBeat - the ticks per beat

bpm - the BPM

setSegmentPairSpeed

public void setSegmentPairSpeed(double rotationsPerSegmentPair,
                       ActivityVector activityVector)

Description copied from interface: LFO

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

Specified by:

setSegmentPairSpeed in interface LFO

Parameters:

rotationsPerSegmentPair - the number of rotations per segment pair

activityVector - the activity vector

setPhase

public void setPhase(double phase)

Description copied from interface: LFO

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.

Specified by:

setPhase in interface LFO

Parameters:

phase - the number of rotations for the initial phase

setMinValue

public void setMinValue(int minValue)

Description copied from interface: LFO

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.

Specified by:

setMinValue in interface LFO

Parameters:

minValue - the value minimum

setMaxValue

public void setMaxValue(int maxValue)

Description copied from interface: LFO

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.

Specified by:

setMaxValue in interface LFO

Parameters:

maxValue - the value maximum

setMinAmplitude

public void setMinAmplitude(int minAmplitude)

Description copied from interface: LFO

Sets the minimum value of the amplitude.

Specified by:

setMinAmplitude in interface LFO

Parameters:

minAmplitude - the minimum amplitude value

setMaxAmplitude

public void setMaxAmplitude(int maxAmplitude)

Description copied from interface: LFO

Sets the maximum value of the amplitude.

Specified by:

setMaxAmplitude in interface LFO

Parameters:

maxAmplitude - the maximum amplitude value

setRandomSeed

public void setRandomSeed(long randomSeed)

Description copied from interface: RandomSeedable

Sets the random seed to use. A class instance given the same configuration and random seed should produce the same method results when the same methods are called with the same parameters and in the same order. If this method is not called on a class instance, the random seed should be set to an arbitrary value (preferable to something non-constant, e.g., System.nanoTime()).

Specified by:

setRandomSeed in interface RandomSeedable

Parameters:

randomSeed - the random seed

getRandomSeed

public long getRandomSeed()

Description copied from interface: RandomSeedable

Returns the current random seed, which is the last seed set by setRandomSeed() or the initial random seed if setRandomSeed() hasn't been called before.

Specified by:

getRandomSeed in interface RandomSeedable

Returns:

the random seed

setSongContext

public void setSongContext(SongContext songContext)

Description copied from interface: LFO

Sets the song context.

Specified by:

setSongContext in interface LFO

Parameters:

songContext - the song context