org.jsynthlib.midi.service.impl

Class MidiServiceImpl

java.lang.Object

org.jsynthlib.midi.service.impl.MidiServiceImpl

All Implemented Interfaces:

MidiService

@Singleton
public class MidiServiceImpl
extends Object
implements MidiService

MIDI Utility Routines. This class contains methods and inner classes for Java Sound API.

Examples:

MIDI output

 Receiver rcvr = MidiUtil.getReceiver(outport);
 MidiUtil.send(rcvr, msg);
 

MIDI input (System Exclusive Message)

 MidiUtil.clearSysexInputQueue(inport);
 SysexMessage msg = MidiUtil.getMessage(inport, 1000);
 

The example above uses a shared input data queue. See the description for each method and code of Master-In and Fader-In for more details and MIDI short message input.

Version:

$Id: MidiUtil.java 1213 2013-10-14 19:10:42Z packe01 $

Author:

Hiroo Hayashi

See Also:

Java Sound Progremmer Guide

Constructor Summary

Constructors

Constructor and Description
MidiServiceImpl(MidiSettings midiSettings, MidiMonitorService midiMonitorService, AppConfig appConfig)

Method Summary

Modifier and Type	Method and Description
SysexMessage[]	byteArrayToSysexMessages(byte[] d) Converts a byte array into an array of SysexMessages.
void	clearSysexInputQueue(int port) clear MIDI input queue specified.
void	closeAllMidiConnections()
MidiMessage	getMessage(int port, long timeout) get Sysex Message from MIDI input queue.
protected HashMap<AutoCloseable,Integer>	getMidiDeviceReferenceMap()
protected Map<Receiver,String>	getMidiReceiverMap()
protected Map<Transmitter,String>	getMidiTransmitterMap()
Receiver	getReceiver(String portName)
Transmitter	getTransmitter(String portName)
boolean	isSysexInputQueueEmpty(int port) return true when MIDI input queue is empty.
void	releaseReceiver(Receiver receiver)
void	releaseTransmitter(Transmitter transmitter)
void	send(String outPortName, MidiMessage msg, int bufSize, int delay) Send a MidiMessage.
void	setSysexInputQueue(int port) Setup an input queue for MIDI System Exclusive Message input.
void	startSequencer(String myport) Maybe these methods should be in an own class, but currently I put them here.
byte[]	sysexMessagesToByteArray(SysexMessage[] msgs) Convert an array of SysexMessage to a byte array.

Methods inherited from class java.lang.Object

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

Constructor Detail

MidiServiceImpl

@Inject
public MidiServiceImpl(MidiSettings midiSettings,
                                MidiMonitorService midiMonitorService,
                                AppConfig appConfig)

Method Detail

setSysexInputQueue

public void setSysexInputQueue(int port)

Description copied from interface: MidiService

Setup an input queue for MIDI System Exclusive Message input. The input queue is shared. If the input queue is already opened, nothing is done.

Specified by:

setSysexInputQueue in interface MidiService

See Also:

MidiService.clearSysexInputQueue(int)

clearSysexInputQueue

public void clearSysexInputQueue(int port)

Description copied from interface: MidiService

clear MIDI input queue specified. Internally setSysexInputQueue(port) is called.

Specified by:

clearSysexInputQueue in interface MidiService

See Also:

MidiService.setSysexInputQueue(int)

isSysexInputQueueEmpty

public boolean isSysexInputQueueEmpty(int port)

Description copied from interface: MidiService

return true when MIDI input queue is empty.

Specified by:

isSysexInputQueueEmpty in interface MidiService

See Also:

MidiService.clearSysexInputQueue(int)

getMessage

public MidiMessage getMessage(int port,
                              long timeout)
                       throws TimeoutException,
                              InvalidMidiDataException

Description copied from interface: MidiService

get Sysex Message from MIDI input queue.

Specified by:

getMessage in interface MidiService

Throws:

TimeoutException

InvalidMidiDataException

See Also:

MidiService.clearSysexInputQueue(int)

byteArrayToSysexMessages

public SysexMessage[] byteArrayToSysexMessages(byte[] d)
                                        throws InvalidMidiDataException

Description copied from interface: MidiService

Converts a byte array into an array of SysexMessages. Each SysexMessage must be terminated by END_OF_EXCLUSIVE.

This method is provided to keep compatibility with the old MIDI layer which handled MIDI data in byte array. It is more efficient to create SysexMessages directly because a synth driver knows the start index and length of each Sysex data in an array.

Specified by:

byteArrayToSysexMessages in interface MidiService

Throws:

InvalidMidiDataException

sysexMessagesToByteArray

public byte[] sysexMessagesToByteArray(SysexMessage[] msgs)

Description copied from interface: MidiService

Convert an array of SysexMessage to a byte array.

Specified by:

sysexMessagesToByteArray in interface MidiService

Parameters:

msgs - an array of SysexMessage.

Returns:

byte array of System Exclusive data.

getReceiver

public Receiver getReceiver(String portName)
                     throws MidiUnavailableException

Specified by:

getReceiver in interface MidiService

Throws:

MidiUnavailableException

releaseReceiver

public void releaseReceiver(Receiver receiver)
                     throws MidiUnavailableException

Specified by:

releaseReceiver in interface MidiService

Throws:

MidiUnavailableException

getTransmitter

public Transmitter getTransmitter(String portName)
                           throws MidiUnavailableException

Specified by:

getTransmitter in interface MidiService

Throws:

MidiUnavailableException

releaseTransmitter

public void releaseTransmitter(Transmitter transmitter)
                        throws MidiUnavailableException

Specified by:

releaseTransmitter in interface MidiService

Throws:

MidiUnavailableException

send

public void send(String outPortName,
                 MidiMessage msg,
                 int bufSize,
                 int delay)
          throws MidiUnavailableException,
                 InvalidMidiDataException

Description copied from interface: MidiService

Send a MidiMessage. A Sysex Message is divided into several Sysex Messages whose size is bufSize.

Specified by:

send in interface MidiService

Parameters:

outPortName - MIDI out port name

msg - MIDI Message

bufSize - MIDI message size. If zero, whole MIDI message is passed to lower MIDI driver.

delay - delay (msec) after every MIDI message transfer.

Throws:

MidiUnavailableException

InvalidMidiDataException

startSequencer

public void startSequencer(String myport)

Description copied from interface: MidiService

Maybe these methods should be in an own class, but currently I put them here. ttittmann 01.Aug.2004

Specified by:

startSequencer in interface MidiService

closeAllMidiConnections

public void closeAllMidiConnections()

Specified by:

closeAllMidiConnections in interface MidiService

getMidiReceiverMap

protected Map<Receiver,String> getMidiReceiverMap()

getMidiTransmitterMap

protected Map<Transmitter,String> getMidiTransmitterMap()

getMidiDeviceReferenceMap

protected HashMap<AutoCloseable,Integer> getMidiDeviceReferenceMap()