net.kreatious.pianoleopard.midi

Class OutputModel

java.lang.Object

net.kreatious.pianoleopard.midi.OutputModel

All Implemented Interfaces:

AutoCloseable

public class OutputModel
extends Object
implements AutoCloseable

Model for the MIDI output sequencer, allows controllers to listen for events.

Author:

Jay-R Studer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OutputModel.EventAction Indicates which action to take in response to an event handler.

Constructor Summary

Constructors

Constructor and Description
OutputModel(net.kreatious.pianoleopard.midi.SequencerFactory sequencerFactory) Constructs a new OutputModel with the specified initial state.

Method Summary

Modifier and Type	Method and Description
void	addCloseable(Closeable closeable) Adds a closeable to close when this output model is closed.
void	addCurrentTimeListener(LongConsumer listener) Adds a listener to notify when the current playback time in microseconds has changed.
void	addEventHandler(BiFunction<MidiMessage,Optional<Event>,OutputModel.EventAction> handler) Adds an event handler to handle MIDI events.
void	addOpenListener(Consumer<? super ParsedSequence> listener) Adds a listener to notify when a parsed MIDI file is opened.
void	addOutputDeviceListener(Consumer<? super MidiDevice.Info> listener) Adds a listener to notify when the output device has changed.
void	addPlayListener(Runnable listener) Adds a listener to notify when a parsed MIDI file is played from the beginning.
void	close()
void	openMidiFile(File midi) Parses a MIDI file and prepares it for playback.
void	sendMessage(MidiMessage message) Sends a MIDI message to the output.
void	setCurrentTime(long time) Seeks the sequence to the specified time
void	setOutputDevice(MidiDevice output) Reconnects the sequencer to a different MIDI output device.
void	setTempoFactor(float factor) Adjusts the tempo of played back sequences.
void	start() Starts playback of the currently loaded MIDI file.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputModel

public OutputModel(net.kreatious.pianoleopard.midi.SequencerFactory sequencerFactory)
            throws MidiUnavailableException

Constructs a new OutputModel with the specified initial state.

The output model is initially unconnected to any MIDI devices. After construction, it is expected that an output device will be set by the consumer.

Parameters:

sequencerFactory - A factory for producing the Sequencer, such as SystemSequencerFactory.

Throws:

MidiUnavailableException - if the MIDI system is unavailable.

Method Detail

setOutputDevice

public void setOutputDevice(MidiDevice output)
                     throws MidiUnavailableException

Reconnects the sequencer to a different MIDI output device.

Parameters:

output - the new output MIDI device to reconnect to

Throws:

MidiUnavailableException - if the MIDI system is unavailable.

start

public void start()

Starts playback of the currently loaded MIDI file.

Any registered start listeners will be called with the last opened MIDI sequence.

setTempoFactor

public void setTempoFactor(float factor)

Adjusts the tempo of played back sequences.

Values higher than 1.0 are faster than normal, less than 1.0 are slower than normal. A value of 1.0 indicates that the regular tempo should be applied. Tempo factors do not affect the microsecond values of MIDI events.

Parameters:

factor - the tempo factor to set

setCurrentTime

public void setCurrentTime(long time)

Seeks the sequence to the specified time

Parameters:

time - the time in microseconds to seek to

openMidiFile

public void openMidiFile(File midi)
                  throws IOException

Parses a MIDI file and prepares it for playback.

Any registered start listeners will be called with the parsed sequence. The file of the parsed sequence will be the specified MIDI file.

Parameters:

midi - the MIDI file to open

Throws:

IOException - if an I/O error occurs

addOutputDeviceListener

public void addOutputDeviceListener(Consumer<? super MidiDevice.Info> listener)

Adds a listener to notify when the output device has changed.

Parameters:

listener - the listener to add

addOpenListener

public void addOpenListener(Consumer<? super ParsedSequence> listener)

Adds a listener to notify when a parsed MIDI file is opened.

Parameters:

listener - the listener to add

addPlayListener

public void addPlayListener(Runnable listener)

Adds a listener to notify when a parsed MIDI file is played from the beginning.

Parameters:

listener - the listener to add

addEventHandler

public void addEventHandler(BiFunction<MidiMessage,Optional<Event>,OutputModel.EventAction> handler)

Adds an event handler to handle MIDI events.

The return value of the handler determines the action to take. A list of actions is provided on OutputModel.EventAction. The default action is to play the event.

Event handlers are allowed to mutate the channel of the MidiMessage object before returning. The Event object contains the original message before any mutations are applied. Handlers are encouraged to use the Event object whenever possible.

Parameters:

handler - the event handler to add.

addCurrentTimeListener

public void addCurrentTimeListener(LongConsumer listener)

Adds a listener to notify when the current playback time in microseconds has changed.

This listener is called asynchronously several times per second for the lifetime of this object from a different thread than the one which invokes this method.

Parameters:

listener - the listener to add

addCloseable

public void addCloseable(Closeable closeable)

Adds a closeable to close when this output model is closed.

Used for releasing resources closely tied with the lifetime of this output model. Resources will be released in the same order they are registered.

Parameters:

closeable - the closeable to add

sendMessage

public void sendMessage(MidiMessage message)

Sends a MIDI message to the output.

Parameters:

message - the MIDI message to send to the connected output device

close

public void close()
           throws InterruptedException,
                  IOException

Specified by:

close in interface AutoCloseable

Throws:

InterruptedException

IOException