org.midica.midi

Class SequenceAnalyzer

java.lang.Object

org.midica.midi.SequenceAnalyzer

public class SequenceAnalyzer
extends java.lang.Object

This class analyzes a MIDI sequence and collects information from it. This information can be displayed later by the InfoView

It also adds marker events to the sequence at each tick where the channel activity changes for at least one channel.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Integer>>	activityByChannel channel – tick – number of keys pressed at this time
private static MidicaTreeModel	banksAndInstrPerChannel
private static MidicaTreeModel	banksAndInstrTotal
private static java.util.TreeMap<java.lang.Byte,java.lang.Byte[]>	channelParamConfig Describes which parameter (RPN/NRPN and MSB/LSB) will be changed in case of a data entry / data increment / data decrement.
private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Byte[]>>	channelParamHistory History of channelParamConfig by tick.
private static java.lang.String	chosenCharset
private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.String>>	commentHistory channel – tick – comment
private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Byte>>>	controllerHistory channel – controller – tick – value
private static long	DEFAULT_CHANNEL_CONFIG_TICK
private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Byte[]>>	instrumentHistory History of the instrument configuration for each channel.
private static java.util.TreeMap<java.lang.Long,java.util.TreeSet<java.lang.Byte>>	markers tick – channel
private static java.util.TreeSet<java.lang.Long>	markerTicks tick
private static java.util.ArrayList<SingleMessage>	messages
private static java.util.HashMap<javax.sound.midi.MidiMessage,SingleMessage>	midiMsgToSingleMsg translates a MIDI message to the derived SingleMessage
private static MidicaTreeModel	msgTreeModel
static byte	NOTE_HISTORY_BUFFER_SIZE_FUTURE
static byte	NOTE_HISTORY_BUFFER_SIZE_PAST
private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Byte,java.lang.Byte>>>	noteHistory channel – tick – note – velocity
private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Boolean>>>	noteOnOffByChannel channel – note – tick – on/off
private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Integer,java.util.TreeMap<java.lang.Long,java.lang.Integer>>>	rpnHistory RPN history by tick.
private static javax.sound.midi.Sequence	sequence
private static java.util.HashMap<java.lang.String,java.lang.Object>	sequenceInfo

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
private static void	addNoteOff(long tick, byte channel, byte note) Adds a detected note-off event to the data structures.
private static void	addNoteOn(long tick, byte channel, byte note, byte velocity) Adds a detected note-on event to the data structures.
static void	analyze(javax.sound.midi.Sequence seq, java.lang.String charset) Analyzes the given MIDI sequence and collects information about it.
static boolean	getChannelActivity(byte channel, long tick) Calculates the channel activity for the given channel at the given tick.
static java.lang.String	getChannelComment(byte channel, long tick) Returns the channel comment for the given channel at the given tick.
static java.lang.Byte[]	getChannelParamMsbLsbType(byte channel, long tick) Calculates and returns RPN/NRPN info for the given channel at the given tick.
static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.String>>	getCommentHistory() Returns the channel comment history.
private static byte	getControllerDefault(int ctrl) Returns the default value for the given controller number.
static java.lang.Byte[]	getInstrument(byte channel, long tick) Calculates and returns bank and instrument information for the given channel at the given tick.
static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Byte[]>>	getInstrumentHistory() Returns the instrument history.
static java.util.ArrayList<SingleMessage>	getMessages() Returns a list of all MIDI messages.
static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Byte,java.lang.Byte>>>	getNoteHistory() Returns the note history.
static java.util.ArrayList<java.lang.Long[]>	getNoteHistory(byte channel, long tick) Calculates the note history for the given channel at the given tick.
static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Boolean>>>	getOnOffHistory() Returns the note-ON/note-OFF history.
static float	getPitchBendSensitivity(byte channel, long tick) Returns the pitch bend sensitivity for the given channel at the given tick.
private static byte[]	getRpnDefault(int msb, int lsb) Returns the default value for the given RPN.
static java.util.HashMap<java.lang.String,java.lang.Object>	getSequenceInfo() Returns the information that have been collected while analyzing the MIDI sequence.
static SingleMessage	getSingleMsgByMidiMsg(javax.sound.midi.MidiMessage msg) Searches for the single message in the message list that has been derived by the given MIDI message.
private static void	init() Initializes the internal data structures so that they are ready to be filled with sequence information during the parsing process.
private static void	parse() Parses the MIDI sequence track by track and event by event and collects information.
private static void	postprocess() Adds last information to the info data structure about the MIDI sequence.
private static void	processMetaMessage(javax.sound.midi.MetaMessage msg, long tick, int trackNum, int msgNum) Retrieves general information from meta messages.
private static void	processMetaMessageByChannel(javax.sound.midi.MetaMessage msg, long tick, int trackNum) Retrieves instrument specific information from meta messages.
private static void	processShortMessageByChannel(javax.sound.midi.ShortMessage msg, long tick) Retrieves some channel-specific information from short messages that can affect following messages.
static void	reset() Resets all information that can be queried in public getter methods.
private static void	resetAllControllers(byte channel, long tick) Resets all controllers of the given channel to their default values.
private static void	resetAllRPNs(byte channel, long tick) Resets all known RPNs to their default values.
static void	retrieveSoftwareVersion(java.lang.String text) Analyzes the software version string from the MIDI sequence.

