com.soundhelix.misc

Class Pattern

java.lang.Object

com.soundhelix.misc.Pattern

All Implemented Interfaces:

Iterable<Pattern.PatternEntry>

public class Pattern
extends Object
implements Iterable<Pattern.PatternEntry>

Represents a pattern, which is like a repeatable Sequence, but is immutable and allows particular notes (or offsets) as well as wildcards used for special purposes. Patterns can be created from pattern strings.

Author:

Thomas Schuerger (thomas@schuerger.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pattern.PatternEntry Represents a pattern entry.

Constructor Summary

Constructors

Constructor and Description
Pattern(Pattern.PatternEntry[] pattern) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static String	expandPatternString(String patternString) Expands the given pattern string until no more expansion is possible.
Pattern.PatternEntry	get(int index) Returns the pattern entry with the given index.
static int	getStringTicks(String patternString) Returns the number of ticks of the given pattern string.
int	getTicks() Returns the total number of ticks this pattern spans.
boolean	isLegatoLegal(ActivityVector activityVector, int tick, int patternOffset) Checks whether it is legal to use legato at the note that ends on the given tick.
Iterator<Pattern.PatternEntry>	iterator() Provides an iterator that iterates over all PatternEntries of this pattern.
static Pattern	parseString(SongContext songContext, String patternString, int targetTPB) Parses the given pattern string using no wildcards.
static Pattern	parseString(SongContext songContext, String patternString, String wildcardString, int targetTPB) Parses the given pattern string using the given wildcard string.
Pattern	scale(double factor) Returns a new pattern whose entries' ticks are scaled by the given factor.
int	size() Returns the number of pattern entries this pattern contains.
String	toString()
Pattern	transpose(int pitch) Transposes the pattern up by the given pitch (which may be negative) and returns it as a new pattern (or the original pattern if pitch is 0).

Methods inherited from class java.lang.Object

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

Constructor Detail

Pattern

public Pattern(Pattern.PatternEntry[] pattern)

Constructor.

Parameters:

pattern - the pattern

Method Detail

parseString

public static Pattern parseString(SongContext songContext,
                  String patternString,
                  int targetTPB)

Parses the given pattern string using no wildcards.

Parameters:

songContext - the song context

patternString - the pattern string

targetTPB - the ticks per beat the pattern is for

Returns:

the pattern

parseString

public static Pattern parseString(SongContext songContext,
                  String patternString,
                  String wildcardString,
                  int targetTPB)

Parses the given pattern string using the given wildcard string.

Parameters:

songContext - the song context

patternString - the pattern string

wildcardString - the wildcard string

targetTPB - the ticks per beat the pattern is for

Returns:

the pattern

expandPatternString

public static String expandPatternString(String patternString)

Expands the given pattern string until no more expansion is possible. This method search for occurences of the pattern "(string)*count" and replaces this with the string concatenated count times using the separator character in between. These constructs can be nested. The replacement starts with the innermost occurrence.

Parameters:

patternString - the pattern string

Returns:

the expanded pattern string

getStringTicks

public static int getStringTicks(String patternString)

Returns the number of ticks of the given pattern string. The pattern string is expanded if necessary to count the number of ticks.

Parameters:

patternString - the pattern string

Returns:

the number of ticks

transpose

public Pattern transpose(int pitch)

Transposes the pattern up by the given pitch (which may be negative) and returns it as a new pattern (or the original pattern if pitch is 0). Only the notes will be affected by this operation (wildcards and pauses are not affected).

Parameters:

pitch - the number of halftones to transpose up (may be negative)

Returns:

a new pattern that is a transposed version of this pattern

scale

public Pattern scale(double factor)

Returns a new pattern whose entries' ticks are scaled by the given factor.

Parameters:

factor - the scale factor

Returns:

a new pattern that is a scaled by the factor

getTicks

public int getTicks()

Returns the total number of ticks this pattern spans.

Returns:

the number of ticks

See Also:

size()

get

public Pattern.PatternEntry get(int index)

Returns the pattern entry with the given index.

Parameters:

index - the index

Returns:

the sequence entry at that index

size

public int size()

Returns the number of pattern entries this pattern contains. Note that in general this is not the number of ticks.

Returns:

the size of the pattern

See Also:

getTicks()

toString

public String toString()

Overrides:

toString in class Object

isLegatoLegal

public boolean isLegatoLegal(ActivityVector activityVector,
                    int tick,
                    int patternOffset)

Checks whether it is legal to use legato at the note that ends on the given tick. The tick must be the tick on which the note would be switched off if no legato was used; the same applies to the pattern offset. Legato is legal for the tick if there is a subsequent note on the pattern that lies in the activity range of the activity vector. I.e., it is illegal to use legato on a note which ends outside of an activity interval.

Parameters:

activityVector - the activity vector

tick - the tick

patternOffset - the pattern offset

Returns:

true if legato is legal, false otherwise

iterator

public Iterator<Pattern.PatternEntry> iterator()

Provides an iterator that iterates over all PatternEntries of this pattern.

Specified by:

iterator in interface Iterable<Pattern.PatternEntry>

Returns:

the iterator