org.jsynthlib.device.model

Class AbstractBankDriver

java.lang.Object

org.jsynthlib.device.model.AbstractDriver

org.jsynthlib.device.model.AbstractBankDriver

All Implemented Interfaces:

IBankDriver, IDriver

Direct Known Subclasses:

AlesisA6MixBankDriver, AlesisA6PgmBankDriver, CasioCZ1000BankDriver, DX7FamilyAdditionalVoiceBankDriver, DX7FamilyFractionalScalingBankDriver, DX7FamilyMicroTuningBankDriver, DX7FamilyPerformanceBankDriver, DX7FamilyPerformanceIIBankDriver, DX7FamilyPerformanceIIIBankDriver, DX7FamilyVoiceBankDriver, EmuProteus2BankDriver, EmuProteusMPSBankDriver, EnsoniqESQ1BankDriver, EnsoniqVFXBankDriver, KawaiK4BankDriver, KawaiK4EffectBankDriver, KawaiK4MultiBankDriver, KawaiK5000BankDriver, KawaiK5000CombiBankDriver, KorgWavestationBankPatchDriver, KorgWavestationBankPerformanceDriver, KorgX3BankDriver, Line6BassPodBankDriver, Line6Pod20BankDriver, MIDIboxFMBankDriver, MIDIboxSIDBankDriver, MKS50PatchBankDriver, MKS50ToneBankDriver, NL2PerfBankDriver, NLDrumBankDriver, NLPatchBankDriver, NLPerfBankDriver, NovationNova1BankDriver, NovationNova1SinglePerformanceDriver, NovationXioSynthBankDriver, OberheimMatrixBankDriver, P600ProgBankDriver, PeaveyPC1600BankDriver, QuasimidiQuasarBankDriver, RocktronIntellifexBankDriver, RolandD10PatchBankDriver, RolandD10RythmSetupBankDriver, RolandD10TimbreBankDriver, RolandD10ToneBankDriver, RolandGP16AllDriver, RolandGP16BankDriver, RolandGP16GroupDriver, RolandJD800BankDriver, RolandJV80BankDriver, RolandMT32PatchMemoryBankDriver, RolandMT32PatchTempBankDriver, RolandMT32TimbreMemoryBankDriver, RolandMT32TimbreTempBankDriver, RolandVG88BankDriver, RolandXV5080PatchBankDriver, RolandXV5080PerfBankDriver, SPD11DumpAllDriver, SPD11PatchDriver, TCElectronicGMajorBankDriver, TD6BankDriver, VAmp2BankDriver, VirusMultiBankDriver, VirusProgBankDriver, WaldorfMW2BankDriver, XMLBankDriver, YamahaCS2xBank2Driver, YamahaCS2xBankDriver, YamahaDX100BankDriver, YamahaFS1RBankDriver, YamahaSY77VoiceBankDriver, YamahaTG100BankDriver, YamahaTG33BankDriver, YamahaTX81zBankDriver, YamahaUB99BankDriver

public abstract class AbstractBankDriver
extends AbstractDriver
implements IBankDriver

This is an implementation of IBankDriver and the base class for bank drivers which use Patch.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	singleSize The size of the patches which go in this bank.
protected String	singleSysexID The Sysex header for the patches which go in this bank.

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
AbstractBankDriver(String patchType, String authors, int numPatches, int numColumns) Creates a new BankDriver instance.

Method Summary

Modifier and Type	Method and Description
boolean	canHoldPatch(Patch p) Compares the header & size of a Single Patch to this driver to see if this bank can hold the patch.
protected BankPatch	createNewPatch() Create a new Patch.
void	deletePatch(Patch single, int patchNum) Delete a patch.
JSLFrame	editPatch(Patch bank) Creates a default bank editor window to edit this bank.
int	getNumColumns()
int	getNumPatches()
String	getPatchName(Patch bank) Get name of the bank.
int	getSingleSize()
String	getSingleSysexID()
boolean	hasEditor()
boolean	isBankDriver() Returns whether this driver is a Bank Driver.
boolean	isConverter() Returns whether this driver is a Converter.
boolean	isSingleDriver() Returns whether this driver is a Single Driver.
void	setPatchName(Patch bank, String name) Set name of the bank.
void	setSingleSize(int singleSize)
void	setSingleSysexID(String singleSysexID)
void	storePatch(Patch bank, int bankNum, int patchNum) Store the bank to a given bank on the synth.

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

