org.jsynthlib.device.model

Class AbstractPatchDriver

java.lang.Object

org.jsynthlib.device.model.AbstractDriver

org.jsynthlib.device.model.AbstractPatchDriver

All Implemented Interfaces:

IDriver, IPatchDriver

Direct Known Subclasses:

AbstractRolandJV80Driver, AlesisA6MixSingleDriver, AlesisA6PgmSingleDriver, AlesisDM5PrChgDriver, AlesisDM5SgSetDriver, AlesisDM5SysInfoDriver, AlesisDM5TrSetDriver, AlesisDMProDrumKitDriver, AlesisDMProEffectDriver, AlesisQSEffectsDriver, AlesisQSGlobalDriver, AlesisQSMixDriver, AlesisQSProgramDriver, BossDR660DrumkitDriver, CasioCZ1000SingleDriver, DX7FamilyAdditionalVoiceSingleDriver, DX7FamilyFractionalScalingSingleDriver, DX7FamilyMicroTuningSingleDriver, DX7FamilyPerformanceIIISingleDriver, DX7FamilyPerformanceIISingleDriver, DX7FamilyPerformanceSingleDriver, DX7FamilySystemSetupIIDriver, DX7FamilySystemSetupIIIDriver, DX7FamilyVoiceSingleDriver, EmuProteusMPSSingleDriver, EnsoniqVFXMultiDriver, EnsoniqVFXSingleDriver, KawaiK4DrumsetDriver, KawaiK4EffectDriver, KawaiK4MultiDriver, KawaiK4SingleDriver, KawaiK5000ADDSingleDriver, KawaiK5000CombiDriver, KorgER1SingleDriver, KorgWavestationMicroTuneScaleDriver, KorgWavestationMultiModeSetupDriver, KorgWavestationPerformanceMapDriver, KorgWavestationSinglePatchDriver, KorgWavestationSinglePerformanceDriver, KorgWavestationSystemSetupDriver, KorgWavestationWaveSequenceDriver, KorgX3SingleDriver, Line6BassPodSingleDriver, Line6Pod20SingleDriver, MIDIboxFMSingleDriver, MIDIboxSIDSingleDriver, MKS50PatchSingleDriver, MKS50ToneSingleDriver, MKS7ToneSingleDriver, NL2PerfSingleDriver, NLDrumSingleDriver, NLPatchSingleDriver, NLPerfSingleDriver, NovationNova1SingleDriver, NovationSBSProgramDriver, NovationXioSynthSingleDriver, OberheimMatrixSingleDriver, P600ProgSingleDriver, PeaveyPC1600SingleDriver, QuasimidiQuasarSingleDriver, RocktronIntellifexPresetDriver, RocktronIntellifexS81Driver, RocktronIntellifexS82Driver, RolandD10PatchDriver, RolandD10RythmSetupDriver, RolandD10TimbreDriver, RolandD10ToneDriver, RolandGP16SingleDriver, RolandJD800SinglePatchDriver, RolandJD800SystemArea, RolandMT32DisplayDriver, RolandMT32PatchMemoryDriver, RolandMT32PatchTempDriver, RolandMT32RhythmSetupTempDriver, RolandMT32SystemDriver, RolandMT32TimbreMemoryDriver, RolandMT32TimbreTempDriver, RolandVG88SingleDriver, RolandVG88SysDatDriver, RolandXV5080PatchDriver, RolandXV5080PerfDriver, SPD11ChainDriver, SPD11PadDriver, SPD11Patch2Driver, SPD11SettingsDriver, SPD11SystemDriver, TCElectronicGMajorSingleDriver, TCElectronicM350SingleDriver, TD6SingleDriver, VAmp2SingleDriver, VirusMultiSingleDriver, VirusProgSingleDriver, WaldorfMW2SingleDriver, WaldorfPulseSingleDriver, XMLPatchDriver, Yamaha01vCtrlChangeTabDriver, Yamaha01vDynamicsDriver, Yamaha01vEffectDriver, Yamaha01vEqDriver, Yamaha01vPrChangeTabDriver, Yamaha01vRemoteIntDriver, Yamaha01vRemoteMMCDriver, Yamaha01vRemoteUserDriver, Yamaha01vSceneDriver, Yamaha01vSetupDriver, YamahaCS2xCommonDriver, YamahaCS2xLayerDriver, YamahaCS2xLayersDriver, YamahaCS2xPerformanceDriver, YamahaCS2xSystemDriver, YamahaDX100SingleDriver, YamahaFS1RFseqDriver, YamahaFS1RPerformanceDriver, YamahaFS1RSystemDriver, YamahaFS1RVoiceDriver, YamahaMotifSingleDriver, YamahaSY77KSeqDriver, YamahaSY77NSeqDriver, YamahaSY77VoiceDriver, YamahaSY85SingleDriver, YamahaTG100SingleDriver, YamahaTG33SingleDriver, YamahaTX81zSingleDriver, YamahaUB99Driver

public abstract class AbstractPatchDriver
extends AbstractDriver
implements IPatchDriver

This is an implementation of ISingleDriver and the base class for single drivers which use Patch.

Compatibility Note: The following fields are now private. Use setter/getter method to access them.

   device, patchType, authors
 

Compatibility Note: The following fields are now obsoleted. Use a getter method to access them. The getter method queries parent Device object.

   deviceNum, driverNum,
   channel, port, inPort, manufacturer, model, inquiryID, id
 

Compatibility Note: SysexHandler.send(getPort(), sysex); or PatchEdit.MidiOut.writeLongMessage(getPort(), sysex); was replaced by send(sysex);

Version:

$Id: Driver.java 1085 2007-10-01 23:47:28Z billzwicky $

Author:

Brian Klock

See Also:

Patch

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
AbstractPatchDriver(String authors)
AbstractPatchDriver(String patchType, String authors) Creates a new Driver instance.

Method Summary

Modifier and Type	Method and Description
JSLFrame	editPatch(Patch p) Override this if your driver implement Patch Editor.
protected String	getFullPatchName(Patch p) Returns String ..
String	getPatchName(Patch p) Gets the name of the patch from the sysex.
String[]	getPatchNumbersForStore() Returns String[] list of patch numbers for writable patches.
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 p, String name) Set the name of the patch in the sysex.
void	storePatch(Patch p, int bankNum, int patchNum) Sends a patch to a set location on a synth.

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

calculateChecksum, calculateChecksum, calculateChecksum, canCreatePatch, createNewPatch, 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.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

Constructor Detail

AbstractPatchDriver

public AbstractPatchDriver(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.

AbstractPatchDriver

public AbstractPatchDriver(String authors)

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

getPatchNumbersForStore

public String[] getPatchNumbersForStore()

Description copied from interface: IPatchDriver

Returns String[] list of patch numbers for writable patches. This can be overridden if some patch locations are read only. e.g. the Waldorf Pulse has 100 patches, but only 0 to 39 are writable. Currently writable patches are assumed to start at patch location 0. (This has nothing to with the "Storable" class in JSynthLib.)

Specified by:

getPatchNumbersForStore in interface IPatchDriver

See Also:

DriverUtil#generateNumbers

getPatchName

public String getPatchName(Patch p)

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

See Also:

Patch.getName()

setPatchName

public void setPatchName(Patch p,
                         String name)

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

Specified by:

setPatchName in interface IDriver

See Also:

Patch.setName(String)

storePatch

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

Sends a patch to a set location on a synth.

Override this if required.

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

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

Specified by:

editPatch in interface IDriver

See Also:

Patch.edit()

getFullPatchName

protected String getFullPatchName(Patch p)

Returns String .. full name for referring to this patch for debugging purposes.