org.jsynthlib.device.model

Class AbstractDriver

java.lang.Object

org.jsynthlib.device.model.AbstractDriver

All Implemented Interfaces:

IDriver

Direct Known Subclasses:

AbstractBankDriver, AbstractPatchDriver, Converter

public abstract class AbstractDriver
extends Object
implements IDriver

Author:

Pascal Collberg

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	bankNumbers Array holding names or numbers for all banks.
protected int	checksumEnd End of range that Checksum covers.
protected int	checksumOffset Offset of checksum byte.
protected int	checksumStart Start of range that Checksum covers.
protected int	deviceIDoffset Offset of deviceID in sysex.
protected org.apache.log4j.Logger	log
protected int	numSysexMsgs Number of sysex messages in patch dump.
protected int	patchNameSize Number of characters in the patch name.
protected int	patchNameStart The offset in the patch where the patchname starts.
protected String[]	patchNumbers Array holding names/numbers for all patches.
protected int	patchSize The size of the patch this Driver supports (or 0 for variable).
protected String	sysexID The hex header that sysex files of the format this driver supports will have.
protected SysexHandler	sysexRequestDump SysexHandler object to request dump.
protected int	trimSize The size of the patch for trimming purposes.

Constructor Summary

Constructors

Constructor and Description
AbstractDriver(String patchType, String authors) Creates a new Driver instance.

Method Summary

Modifier and Type	Method and Description
void	calculateChecksum(byte[] sysex, int start, int end, int ofs) Caluculate check sum of a byte array sysex.
void	calculateChecksum(Patch p) Calculate check sum of a Patch.
protected void	calculateChecksum(Patch patch, int start, int end, int offset) Calculate check sum of a Patch.
boolean	canCreatePatch() Check if this driver supports creating a new patch.
protected Patch	createNewPatch() Create a new Patch.
Patch	createPatch() Create a new Patch for this driver.
Patch	createPatch(byte[] sysex) Create a patch from a byte array for the driver.
Patch[]	createPatches(SysexMessage[] msgs) Create an array of patches from an array of SysexMessage for the driver.
protected String[]	generateNumbers(int min, int max, String format) A utility method to generates an array of formatted numbers.
String	getAuthors() return the names of the authors of this driver.
String[]	getBankNumbers() Returns String[] returns full list of bankNumbers.
int	getChannel() Return MIDI channel number.
int	getChecksumEnd()
int	getChecksumOffset()
int	getChecksumStart()
Device	getDevice() Return Device with which this driver go..
int	getDeviceID() Return MIDI devide ID.
int	getDeviceIDoffset()
protected String	getManufacturerName() Return the name of manufacturer of synth.
protected String	getModelName() Return the name of model of synth.
protected PatchFactory	getPatchFactory()
int	getPatchNameSize() Getter of patchNameSize.
int	getPatchNameStart()
String[]	getPatchNumbers() Returns String[] returns full list of patchNumbers.
int	getPatchSize() Return the size of the patch which the driver handles.
String	getPatchType() return type of patch which the driver handles.
protected String	getSynthName() Return the personal name of the synth.
String	getSysexID()
SysexHandler	getSysexRequestDump()
int	getTrimSize()
void	playPatch(Patch p) Play note.
void	requestPatchDump(int bankNum, int patchNum) Request the synth to send a patch dump.
void	send(byte[] sysex) Send Sysex byte array data to MIDI outport.
void	send(int status, int d1) Send ShortMessage to MIDI outport.
void	send(int status, int d1, int d2) Send ShortMessage to MIDI outport.
void	send(MidiMessage msg) Send a MidiMessage to the MIDI outport for this driver.
void	sendPatch(Patch p) Sends a patch to the synth's edit buffer.
protected void	sendPatchWorker(Patch p) Set Device ID and send the sysex data to MIDI output.
protected void	setBankNum(int bankNum) Send Control Change (Bank Select) MIDI message.
void	setBankNumbers(String[] bankNumbers)
void	setChecksumEnd(int checksumEnd)
void	setChecksumOffset(int checksumOffset)
void	setChecksumStart(int checksumStart)
void	setDevice(Device d) Set Device with which this driver go.
void	setDeviceIDoffset(int deviceIDoffset)
void	setPatchNameSize(int patchNameSize)
void	setPatchNameStart(int patchNameStart)
protected void	setPatchNum(int patchNum) Send Program Change MIDI message.
void	setPatchNumbers(String[] patchNumbers)
void	setPatchSize(int patchSize)
void	setSysexID(String sysexID)
void	setSysexRequestDump(SysexHandler sysexRequestDump)
void	setTrimSize(int trimSize)
boolean	supportsPatch(String patchString, byte[] sysex) Compares the header & size of a Patch to this driver to see if this driver is the correct one to support the patch.
String	toString() Returns full name for referring to this Driver.
int	trimSysex(Patch patch) This method trims a patch, containing more than one real patch to a correct size.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jsynthlib.device.model.IDriver