calculateChecksum, 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, requestPatchDump, send, send, send, send, sendPatch, sendPatchWorker, setBankNum, setBankNumbers, setChecksumEnd, setChecksumOffset, setChecksumStart, setDevice, setDeviceIDoffset, setPatchNameSize, setPatchNameStart, setPatchNum, setPatchNumbers, setPatchSize, setSysexID, setSysexRequestDump, setTrimSize, supportsPatch, 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.IBankDriver

getPatch, getPatchName, putPatch, setPatchName

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

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

Field Detail

singleSysexID

protected String singleSysexID

The Sysex header for the patches which go in this bank. This should be same value as the sysexID field of the single driver. It can be up to 16 bytes and have wildcards (*). (ex. "F041.*003F12")

See Also:

AbstractDriver.sysexID, canHoldPatch(org.jsynthlib.patch.model.impl.Patch)

singleSize

protected int singleSize

The size of the patches which go in this bank.

See Also:

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

Constructor Detail

AbstractBankDriver

public AbstractBankDriver(String patchType,
                          String authors,
                          int numPatches,
                          int numColumns)

Creates a new BankDriver instance.

Parameters:

patchType - The patch type. eg. "Bank", "Multi Bank", "Drum Bank", etc.

authors - The names of the authors of this driver.

numPatches - The Number of Patches the Bank holds.

numColumns - How many columns to use when displaying the patches as a table.

Method Detail

isSingleDriver

public final boolean isSingleDriver()

Description copied from interface: IDriver

Returns whether this driver is a Single Driver.

Specified by:

isSingleDriver in interface IDriver

isBankDriver

public final boolean isBankDriver()

Description copied from interface: IDriver

Returns whether this driver is a Bank Driver.

Specified by:

isBankDriver in interface IDriver

isConverter

public final boolean isConverter()

Description copied from interface: IDriver

Returns whether this driver is a Converter. Equivalent with instanceof IConverter. Note that there can be a Driver which are both Single Driver and Converter.

Specified by:

isConverter in interface IDriver

See Also:

IConverter

storePatch

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

Store the bank to a given bank on the synth. Ignores the patchNum parameter. Should probably be overridden in most drivers

Specified by:

storePatch in interface IDriver

See Also:

Patch.send(int, int)

hasEditor

public boolean hasEditor()

Specified by:

hasEditor in interface IDriver

See Also:

Patch.hasEditor()

editPatch

public JSLFrame editPatch(Patch bank)

Creates a default bank editor window to edit this bank.

Specified by:

editPatch in interface IDriver

See Also:

Patch.edit()

getPatchName

public String getPatchName(Patch bank)

Get name of the bank.

Specified by:

getPatchName in interface IDriver

See Also:

Patch.getName()

setPatchName

public void setPatchName(Patch bank,
                         String name)

Set name of the bank.

Specified by:

setPatchName in interface IDriver

See Also:

Patch.setName(String)

getNumPatches

public final int getNumPatches()

Specified by:

getNumPatches in interface IBankDriver

See Also:

Patch#getNumPatches()

getNumColumns

public final int getNumColumns()

Specified by:

getNumColumns in interface IBankDriver

See Also:

Patch#getNumColumns()

canHoldPatch

public boolean canHoldPatch(Patch p)

Compares the header & size of a Single Patch to this driver to see if this bank can hold the patch.

Specified by:

canHoldPatch in interface IBankDriver

See Also:

Patch#put(Patch, int), AbstractDriver.supportsPatch(java.lang.String, byte[])

deletePatch

public void deletePatch(Patch single,
                        int patchNum)

Delete a patch.

Specified by:

deletePatch in interface IBankDriver

See Also:

Patch#delete(int)

createNewPatch

protected BankPatch createNewPatch()

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()

getSingleSysexID

public String getSingleSysexID()

setSingleSysexID

public void setSingleSysexID(String singleSysexID)

getSingleSize

public int getSingleSize()

setSingleSize

public void setSingleSize(int singleSize)