uk.co.xfactorylibrarians.coremidi4j

Class CoreMidiClient

java.lang.Object

uk.co.xfactorylibrarians.coremidi4j.CoreMidiClient

public class CoreMidiClient
extends Object

CoreMidiClient class

Field Summary

Fields

Modifier and Type	Field and Description
private AtomicInteger	callbackCount Used to count the number of CoreMidi environment change callbacks we have received, so that if additional ones come in while we are delivering callback messages to our listeners, we know to start another round at the end.
private int	midiClientReference
private CoreMidiNotification	mostRecentDeviceProvider Keeps track of the latest CoreMidiDeviceProvider added to our listener list; this is the only one that we want to call when the MIDI environment changes, since we only need to update the device map once, and Java creates a vast number of instances of our device provider.
private Set<CoreMidiNotification>	notificationListeners
private AtomicBoolean	runningCallbacks The message callback for receiving notifications about changes in the MIDI environment from the JNI code.

Constructor Summary

Constructors

Constructor and Description
CoreMidiClient(String name) Constructor for class

Method Summary

Modifier and Type	Method and Description
void	addNotificationListener(CoreMidiNotification listener) Adds a notification listener to the listener set maintained by this class
private int	createClient(String clientName) Creates the MIDI Client
private void	deliverCallbackToListeners() Check whether we are already in the process of delivering callbacks to our listeners; if not, start a background thread to do so, and at the end of that process, see if additional callbacks were attempted while it was going on.
private void	disposeClient(int clientReference) Disposes of a CoreMIDI Client
CoreMidiInputPort	inputPortCreate(String name) Creates a new CoreMidiInputPort
void	notifyCallback() The message callback for receiving notifications about changes in the MIDI environment from the JNI code
CoreMidiOutputPort	outputPortCreate(String name) Creates a new CoreMidiOutputPort
void	removeNotificationListener(CoreMidiNotification listener) Removes a notification listener from the listener set maintained by this class

Methods inherited from class java.lang.Object

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

Field Detail

midiClientReference

private final int midiClientReference

notificationListeners

private final Set<CoreMidiNotification> notificationListeners

mostRecentDeviceProvider

private CoreMidiNotification mostRecentDeviceProvider

Keeps track of the latest CoreMidiDeviceProvider added to our listener list; this is the only one that we want to call when the MIDI environment changes, since we only need to update the device map once, and Java creates a vast number of instances of our device provider.

runningCallbacks

private final AtomicBoolean runningCallbacks

The message callback for receiving notifications about changes in the MIDI environment from the JNI code.

A reference to this method is created by the C++ method Java_uk_co_xfactorylibrarians_coremidi4j_CoreMidiClient_createClient which in turn is called by createClient(String).

Used to make sure we are only running one callback delivery loop at a time without having to serialize the process in a way that will block the actual CoreMidi callback.

callbackCount

private final AtomicInteger callbackCount

Used to count the number of CoreMidi environment change callbacks we have received, so that if additional ones come in while we are delivering callback messages to our listeners, we know to start another round at the end.

Constructor Detail

CoreMidiClient

public CoreMidiClient(String name)
               throws CoreMidiException

Constructor for class

Parameters:

name - The name of the client

Throws:

CoreMidiException - if the client cannot be initialized

Method Detail

inputPortCreate

public CoreMidiInputPort inputPortCreate(String name)
                                  throws CoreMidiException

Creates a new CoreMidiInputPort

Parameters:

name - The name of the port

Returns:

A new CoreMidiInputPort

Throws:

CoreMidiException - if the port cannot be created

outputPortCreate

public CoreMidiOutputPort outputPortCreate(String name)
                                    throws CoreMidiException

Creates a new CoreMidiOutputPort

Parameters:

name - The name of the port

Returns:

A new CoreMidiOutputPort

Throws:

CoreMidiException - if the port cannot be created

deliverCallbackToListeners

private void deliverCallbackToListeners()

Check whether we are already in the process of delivering callbacks to our listeners; if not, start a background thread to do so, and at the end of that process, see if additional callbacks were attempted while it was going on.

notifyCallback

public void notifyCallback()
                    throws CoreMidiException

The message callback for receiving notifications about changes in the MIDI environment from the JNI code

Throws:

CoreMidiException - if a problem occurs passing along the notification

addNotificationListener

public void addNotificationListener(CoreMidiNotification listener)

Adds a notification listener to the listener set maintained by this class

Parameters:

listener - The CoreMidiNotification listener to add

removeNotificationListener

public void removeNotificationListener(CoreMidiNotification listener)

Removes a notification listener from the listener set maintained by this class

Parameters:

listener - The CoreMidiNotification listener to remove

createClient

private int createClient(String clientName)
                  throws CoreMidiException

Creates the MIDI Client

Parameters:

clientName - The name of the client

Returns:

A reference to the MIDI client

Throws:

CoreMidiException - if the client cannot be created

disposeClient

private void disposeClient(int clientReference)
                    throws CoreMidiException

Disposes of a CoreMIDI Client

Parameters:

clientReference - The reference of the client to dispose of

Throws:

CoreMidiException - if there is a problem disposing of the client