com.soundhelix.component.sequenceengine.impl

Class DrumSequenceEngine

java.lang.Object

com.soundhelix.component.sequenceengine.impl.AbstractSequenceEngine

com.soundhelix.component.sequenceengine.impl.DrumSequenceEngine

All Implemented Interfaces:

Component, RandomSeedable, SequenceEngine, XMLConfigurable

public class DrumSequenceEngine
extends AbstractSequenceEngine

Implements a sequence engine for drum machines. Drum machines normally play a certain sample (e.g., a base drum or a snare) when a certain pitch is played. This class supports an arbitrary number of combinations of patterns, pitches and activity vectors. Each pattern acts as a voice for a certain pitch. Conditional patterns allow the modification of the generated sequences when certain conditions are met, e.g., for generating fill-ins, crescendos, etc. when monitored ActivityVectors become active or inactive. Conditional LFOs allow the creation of LFO sequences certain conditions are met, e.g., for generating fill-ins, crescendos, etc. when monitored ActivityVectors become active or inactive.

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
DrumSequenceEngine()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(SongContext songContext, Node node) Configures the instance using the specified XML node.
int	getActivityVectorCount() Returns the required number of ActivityVectors.
Track	render(SongContext songContext, ActivityVector[] activityVectors) Renders one or more sequences (i.e., voices) as a track.
void	setConditionalLFOEntries(com.soundhelix.component.sequenceengine.impl.DrumSequenceEngine.ConditionalLFODrumEntry[] conditionalLFOEntries)
void	setConditionalPatternEntries(com.soundhelix.component.sequenceengine.impl.DrumSequenceEngine.ConditionalPatternDrumEntry[] conditionalPatternEntries)
void	setDrumEntries(com.soundhelix.component.sequenceengine.impl.DrumSequenceEngine.DrumEntry[] drumEntries)

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

configurePatternRestartMode, getNextPatternRestartTick, getRandomSeed, setPatternRestartMode, setRandomSeed

Methods inherited from class java.lang.Object

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

Constructor Detail

DrumSequenceEngine

public DrumSequenceEngine()

Method Detail

setDrumEntries

public void setDrumEntries(com.soundhelix.component.sequenceengine.impl.DrumSequenceEngine.DrumEntry[] drumEntries)

setConditionalPatternEntries

public void setConditionalPatternEntries(com.soundhelix.component.sequenceengine.impl.DrumSequenceEngine.ConditionalPatternDrumEntry[] conditionalPatternEntries)

setConditionalLFOEntries

public void setConditionalLFOEntries(com.soundhelix.component.sequenceengine.impl.DrumSequenceEngine.ConditionalLFODrumEntry[] conditionalLFOEntries)

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

getActivityVectorCount

public int getActivityVectorCount()

Description copied from class: AbstractSequenceEngine

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

Overrides:

getActivityVectorCount in class AbstractSequenceEngine

Returns:

the number of ActivityVectors

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