org.midica.midi

Class MessageClassifier

java.lang.Object

org.midica.midi.MessageClassifier

public class MessageClassifier
extends java.lang.Object

This class is used to classify a message.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private static int	INVALID_BYTE
private static java.lang.String	MSG_LVL_1_SORT_CH_MODE
private static java.lang.String	MSG_LVL_1_SORT_CH_VOICE
private static java.lang.String	MSG_LVL_1_SORT_META
private static java.lang.String	MSG_LVL_1_SORT_SYS_COM
private static java.lang.String	MSG_LVL_1_SORT_SYS_RT

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MessageClassifier() Private constructor because this class is only used statically.

Method Summary

Modifier and Type	Method and Description
static java.lang.String[]	getDescription(IMessageType message) Returns a long and short description for the given message or message category.
static java.lang.String[]	getKeySignature(byte sharpsOrFlats, byte tonality) Returns the note and tonality of a KEY_SIGNATURE message like it’s used in MidicaPL format.
private static java.lang.String	getLvl2MetaText(int type) Returns the level 2 message name of META messages.
private static java.lang.String	getLvl2ModeMsgTxtByData1(int val) Returns the level 2 command of a channel mode message.
private static java.lang.String	getLvl2SystemMsgTxtByStatusByte(int status) Returns the level 2 message name of system common and system realtime messages by status byte.
private static java.lang.String	getLvl2VoiceMsgTxtByCommand(int cmd) Returns the level 2 message name of channel voice messages by message command.
private static java.lang.String[]	getLvl34ControllerMsgTxtByData1(int val) Returns the level 3 and 4 node names of control change messages.
private static java.lang.String[]	getLvl456UniversalSysexTxt(boolean isRealTime, int sub1, int sub2) Returns the level 4, 5, and 6 node names of universal SysEx messages.
private static java.lang.String[]	getLvl4RpnNrpnDataTxt(byte msb, byte lsb, byte type) Returns the level 4 message fields for the tree node of Data entry/increment/decrement messages.
private static java.lang.String	getNoteString(byte number, int channel) Returns the configured note name or percussion IDs by number and channel.
private static java.lang.String	getVendorName(java.lang.String vendorNum) Returns the vendor name for the given vendor number.
static SingleMessage	processMetaMessage(javax.sound.midi.MetaMessage msg, long tick, int trackNum, int msgNum, java.util.ArrayList<SingleMessage> messages, MidicaTreeModel msgTreeModel, java.lang.String chosenCharset, java.lang.String midiFileCharset) Retrieves general information from meta messages.
static SingleMessage	processShortMessage(javax.sound.midi.ShortMessage msg, long tick, int trackNum, int msgNum, java.util.ArrayList<SingleMessage> messages, MidicaTreeModel msgTreeModel) Retrieves general information from short messages.
static SingleMessage	processSysexMessage(javax.sound.midi.SysexMessage msg, long tick, int trackNum, int msgNum, java.util.ArrayList<SingleMessage> messages, MidicaTreeModel msgTreeModel) Retrieves general information from SysEx messages.

Methods inherited from class java.lang.Object

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

Field Detail

MSG_LVL_1_SORT_CH_VOICE

private static final java.lang.String MSG_LVL_1_SORT_CH_VOICE

See Also:

Constant Field Values

MSG_LVL_1_SORT_CH_MODE

private static final java.lang.String MSG_LVL_1_SORT_CH_MODE

See Also:

Constant Field Values

MSG_LVL_1_SORT_SYS_COM

private static final java.lang.String MSG_LVL_1_SORT_SYS_COM

See Also:

Constant Field Values

MSG_LVL_1_SORT_SYS_RT

private static final java.lang.String MSG_LVL_1_SORT_SYS_RT

See Also:

Constant Field Values

MSG_LVL_1_SORT_META

private static final java.lang.String MSG_LVL_1_SORT_META

See Also:

Constant Field Values

INVALID_BYTE

private static final int INVALID_BYTE

See Also:

Constant Field Values

