org.openimaj.audio.util

Class BasicMusicTimekeeper

java.lang.Object

org.openimaj.audio.util.BasicMusicTimekeeper

All Implemented Interfaces:

Runnable, TimeKeeper<MeasuresBeatsTicksTimecode>

public class BasicMusicTimekeeper
extends Object
implements TimeKeeper<MeasuresBeatsTicksTimecode>

A timekeeper that generates MeasuresBeatsTicksTimecodes that allow the position within a music score to be tracked.

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

12 Feb 2013

Constructor Summary

Constructors

Constructor and Description
BasicMusicTimekeeper()

Method Summary

Modifier and Type	Method and Description
double	getBPM() Returns the number of BPMs this timekeeper is running at.
int	getTicksPerBeat() Returns the number of ticks per beat
MeasuresBeatsTicksTimecode	getTime() Returns the current time.
void	pause() Pause the running of the timekeeper.
void	reset() Reset the timekeeper.
void	run() Use this method to start the time keeper running.
void	seek(long timestamp) Seek to a given timestamp.
void	setBPM(float bpm) Set the tempo of the timekeeper
void	stop() Use this method to stop the time keeper from running.
boolean	supportsPause() Returns whether the timekeeper supports pausing.
boolean	supportsSeek() Returns whether the timekeeper supports seeking.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicMusicTimekeeper

public BasicMusicTimekeeper()

Method Detail

setBPM

public void setBPM(float bpm)

Set the tempo of the timekeeper

Parameters:

bpm - The new beats per minute.

getBPM

public double getBPM()

Returns the number of BPMs this timekeeper is running at.

Returns:

The BPMs

run

public void run()

Use this method to start the time keeper running.

Specified by:

run in interface Runnable

Specified by:

run in interface TimeKeeper<MeasuresBeatsTicksTimecode>

See Also:

TimeKeeper.run()

pause

public void pause()

Pause the running of the timekeeper.

Specified by:

pause in interface TimeKeeper<MeasuresBeatsTicksTimecode>

See Also:

TimeKeeper.pause()

stop

public void stop()

Use this method to stop the time keeper from running.

Specified by:

stop in interface TimeKeeper<MeasuresBeatsTicksTimecode>

See Also:

TimeKeeper.stop()

getTime

public MeasuresBeatsTicksTimecode getTime()

Returns the current time.

Specified by:

getTime in interface TimeKeeper<MeasuresBeatsTicksTimecode>

Returns:

the current time object.

See Also:

TimeKeeper.getTime()

seek

public void seek(long timestamp)

Seek to a given timestamp.

Specified by:

seek in interface TimeKeeper<MeasuresBeatsTicksTimecode>

Parameters:

timestamp - The timestamp to seek to

See Also:

TimeKeeper.seek(long)

reset

public void reset()

Reset the timekeeper.

Specified by:

reset in interface TimeKeeper<MeasuresBeatsTicksTimecode>

See Also:

TimeKeeper.reset()

supportsPause

public boolean supportsPause()

Returns whether the timekeeper supports pausing. If the timekeeper supports pausing then a stop() followed by a run() will continue from where the timekeeper was paused. Use reset() inbetween to force the timekeeper to start from the beginning again.

Specified by:

supportsPause in interface TimeKeeper<MeasuresBeatsTicksTimecode>

Returns:

TRUE if the timekeeper supports pausing.

See Also:

TimeKeeper.supportsPause()

supportsSeek

public boolean supportsSeek()

Returns whether the timekeeper supports seeking.

Specified by:

supportsSeek in interface TimeKeeper<MeasuresBeatsTicksTimecode>

Returns:

TRUE if the timekeeper supports seeking.

See Also:

TimeKeeper.supportsSeek()

getTicksPerBeat

public int getTicksPerBeat()

Returns the number of ticks per beat

Returns:

the number of ticks per beat