org.midica.ui.player

Class PlayerController

java.lang.Object

org.midica.ui.player.PlayerController

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.ItemListener, java.awt.event.MouseWheelListener, java.awt.event.WindowListener, java.util.EventListener, javax.swing.event.ChangeListener, javax.swing.event.DocumentListener

public class PlayerController
extends java.lang.Object
implements java.awt.event.ActionListener, java.awt.event.WindowListener, javax.swing.event.ChangeListener, javax.swing.event.DocumentListener, java.awt.event.MouseWheelListener, java.awt.event.ItemListener

This class provides the controller of the player window.

It listens and reacts to events in the PlayerView.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	currentFile
private ErrorMsgView	errorMsg
private SequenceParser	parser
private RefresherThread	refresher
private PlayerView	view

Constructor Summary

Constructors

Constructor and Description
PlayerController(PlayerView view, SequenceParser parser, java.io.File currentFile) Creates a new listener object for the player and a RefresherThread, refreshing the progress slider.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Handles all action events that have happened in the player window.
void	changedUpdate(javax.swing.event.DocumentEvent e) Checks text field contents after a change (by calling handleTextFieldChanges(DocumentEvent)).
void	endOfSequence() Makes the play/pause button ready to begin playing again - called if the end of the MIDI sequence is reached.
private void	handleTextFieldChanges(javax.swing.event.DocumentEvent e) Handles change events in text fields by checking the changed content.
void	insertUpdate(javax.swing.event.DocumentEvent e) Checks text field contents after a change (by calling handleTextFieldChanges(DocumentEvent)).
void	itemStateChanged(java.awt.event.ItemEvent e) Handles checkbox changes.
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e) Handles mouse wheel scrolling over a MidicaSlider.
private void	performControlCommand(java.lang.String cmd) Handles commands after a player control button has been pushed.
void	refreshProgressBar() Refreshes the progress slider state automatically according to the sequencer state - called by the RefresherThread.
void	removeUpdate(javax.swing.event.DocumentEvent e) Checks text field contents after a change (by calling handleTextFieldChanges(DocumentEvent)).
private void	reparse() Re-parses the last successfully parsed file again.
void	setChannelActivity(int channel, boolean active) Turns the given channel’s activity LED on or off.
void	setChannelInfo(byte channel, java.lang.String bankNumShort, java.lang.String bankNumLong, java.lang.String program, java.lang.String instrName, java.lang.String comment) Updates the channel information labels of the given channel.
void	setLyrics(java.lang.String text) Writes the given lyrics string into the karaoke area.
private void	setupMidiDevices() Sets up sequencer, synthesizer and so on.
private void	showErrorMessage(java.lang.Exception e) Shows an error message based on an exception.
void	showErrorMessage(java.lang.String message) Shows an error message based on a message string.
void	stateChanged(javax.swing.event.ChangeEvent e) Handles slider events.
void	windowActivated(java.awt.event.WindowEvent e)
void	windowClosed(java.awt.event.WindowEvent e)
void	windowClosing(java.awt.event.WindowEvent e) Stops and closes player-related resources and windows - called, if the window is going to be closed.
void	windowDeactivated(java.awt.event.WindowEvent e)
void	windowDeiconified(java.awt.event.WindowEvent e)
void	windowIconified(java.awt.event.WindowEvent e)
void	windowOpened(java.awt.event.WindowEvent e) Initializes resources needed for the player - called, if the window is opened.

Methods inherited from class java.lang.Object

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

Field Detail

view

private PlayerView view

errorMsg

private ErrorMsgView errorMsg

refresher

private RefresherThread refresher

parser

private SequenceParser parser

currentFile

private java.io.File currentFile

Constructor Detail

PlayerController

public PlayerController(PlayerView view,
                        SequenceParser parser,
                        java.io.File currentFile)

Creates a new listener object for the player and a RefresherThread, refreshing the progress slider.

Parameters:

view - The player window.

parser - The parser that has successfully parsed the current file.

currentFile - The last loaded (successfully parsed) file.

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Handles all action events that have happened in the player window.

Those are:

• pushing a button
• pressing ENTER in a text field

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - The invoked action event.

windowActivated

public void windowActivated(java.awt.event.WindowEvent e)

Specified by:

windowActivated in interface java.awt.event.WindowListener

windowClosing

public void windowClosing(java.awt.event.WindowEvent e)

Stops and closes player-related resources and windows - called, if the window is going to be closed.

• closes the soundcheck window
• stops the RefresherThread to refresh the progress slider
• stops and destroys the MIDI devices

Specified by:

windowClosing in interface java.awt.event.WindowListener

Parameters:

e - Window activation event.

windowClosed

public void windowClosed(java.awt.event.WindowEvent e)

Specified by:

windowClosed in interface java.awt.event.WindowListener

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent e)

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent e)

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

windowIconified

public void windowIconified(java.awt.event.WindowEvent e)

Specified by:

windowIconified in interface java.awt.event.WindowListener

windowOpened

public void windowOpened(java.awt.event.WindowEvent e)

Initializes resources needed for the player - called, if the window is opened.

• creates and sets up MIDI devices
• adjusts the progress slider to the length of the MIDI stream
• restores the channel-based widgets
• starts the RefresherThread to refresh the progress slider