Methods inherited from class java.lang.Object

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

Field Detail

NOTE_HISTORY_BUFFER_SIZE_PAST

public static final byte NOTE_HISTORY_BUFFER_SIZE_PAST

See Also:

Constant Field Values

NOTE_HISTORY_BUFFER_SIZE_FUTURE

public static final byte NOTE_HISTORY_BUFFER_SIZE_FUTURE

See Also:

Constant Field Values

DEFAULT_CHANNEL_CONFIG_TICK

private static final long DEFAULT_CHANNEL_CONFIG_TICK

See Also:

Constant Field Values

sequence

private static javax.sound.midi.Sequence sequence

chosenCharset

private static java.lang.String chosenCharset

sequenceInfo

private static java.util.HashMap<java.lang.String,java.lang.Object> sequenceInfo

banksAndInstrPerChannel

private static MidicaTreeModel banksAndInstrPerChannel

banksAndInstrTotal

private static MidicaTreeModel banksAndInstrTotal

msgTreeModel

private static MidicaTreeModel msgTreeModel

messages

private static java.util.ArrayList<SingleMessage> messages

noteOnOffByChannel

private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Boolean>>> noteOnOffByChannel

channel – note – tick – on/off

noteHistory

private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Byte,java.lang.Byte>>> noteHistory

channel – tick – note – velocity

activityByChannel

private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Integer>> activityByChannel

channel – tick – number of keys pressed at this time

markers

private static java.util.TreeMap<java.lang.Long,java.util.TreeSet<java.lang.Byte>> markers

tick – channel

markerTicks

private static java.util.TreeSet<java.lang.Long> markerTicks

tick

midiMsgToSingleMsg

private static java.util.HashMap<javax.sound.midi.MidiMessage,SingleMessage> midiMsgToSingleMsg

translates a MIDI message to the derived SingleMessage

instrumentHistory

private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Byte[]>> instrumentHistory

History of the instrument configuration for each channel.

• channel
• tick
• index:
  • 0: bankMSB
  • 1: bankLSB
  • 2: program number

commentHistory

private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.String>> commentHistory

channel – tick – comment

channelParamConfig

private static java.util.TreeMap<java.lang.Byte,java.lang.Byte[]> channelParamConfig

Describes which parameter (RPN/NRPN and MSB/LSB) will be changed in case of a data entry / data increment / data decrement.

• channel
• index
  • 0: RPN MSB
  • 1: RPN LSB
  • 2: NRPN MSB
  • 3: NRPN LSB
  • 4: 1=RPN, 0=NRPN, -1=unknown

channelParamHistory

private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Byte[]>> channelParamHistory

History of channelParamConfig by tick.

• channel
• tick
• index
  • 0: RPN MSB
  • 1: RPN LSB
  • 2: NRPN MSB
  • 3: NRPN LSB
  • 4: 1=RPN, 0=NRPN, -1=unknown

controllerHistory

private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Byte>>> controllerHistory

channel – controller – tick – value

rpnHistory

private static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Integer,java.util.TreeMap<java.lang.Long,java.lang.Integer>>> rpnHistory

RPN history by tick.

• channel
• RPN: (MSB*128+LSB)
• tick
• value: (MSB*128+LSB)

Constructor Detail

SequenceAnalyzer

private SequenceAnalyzer()

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

Method Detail

reset

public static void reset()

Resets all information that can be queried in public getter methods. This is called before a MIDI or MidicaPL file is parsed so that the getters don’t return the information of a former parsing after a later parsing failed.

