/*
* org.openmicroscopy.shoola.agents.imviewer.util.player.Player
*
*------------------------------------------------------------------------------
* Copyright (C) 2006 University of Dundee. All rights reserved.
*
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
*------------------------------------------------------------------------------
*/
package org.openmicroscopy.shoola.agents.imviewer.util.player;
//Java imports
import java.awt.event.ActionListener;
import javax.swing.Timer;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
//Third-party libraries
//Application-internal dependencies
import org.openmicroscopy.shoola.agents.imviewer.view.ImViewer;
/**
* Abstract class that each player should extend e.g. the movie player
* or the channel player.
*
* @author Jean-Marie Burel
* <a href="mailto:j.burel@dundee.ac.uk">j.burel@dundee.ac.uk</a>
* @author Andrea Falconi
* <a href="mailto:a.falconi@dundee.ac.uk">a.falconi@dundee.ac.uk</a>
* @author Donald MacDonald
* <a href="mailto:donald@lifesci.dundee.ac.uk">donald@lifesci.dundee.ac.uk</a>
* @version 3.0
* <small>
* (<b>Internal version:</b> $Revision: $ $Date: $)
* </small>
* @since OME2.2
*/
public abstract class Player
implements ActionListener, ChangeListener
{
/** Indicates the <i>Start</i> state of the timer. */
public static final int START = 0;
/** Indicates the <i>Stop</i> state of the timer. */
public static final int STOP = 1;
/** Indicates the <i>Pause</i> state of the timer. */
public static final int PAUSE = 2;
/** The delay between two images. */
protected static final int DELAY = 1000;
/** The initial delay. */
protected static final int INITIAL_DELAY = 0;
/** Reference to the {@link ImViewer}. */
protected ImViewer model;
/** The timer controlling the display. */
protected Timer timer;
/** The state of the timer. */
protected int state;
/** The state of the timer before setting it. */
protected int historyState;
/** The delay used by the timer. */
protected int delay;
/**
* Subclasses should override the method to synchronize the timer.
*/
protected abstract void onPlayerStateChange();
/**
* Creates a new instance.
*
* @param model Reference to the {@link ImViewer}.
* Mustn't be <code>null</code>.
*/
public Player(ImViewer model)
{
if (model == null)
throw new IllegalArgumentException("Model cannot be null.");
this.model = model;
state = -1;
delay = DELAY;
model.addChangeListener(this);
timer = new Timer(DELAY, this);
timer.setInitialDelay(DELAY/10);
timer.setCoalesce(true);
}
/**
* Sets the state of the player.
*
* @param state One of the constants defined by this class.
*/
public void setPlayerState(int state)
{
switch (state) {
case START:
case STOP:
case PAUSE:
break;
default:
throw new IllegalArgumentException("State not supported.");
}
if (this.state == state) return;
historyState = this.state;
this.state = state;
onPlayerStateChange();
}
/**
* Sets the delay of the timer.
*
* @param v The value to set.
*/
public void setDelay(int v)
{
//if (state != STOP) return;
if (v == 0) return;
delay = DELAY/v;
timer.setDelay(delay);
//timer.setInitialDelay(delay*10);//to check if that's correct.
}
/**
* Returns the state of the timer.
*
* @return See above.
*/
public int getState() { return state; }
/**
* Reacts to change event from the {@link ImViewer}.
* @see ChangeListener#stateChanged(ChangeEvent)
*/
public void stateChanged(ChangeEvent e)
{
int s = model.getState();
if (s == ImViewer.DISCARDED)
setPlayerState(STOP);
else if (s == ImViewer.LOADING_IMAGE) {
if (state == START)
timer.stop();
} else if (s == ImViewer.READY) {
if (state == START) timer.start();
}
}
}