Specified by:

windowOpened in interface java.awt.event.WindowListener

Parameters:

e - Window deactivated event.

refreshProgressBar

public void refreshProgressBar()

Refreshes the progress slider state automatically according to the sequencer state - called by the RefresherThread.

endOfSequence

public void endOfSequence()

Makes the play/pause button ready to begin playing again - called if the end of the MIDI sequence is reached.

setChannelActivity

public void setChannelActivity(int channel,
                               boolean active)

Turns the given channel’s activity LED on or off.

Parameters:

channel - MIDI channel number.

active - true to turn the LED on, false to turn it off.

setChannelInfo

public void setChannelInfo(byte channel,
                           java.lang.String bankNumShort,
                           java.lang.String bankNumLong,
                           java.lang.String program,
                           java.lang.String instrName,
                           java.lang.String comment)

Updates the channel information labels of the given channel.

The following information is updated:

• bank number
• program number
• instrument name
• track comment

Parameters:

channel - Channel number (0-15).

bankNumShort - bank number syntax – MSB, if LSB is null; otherwise: MSB and LSB, separated by the currently configured separator

bankNumLong - full bank number, MSB and LSB in a human-readable form

program - program number

instrName - instrument name

comment - channel comment

setLyrics

public void setLyrics(java.lang.String text)

Writes the given lyrics string into the karaoke area.

Parameters:

text - HTML-formatted lyrics text.

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent e)

Handles checkbox changes.

Channel-independent actions:

• Shows or hides the channel area or lyrics area according to the show-lyrics checkbox.

Channel-dependent actions:

• Adjusts the channel mute state according to the mute checkbox.
• Adjusts the channel solo state according to the solo checkbox.

Specified by:

itemStateChanged in interface java.awt.event.ItemListener

Parameters:

e - Event object.

stateChanged

public void stateChanged(javax.swing.event.ChangeEvent e)

Handles slider events.

Channel-independent actions:

• Adjusts the sequencer state according to the mannually changed progress slider state.
• Adjusts the sequencer state according to the mannually changed tempo slider state.
• Adjusts the synthesizer state according to the mannually changed master volume slider state.
• Adjusts the transpose level according to the manually changed transpose slider.

Channel-dependent actions:

• Adjusts the synthesizer state according to the mannually changed channel volume slider state.

Specified by:

stateChanged in interface javax.swing.event.ChangeListener

Parameters:

e - Event object.

mouseWheelMoved

public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)

Handles mouse wheel scrolling over a MidicaSlider. Sets the slider to the new position, if possible, or otherwise to the minimum or maximum of the slider’s range.

The following sliders are supported by this method:

• progress slider
• master volume slider
• tempo slider
• transpose slider
• channel volume slider

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

Parameters:

e - Event object.

handleTextFieldChanges

private void handleTextFieldChanges(javax.swing.event.DocumentEvent e)

Handles change events in text fields by checking the changed content.

The text is checked against the expected number format and range. The text field’s background will be changed to red, if the check fails, or to green, if it succeeds.

The following text fields are handled by this method:

• The jump field (must be between 0 and the total number of ticks).
• The master volume field (must be between 0 and 127)
• The tempo field (must be a float greater or equal than 0)
• The transpose field (must be between -30 and 30)
• The channel volume fields (must be between 0 and 127)

Parameters:

e - Event object.

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent e)

Checks text field contents after a change (by calling handleTextFieldChanges(DocumentEvent)).

Specified by:

changedUpdate in interface javax.swing.event.DocumentListener

Parameters:

e - Event object.

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent e)

Checks text field contents after a change (by calling handleTextFieldChanges(DocumentEvent)).

Specified by:

insertUpdate in interface javax.swing.event.DocumentListener

Parameters:

e - Event object.

removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent e)

Checks text field contents after a change (by calling handleTextFieldChanges(DocumentEvent)).

Specified by:

removeUpdate in interface javax.swing.event.DocumentListener

Parameters:

e - Event object.

performControlCommand

private void performControlCommand(java.lang.String cmd)

Handles commands after a player control button has been pushed.

Those buttons are:

• play
• pause
• stop
• forward
• fast forward
• rewind
• fast rewind

Parameters:

cmd - The pushed button’s command string.

reparse

private void reparse()

Re-parses the last successfully parsed file again. Then sets up the MIDI devices again and connects them with the new MIDI stream. Re-builds the progress slider because the MIDI stream length could have changed.

Shows an error message if the parsing fails.

showErrorMessage

private void showErrorMessage(java.lang.Exception e)

Shows an error message based on an exception.

Parameters:

e - Exception containing the error message to be shown.

showErrorMessage

public void showErrorMessage(java.lang.String message)

Shows an error message based on a message string. This is also called from MidiDevices if a soundbank file/URL fails to load.

Parameters:

message - Error message.

setupMidiDevices

private void setupMidiDevices()
                       throws java.lang.Exception

Sets up sequencer, synthesizer and so on. This operation may be time consuming if a large soundbank has to be loaded. For this reason this operation is done by a worker in the background while a ‘please wait’ message is displayed.

Throws:

java.lang.Exception - if something went wrong.