analyze

public static void analyze(javax.sound.midi.Sequence seq,
                           java.lang.String charset)
                    throws ParseException

Analyzes the given MIDI sequence and collects information about it. Adds marker events for channel activity changes.

Parameters:

seq - The MIDI sequence to be analyzed.

charset - The charset that has been chosen in the file chooser.

Throws:

ParseException - if something went wrong.

getMessages

public static java.util.ArrayList<SingleMessage> getMessages()

Returns a list of all MIDI messages.

Returns:

MIDI messages

getSingleMsgByMidiMsg

public static SingleMessage getSingleMsgByMidiMsg(javax.sound.midi.MidiMessage msg)

Searches for the single message in the message list that has been derived by the given MIDI message. Returns the message from the list, if found.

Used by the decompiler to create warnings due to ignored messages.

Parameters:

msg - MIDI message

Returns:

the retrieved message, or null if no message could be retrieved.

getSequenceInfo

public static java.util.HashMap<java.lang.String,java.lang.Object> getSequenceInfo()

Returns the information that have been collected while analyzing the MIDI sequence.

If no MIDI sequence has been loaded: returns an empty data structure.

Returns:

MIDI sequence info.

getInstrumentHistory

public static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Byte[]>> getInstrumentHistory()

Returns the instrument history.

Structure:

• channel
• tick
• 0=bankMSB, 1=bankLSB, 3=program

Returns:

the instrument history, or null if no MIDI sequence has been loaded.

getCommentHistory

public static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.String>> getCommentHistory()

Returns the channel comment history.

Structure:

• channel
• tick
• comment

Returns:

the channel comment history, or null if no MIDI sequence has been loaded.

getNoteHistory

public static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.util.TreeMap<java.lang.Byte,java.lang.Byte>>> getNoteHistory()

Returns the note history.

Structure:

• channel
• tick
• note
• velocity

Returns:

the note history, or null if no MIDI sequence has been loaded.

getOnOffHistory

public static java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Byte,java.util.TreeMap<java.lang.Long,java.lang.Boolean>>> getOnOffHistory()

Returns the note-ON/note-OFF history.

Structure:

• channel
• note
• tick
• on/off

Returns:

the on/off history, or null if no MIDI sequence has been loaded.

init

private static void init()
                  throws java.lang.ReflectiveOperationException

Initializes the internal data structures so that they are ready to be filled with sequence information during the parsing process.

Throws:

java.lang.ReflectiveOperationException - if the root node of the message tree cannot be created.

parse

private static void parse()
                   throws java.lang.ReflectiveOperationException

Parses the MIDI sequence track by track and event by event and collects information.

Throws:

java.lang.ReflectiveOperationException - if a tree node cannot be created.

processShortMessageByChannel

private static void processShortMessageByChannel(javax.sound.midi.ShortMessage msg,
                                                 long tick)
                                          throws java.lang.ReflectiveOperationException

Retrieves some channel-specific information from short messages that can affect following messages.

The regarded messages are:

• Bank Select
• Program Change
• Note On/Off
• RPN
• NRPN

Stores these information in order to lookup their values later, when other (affected) messages are found.

Fills the trees for the info view tab “Banks, Instruments, Notes”.

Does not fill the tree in the tab “MIDI Messages”.

Parameters:

msg - Short message

tick - Tickstamp

Throws:

java.lang.ReflectiveOperationException - if the note-on event cannot be added to one of the tree models.

processMetaMessage

private static void processMetaMessage(javax.sound.midi.MetaMessage msg,
                                       long tick,
                                       int trackNum,
                                       int msgNum)
                                throws java.lang.ReflectiveOperationException

Retrieves general information from meta messages.

Parameters:

msg - Meta message

tick - Tickstamp

trackNum - Track number (beginning with 0).

msgNum - Number of the message inside the track.

Throws:

java.lang.ReflectiveOperationException - if the message cannot be added to the tree model.

processMetaMessageByChannel

private static void processMetaMessageByChannel(javax.sound.midi.MetaMessage msg,
                                                long tick,
                                                int trackNum)

Retrieves instrument specific information from meta messages.

Parameters:

msg - Meta message.

tick - Tickstamp.

trackNum - Track number of the created string.

addNoteOn

private static void addNoteOn(long tick,
                              byte channel,
                              byte note,
                              byte velocity)
                       throws java.lang.ReflectiveOperationException

