org.midica.midi

Class SequenceCreator

java.lang.Object

org.midica.midi.SequenceCreator

public class SequenceCreator
extends java.lang.Object

This class is used to create a MIDI sequence. It is used by one of the parser methods while parsing a MidicaPL or MIDI file.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	charset
static int	DEFAULT_RESOLUTION
static int	IMPORT_FORMAT_ABC
static int	IMPORT_FORMAT_ALDA
static int	IMPORT_FORMAT_LY
static int	IMPORT_FORMAT_MIDI
static int	IMPORT_FORMAT_MIDICAPL
static int	IMPORT_FORMAT_MUSESCORE
static int	IMPORT_FORMAT_NONE
private static int	importFormat
private static boolean	isSuccess
private static java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,javax.sound.midi.MidiEvent>>	lastNoteOffEvent channel – note – event
static long	NOW
static int	NUM_META_TRACKS
static int	NUM_TRACKS
private static int	resolution
private static javax.sound.midi.Sequence	seq
private static javax.sound.midi.Track[]	tracks

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SequenceCreator() This class is only used statically so a public constructor is not needed.

Method Summary

Modifier and Type	Method and Description
static void	addMarkers(java.util.TreeMap<java.lang.Long,java.util.TreeSet<java.lang.Byte>> markers) Adds meta events of the type marker to the sequence.
static void	addMessageCopyright(java.lang.String copyright) Adds a copyright meta message to tick 0 of the sequence.
static void	addMessageGeneric(javax.sound.midi.MidiMessage msg, int channel, long tick) Adds a channel-dependent generic message.
static void	addMessageGeneric(javax.sound.midi.MidiMessage msg, long tick) Adds a channel-independent generic message.
static void	addMessageKeySignature(int note, boolean isMajor, long tick, boolean preferFlat) Sets the key signature using a meta message.
static void	addMessageKeystroke(int channel, int note, long startTick, long endTick, int velocity) Adds the note-ON and note-OFF messages for one note to be played.
static void	addMessageLyrics(java.lang.String lyrics, long tick, boolean isRp26) Adds a lyrics meta message.
static void	addMessageNoteOFF(int channel, int note, long tick) Adds a note-OFF event.
static void	addMessageNoteON(int channel, int note, long tick, int velocity) Adds a note-ON event.
static void	addMessageTempo(int bpm, long tick) Sets the tempo in beats per minute by creating a tempo change message.
static void	addMessageText(java.lang.String text, long tick, int skType) Adds a text meta message.
static void	addMessageTimeSignature(int numerator, int denominator, long tick) Sets the time signature using a meta message.
static void	addMessageToTrack(javax.sound.midi.MidiMessage msg, int track, long tick) Adds a MIDI message to the given track.
static java.lang.String	getCharset() Returns the chosen (or assumed) charset of the last successfully parsed sequence.
static int	getImportFormat() Returns the import format of the last attempted import.
static int	getResolution() Returns the resolution of the MIDI sequence in ticks per quarter note.
static javax.sound.midi.Sequence	getSequence() Returns the created MIDI sequence from the last import attempt, if any.
static void	initChannel(int channel, int instrNum, java.lang.String comment, long tick) Initiates or changes the given channel’s instrument, bank and channel comment.
static void	moveNoteOffMessage(int channel, int note, long fromTick, long toTick) Moves the last note-off event matching the given parameters to a new position.
static void	postprocess() Remembers that this parsing attempt was successful.
static void	reset(int res, java.lang.String chosenCharset, int importFormat) Creates a new sequence and sets it’s resolution to the given value.
static void	reset(java.lang.String chosenCharset) Creates a new sequence and sets it’s resolution to the default value.
static void	setBank(int channel, long tick, int value, boolean isLSB) Sets the bank MSB or LSB by sending an according control change message.

Methods inherited from class java.lang.Object

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

Field Detail

NOW

public static final long NOW

See Also:

Constant Field Values

