org.jsynthlib.synthdrivers.YamahaCS2x

Class YamahaCS2xCommonDriver

java.lang.Object

org.jsynthlib.device.model.AbstractDriver

org.jsynthlib.device.model.AbstractPatchDriver

org.jsynthlib.synthdrivers.YamahaCS2x.YamahaCS2xCommonDriver

All Implemented Interfaces:

IDriver, IPatchDriver

public class YamahaCS2xCommonDriver
extends AbstractPatchDriver

YamahaCS2xCommonDriver needs to know about the type (current, bank1 or bank2) and performance number

Author:

peter

Field Summary

Fields inherited from class org.jsynthlib.device.model.AbstractDriver

bankNumbers, checksumEnd, checksumOffset, checksumStart, deviceIDoffset, log, numSysexMsgs, patchNameSize, patchNameStart, patchNumbers, patchSize, sysexID, sysexRequestDump, trimSize

Constructor Summary

Constructors

Constructor and Description
YamahaCS2xCommonDriver()

Method Summary

Modifier and Type	Method and Description
void	calculateChecksum(Patch p) Calculate check sum of a Patch.
Patch	createNewPatch() Create a new Patch.
JSLFrame	editPatch(Patch p) Override this if your driver implement Patch Editor.
String	getPatchName(Patch p) Gets the name of the patch from the sysex.
void	requestPatchDump(int bankNum, int patchNum) Request the synth to send a patch dump.
void	sendPatch(Patch p) Sends a patch to the synth's edit buffer.
void	storePatch(Patch p, int bankNum, int patchNum) Sends a patch to a set location on a synth.
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.

Methods inherited from class org.jsynthlib.device.model.AbstractPatchDriver

getFullPatchName, getPatchNumbersForStore, hasEditor, isBankDriver, isConverter, isSingleDriver, setPatchName

Methods inherited from class org.jsynthlib.device.model.AbstractDriver

calculateChecksum, calculateChecksum, canCreatePatch, createPatch, createPatch, createPatches, generateNumbers, getAuthors, getBankNumbers, getChannel, getChecksumEnd, getChecksumOffset, getChecksumStart, getDevice, getDeviceID, getDeviceIDoffset, getManufacturerName, getModelName, getPatchFactory, getPatchNameSize, getPatchNameStart, getPatchNumbers, getPatchSize, getPatchType, getSynthName, getSysexID, getSysexRequestDump, getTrimSize, playPatch, send, send, send, send, sendPatchWorker, setBankNum, setBankNumbers, setChecksumEnd, setChecksumOffset, setChecksumStart, setDevice, setDeviceIDoffset, setPatchNameSize, setPatchNameStart, setPatchNum, setPatchNumbers, setPatchSize, setSysexID, setSysexRequestDump, setTrimSize, toString, trimSysex

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

calculateChecksum, canCreatePatch, createPatch, createPatch, createPatches, getAuthors, getBankNumbers, getChannel, getChecksumEnd, getChecksumOffset, getChecksumStart, getDevice, getDeviceID, getDeviceIDoffset, getPatchNameSize, getPatchNameStart, getPatchNumbers, getPatchSize, getPatchType, getSysexID, getSysexRequestDump, getTrimSize, playPatch, send, setBankNumbers, setChecksumEnd, setChecksumOffset, setChecksumStart, setDevice, setDeviceIDoffset, setPatchNameSize, setPatchNameStart, setPatchNumbers, setPatchSize, setSysexID, setSysexRequestDump, setTrimSize, toString, trimSysex

Constructor Detail

YamahaCS2xCommonDriver

public YamahaCS2xCommonDriver()

Method Detail

requestPatchDump

public void requestPatchDump(int bankNum,
                             int patchNum)

Description copied from class: AbstractDriver

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

Overrides:

requestPatchDump in class AbstractDriver

See Also:

IDriver.requestPatchDump(int, int), SysexHandler

calculateChecksum

public void calculateChecksum(Patch p)

Description copied from class: AbstractDriver

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

Overrides:

calculateChecksum in class AbstractDriver

Parameters:

p - a Patch value

sendPatch

public void sendPatch(Patch p)

Description copied from class: AbstractDriver

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

Overrides:

sendPatch in class AbstractDriver

See Also:

Patch.send(), ISinglePatch#send()

storePatch

public void storePatch(Patch p,
                       int bankNum,
                       int patchNum)

Description copied from class: AbstractPatchDriver

Sends a patch to a set location on a synth.

Override this if required.

Specified by:

storePatch in interface IDriver

Overrides:

storePatch in class AbstractPatchDriver

See Also:

Patch.send(int, int)

getPatchName

public String getPatchName(Patch p)

Description copied from class: AbstractPatchDriver

Gets the name of the patch from the sysex. If the patch uses some weird format or encoding, this needs to be overidden in the particular driver.

Specified by:

getPatchName in interface IDriver

Overrides:

getPatchName in class AbstractPatchDriver

See Also:

Patch.getName()

createNewPatch

public Patch createNewPatch()

Description copied from class: AbstractDriver

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

Overrides:

createNewPatch in class AbstractDriver

See Also:

IDriver.createPatch(), AbstractDriver.createPatch()

supportsPatch

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

Description copied from class: AbstractDriver

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

Overrides:

supportsPatch in class AbstractDriver

Parameters:

patchString - the result of p.getPatchHeader().

sysex - a byte array of sysex message

Returns:

true if this driver supports the Patch.

See Also:

AbstractDriver.patchSize, AbstractDriver.sysexID

editPatch

public JSLFrame editPatch(Patch p)

Description copied from class: AbstractPatchDriver

Override this if your driver implement Patch Editor. Don't override this otherwise.

Specified by:

editPatch in interface IDriver

Overrides:

editPatch in class AbstractPatchDriver

See Also:

Patch.edit()