uk.co.dolphin_com.sscore.playdata

Class PlayData

java.lang.Object

uk.co.dolphin_com.sscore.playdata.PlayData

All Implemented Interfaces:

java.lang.Iterable<BarIterator.Bar>

public class PlayData
extends java.lang.Object
implements java.lang.Iterable<BarIterator.Bar>

Access to the midi-style play information for the score.

iterator returns a BarIterator which steps to each bar in the correct play sequence. The BarIterator returns each Part in the bar and also a virtual metronome part.

Part.iterator returns a NoteIterator which steps to each note in the bar in that part. The note returns a midi pitch and start time and duration in ms.

Field Summary

Fields

Modifier and Type	Field and Description
static int	Bartype_default for default argument
static int	Bartype_full_bar a normal full bar
static int	Bartype_partial_bar_end partial bar missing beat 1 (ie after repeat mark)
static int	Bartype_partial_bar_start partial bar including beat 1 (ie before repeat mark)
static int	Bartype_partial_first_bar partial bar is first bar in score (ie anacrusis)
static int	kDefaultCountInBars the default count-in is 1 bar

Constructor Summary

Constructors

Constructor and Description
PlayData(SScore score, UserTempo userTempo) construct PlayData with default count-in of 1 bar
PlayData(SScore score, UserTempo userTempo, int countInBars) construct PlayData

Method Summary

Methods

Modifier and Type	Method and Description
TimeSig	actualBeatsForBar(int barIndex) get the actual number of beats in the bar and the beat type This is normally the same as timeSigForBar, but will have fewer beats for a partial bar (eg anacrusis)
int	barTypeForBar(int barIndex) get the type of the bar
int	convertTempoToBPM(Tempo tempo, TimeSig timesig) get a beats-per-minute value for a given Tempo and TimeSig
protected void	finalize()
boolean	firstBarAnacrusis() is the first bar an 'up-beat' or anacrusis partial bar?
BarBeats	getBarBeats(int barIndex, int bpm, int bartype) get the number of beats in a bar and the beat timing
boolean	hasDefinedTempo() does the score define any tempo at the start with metronome or sound tempo elements?
BarIterator	iterator() get an iterator to the set of bars in the score.
float	maxSoundDynamic() get the maximum value of any sound dynamic in any bar.
Tempo	metronomeForBar(int barIndex) get information about any metronome defined in the bar
int	numParts() get the number of playing parts in the score
Tempo	tempoAtBar(int barIndex) get the effective tempo at the bar accounting for any sound tempo elements and metronome elements
Tempo	tempoAtStart() get the effective tempo at start of the score accounting for any sound tempo elements and metronome elements
TimeSig	timeSigForBar(int barIndex) get the applicable time signature for a particular bar
void	updateTempo() call this on changing the user tempo to tell the interface to re-read the UserTempo and update the note timings returned

Methods inherited from class java.lang.Object

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

Field Detail

kDefaultCountInBars

public static final int kDefaultCountInBars

the default count-in is 1 bar

See Also:

Constant Field Values

Bartype_full_bar

public static final int Bartype_full_bar

a normal full bar

See Also:

Constant Field Values

Bartype_partial_first_bar

public static final int Bartype_partial_first_bar

partial bar is first bar in score (ie anacrusis)

See Also:

Constant Field Values

Bartype_partial_bar_start

public static final int Bartype_partial_bar_start

partial bar including beat 1 (ie before repeat mark)

See Also:

Constant Field Values

Bartype_partial_bar_end

public static final int Bartype_partial_bar_end

partial bar missing beat 1 (ie after repeat mark)

See Also:

Constant Field Values

Bartype_default

public static final int Bartype_default

for default argument

See Also:

Constant Field Values

Constructor Detail

PlayData

public PlayData(SScore score,
        UserTempo userTempo,
        int countInBars)
         throws ScoreException

construct PlayData