DEFAULT_RESOLUTION

public static final int DEFAULT_RESOLUTION

See Also:

Constant Field Values

NUM_META_TRACKS

public static final int NUM_META_TRACKS

See Also:

Constant Field Values

NUM_TRACKS

public static final int NUM_TRACKS

See Also:

Constant Field Values

IMPORT_FORMAT_NONE

public static final int IMPORT_FORMAT_NONE

See Also:

Constant Field Values

IMPORT_FORMAT_MIDICAPL

public static final int IMPORT_FORMAT_MIDICAPL

See Also:

Constant Field Values

IMPORT_FORMAT_MIDI

public static final int IMPORT_FORMAT_MIDI

See Also:

Constant Field Values

IMPORT_FORMAT_ALDA

public static final int IMPORT_FORMAT_ALDA

See Also:

Constant Field Values

IMPORT_FORMAT_ABC

public static final int IMPORT_FORMAT_ABC

See Also:

Constant Field Values

IMPORT_FORMAT_LY

public static final int IMPORT_FORMAT_LY

See Also:

Constant Field Values

IMPORT_FORMAT_MUSESCORE

public static final int IMPORT_FORMAT_MUSESCORE

See Also:

Constant Field Values

isSuccess

private static boolean isSuccess

importFormat

private static int importFormat

resolution

private static int resolution

charset

private static java.lang.String charset

tracks

private static javax.sound.midi.Track[] tracks

seq

private static javax.sound.midi.Sequence seq

lastNoteOffEvent

private static java.util.HashMap<java.lang.Integer,java.util.HashMap<java.lang.Integer,javax.sound.midi.MidiEvent>> lastNoteOffEvent

channel – note – event

Constructor Detail

SequenceCreator

private SequenceCreator()

This class is only used statically so a public constructor is not needed.

Method Detail

reset

public static void reset(java.lang.String chosenCharset)
                  throws javax.sound.midi.InvalidMidiDataException

Creates a new sequence and sets it’s resolution to the default value. Initiates all necessary data structures.

Only called by MidicaPLParser.

Parameters:

chosenCharset - Charset to be used for text-based messages.

Throws:

javax.sound.midi.InvalidMidiDataException - if Sequence.PPQ is not a valid division type. This should never happen.

reset

public static void reset(int res,
                         java.lang.String chosenCharset,
                         int importFormat)
                  throws javax.sound.midi.InvalidMidiDataException

Creates a new sequence and sets it’s resolution to the given value. Initiates all necessary data structures. This method is called by the MidiParser.

Parameters:

res - Resolution of the new sequence.

chosenCharset - Charset to be used for text-based messages.

importFormat - File type of the import file.

Throws:

javax.sound.midi.InvalidMidiDataException - if Sequence.PPQ is not a valid division type. This should never happen.

postprocess

public static void postprocess()

Remembers that this parsing attempt was successful.

getSequence

public static javax.sound.midi.Sequence getSequence()

Returns the created MIDI sequence from the last import attempt, if any.

Returns:

MIDI sequence or null.

getImportFormat

public static int getImportFormat()

Returns the import format of the last attempted import.

The import format is one of the IMPORT_FILE_* constants. If the last import attempt failed, IMPORT_FORMAT_NONE is returned.

Returns:

the import format, as described above.

getCharset

public static java.lang.String getCharset()

Returns the chosen (or assumed) charset of the last successfully parsed sequence.

Returns null if the last import attempt failed.

Returns:

the charset.

setBank

public static void setBank(int channel,
                           long tick,
                           int value,
                           boolean isLSB)
                    throws javax.sound.midi.InvalidMidiDataException

Sets the bank MSB or LSB by sending an according control change message.

Parameters:

channel - Channel number from 0 to 15.

tick - Tickstamp of the bank select or -1 if the method is called during initialization. TODO: test, how much the tick must be BEFORE the program change

value - The value to set.

isLSB - false: set the MSB; true: set the LSB

Throws:

