org.jsynthlib.device.model

Class SysexHandler

java.lang.Object

org.jsynthlib.device.model.SysexHandler

public class SysexHandler
extends Object

A class for efficient and convenient creatation of sysex messages. The basic concept is to store a sysex as a byte array, using an index to the special bytes (eg @@, *patchNum*, ..) to insert values.

1. Understands space seperated "Sysex" strings of the form:

    "F0 00 00 1B 0B @@ 14 *patchNum* 00 *bankNum* 00 F7"
    

   Or dense hex strings of the form:

    "F000001B*B0015**00**0*F7"
    

   (though this syntax can not handled multiple values such as *patchNum*, *bankNum*)
2. On converstion to byte array (prior to being sent as a sysex message):
   ** - Replace by the value of argument value.
   @@ - Replaced by the value of argument deviceID argument.
   ## - Replaced by the value of argument deviceID argument + 16.
   *name* - Replaced by the appropriate value by using a NameValue instance. This is useful if you have to replace multiple values.

Example:

 sysexHandler =
         new SysexHandler("F0 00 00 1B 0B @@ 14 *patchNum* 00 *bankNum* 00 F7");
 send(sysexHandler.toSysexMessage(getDeviceID(), new SysexHander.NameValue(
         "patchNum", patchNum), new SysexHander.NameValue("bankNum", bankNum)));
 

See Also:

SysexHandler.NameValue, AbstractDriver.sysexRequestDump, IDriver.requestPatchDump(int, int)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SysexHandler.NameValue A class which provides access to an int value by name.

Constructor Summary

Constructors

Constructor and Description
SysexHandler(String src) Creates a new SysexHandler instance.

Method Summary

Modifier and Type	Method and Description
byte[]	toByteArray() Return a byte array where @@,** etc..
byte[]	toByteArray(int deviceID, int value) A simplified methodology to use when there's only one value to be replaced (so the *patchNum* syntax is wasteful).
byte[]	toByteArray(int deviceID, SysexHandler.NameValue[] nameValues) Return Sysex string as a byte array with replacable values set via data passed as arguments.
SysexMessage	toSysexMessage(int deviceID) A simplified methodology to use when no value to be replaced (so the *patchNum* syntax is wasteful).
SysexMessage	toSysexMessage(int deviceID, int value) A simplified methodology to use when there's only one value to be replaced (so the *patchNum* syntax is wasteful).
SysexMessage	toSysexMessage(int deviceID, SysexHandler.NameValue nameValue) Return SysexMessage with replacable values set via data passed as arguments.
SysexMessage	toSysexMessage(int deviceID, SysexHandler.NameValue[] nameValues) Return SysexMessage with replacable values set via data passed as arguments.
SysexMessage	toSysexMessage(int deviceID, SysexHandler.NameValue nameValue1, SysexHandler.NameValue nameValue2) Return SysexMessage with replacable values set via data passed as arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

SysexHandler

public SysexHandler(String src)

Creates a new SysexHandler instance.

Parameters:

src - a Sysex String

See Also:

SysexHandler.NameValue

Method Detail

toSysexMessage

public SysexMessage toSysexMessage(int deviceID,
                                   SysexHandler.NameValue[] nameValues)

Return SysexMessage with replacable values set via data passed as arguments.

Parameters:

deviceID - Device ID

nameValues - a array of NameValue value

Returns:

a SysexMessage value

See Also:

SysexHandler.NameValue

toSysexMessage

public SysexMessage toSysexMessage(int deviceID,
                                   SysexHandler.NameValue nameValue)

Return SysexMessage with replacable values set via data passed as arguments.

toSysexMessage(int deviceID, int value) is a simple form of this method.

Parameters:

deviceID - Device ID

nameValue - a NameValue value

Returns:

a SysexMessage value

See Also:

SysexHandler.NameValue, toSysexMessage(int deviceID, int value)

toSysexMessage

public SysexMessage toSysexMessage(int deviceID,
                                   SysexHandler.NameValue nameValue1,
                                   SysexHandler.NameValue nameValue2)

Return SysexMessage with replacable values set via data passed as arguments.

Parameters:

deviceID - Device ID

nameValue1 - a NameValue value

nameValue2 - a NameValue value

Returns:

a SysexMessage value

See Also:

SysexHandler.NameValue

toSysexMessage

public SysexMessage toSysexMessage(int deviceID,
                                   int value)

A simplified methodology to use when there's only one value to be replaced (so the *patchNum* syntax is wasteful).

toSysexMessage

public SysexMessage toSysexMessage(int deviceID)

A simplified methodology to use when no value to be replaced (so the *patchNum* syntax is wasteful).

toByteArray

public byte[] toByteArray(int deviceID,
                          SysexHandler.NameValue[] nameValues)

Return Sysex string as a byte array with replacable values set via data passed as arguments.

Parameters:

deviceID - Device ID

nameValues - a array of NameValue value

Returns:

a byte[] value

See Also:

SysexHandler.NameValue, toSysexMessage(int deviceID, SysexHandler.NameValue[] nameValues)

toByteArray

public byte[] toByteArray(int deviceID,
                          int value)

A simplified methodology to use when there's only one value to be replaced (so the *patchNum* syntax is wasteful).

See Also:

toSysexMessage(int deviceID, int value)

toByteArray

public byte[] toByteArray()

Return a byte array where @@,** etc.. have been replaced by 0. This is equivalent with toByteArray(0, 0).

See Also:

toSysexMessage(int, int)