Class SongChordSequence

java.lang.Object

java.util.AbstractCollection<CLI_ChordSymbol>

java.util.AbstractSet<CLI_ChordSymbol>

java.util.TreeSet<CLI_ChordSymbol>

org.jjazz.rhythmmusicgeneration.api.ChordSequence

org.jjazz.rhythmmusicgeneration.api.SongChordSequence

All Implemented Interfaces:

Serializable, Cloneable, Comparable<ChordSequence>, Iterable<CLI_ChordSymbol>, Collection<CLI_ChordSymbol>, NavigableSet<CLI_ChordSymbol>, SequencedCollection<CLI_ChordSymbol>, SequencedSet<CLI_ChordSymbol>, Set<CLI_ChordSymbol>, SortedSet<CLI_ChordSymbol>

public class SongChordSequence
extends ChordSequence

A ChordSequence built for a song, or a part of a song.

When constructed a SongChordSequence always has a starting chord symbol.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SongChordSequence(Song song, IntRange barRange)	Build a ChordSequence for the specified song, or part of the song.

Method Summary

Modifier and Type	Method	Description
List<SimpleChordSequence>	buildSimpleChordSequences(Predicate<SongPart> sptTester)	Build a SimpleChordSequence for each sequence of contiguous SongParts which match the predicate.
static void	fillChordSequence(ChordSequence cSeq, Song song, IntRange barRange)	Fill a ChordSequence with the chord symbols of the specified song (or part of the song).
FloatRange	getBeatRange()	Get the BeatRange of this SongChordSequence.
float	getChordDuration(CLI_ChordSymbol cliCs, TimeSignature ts)	Return the duration in natural beats of the specified chord.
Song	getSong()
List<SongPart>	getSongParts()	Get the SongParts (whole or partially) included in this SongChordSequence.
IntRange	getSptBarRange(SongPart spt)	Get the intersection between the specified SongPart and the bar range of this ChordSequence.

Methods inherited from class org.jjazz.rhythmmusicgeneration.api.ChordSequence

clone, compareTo, equals, getBarRange, getChordSymbol, getFirstAfter, getLastBefore, getRootAscIntervals, hasChordAtBeginning, hashCode, removeRedundantStandardChords, subSequence, toString

Methods inherited from class java.util.TreeSet

add, addAll, addFirst, addLast, ceiling, clear, comparator, contains, descendingIterator, descendingSet, first, floor, headSet, headSet, higher, isEmpty, iterator, last, lower, pollFirst, pollLast, remove, size, spliterator, subSet, subSet, tailSet, tailSet

Methods inherited from class java.util.AbstractSet

removeAll

Methods inherited from class java.util.AbstractCollection

containsAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.NavigableSet

removeFirst, removeLast, reversed

Methods inherited from interface java.util.Set

containsAll, removeAll, retainAll, toArray, toArray

Methods inherited from interface java.util.SortedSet

getFirst, getLast

Constructor Details

SongChordSequence

public SongChordSequence(Song song,
 IntRange barRange)
                  throws UserErrorGenerationException

Build a ChordSequence for the specified song, or part of the song.

The constructor relies on fillChordSequence() to add the chord symbols, then it makes sure that the created object has a ChordSymbol at beginning.

Parameters:

song -

barRange - If null, use the whole song.

Throws:

IllegalArgumentException - If barRange is not contained in the song.

UserErrorGenerationException - If no chord found to be the 1st chord of the ChordSequence

See Also:

• fillChordSequence(org.jjazz.rhythmmusicgeneration.api.ChordSequence, org.jjazz.song.api.Song, org.jjazz.util.api.IntRange)

Method Details

getSong

public Song getSong()

getSongParts

public List<SongPart> getSongParts()

Get the SongParts (whole or partially) included in this SongChordSequence.

Returns:

getBeatRange

public FloatRange getBeatRange()

Get the BeatRange of this SongChordSequence.

Returns:

getSptBarRange

public IntRange getSptBarRange(SongPart spt)

Get the intersection between the specified SongPart and the bar range of this ChordSequence.

Parameters:

spt -

Returns:

getChordDuration

public float getChordDuration(CLI_ChordSymbol cliCs,
 TimeSignature ts)

Return the duration in natural beats of the specified chord.

This is the duration until next chord or the end of the SongChordSequence.

Parameters:

cliCs -

ts - The TimeSignature of the section where chordIndex belongs to (a chord symbol can not span on 2 sections).

Returns:

buildSimpleChordSequences

public List<SimpleChordSequence> buildSimpleChordSequences(Predicate<SongPart> sptTester)

Build a SimpleChordSequence for each sequence of contiguous SongParts which match the predicate.

Returned SimpleChordSequences are limited to the bar range of this SongChordSequence.

Parameters:

sptTester - All the accepted SongParts must have the same TimeSignature

Returns:

An ordered list by bar. Can be empty.

Throws:

IllegalArgumentException - If all the accepted SongParts don't have the same TimeSignature

fillChordSequence

public static void fillChordSequence(ChordSequence cSeq,
 Song song,
 IntRange barRange)

Fill a ChordSequence with the chord symbols of the specified song (or part of the song).

Use the song's SongStructure and ChordLeadSheet, limited to the specified bar range, to fill the specified ChordSequence. Process the alternate chord symbols when relevant.
Example:
- ChordLeadSheet: Section B1: bar0=Cm7, bar1=empty Section B2: bar2=Bb bar3=empty
- SongStructure: B1 B2 B1
- Range: [bar1; bar5] Method returns: Cm7(bar1), Bb(bar2), Cm7(bar4), empty(bar5)

Parameters:

cSeq -

song -

barRange - If null, use the whole song.

Throws:

IllegalArgumentException - If barRange is not contained in the song.