Constructor Detail

MessageClassifier

private MessageClassifier()

Private constructor because this class is only used statically.

Method Detail

getDescription

public static final java.lang.String[] getDescription(IMessageType message)

Returns a long and short description for the given message or message category.

The first returned value is the long description or null, if not available. It’s used for the description part in the message detail field.

The second returned value is the short description or an empty string, if not available. It’s used for the summary column message table.

Parameters:

message - message or message category

Returns:

long and short description as described above.

getKeySignature

public static java.lang.String[] getKeySignature(byte sharpsOrFlats,
                                                 byte tonality)

Returns the note and tonality of a KEY_SIGNATURE message like it’s used in MidicaPL format.

Example:

In standard configuration, getKeySignature(0, 1) returns [“c”, “maj”].

If note or tonality cannot be found out, both returned values are empty strings.

Parameters:

sharpsOrFlats - number of sharps or flats

tonality - tonality byte from the message

Returns:

note name and tonality.

getNoteString

private static final java.lang.String getNoteString(byte number,
                                                    int channel)

Returns the configured note name or percussion IDs by number and channel.

Parameters:

number - MIDI number

channel - MIDI channel

Returns:

note or percussion description

processShortMessage

public static final SingleMessage processShortMessage(javax.sound.midi.ShortMessage msg,
                                                      long tick,
                                                      int trackNum,
                                                      int msgNum,
                                                      java.util.ArrayList<SingleMessage> messages,
                                                      MidicaTreeModel msgTreeModel)
                                               throws java.lang.ReflectiveOperationException

Retrieves general information from short messages.

• Creates a path and adds it to the given tree model.
• Adds the created SingleMessage to the given messages list.
• Adds the leaf node of the created path to the created message.

Parameters:

msg - Short message

tick - Tickstamp

trackNum - Track number (beginning with 0).

msgNum - Number of the message inside the track.

messages - List of messages where the processed message will be added.

msgTreeModel - Tree model where the created leaf note will be added.

Returns:

the created message object

Throws:

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

processMetaMessage

public static final SingleMessage processMetaMessage(javax.sound.midi.MetaMessage msg,
                                                     long tick,
                                                     int trackNum,
                                                     int msgNum,
                                                     java.util.ArrayList<SingleMessage> messages,
                                                     MidicaTreeModel msgTreeModel,
                                                     java.lang.String chosenCharset,
                                                     java.lang.String midiFileCharset)
                                              throws java.lang.ReflectiveOperationException

Retrieves general information from meta messages.

• Creates a path and adds it to the given tree model.
• Adds the created SingleMessage to the given messages list.
• Adds the leaf node of the created path to the created message.

Parameters:

msg - Meta message

tick - Tickstamp

trackNum - Track number (beginning with 0).

msgNum - Number of the message inside the track.

messages - List of messages where the processed message will be added.

msgTreeModel - Tree model where the created leaf note will be added.

chosenCharset - Charset that has been chosen with the file chooser.

midiFileCharset - The last charset from a charset switch inside of a lyrics message.

Returns:

the created message object

Throws:

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

processSysexMessage

public static final SingleMessage processSysexMessage(javax.sound.midi.SysexMessage msg,
                                                      long tick,
                                                      int trackNum,
                                                      int msgNum,
                                                      java.util.ArrayList<SingleMessage> messages,
                                                      MidicaTreeModel msgTreeModel)
                                               throws java.lang.ReflectiveOperationException

Retrieves general information from SysEx messages.

• Creates a path and adds it to the given tree model.
• Adds the created SingleMessage to the given messages list.
• Adds the leaf node of the created path to the created message.

Parameters:

msg - SysEx message

tick - Tickstamp

trackNum - Track number (beginning with 0).

msgNum - Number of the message inside the track.

messages - List of messages where the processed message will be added.

msgTreeModel - Tree model where the created leaf note will be added.

Returns:

the created message object

Throws:

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

getLvl2SystemMsgTxtByStatusByte