javax.sound.midi.InvalidMidiDataException

initChannel

public static void initChannel(int channel,
                               int instrNum,
                               java.lang.String comment,
                               long tick)
                        throws javax.sound.midi.InvalidMidiDataException

Initiates or changes the given channel’s instrument, bank and channel comment.

The following steps are performed:

• adding a meta message (INSTRUMENT NAME) containing the channel number and the channel comment
• adding a program change message

Parameters:

channel - Channel number from 0 to 15.

instrNum - Instrument number - corresponds to the MIDI program number.

comment - Comment to be used as the track name.

tick - Tickstamp of the instrument change or 0 if the method is called during initialization.

Throws:

javax.sound.midi.InvalidMidiDataException - if invalid MIDI data is used to create a MIDI message.

addMessageKeystroke

public static void addMessageKeystroke(int channel,
                                       int note,
                                       long startTick,
                                       long endTick,
                                       int velocity)
                                throws javax.sound.midi.InvalidMidiDataException

Adds the note-ON and note-OFF messages for one note to be played.

Parameters:

channel - Channel number from 0 to 15.

note - Note number.

startTick - Tickstamp of the note-ON event.

endTick - Tickstamp of the note-OFF event.

velocity - Velocity of the key stroke.

Throws:

javax.sound.midi.InvalidMidiDataException - if invalid MIDI data is used to create a MIDI message.

addMessageNoteON

public static void addMessageNoteON(int channel,
                                    int note,
                                    long tick,
                                    int velocity)
                             throws javax.sound.midi.InvalidMidiDataException

Adds a note-ON event.

Parameters:

channel - Channel number from 0 to 15.

note - Note number.

tick - Tickstamp of the event.

velocity - Velocity of the key stroke.

Throws:

javax.sound.midi.InvalidMidiDataException - if invalid MIDI data is used to create a MIDI message.

addMessageNoteOFF

public static void addMessageNoteOFF(int channel,
                                     int note,
                                     long tick)
                              throws javax.sound.midi.InvalidMidiDataException

Adds a note-OFF event.

Parameters:

channel - Channel number from 0 to 15.

note - Note number.

tick - Tickstamp of the event.

Throws:

javax.sound.midi.InvalidMidiDataException - if invalid MIDI data is used to create a MIDI message.

moveNoteOffMessage

public static void moveNoteOffMessage(int channel,
                                      int note,
                                      long fromTick,
                                      long toTick)
                               throws java.lang.Exception

Moves the last note-off event matching the given parameters to a new position. This is needed to correct legato-overlappings, otherwise resulting in a sequence like this:

note-on

note-on

note-off

note-off

This can happen if a note is played twice in a row in the same channel, with a legato value of more than 100%.

Parameters:

channel - Channel number from 0 to 15.

note - Note number.

fromTick - Tick from where the event shall be moved away.

toTick - Tick where the event shall be moved to.

Throws:

java.lang.Exception - if the event to be moved was not found or has a different tick than expected.

addMessageTempo

public static void addMessageTempo(int bpm,
                                   long tick)
                            throws javax.sound.midi.InvalidMidiDataException

Sets the tempo in beats per minute by creating a tempo change message.

Parameters:

bpm - Tempo in beats per minute.

tick - Tickstamp of the tempo change event.

Throws:

javax.sound.midi.InvalidMidiDataException - if invalid MIDI data is used to create a MIDI message.

addMessageTimeSignature

public static void addMessageTimeSignature(int numerator,
                                           int denominator,
                                           long tick)
                                    throws javax.sound.midi.InvalidMidiDataException

Sets the time signature using a meta message.

Parameters:

numerator - Numerator of the time signature

denominator - Denominator of the time signature

tick - Tickstamp of the time signature event

Throws:

javax.sound.midi.InvalidMidiDataException - if invalid MIDI data is used to create a MIDI message.

addMessageKeySignature

