org.openksavi.sponge.midi

Class MidiUtils

java.lang.Object

org.openksavi.sponge.midi.MidiUtils

public abstract class MidiUtils
extends Object

A set of MIDI utility methods.

Method Summary

Modifier and Type	Method and Description
static void	close(MidiDevice device) Closes the MIDI device.
static void	close(Receiver receiver) Closes the MIDI receiver.
static void	close(Transmitter transmitter) Closes the MIDI transmitter.
static void	closeTransmitters(MidiDevice device) Closes all transmitter of the device.
static ShortMessage	createShortMessage(int command, int channel, int data1, int data2) Creates a new MIDI short message.
static MidiShortMessageEvent	createShortMessageEvent(MidiPlugin midiPlugin, ShortMessage message) Create a new Sponge MIDI event.
static MidiShortMessageEvent	createShortMessageEvent(MidiPlugin midiPlugin, ShortMessage message, long timeStamp) Create a new Sponge MIDI event.
static MidiChannel	getChannel(Synthesizer synthesizer, int channel, boolean required) Returns the MIDI channel.
static MidiDevice	getDefaultInputDevice() Returns the default input MIDI device.
static MidiDevice	getDevice(Predicate<? super MidiDevice> predicate) Searches for a MIDI device by a predicate.
static MidiDevice	getDeviceByName(String name) Returns the MIDI device by name.
static Map<MidiDevice.Info,MidiDevice>	getDeviceMap() Returns the map of all available MIDI devices.
static List<MidiDevice>	getDevices() Returns all available MIDI devices.
static int	getFirstSupportedMidiFileType(Sequence sequence) Returns the first supported MIDI file type.
static Instrument	getInstrument(Synthesizer synthesizer, int channel) Returns the MIDI instrument.
static List<Instrument>	getInstruments(Synthesizer synthesizer) Returns the synthesizer loaded instruments.
static String	getKeyNote(int key) Returns the note representation for the given MIDI key.
static boolean	loadAllInstruments(Synthesizer synthesizer) Loads all instruments to the synthesizer from the default soundbank.
static boolean	loadAllInstruments(Synthesizer synthesizer, Soundbank soundbank) Loads all instruments to the synthesizer from the soundbank.
static Instrument	loadInstrument(Synthesizer synthesizer, String instrumentName) Loads a MIDI instrument by name.
static void	open(MidiDevice device) Opens the MIDI device.
static Instrument	setInstrument(Synthesizer synthesizer, int channel, int instrument) Sets the synthesizer instrument from the currently selected bank of instruments.
static Instrument	setInstrument(Synthesizer synthesizer, int channel, String instrumentName) Sets the synthesizer instrument from the currently selected bank of instruments.
static void	setMute(Sequencer sequencer, Sequence sequence, boolean mute) Sets the mute flag for all tracks in the sequence.

Methods inherited from class java.lang.Object

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

Method Detail

getDevices

public static List<MidiDevice> getDevices()

Returns all available MIDI devices.

Returns:

all available MIDI devices.

getDefaultInputDevice

public static MidiDevice getDefaultInputDevice()

Returns the default input MIDI device.

Returns:

the default input MIDI device or null if not found.

getDeviceByName

public static MidiDevice getDeviceByName(String name)

Returns the MIDI device by name.

Parameters:

name - the MIDI device name.

Returns:

the MIDI device or null if not found.

getDevice

public static MidiDevice getDevice(Predicate<? super MidiDevice> predicate)

Searches for a MIDI device by a predicate.

Parameters:

predicate - the predicate.

Returns:

the MIDI device or null if not found.

getDeviceMap

public static Map<MidiDevice.Info,MidiDevice> getDeviceMap()

Returns the map of all available MIDI devices.

Returns:

the map of all available MIDI devices.

open

public static void open(MidiDevice device)

Opens the MIDI device.

Parameters:

device - the MIDI device.

close

public static void close(MidiDevice device)

Closes the MIDI device.

Parameters:

device - the MIDI device.

close

public static void close(Transmitter transmitter)