private static final java.lang.String getLvl2SystemMsgTxtByStatusByte(int status)

Returns the level 2 message name of system common and system realtime messages by status byte.

Parameters:

status - Status byte of the message.

Returns:

Level 2 Message type.

getLvl2MetaText

private static final java.lang.String getLvl2MetaText(int type)

Returns the level 2 message name of META messages.

Parameters:

type - Second byte of the message.

Returns:

Level 2 META message type.

getLvl2VoiceMsgTxtByCommand

private static final java.lang.String getLvl2VoiceMsgTxtByCommand(int cmd)

Returns the level 2 message name of channel voice messages by message command.

The command contains the first 4 bits of the status byte.

Parameters:

cmd - Command of the voice message.

Returns:

Level 2 Message type.

getLvl2ModeMsgTxtByData1

private static final java.lang.String getLvl2ModeMsgTxtByData1(int val)

Returns the level 2 command of a channel mode message. The status is the same as a channel voice / control change message. So this has to be determined by the (given) first data value.

Parameters:

val - First data byte of the message.

Returns:

level 2 text.

getLvl34ControllerMsgTxtByData1

private static final java.lang.String[] getLvl34ControllerMsgTxtByData1(int val)

Returns the level 3 and 4 node names of control change messages. A level 4 node name is only added for controllers that have an MSB and LSB.

• Level 3: the controller
• Level 4: MSB or LSB

The returned array consists of:

• level 3 text
• level 4 text (or null, if the controller is unknown or doesn’t have MSB/LSB)

Parameters:

val - First data byte of the message.

Returns:

level 3 and 4 texts

getLvl4RpnNrpnDataTxt

private static final java.lang.String[] getLvl4RpnNrpnDataTxt(byte msb,
                                                              byte lsb,
                                                              byte type)

Returns the level 4 message fields for the tree node of Data entry/increment/decrement messages. These messages affect the last set (N)RPN of the given channel.

The following strings are returned:

• Main text (Parameter name)
• Parameter number (2 bytes as a comma-separated string).

Parameters:

msb - The MSB of the (N)RPN.

lsb - The LSB of the (N)RPN.

type - 1 for RPN, 0 for NRPN, -1 for none

Returns:

the strings needed for the tree node as described above.

getLvl456UniversalSysexTxt

private static final java.lang.String[] getLvl456UniversalSysexTxt(boolean isRealTime,
                                                                   int sub1,
                                                                   int sub2)

Returns the level 4, 5, and 6 node names of universal SysEx messages.

A level 5 or 6 node name is not always available - depending on the given Sub-ID 1.

• Level 4: SysEx main type, defined by Sub-ID 1.
• Level 5: SysEx sub type, defined by Sub-ID 2.
• Level 6: MIDI-CI sub type, defined by Sub-ID 2 (if Sub-ID 1 = 0x0D).

The returned array consists of 1, 3 or 4 elements:

• 1st element: level 4 text (main type)
• 2nd element: level 5 text (sub type)
• 3rd element:
  • level 6 text, if avaliable, or otherwise:
  • the given Sub-ID 2 as a Hex value
• 4th element: the given Sub-ID 2 as a Hex value (only if level 6 is available)

The 2nd and 3rd element are only returned if Sub-ID 1 allows a sub type.

The 4th element is only available for MIDI-CI messages.

Parameters:

isRealTime - true for Real Time messages, false for Non Real Time messages.

sub1 - Sub-ID 1 (4th byte of the message)

sub2 - Sub-ID 2 (5th byte of the message)

Returns:

level 4, 5 and 6 text and Sub-ID 2, as described above.

getVendorName

private static final java.lang.String getVendorName(java.lang.String vendorNum)

Returns the vendor name for the given vendor number.

The given vendor number can be one of the following:

• a hex number consisting of 2 digits (one-byte-ID)
• a hex number consisting of 6 digits (3-byte-ID beginning with 00)
• the string “-” for a corrupted message without a valid vendor ID

Parameters:

vendorNum - The vendor number as described above.

Returns:

the vendor name.