public static void addMessageKeySignature(int note,
                                          boolean isMajor,
                                          long tick,
                                          boolean preferFlat)
                                   throws javax.sound.midi.InvalidMidiDataException

Sets the key signature using a meta message.

Parameters:

note - any note number from 0 to 127

isMajor - true for a major key signature, false for a minor one

tick - Tickstamp of the time signature event

preferFlat - true use flat symbols, if both is possible; false: use sharp

Throws:

javax.sound.midi.InvalidMidiDataException - if invalid MIDI data is used to create a MIDI message.

addMessageCopyright

public static void addMessageCopyright(java.lang.String copyright)
                                throws javax.sound.midi.InvalidMidiDataException

Adds a copyright meta message to tick 0 of the sequence. This is called from the MidicaPLParser when postprocessing meta commands.

Parameters:

copyright - The message to be added to the sequence.

Throws:

javax.sound.midi.InvalidMidiDataException - if invalid MIDI data is used to create a MIDI message.

addMessageLyrics

public static void addMessageLyrics(java.lang.String lyrics,
                                    long tick,
                                    boolean isRp26)
                             throws javax.sound.midi.InvalidMidiDataException

Adds a lyrics meta message. The message may also be a meta message according to RP-026.

Parameters:

lyrics - The message to be added.

tick - The tick where the lyrics event shall be added.

isRp26 - true in case of a RP-026 message, otherwis: false

Throws:

javax.sound.midi.InvalidMidiDataException - if invalid MIDI data is used to create a MIDI message.

addMessageText

public static void addMessageText(java.lang.String text,
                                  long tick,
                                  int skType)
                           throws javax.sound.midi.InvalidMidiDataException

Adds a text meta message.

The skType parameter can have the following values:

• 0: not a Soft Karaoke text event
• 1: used for Soft Karaoke events starting with @K, @V or @I
• 2: used for Soft Karaoke events starting with @L, @T or normal lyrics

Parameters:

text - The text to be added.

tick - MIDI tick.

skType - Soft Karaoke text type: 0, 1 or 2 - as described above.

Throws:

javax.sound.midi.InvalidMidiDataException

addMessageGeneric

public static void addMessageGeneric(javax.sound.midi.MidiMessage msg,
                                     int channel,
                                     long tick)

Adds a channel-dependent generic message. This is called by the MidiParser to add messages that are not handled by another method.

Parameters:

msg - Generic MIDI message.

channel - Channel number from 0 to 15.

tick - Tickstamp of the event.

addMessageGeneric

public static void addMessageGeneric(javax.sound.midi.MidiMessage msg,
                                     long tick)

Adds a channel-independent generic message. This is called by the MidiParser to add messages that are not handled by another method.

Those messages are added to track 0.

Parameters:

msg - Generic MIDI message.

tick - Tickstamp of the event.

addMessageToTrack

public static void addMessageToTrack(javax.sound.midi.MidiMessage msg,
                                     int track,
                                     long tick)

Adds a MIDI message to the given track.

This is needed for karaoke-related meta messages from foreign MIDI files. These messages must be put into the right track. That makes sure that they are later processed in the right order. (Sorted by tick, not by original track number).

Parameters:

msg - Meta message.

track - Track number.

tick - Tickstamp of the event.

getResolution

public static int getResolution()

Returns the resolution of the MIDI sequence in ticks per quarter note.

Returns:

Resolution in ticks per quarter note.

addMarkers

public static void addMarkers(java.util.TreeMap<java.lang.Long,java.util.TreeSet<java.lang.Byte>> markers)
                       throws javax.sound.midi.InvalidMidiDataException

Adds meta events of the type marker to the sequence. These events show that the activity state of some channels change at this point.

This is called by the SequenceAnalyzer after all other analyzing is done.

The markers are always added to track 0.

Parameters:

markers - First dimension: tick; Second dimension: bitmasked channels that change their activity (and/or other properties) at this tick.

Throws:

javax.sound.midi.InvalidMidiDataException - if one of the marker messages cannot be created.