editPatch, getPatchName, hasEditor, isBankDriver, isConverter, isSingleDriver, setPatchName, storePatch

Field Detail

log

protected final transient org.apache.log4j.Logger log

patchSize

protected int patchSize

The size of the patch this Driver supports (or 0 for variable).

See Also:

supportsPatch(java.lang.String, byte[])

sysexID

protected String sysexID

The hex header that sysex files of the format this driver supports will have. The program will attempt to match loaded sysex drivers with the sysexID of a loaded driver. It can be up to 16 bytes and have wildcards ( *). (ex. "F041**003F12")

See Also:

supportsPatch(java.lang.String, byte[])

patchNumbers

protected String[] patchNumbers

Array holding names/numbers for all patches. Used for comboBox selection.

See Also:

getPatchNumbers(), #getPatchNumbersForStore, DriverUtil#generateNumbers

bankNumbers

protected String[] bankNumbers

Array holding names or numbers for all banks. Used for comboBox selection.

See Also:

getBankNumbers(), DriverUtil#generateNumbers

deviceIDoffset

protected int deviceIDoffset

Offset of deviceID in sysex. Used by sendPatchWorker method.

See Also:

sendPatchWorker(org.jsynthlib.patch.model.impl.Patch)

sysexRequestDump

protected SysexHandler sysexRequestDump

SysexHandler object to request dump. You don't have to use this field if you override requestPatchDump method.

See Also:

requestPatchDump(int, int), SysexHandler

checksumOffset

protected int checksumOffset

Offset of checksum byte.

Need to be set if default calculateChecksum(Patch) method is used.

See Also:

calculateChecksum(Patch)

checksumStart

protected int checksumStart

Start of range that Checksum covers.

Need to be set if default calculateChecksum(Patch) method is used.

See Also:

calculateChecksum(Patch)

checksumEnd

protected int checksumEnd

End of range that Checksum covers.

Need to be set if default calculateChecksum(Patch) method is used.

See Also:

calculateChecksum(Patch)

patchNameStart

protected int patchNameStart

The offset in the patch where the patchname starts. '0' if patch is not named -- remember all offsets are zero based.

See Also:

IDriver.setPatchName(org.jsynthlib.patch.model.impl.Patch, java.lang.String), IDriver.getPatchName(org.jsynthlib.patch.model.impl.Patch)

patchNameSize

protected int patchNameSize

Number of characters in the patch name. (0 if no name)

See Also:

IDriver.setPatchName(org.jsynthlib.patch.model.impl.Patch, java.lang.String), IDriver.getPatchName(org.jsynthlib.patch.model.impl.Patch)

trimSize

protected int trimSize

The size of the patch for trimming purposes.

See Also:

trimSysex(org.jsynthlib.patch.model.impl.Patch)

numSysexMsgs

protected int numSysexMsgs

Number of sysex messages in patch dump. Not used now.

Constructor Detail

AbstractDriver

public AbstractDriver(String patchType,
                      String authors)

Creates a new Driver instance.

Parameters:

patchType - The patch type. eg. "Single", "Bank", "Drumkit", etc.

authors - The names of the authors of this driver.

Method Detail

getPatchType

public final String getPatchType()

Description copied from interface: IDriver

return type of patch which the driver handles. eg. "Single", "Bank", "Drumkit", "Converter", etc.

Specified by:

getPatchType in interface IDriver

getAuthors

public final String getAuthors()

Description copied from interface: IDriver

return the names of the authors of this driver.

Specified by:

getAuthors in interface IDriver

setDevice

public void setDevice(Device d)

Description copied from interface: IDriver

Set Device with which this driver go.

Specified by:

setDevice in interface IDriver

getDevice

public final Device getDevice()

Description copied from interface: IDriver

Return Device with which this driver go..

Specified by:

getDevice in interface IDriver

supportsPatch

public boolean supportsPatch(String patchString,
                             byte[] sysex)

Compares the header & size of a Patch to this driver to see if this driver is the correct one to support the patch.

Specified by:

supportsPatch in interface IDriver

Parameters:

patchString - the result of p.getPatchHeader().

sysex - a byte array of sysex message

Returns:

true if this driver supports the Patch.

See Also:

patchSize, sysexID

getPatchSize

public int getPatchSize()

Description copied from interface: IDriver

Return the size of the patch which the driver handles. SysexGetDialog uses this to estimate timeout value.

Specified by:

getPatchSize in interface IDriver

See Also:

SysexGetDialog

getPatchNumbers

public String[] getPatchNumbers()

Description copied from interface: IDriver

Returns String[] returns full list of patchNumbers.

Specified by:

