org.openksavi.sponge.midi

Class MidiPlugin

java.lang.Object

org.openksavi.sponge.core.engine.BaseEngineModule

org.openksavi.sponge.core.plugin.BasePlugin

org.openksavi.sponge.java.JPlugin

org.openksavi.sponge.midi.MidiPlugin

All Implemented Interfaces:

org.openksavi.sponge.engine.EngineModule, org.openksavi.sponge.plugin.Plugin, org.openksavi.sponge.util.Descriptive, org.openksavi.sponge.util.HasEngine, org.openksavi.sponge.util.Manageable

public class MidiPlugin
extends JPlugin

MIDI plugin.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PLUGIN_NAME The default name of this plugin.

Constructor Summary

Constructors

Constructor and Description
MidiPlugin() Creates a new MIDI plugin.
MidiPlugin(String name) Creates a new MIDI plugin.

Method Summary

Modifier and Type	Method and Description
void	connectDefaultInputDevice() Sets and updates the default input MIDI device in the plugin.
void	connectInputDevice(String deviceName) Sets and updates the input MIDI device in the plugin.
ShortMessage	createShortMessage(int command, int channel, int data1, int data2) Creates a new MIDI short message.
MidiShortMessageEvent	createShortMessageEvent(ShortMessage message) Create a new Sponge MIDI ShortMessage event.
MidiShortMessageEvent	createShortMessageEvent(ShortMessage message, long timeStamp) Create a new Sponge MIDI ShortMessage event.
List<MidiChannel>	getChannels() Returns the synthesizer channels.
MidiDevice	getDefaultInputDevice() Returns the default input MIDI device.
MidiDevice	getDeviceByName(String name) Returns the MIDI device by name.
List<MidiDevice>	getDevices() Returns all available MIDI devices.
MidiDevice	getInputDevice() Returns the input device.
Transmitter	getInputTransmitter() Returns the input device transmitter.
Instrument	getInstrument(int channel) Returns the selected instrument for the specified channel.
List<Instrument>	getInstruments() Returns the loaded synthesizer instruments.
String	getMidiMetaMessageEventName() Returns a name of a MIDI MetaMessage Sponge event sent by this plugin to the engine.
String	getMidiShortMessageEventName() Returns a name of a MIDI ShortMessage Sponge event sent by this plugin to the engine.
String	getMidiSysexMessageEventName() Returns a name of a MIDI SysexMessage Sponge event sent by this plugin to the engine.
Sequencer	getSequencer() Returns the sequencer.
Transmitter	getSequencerTransmitter() Returns the sequencer transmitter.
Synthesizer	getSynthesizer() Returns the synthesizer.
Receiver	getSynthesizerReceiver() Returns the synthesizer receiver.
boolean	isLoadAllInstruments() Returns the load all instruments behavior.
boolean	isSequencerConnectedToSynthesizer() Returns the default sequencer connected to the default synthesizer behavior.
boolean	loadAllInstruments() Loads all instruments in the default soundbank to the synthesizer.
void	logInstruments() Logs available synthesizer instruments.
void	logMidiSystemInfo() Logs MIDI system info (e.g.
void	noteOff(int channel, int data1, int data2) Sends a note off MIDI message to the synthesizer receiver.
void	noteOn(int channel, int data1, int data2) Sends a note on MIDI message to the synthesizer receiver.
void	onConfigure(org.openksavi.sponge.config.Configuration configuration) Applies the XML configuration to this plugin.
void	onShutdown() Shuts down the plugin.
void	onStartup() Starts up this plugin.
void	setInputDevice(MidiDevice inputDevice) Sets the input device.
Instrument	setInstrument(int channel, int instrument) Sets the synthesizer instrument.
Instrument	setInstrument(int channel, String instrumentName) Sets the synthesizer instrument.
void	setLoadAllInstruments(boolean loadAllInstruments) Sets the load all instruments behavior.
void	setMidiMetaMessageEventName(String midiMetaMessageEventName) Sets a name of a MIDI MetaMessage Sponge event sent by this plugin to the engine.
void	setMidiShortMessageEventName(String midiShortMessageEventName) Sets a name of a MIDI ShortMessage Sponge event sent by this plugin to the engine.
void	setMidiSysexMessageEventName(String midiSysexMessageEventName) Sets a name of a MIDI SysexMessage Sponge event sent by this plugin to the engine.
void	setSequencer(Sequencer sequencer) Sets the sequencer.
void	setSequencerConnectedToSynthesizer(boolean sequencerConnectedToSynthesizer) Sets the default sequencer connected to the default synthesizer behavior.
void	setSynthesizer(Synthesizer synthesizer) Sets the synthesizer.
void	sound(int command, int channel, int data1, int data2) Generates a sound by sending the short MIDI message to the synthesizer receiver.
void	sound(MidiMessage message) Generates a sound by sending the MIDI message to the synthesizer receiver.
void	sound(MidiMessage message, long timeStamp) Generates a sound by sending the MIDI message to the synthesizer receiver.
void	startPlay(File midiFile) Starts playing the MIDI file using the sequencer.
void	startPlay(InputStream stream) Starts playing the MIDI file using the sequencer.
void	startPlay(Sequence sequence) Starts playing the MIDI file using the sequencer.
void	startPlay(String midiFileName) Starts playing the MIDI file using the sequencer.
void	startPlay(URL url) Starts playing the MIDI file using the sequencer.
void	stopPlay() Stops playing.
void	update() Updates the plugin state, e.g.
void	updateInputDevice() Updates the input device state.
void	updateSequencer() Updates the sequencer state.
void	updateSynthesizer() Updates the synthesizer state.

Methods inherited from class org.openksavi.sponge.core.plugin.BasePlugin

doShutdown, doStartup, getConfiguration, getEngineOperations, getKnowledgeBase, getLogger, getSponge, onAfterReload, onBeforeReload, onInit, setConfiguration, setKnowledgeBase, shutdown, startup, toString

Methods inherited from class org.openksavi.sponge.core.engine.BaseEngineModule

getDescription, getDisplayName, getEngine, getInternalService, getName, getState, isFailed, isNew, isNewOrStartingOrRunning, isRunning, isStarting, isStopping, isTerminated, setDescription, setDisplayName, setEngine, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openksavi.sponge.util.Manageable

isFailed, isNew, isRunning, isStarting, isStopping, isTerminated

Methods inherited from interface org.openksavi.sponge.util.Descriptive

getDescription, getDisplayName, getName, setDescription, setDisplayName, setName

Methods inherited from interface org.openksavi.sponge.util.HasEngine

getEngine, setEngine

Field Detail

DEFAULT_PLUGIN_NAME

public static final String DEFAULT_PLUGIN_NAME

The default name of this plugin.

See Also:

Constant Field Values

Constructor Detail

MidiPlugin

public MidiPlugin()

Creates a new MIDI plugin.

MidiPlugin

public MidiPlugin(String name)

Creates a new MIDI plugin.

Parameters:

name - the plugin name.

Method Detail

onConfigure

public void onConfigure(org.openksavi.sponge.config.Configuration configuration)

Applies the XML configuration to this plugin.

Specified by:

onConfigure in interface org.openksavi.sponge.plugin.Plugin

Overrides:

onConfigure in class BasePlugin

onStartup

public void onStartup()

Starts up this plugin. Obtains and opens the required MIDI devices and sets up receivers and transmitters. Any setters for MIDI devices must be invoked before the Sponge startup.

Specified by:

onStartup in interface org.openksavi.sponge.plugin.Plugin

Overrides:

onStartup in class BasePlugin

update

public void update()

Updates the plugin state, e.g. device wiring using transmitters and receivers.

updateSequencer

public void updateSequencer()

Updates the sequencer state. This method should be invoked after setting the sequencer in the plugin.

updateSynthesizer

public void updateSynthesizer()

Updates the synthesizer state. This method should be invoked after setting the synthesizer in the plugin.

updateInputDevice

public void updateInputDevice()

Updates the input device state. This method should be invoked after setting the input device in the plugin.

onShutdown

public void onShutdown()

Shuts down the plugin. Closes the MIDI devices.

Specified by:

onShutdown in interface org.openksavi.sponge.plugin.Plugin

Overrides:

onShutdown in class BasePlugin

connectInputDevice

public void connectInputDevice(String deviceName)

Sets and updates the input MIDI device in the plugin. If there has already been connected an another input device then replaces it.

Parameters:

deviceName - the input MIDI device name.

connectDefaultInputDevice

public void connectDefaultInputDevice()

Sets and updates the default input MIDI device in the plugin. If there has already been connected an another input device then replaces it.

getSequencer

public Sequencer getSequencer()

Returns the sequencer.

Returns:

the sequencer.

setSequencer

public void setSequencer(Sequencer sequencer)

Sets the sequencer. If there has already been an another sequencer set then it will be closed.

Parameters:

sequencer - the sequencer.

getSynthesizer

public Synthesizer getSynthesizer()

Returns the synthesizer.

Returns:

the synthesizer.

setSynthesizer

public void setSynthesizer(Synthesizer synthesizer)

Sets the synthesizer. If there has already been an another synthesizer set then it will be closed.

Parameters:

synthesizer - the synthesizer.

getInputDevice

public MidiDevice getInputDevice()

Returns the input device.

Returns:

the input device.

setInputDevice

public void setInputDevice(MidiDevice inputDevice)

Sets the input device. If there has already been an another input device set then it will be closed.

Parameters:

inputDevice - the input device.

getSynthesizerReceiver

public Receiver getSynthesizerReceiver()

Returns the synthesizer receiver.

Returns:

the synthesizer receiver.

getInputTransmitter

public Transmitter getInputTransmitter()

Returns the input device transmitter.

Returns:

the input device transmitter.

getSequencerTransmitter

public Transmitter getSequencerTransmitter()

Returns the sequencer transmitter.

Returns:

the sequencer transmitter.

isSequencerConnectedToSynthesizer

public boolean isSequencerConnectedToSynthesizer()

Returns the default sequencer connected to the default synthesizer behavior.

Returns:

true if the default sequencer will be connected to the default synthesizer (e.g. to generate sound while playing MIDI files)

setSequencerConnectedToSynthesizer

public void setSequencerConnectedToSynthesizer(boolean sequencerConnectedToSynthesizer)

Sets the default sequencer connected to the default synthesizer behavior.

Parameters:

sequencerConnectedToSynthesizer - if true then the default sequencer will be connected to the default synthesizer (e.g. to generate sound while playing MIDI files)

isLoadAllInstruments

public boolean isLoadAllInstruments()

Returns the load all instruments behavior.

Returns:

true if all instruments in the default soundbank will be loaded at startup.

setLoadAllInstruments

public void setLoadAllInstruments(boolean loadAllInstruments)

Sets the load all instruments behavior.

Parameters:

loadAllInstruments - if true then all instruments in the default soundbank will be loaded at startup.

getMidiShortMessageEventName

public String getMidiShortMessageEventName()

Returns a name of a MIDI ShortMessage Sponge event sent by this plugin to the engine.

Returns:

a name of a MIDI ShortMessage Sponge event sent by this plugin to the engine.

setMidiShortMessageEventName

public void setMidiShortMessageEventName(String midiShortMessageEventName)

Sets a name of a MIDI ShortMessage Sponge event sent by this plugin to the engine.

Parameters:

midiShortMessageEventName - a name of a MIDI ShortMessage Sponge event sent by this plugin to the engine.

getMidiSysexMessageEventName

public String getMidiSysexMessageEventName()

Returns a name of a MIDI SysexMessage Sponge event sent by this plugin to the engine.

Returns:

a name of a MIDI SysexMessage Sponge event sent by this plugin to the engine.

setMidiSysexMessageEventName

public void setMidiSysexMessageEventName(String midiSysexMessageEventName)

Sets a name of a MIDI SysexMessage Sponge event sent by this plugin to the engine.

Parameters:

midiSysexMessageEventName - a name of a MIDI SysexMessage Sponge event sent by this plugin to the engine.

getMidiMetaMessageEventName

public String getMidiMetaMessageEventName()

Returns a name of a MIDI MetaMessage Sponge event sent by this plugin to the engine.

Returns:

a name of a MIDI MetaMessage Sponge event sent by this plugin to the engine.

setMidiMetaMessageEventName

public void setMidiMetaMessageEventName(String midiMetaMessageEventName)

Sets a name of a MIDI MetaMessage Sponge event sent by this plugin to the engine.

Parameters:

midiMetaMessageEventName - a name of a MIDI MetaMessage Sponge event sent by this plugin to the engine.

sound

public void sound(MidiMessage message)

Generates a sound by sending the MIDI message to the synthesizer receiver.

Parameters:

message - the MIDI message.

sound

public void sound(MidiMessage message,
                  long timeStamp)

Generates a sound by sending the MIDI message to the synthesizer receiver.

Parameters:

message - the MIDI message.

timeStamp - the message timestamp.

sound

public void sound(int command,
                  int channel,
                  int data1,
                  int data2)

Generates a sound by sending the short MIDI message to the synthesizer receiver.

Parameters:

command - the MIDI message command.

channel - the MIDI message channel.

data1 - the MIDI message data1.

data2 - the MIDI message data2.

noteOn

public void noteOn(int channel,
                   int data1,
                   int data2)

Sends a note on MIDI message to the synthesizer receiver.

Parameters:

channel - the MIDI message channel.

data1 - the MIDI message data1.

data2 - the MIDI message data2.

noteOff

public void noteOff(int channel,
                    int data1,
                    int data2)

Sends a note off MIDI message to the synthesizer receiver.

Parameters:

channel - the MIDI message channel.

data1 - the MIDI message data1.

data2 - the MIDI message data2.

startPlay

public void startPlay(String midiFileName)

Starts playing the MIDI file using the sequencer.

Parameters:

midiFileName - the MIDI file name.

startPlay

public void startPlay(File midiFile)

Starts playing the MIDI file using the sequencer.

Parameters:

midiFile - the MIDI file.

startPlay

public void startPlay(InputStream stream)

Starts playing the MIDI file using the sequencer.

Parameters:

stream - the MIDI file stream.

startPlay

public void startPlay(URL url)

Starts playing the MIDI file using the sequencer.

Parameters:

url - the MIDI file url.

startPlay

public void startPlay(Sequence sequence)

Starts playing the MIDI file using the sequencer.

Parameters:

sequence - the MIDI sequence.

stopPlay

public void stopPlay()

Stops playing.

createShortMessage

public ShortMessage createShortMessage(int command,
                                       int channel,
                                       int data1,
                                       int data2)

Creates a new MIDI short message.

Parameters:

command - the MIDI short message command.

channel - the MIDI short message channel.

data1 - the MIDI short message data1.

data2 - the MIDI short message data2.

Returns:

the MIDI short message.

createShortMessageEvent

public MidiShortMessageEvent createShortMessageEvent(ShortMessage message,
                                                     long timeStamp)

Create a new Sponge MIDI ShortMessage event.

Parameters:

message - the MIDI short message.

timeStamp - the MIDI timestamp.

Returns:

the Sponge MIDI event.

createShortMessageEvent

public MidiShortMessageEvent createShortMessageEvent(ShortMessage message)

Create a new Sponge MIDI ShortMessage event.

Parameters:

message - the MIDI short message.

Returns:

the Sponge MIDI event.

loadAllInstruments

public boolean loadAllInstruments()

Loads all instruments in the default soundbank to the synthesizer.

Returns:

true on success.

setInstrument

public Instrument setInstrument(int channel,
                                int instrument)

Sets the synthesizer instrument.

Parameters:

channel - the channel.

instrument - the instrument number.

Returns:

the new instrument.

setInstrument

public Instrument setInstrument(int channel,
                                String instrumentName)

Sets the synthesizer instrument.

Parameters:

channel - the channel.

instrumentName - the instrument name.

Returns:

the new instrument.

getInstruments

public List<Instrument> getInstruments()

Returns the loaded synthesizer instruments.

Returns:

the instruments.

getInstrument

public Instrument getInstrument(int channel)

Returns the selected instrument for the specified channel.

Parameters:

channel - the channel number.

Returns:

the instrument.

getChannels

public List<MidiChannel> getChannels()

Returns the synthesizer channels.

Returns:

the synthesizer channels.

getDevices

public List<MidiDevice> getDevices()

Returns all available MIDI devices.

Returns:

all available MIDI devices.

getDefaultInputDevice

public MidiDevice getDefaultInputDevice()

Returns the default input MIDI device.

Returns:

the default input MIDI device.

getDeviceByName

public MidiDevice getDeviceByName(String name)

Returns the MIDI device by name.

Parameters:

name - the MIDI device name.

Returns:

the MIDI device.

logMidiSystemInfo

public void logMidiSystemInfo()

Logs MIDI system info (e.g. MIDI devices).

logInstruments

public void logInstruments()

Logs available synthesizer instruments.