Closes the MIDI transmitter.

Parameters:

transmitter - the MIDI transmitter.

close

public static void close(Receiver receiver)

Closes the MIDI receiver.

Parameters:

receiver - the MIDI receiver.

createShortMessage

public static 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.

setMute

public static void setMute(Sequencer sequencer,
                           Sequence sequence,
                           boolean mute)

Sets the mute flag for all tracks in the sequence.

Parameters:

sequencer - the sequencer.

sequence - the sequence.

mute - the mute flag.

createShortMessageEvent

public static MidiShortMessageEvent createShortMessageEvent(MidiPlugin midiPlugin,
                                                            ShortMessage message,
                                                            long timeStamp)

Create a new Sponge MIDI event.

Parameters:

midiPlugin - the MIDI plugin.

message - the MIDI short message.

timeStamp - the MIDI timestamp.

Returns:

the Sponge MIDI event.

createShortMessageEvent

public static MidiShortMessageEvent createShortMessageEvent(MidiPlugin midiPlugin,
                                                            ShortMessage message)

Create a new Sponge MIDI event.

Parameters:

midiPlugin - the MIDI plugin.

message - the MIDI short message.

Returns:

the Sponge MIDI event.

getKeyNote

public static String getKeyNote(int key)

Returns the note representation for the given MIDI key. Middle C (key 60) is represented as C5.

Parameters:

key - the MIDI key.

Returns:

the note representation.

loadInstrument

public static Instrument loadInstrument(Synthesizer synthesizer,
                                        String instrumentName)

Loads a MIDI instrument by name. Throws exception if not found.

Parameters:

synthesizer - the synthesizer.

instrumentName - the instrument name.

Returns:

the instrument or null if the instrument couldn't be loaded.

getChannel

public static MidiChannel getChannel(Synthesizer synthesizer,
                                     int channel,
                                     boolean required)

Returns the MIDI channel.

Parameters:

synthesizer - the synthesizer.

channel - the channel number.

required - if true then throws exception when not found or not available. Otherwise returns null.

Returns:

the MIDI channel.

getInstrument

public static Instrument getInstrument(Synthesizer synthesizer,
                                       int channel)

Returns the MIDI instrument.

Parameters:

synthesizer - the synthesizer.

channel - the channel number.

Returns:

the MIDI instrument.

setInstrument

public static Instrument setInstrument(Synthesizer synthesizer,
                                       int channel,
                                       int instrument)

Sets the synthesizer instrument from the currently selected bank of instruments.

Parameters:

synthesizer - the synthesizer.

channel - the channel.

instrument - the instrument number.

Returns:

the new instrument.

setInstrument

public static Instrument setInstrument(Synthesizer synthesizer,
                                       int channel,
                                       String instrumentName)

Sets the synthesizer instrument from the currently selected bank of instruments.

Parameters:

synthesizer - the synthesizer.

channel - the channel.

instrumentName - the instrument name.

Returns:

the new instrument.

loadAllInstruments

public static boolean loadAllInstruments(Synthesizer synthesizer,
                                         Soundbank soundbank)

Loads all instruments to the synthesizer from the soundbank.

Parameters:

synthesizer - the synthesizer.

soundbank - the soundbank.

Returns:

true on success.

loadAllInstruments

public static boolean loadAllInstruments(Synthesizer synthesizer)

Loads all instruments to the synthesizer from the default soundbank.

Parameters:

synthesizer - the synthesizer.

Returns:

true on success.

getInstruments

public static List<Instrument> getInstruments(Synthesizer synthesizer)

Returns the synthesizer loaded instruments.

Parameters:

synthesizer - the synthesizer.

Returns:

the instruments.

closeTransmitters

public static void closeTransmitters(MidiDevice device)

Closes all transmitter of the device.

Parameters:

device - the MIDI device.

getFirstSupportedMidiFileType

public static int getFirstSupportedMidiFileType(Sequence sequence)

Returns the first supported MIDI file type.

Parameters:

sequence - the sequence;

Returns:

the supported MIDI file type.