Parameters:

score - the score

userTempo - an implementation of the UserTempo interface allowing the user eg with a slider to define the tempo, or tempo scaling

countInBars - the number of bars to count in before start

Throws:

ScoreException - any error

PlayData

public PlayData(SScore score,
        UserTempo userTempo)
         throws ScoreException

construct PlayData with default count-in of 1 bar

Parameters:

score - the score

userTempo - user-defining tempo instance

Throws:

ScoreException - any error

Method Detail

barTypeForBar

public int barTypeForBar(int barIndex)

get the type of the bar

Parameters:

barIndex -

Returns:

Bartype_*

timeSigForBar

public TimeSig timeSigForBar(int barIndex)
                      throws ScoreException

get the applicable time signature for a particular bar

Parameters:

barIndex - the index of the bar. 0 is the first bar

Returns:

the applicable TimeSig

Throws:

ScoreException - on error

actualBeatsForBar

public TimeSig actualBeatsForBar(int barIndex)
                          throws ScoreException

get the actual number of beats in the bar and the beat type This is normally the same as timeSigForBar, but will have fewer beats for a partial bar (eg anacrusis)

Parameters:

barIndex - the index of the bar. 0 is the first bar

Returns:

the effective TimeSig

Throws:

ScoreException - on error

metronomeForBar

public Tempo metronomeForBar(int barIndex)
                      throws ScoreException

get information about any metronome defined in the bar

Parameters:

barIndex - the index of the bar. 0 is the first bar

Returns:

metronome information

Throws:

ScoreException - on error

tempoAtBar

public Tempo tempoAtBar(int barIndex)
                 throws ScoreException

get the effective tempo at the bar accounting for any sound tempo elements and metronome elements

Parameters:

barIndex - the index of the bar (0 is 1st)

Returns:

the effective Tempo

Throws:

ScoreException - on error

tempoAtStart

public Tempo tempoAtStart()
                   throws ScoreException

get the effective tempo at start of the score accounting for any sound tempo elements and metronome elements

Returns:

the effective Tempo

Throws:

ScoreException - on error

convertTempoToBPM

public int convertTempoToBPM(Tempo tempo,
                    TimeSig timesig)

get a beats-per-minute value for a given Tempo and TimeSig

Parameters:

tempo - the score-defined or user-defined tempo

timesig - the effective time signature

Returns:

beats per minute

getBarBeats

public BarBeats getBarBeats(int barIndex,
                   int bpm,
                   int bartype)
                     throws ScoreException

get the number of beats in a bar and the beat timing

Parameters:

barIndex - the index of the bar (0 is 1st)

bpm - the effective beats-per-minute value

bartype - one of Bartype_?

Returns:

beat number and timing

Throws:

ScoreException

hasDefinedTempo

public boolean hasDefinedTempo()

does the score define any tempo at the start with metronome or sound tempo elements?

Returns:

true if the score defines tempo. Use this to determine whether the user defines the absolute tempo or the tempo scaling

iterator

public BarIterator iterator()

get an iterator to the set of bars in the score. The iterator will start at the first bar (ie count-in bars before start) and sequence through all bars in playing order accounting for repeats, DC.DS etc

Specified by:

iterator in interface java.lang.Iterable<BarIterator.Bar>

Returns:

the iterator

numParts

public int numParts()

get the number of playing parts in the score

Returns:

the number of playing parts

maxSoundDynamic

public float maxSoundDynamic()

get the maximum value of any sound dynamic in any bar. This allows note dynamic values to be scaled accordingly

Returns:

the maximum dynamic

firstBarAnacrusis

public boolean firstBarAnacrusis()

is the first bar an 'up-beat' or anacrusis partial bar?

Returns:

true if the first bar is missing the first beat (anacrusis)

updateTempo

public void updateTempo()

call this on changing the user tempo to tell the interface to re-read the UserTempo and update the note timings returned

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object