com.soundhelix.util

Class HarmonyUtils

java.lang.Object

com.soundhelix.util.HarmonyUtils

public final class HarmonyUtils
extends Object

Implements some static methods for Harmony stuff.

Author:

Thomas Schuerger (thomas@schuerger.com)

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkSanity(SongContext songContext) Checks the sanity of the song's harmony.
static void	dumpChords(SongContext songContext) Dumps all chords and their lengths in ticks.
static int	getChordSectionCount(SongContext songContext) Returns the total number of chord sections.
static int	getChordSectionNumber(SongContext songContext, int tick) Returns the number of the chord section of the given tick (counted from 0) or -1 if the tick is negative or at or beyond the end of the song.
static List<Integer>	getChordSectionStartTicks(SongContext songContext) Returns a list of start ticks for all chord sections, in ascending order.
static String	getChordSectionString(SongContext songContext, int tick) Returns a string specifying the chord section that starts at the specified tick, which is a comma-separated list of chords and tick lengths.
static int	getChordSectionTick(SongContext songContext, int chordSection) Returns the first tick of the given chord section number (starting from 0) or -1 if the chord section number is negative or beyond the end of the song.
static int	getDistinctChordSectionCount(SongContext songContext) Returns the number of distinct chord sections.
static int[]	getMinMaxSegmentLengths(SongContext songContext, ActivityVector av) Returns the minimum and the maximum length of all activity segments of the given ActivityVector as well as the minimum and maximum length of all pauses between activity segments, all counted in chord sections.

Methods inherited from class java.lang.Object

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

Method Detail

getChordSectionCount

public static int getChordSectionCount(SongContext songContext)

Returns the total number of chord sections.

Parameters:

songContext - the song context

Returns:

the total number of chord sections

getChordSectionString

public static String getChordSectionString(SongContext songContext,
                           int tick)

Returns a string specifying the chord section that starts at the specified tick, which is a comma-separated list of chords and tick lengths. This is done by listing all the chords and their lengths until the next chord section starts or the song ends.

Parameters:

songContext - the song context

tick - the starting tick

Returns:

a chord section string (or null if the tick parameter is invalid)

getChordSectionNumber

public static int getChordSectionNumber(SongContext songContext,
                        int tick)

Returns the number of the chord section of the given tick (counted from 0) or -1 if the tick is negative or at or beyond the end of the song.

Parameters:

songContext - the song context

tick - the tick

Returns:

the chord section number (or -1)

getChordSectionTick

public static int getChordSectionTick(SongContext songContext,
                      int chordSection)

Returns the first tick of the given chord section number (starting from 0) or -1 if the chord section number is negative or beyond the end of the song. If

Parameters:

songContext - the song context

chordSection - the number of the chord section

Returns:

the tick (or -1)

getDistinctChordSectionCount

public static int getDistinctChordSectionCount(SongContext songContext)

Returns the number of distinct chord sections.

Parameters:

songContext - the song context

Returns:

the number of distinct chord sections

getChordSectionStartTicks

public static List<Integer> getChordSectionStartTicks(SongContext songContext)

Returns a list of start ticks for all chord sections, in ascending order. The first chord section will always start at tick 0. The number of list entries always equals getChordSectionCount(structure).

Parameters:

songContext - the song context

Returns:

a list of start ticks for all chord sections

getMinMaxSegmentLengths

public static int[] getMinMaxSegmentLengths(SongContext songContext,
                            ActivityVector av)

Returns the minimum and the maximum length of all activity segments of the given ActivityVector as well as the minimum and maximum length of all pauses between activity segments, all counted in chord sections. Returns null if the ActivityVector never becomes active. If the ActivityVector only has one activity segment, then there is no pause, and therefore the minimum and maximum pause length will be 0.

Parameters:

songContext - the song context

av - the ActivityVector

Returns:

a 4-element int array containing the minimum and the maximum segment length and the minimum and maximum pause length (in this order) or null

dumpChords

public static void dumpChords(SongContext songContext)

Dumps all chords and their lengths in ticks.

Parameters:

songContext - the song context

checkSanity

public static void checkSanity(SongContext songContext)

Checks the sanity of the song's harmony. An exception with details will be thrown if the sanity check has failed.

Parameters:

songContext - the song context