com.soundhelix.component.sequenceengine.impl

Class ArpeggioSequenceEngine

java.lang.Object

com.soundhelix.component.sequenceengine.impl.AbstractSequenceEngine

com.soundhelix.component.sequenceengine.impl.ArpeggioSequenceEngine

All Implemented Interfaces:

Component, RandomSeedable, SequenceEngine, XMLConfigurable

public class ArpeggioSequenceEngine
extends AbstractSequenceEngine

Implements a sequence engine that repeats user-specified patterns. Patterns are comma-separated integers (notes from chords) or minus signs (pauses). For each chord the pattern with the best-matching length is used. The best-matching pattern is the one with the smallest length that is equal to or larger than the required length or the pattern with the largest length if the former doesn't exist. At least some patterns with lengths of powers of two should be provided.

Author:

Thomas Schuerger (thomas@schuerger.com)

Nested Class Summary

Nested classes/interfaces inherited from class com.soundhelix.component.sequenceengine.impl.AbstractSequenceEngine

AbstractSequenceEngine.PatternRestartMode

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isNormalizeChords Boolean indicating if chords should be normalized.
protected boolean	obeyChordSections Boolean indicating of chord sections should be obeyed.
protected Random	random The random generator.

Fields inherited from class com.soundhelix.component.sequenceengine.impl.AbstractSequenceEngine

logger, patternRestartMode, randomSeed

Constructor Summary

Constructors

Constructor and Description
ArpeggioSequenceEngine() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(SongContext songContext, Node node) Configures the instance using the specified XML node.
Track	render(SongContext songContext, ActivityVector[] activityVectors) Renders one or more sequences (i.e., voices) as a track.
void	setNormalizeChords(boolean isNormalizeChords)
void	setObeyChordSections(boolean obeyChordSections)
void	setPatterns(Pattern[] patterns)

Methods inherited from class com.soundhelix.component.sequenceengine.impl.AbstractSequenceEngine

configurePatternRestartMode, getActivityVectorCount, getNextPatternRestartTick, getRandomSeed, setPatternRestartMode, setRandomSeed

Methods inherited from class java.lang.Object

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

Field Detail

random

protected Random random

The random generator.

isNormalizeChords

protected boolean isNormalizeChords

Boolean indicating if chords should be normalized.

obeyChordSections

protected boolean obeyChordSections

Boolean indicating of chord sections should be obeyed.

Constructor Detail

ArpeggioSequenceEngine

public ArpeggioSequenceEngine()

Constructor.

Method Detail

setPatterns

public void setPatterns(Pattern[] patterns)

setObeyChordSections

public void setObeyChordSections(boolean obeyChordSections)

render

public Track render(SongContext songContext,
           ActivityVector[] activityVectors)

Description copied from interface: SequenceEngine

Renders one or more sequences (i.e., voices) as a track. The method should check the given ActivityVectors to decide when to insert notes and when to insert pauses. The method should also take care that played notes are not sustained beyond inactive intervals of the ActivityVector (however, it is not strictly forbidden to do so). The returned track must contain at least one sequence. The length of each sequence must match the length of the song. The method must take the song's harmony into consideration.

Parameters:

songContext - the song context

activityVectors - the activity vectors

Returns:

the track

configure

public void configure(SongContext songContext,
             Node node)
               throws XPathException

Description copied from interface: XMLConfigurable

Configures the instance using the specified XML node. The method should read all supported configuration tags and should call the corresponding setter methods of the class. All settings of the class that are settable using XML should also be settable by using public methods (for example, if the beats per minute are settable using an XML tag, then the class should also provide a public method setBPM(), which does the same). XML configuration can also be a recursive process, if XML settings contain nodes that require XML configuration themselves, but this is up to the implementation of this method. The method should (but need not) use XPath to access the node's tags. Only the node and its descendant nodes may be used for configuration.

Parameters:

songContext - the song context

node - the parent XML node of the configuration tags

Throws:

XPathException - in case of an XPath problem

setNormalizeChords

public void setNormalizeChords(boolean isNormalizeChords)