Adds a detected note-on event to the data structures.

• tracks note events for the note history
• tracks the channel activity
• prepares markers
• builds up the tree model for the bank/instrument/note trees

Parameters:

tick - The tickstamp when this event occurred.

channel - The MIDI channel number.

note - The note number.

velocity - The note’s velocity.

Throws:

java.lang.ReflectiveOperationException - if the note cannot be added to one of the tree models.

addNoteOff

private static void addNoteOff(long tick,
                               byte channel,
                               byte note)

Adds a detected note-off event to the data structures.

• tracks note events for the note history
• tracks the channel activity
• prepares markers

Parameters:

tick - The tickstamp when this event occurred.

channel - The MIDI channel number.

note - The note number.

postprocess

private static void postprocess()
                         throws ParseException

Adds last information to the info data structure about the MIDI sequence. Adds marker events to the sequence.

Throws:

ParseException - if the marker events cannot be added to the MIDI sequence.

getChannelActivity

public static boolean getChannelActivity(byte channel,
                                         long tick)

Calculates the channel activity for the given channel at the given tick.

Parameters:

channel - MIDI channel

tick - tickstamp of the sequence

Returns:

the channel activity

getNoteHistory

public static java.util.ArrayList<java.lang.Long[]> getNoteHistory(byte channel,
                                                                   long tick)

Calculates the note history for the given channel at the given tick.

The returned history consists of past and future notes, ordered by the tickstamp of their occurrence. Each entry contains the following parts:

• index 0: note number
• index 1: velocity
• index 2: tickstamp
• index 3: past/future marker (**0** = presence or past, 1 = future)

Parameters:

channel - MIDI channel

tick - tickstamp of the sequence

Returns:

the note history

getInstrument

public static java.lang.Byte[] getInstrument(byte channel,
                                             long tick)

Calculates and returns bank and instrument information for the given channel at the given tick.

The returned value consists of 3 bytes with the following meaning:

• 1st byte: bank MSB
• 2nd byte: bank LSB
• 3rd byte: program number

Parameters:

channel - MIDI channel

tick - tickstamp of the sequence

Returns:

instrument description as described above

getChannelComment

public static java.lang.String getChannelComment(byte channel,
                                                 long tick)

Returns the channel comment for the given channel at the given tick.

Parameters:

channel - MIDI channel

tick - tickstamp of the sequence

Returns:

channel comment

getChannelParamMsbLsbType

public static java.lang.Byte[] getChannelParamMsbLsbType(byte channel,
                                                         long tick)

Calculates and returns RPN/NRPN info for the given channel at the given tick. Called from MessageClassifier while processing a data entry/increment/decrement message.

The returned value consists of 3 bytes with the following meaning:

• 1st byte: (N)RPN MSB
• 2nd byte: (N)RPN LSB
• 3rd byte: type (0=NRPN, 1=RPN, -1=none)

Parameters:

channel - MIDI channel

tick - tickstamp of the sequence

Returns:

MSB/LSB/type as described above

getPitchBendSensitivity

public static final float getPitchBendSensitivity(byte channel,
                                                  long tick)

Returns the pitch bend sensitivity for the given channel at the given tick.

Parameters:

channel - MIDI channel

tick - tickstamp of the sequence

Returns:

pitch bend sensitivity

retrieveSoftwareVersion

public static void retrieveSoftwareVersion(java.lang.String text)

Analyzes the software version string from the MIDI sequence. Called from the KaraokeAnalyzer.

Parameters:

text - software version string.

resetAllControllers

private static final void resetAllControllers(byte channel,
                                              long tick)

Resets all controllers of the given channel to their default values.

Parameters:

channel - MIDI channel

tick - tickstamp of the sequence

getControllerDefault

private static final byte getControllerDefault(int ctrl)

Returns the default value for the given controller number.

Parameters:

ctrl - Controller number

Returns:

default value.

resetAllRPNs

private static final void resetAllRPNs(byte channel,
                                       long tick)

Resets all known RPNs to their default values.

Parameters:

channel - MIDI channel

tick - tickstamp of the sequence

getRpnDefault

private static final byte[] getRpnDefault(int msb,
                                          int lsb)

Returns the default value for the given RPN.

Parameters:

msb - RPN MSB

lsb - RPN LSB

Returns:

default MSB (index 0) and default LSB (index 1)