getPatchNumbers in interface IDriver

See Also:

DriverUtil#generateNumbers

getBankNumbers

public String[] getBankNumbers()

Description copied from interface: IDriver

Returns String[] returns full list of bankNumbers.

Specified by:

getBankNumbers in interface IDriver

See Also:

DriverUtil#generateNumbers

sendPatch

public void sendPatch(Patch p)

Sends a patch to the synth's edit buffer.

Override this in the subclass if parameters or warnings need to be sent to the user (aka if the particular synth does not have a edit buffer or it is not MIDI accessable).

Specified by:

sendPatch in interface IDriver

See Also:

Patch.send(), ISinglePatch#send()

sendPatchWorker

protected final void sendPatchWorker(Patch p)

Set Device ID and send the sysex data to MIDI output.

See Also:

sendPatch(Patch)

send

public final void send(byte[] sysex)

Send Sysex byte array data to MIDI outport.

Parameters:

sysex - a byte array of Sysex data. If it has checksum, the checksum must be calculated before calling this method.

playPatch

public void playPatch(Patch p)

Play note. plays a MIDI file or a single note depending which preference is set. Currently the MIDI sequencer support isn't implemented!

Specified by:

playPatch in interface IDriver

See Also:

Patch.play(), ISinglePatch#play()

send

public final void send(MidiMessage msg)

Description copied from interface: IDriver

Send a MidiMessage to the MIDI outport for this driver.

Specified by:

send in interface IDriver

createPatches

public Patch[] createPatches(SysexMessage[] msgs)

Description copied from interface: IDriver

Create an array of patches from an array of SysexMessage for the driver. Returns an array of patches because Converter may be used. This is used for SysexMessages received by using requestPatchDump(int, int).

Specified by:

createPatches in interface IDriver

Parameters:

msgs - an array of SysexMessage.

Returns:

an array of IPatch value.

See Also:

IDriver.requestPatchDump(int, int), SysexGetDialog

createPatch

public Patch createPatch(byte[] sysex)

Description copied from interface: IDriver

Create a patch from a byte array for the driver. This must be called only when IDriver.supportsPatch() returns true.

Specified by:

createPatch in interface IDriver

Parameters:

sysex - a byte array of sysex data.

Returns:

a array of IPatch object.

See Also:

IDriver.supportsPatch(String, byte[]), DriverUtil#createPatch(byte[])

getManufacturerName

protected final String getManufacturerName()

Return the name of manufacturer of synth.

getModelName

protected final String getModelName()

Return the name of model of synth.

getSynthName

protected final String getSynthName()

Return the personal name of the synth.

getDeviceID

public final int getDeviceID()

Description copied from interface: IDriver

Return MIDI devide ID.

Specified by:

getDeviceID in interface IDriver

getChannel

public final int getChannel()

Return MIDI channel number.

Specified by:

getChannel in interface IDriver

getPatchNameSize

public int getPatchNameSize()

Description copied from interface: IDriver

Getter of patchNameSize.

Specified by:

getPatchNameSize in interface IDriver

calculateChecksum

public void calculateChecksum(Patch p)

Calculate check sum of a Patch.

Need to be overridden if a patch is consist from multiple SysEX messages.

Specified by:

calculateChecksum in interface IDriver

Parameters:

p - a Patch value

calculateChecksum

protected final void calculateChecksum(Patch patch,
                                       int start,
                                       int end,
                                       int offset)

Calculate check sum of a Patch.

This method is called by calculateChecksum(Patch). The checksum calculation method of this method is used by Roland, YAMAHA, etc. Override this for different checksum calculation method.

Compatibility Note: This method became 'static' method.

Parameters:

patch - a Patch value

start - start offset

end - end offset

offset - offset of the checksum data

See Also:

calculateChecksum(Patch)

trimSysex

public int trimSysex(Patch patch)

This method trims a patch, containing more than one real patch to a correct size. Useful for files containg more than one bank for example. Some drivers are incompatible with this method so it reqires explicit activation with the trimSize variable.

Specified by:

trimSysex in interface IDriver

Parameters:

patch - the patch, which should be trimmed to the right size

Returns:

the size of the (modified) patch

See Also:

fixPatch(Patch, String), IDriver.createPatches(SysexMessage[])

setBankNum

protected void setBankNum(int bankNum)

Send Control Change (Bank Select) MIDI message.

See Also:

IDriver.storePatch(Patch, int, int)

requestPatchDump

public void requestPatchDump(int bankNum,
                             int patchNum)

Request the synth to send a patch dump. If sysexRequestDump is not null, a request dump message is sent. Otherwise a dialog window will prompt users.

Specified by:

requestPatchDump in interface IDriver

See Also:

IDriver.requestPatchDump(int, int), SysexHandler

setPatchNum

