com.soundhelix.component.sequenceengine.impl

Class AbstractSequenceEngine

java.lang.Object

com.soundhelix.component.sequenceengine.impl.AbstractSequenceEngine

All Implemented Interfaces:

Component, RandomSeedable, SequenceEngine, XMLConfigurable

Direct Known Subclasses:

AbstractFreeMultiPatternSequenceEngine, AbstractMultiPatternSequenceEngine, ArpeggioSequenceEngine, DrumSequenceEngine, MelodySequenceEngine, PadSequenceEngine

public abstract class AbstractSequenceEngine
extends Object
implements SequenceEngine

Implements an abstract SequenceEngine with some basic functionality.

Author:

Thomas Schuerger (thomas@schuerger.com)

See Also:

SequenceEngine

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractSequenceEngine.PatternRestartMode The restart mode for patterns.

Field Summary

Fields

Modifier and Type	Field and Description
protected Logger	logger The logger.
protected AbstractSequenceEngine.PatternRestartMode	patternRestartMode The pattern restart mode, including its default.
protected long	randomSeed The random seed.

Constructor Summary

Constructors

Constructor and Description
AbstractSequenceEngine() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configurePatternRestartMode(Random random, Node node)
int	getActivityVectorCount() Returns the required number of ActivityVectors.
protected int	getNextPatternRestartTick(SongContext songContext, int tick) Returns the tick number of the next required pattern restart after the given tick.
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.
void	setPatternRestartMode(AbstractSequenceEngine.PatternRestartMode patternRestartMode)
void	setRandomSeed(long randomSeed) Sets the random seed to use.

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.sequenceengine.SequenceEngine

render

Methods inherited from interface com.soundhelix.component.XMLConfigurable

configure

Field Detail

logger

protected final Logger logger

The logger.

randomSeed

protected long randomSeed

The random seed.

patternRestartMode

protected AbstractSequenceEngine.PatternRestartMode patternRestartMode

The pattern restart mode, including its default.

Constructor Detail

AbstractSequenceEngine

public AbstractSequenceEngine()

Constructor.

Method Detail

getActivityVectorCount

public int getActivityVectorCount()

Returns the required number of ActivityVectors. For most implementations, this will be 1, but certain implementations, like for multi-instrument sequences, more than 1 might be required. Subclasses should override this.

Specified by:

getActivityVectorCount in interface SequenceEngine

Returns:

the number of ActivityVectors

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

getNextPatternRestartTick

protected int getNextPatternRestartTick(SongContext songContext,
                            int tick)

Returns the tick number of the next required pattern restart after the given tick.

Parameters:

songContext - the song context

tick - the tick

Returns:

the pattern restart tick

setPatternRestartMode

public void setPatternRestartMode(AbstractSequenceEngine.PatternRestartMode patternRestartMode)

configurePatternRestartMode

protected void configurePatternRestartMode(Random random,
                               Node node)