com.soundhelix.component.sequenceengine.impl

Class PadSequenceEngine

java.lang.Object

com.soundhelix.component.sequenceengine.impl.AbstractSequenceEngine

com.soundhelix.component.sequenceengine.impl.PadSequenceEngine

All Implemented Interfaces:

Component, RandomSeedable, SequenceEngine, XMLConfigurable

public class PadSequenceEngine
extends AbstractSequenceEngine

Implements a pad sequence engine using 1 or more voices, playing at a configurable velocity. This engine simply plays each chord for its whole length. The chord tones are selected by specifying a list of chord offsets. For example, offsets 0, 1 and 2 form a normal 3-tone chord. The chord can be "stretched" by using a wider offset range, e.g., 0,1,2,3,4 which would add base and middle tone with increased octave to the normal chord tones.

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 inherited from class com.soundhelix.component.sequenceengine.impl.AbstractSequenceEngine

logger, patternRestartMode, randomSeed

Constructor Summary

Constructors

Constructor and Description
PadSequenceEngine()

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	setOffsets(int[] offsets)
void	setRetriggerPitches(boolean retriggerPitches)
void	setVelocity(int velocity)

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

Constructor Detail

PadSequenceEngine

public PadSequenceEngine()

Method Detail

setOffsets

public void setOffsets(int[] offsets)

setVelocity

public void setVelocity(int velocity)

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

setObeyChordSections

public void setObeyChordSections(boolean obeyChordSections)

setNormalizeChords

public void setNormalizeChords(boolean isNormalizeChords)

setRetriggerPitches

public void setRetriggerPitches(boolean retriggerPitches)