uk.co.dolphin_com.sscore.playdata

Class PlayData

java.lang.Object

uk.co.dolphin_com.sscore.playdata.PlayData

All Implemented Interfaces:

java.lang.Iterable<Bar>

public class PlayData
extends java.lang.Object
implements java.lang.Iterable<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 Bar 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PlayData.PlayControls

Field Summary

Fields

Modifier and Type	Field and Description
int	numBars the number of bars in the score;

Constructor Summary

Constructors

Constructor and Description
PlayData(SScore score, UserTempo userTempo) construct PlayData
PlayData(SScore score, UserTempo userTempo, int loopStart, int loopBack, int numRepeats) construct PlayData

Method Summary

Modifier and Type	Method and Description
boolean	createMIDIFile(java.lang.String midiFilePath) generate a MIDI file from the play data
boolean	createMIDIFileWithControls(java.lang.String midiFilePath, PlayData.PlayControls controls) generate a MIDI file from the play data with control of enabled parts
protected void	finalize()
boolean	firstBarAnacrusis() is the first bar an 'up-beat' or anacrusis partial bar?
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.
int	numParts() get the number of playing parts in the score
static void	scaleMIDIFileTempo(java.lang.String midiFilePath, float tempoScaling) scale the tempo in the MIDI file by writing tempo-defining bytes into it NB This assumes that the file was written by createMIDIFile and by the same version of the SeeScoreLib

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

numBars

public final int numBars

the number of bars in the score;

Constructor Detail

PlayData

public PlayData(SScore score,
                UserTempo userTempo)
         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

Throws:

ScoreException - on error

PlayData

public PlayData(SScore score,
                UserTempo userTempo,
                int loopStart,
                int loopBack,
                int numRepeats)
         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

loopStart - the index of the first bar to play in each loop

loopBack - the index of the last bar to play in each loop

numRepeats - the number of times to repeat the loop

Throws:

ScoreException - on error

Method Detail

iterator

public BarIterator iterator()

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

Specified by:

iterator in interface java.lang.Iterable<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)

createMIDIFile

public boolean createMIDIFile(java.lang.String midiFilePath)

generate a MIDI file from the play data

Parameters:

midiFilePath - the full pathname of the MIDI file to create

Returns:

false if failed

createMIDIFileWithControls

public boolean createMIDIFileWithControls(java.lang.String midiFilePath,
                                          PlayData.PlayControls controls)

generate a MIDI file from the play data with control of enabled parts

Parameters:

midiFilePath - the full pathname of the MIDI file to create

controls - define which parts should be output to the file

Returns:

false if failed

scaleMIDIFileTempo

public static void scaleMIDIFileTempo(java.lang.String midiFilePath,
                                      float tempoScaling)

scale the tempo in the MIDI file by writing tempo-defining bytes into it NB This assumes that the file was written by createMIDIFile and by the same version of the SeeScoreLib

Parameters:

midiFilePath - the full pathname of the MIDI file

tempoScaling - the scaling (1.0 is unscaled)

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object