protected void setPatchNum(int patchNum)

Send Program Change MIDI message.

See Also:

IDriver.storePatch(Patch, int, int)

send

public final void send(int status,
                       int d1,
                       int d2)

Send ShortMessage to MIDI outport.

send

public final void send(int status,
                       int d1)

Send ShortMessage to MIDI outport.

canCreatePatch

public boolean canCreatePatch()

Check if this driver supports creating a new patch. By default it uses reflection to test if the method createNewPatch() is overridden by the subclass of Driver.

Specified by:

canCreatePatch in interface IDriver

See Also:

IDriver.createPatch()

toString

public String toString()

Description copied from interface: IDriver

Returns full name for referring to this Driver. Used for labels by driver selection comboboxes.

Specified by:

toString in interface IDriver

Overrides:

toString in class Object

createPatch

public final Patch createPatch()

Description copied from interface: IDriver

Create a new Patch for this driver.

Specified by:

createPatch in interface IDriver

createNewPatch

protected Patch createNewPatch()

Create a new Patch. Don't override this unless your driver properly implement this method.

See Also:

IDriver.createPatch(), createPatch()

getPatchFactory

protected PatchFactory getPatchFactory()

generateNumbers

protected String[] generateNumbers(int min,
                                   int max,
                                   String format)

A utility method to generates an array of formatted numbers. For example,

 patchNumbers = generateNumbers(1, 10, "Patch 00");
 

setups the following array,

   {
     "Patch 01", "Patch 02", "Patch 03", "Patch 04", "Patch 05"
     "Patch 06", "Patch 07", "Patch 08", "Patch 09", "Patch 10"
   }
 

Parameters:

min - minumux value

max - maximum value

format - pattern String for java.text.DecimalFormat

Returns:

an array of formatted numbers.

See Also:

DecimalFormat, IDriver.getPatchNumbers(), IPatchDriver.getPatchNumbersForStore(), IDriver.getBankNumbers()

calculateChecksum

public void calculateChecksum(byte[] sysex,
                              int start,
                              int end,
                              int ofs)

Description copied from interface: IDriver

Caluculate check sum of a byte array sysex.

The checksum calculation method of this method is used by Roland, YAMAHA, etc.

Compatibility Note: This method became 'static' method.

Specified by:

calculateChecksum in interface IDriver

Parameters:

sysex - a byte array

start - start offset

end - end offset

ofs - offset of the checksum data

See Also:

calculateChecksum(Patch)

getSysexID

public String getSysexID()

Specified by:

getSysexID in interface IDriver

setSysexID

public void setSysexID(String sysexID)

Specified by:

setSysexID in interface IDriver

getDeviceIDoffset

public int getDeviceIDoffset()

Specified by:

getDeviceIDoffset in interface IDriver

setDeviceIDoffset

public void setDeviceIDoffset(int deviceIDoffset)

Specified by:

setDeviceIDoffset in interface IDriver

getSysexRequestDump

public SysexHandler getSysexRequestDump()

Specified by:

getSysexRequestDump in interface IDriver

setSysexRequestDump

public void setSysexRequestDump(SysexHandler sysexRequestDump)

Specified by:

setSysexRequestDump in interface IDriver

getChecksumOffset

public int getChecksumOffset()

Specified by:

getChecksumOffset in interface IDriver

setChecksumOffset

public void setChecksumOffset(int checksumOffset)

Specified by:

setChecksumOffset in interface IDriver

getChecksumStart

public int getChecksumStart()

Specified by:

getChecksumStart in interface IDriver

setChecksumStart

public void setChecksumStart(int checksumStart)

Specified by:

setChecksumStart in interface IDriver

getChecksumEnd

public int getChecksumEnd()

Specified by:

getChecksumEnd in interface IDriver

setChecksumEnd

public void setChecksumEnd(int checksumEnd)

Specified by:

setChecksumEnd in interface IDriver

getPatchNameStart

public int getPatchNameStart()

Specified by:

getPatchNameStart in interface IDriver

setPatchNameStart

public void setPatchNameStart(int patchNameStart)

Specified by:

setPatchNameStart in interface IDriver

getTrimSize

public int getTrimSize()

Specified by:

getTrimSize in interface IDriver

setTrimSize

public void setTrimSize(int trimSize)

Specified by:

setTrimSize in interface IDriver

setPatchSize

public void setPatchSize(int patchSize)

Specified by:

setPatchSize in interface IDriver

setPatchNumbers

public void setPatchNumbers(String[] patchNumbers)

Specified by:

setPatchNumbers in interface IDriver

setBankNumbers

public void setBankNumbers(String[] bankNumbers)

Specified by:

setBankNumbers in interface IDriver

setPatchNameSize

public void setPatchNameSize(int patchNameSize)

Specified by:

setPatchNameSize in interface IDriver