heronarts.lx

Class Tempo

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXModulatorComponent

heronarts.lx.Tempo

All Implemented Interfaces:

LXLoopTask, LXPath, LXSerializable, LXOscComponent, LXParameterListener

public class Tempo
extends LXModulatorComponent
implements LXOscComponent

Class to represent a musical tempo at which patterns are operating. This can be updated in real-time via invoking the tap() method. Note there is no automatic beat detection - the Tempo object must be explicitly tap()'d to learn the tempo. "Beats" are indicated by the return value of beat(). ramp() returns the current beat phase from 0 to 1 The bpm parameter indicates the current BPM, and period can be used to invert the beat frequency (BPM) into a listenable period (ms per beat). Additional utility functions are available that assume beats represent the tempo: - measure() can be polled to check measure beats, respectively. - Tempo.Listener's can be added to trigger on beats or measures without polling the Tempo object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tempo.ClockSource
static class	Tempo.Division
static interface	Tempo.Listener

Nested classes/interfaces inherited from class heronarts.lx.LXModulatorComponent

LXModulatorComponent.Profiler

Nested classes/interfaces inherited from class heronarts.lx.LXComponent

LXComponent.Placeholder, LXComponent.Renamable

Nested classes/interfaces inherited from interface heronarts.lx.LXSerializable

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field and Description
DiscreteParameter	beatsPerMeasure
BoundedParameter	bpm
EnumParameter<Tempo.ClockSource>	clockSource
BooleanParameter	enabled
static double	MAX_BPM
static double	MIN_BPM
BooleanParameter	nudgeDown
BooleanParameter	nudgeUp
MutableParameter	period
BooleanParameter	tap
BooleanParameter	trigger

Fields inherited from class heronarts.lx.LXModulatorComponent

modulators, profiler

Fields inherited from class heronarts.lx.LXComponent

controlSurfaceSemaphore, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_PARAMETER_PATH, KEY_PATH, label, lx, modulationColor

Constructor Summary

Constructors

Constructor and Description
Tempo(LX lx)

Method Summary

Modifier and Type	Method and Description
Tempo	addListener(Tempo.Listener listener)
Tempo	adjustBpm(double amount) Adjust the BPM by the given amount
double	basis() Indicates phase of the current beat.
double	basisf()
boolean	beat() Method to indicate when we are on-beat, assuming quarter-notes being given one beat.
int	beatCount() Gets the count of the current beat we are on
double	bpm() Returns the current tempo in Beats Per Minute
float	bpmf() Returns the tempo in floating point
double	getBasis(Tempo.Division division) Gets the basis of the tempo, relative to a tempo division.
double	getBasis(Tempo.Division division, boolean mod) Gets the basis of the tempo, relative to a division.
double	getCompositeBasis() Gets the composite basis of the tempo, which is the beatCount combined with the current basis cycle.
String	getLabel() Accessor for the user-facing label of this component.
boolean	handleOscMessage(OscMessage message, String[] parts, int index) Handles an OSC message sent to this component.
void	loop(double deltaMs)
boolean	measure() Method to indicate the start of a measure.
void	onParameterChanged(LXParameter p) Subclasses are free to override this if desired.
double	ramp() Deprecated.
float	rampf() Deprecated.
Tempo	removeListener(Tempo.Listener listener)
Tempo	setBpm(double bpm) Sets the BPM to the given value
Tempo	setPeriod(double beatMillis) Sets the period of one beat
void	tap() Adjusts the tempo in realtime by tapping.
void	tap(long now) Adjusts the tempo, specifying an exact timestamp in milliseconds of when the tap event occurred.
void	trigger() Re-triggers the metronome, so that it immediately beats.
void	trigger(boolean resetBeat) Triggers a beat, optionally resetting the beat count
void	trigger(int beat) Triggers the metronome, setting the beat count to the given explicit value

Methods inherited from class heronarts.lx.LXModulatorComponent

addModulator, addModulator, addModulator, constructProfiler, dispose, getModulator, getModulators, moveModulator, removeModulator, startModulator

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addParameter, addParameter, contains, copyParameters, getChild, getComponentName, getComponentName, getComponentName, getId, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, load, loadParameters, removeParameter, removeParameter, save, saveParameters, setParent, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface heronarts.lx.osc.LXOscComponent

getOscAddress

Methods inherited from interface heronarts.lx.LXPath

get, get, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getComponent, getComponent, getParameter, getParameter

Field Detail

MIN_BPM

public static final double MIN_BPM

See Also:

Constant Field Values

MAX_BPM

public static final double MAX_BPM

See Also:

Constant Field Values

clockSource

public final EnumParameter<Tempo.ClockSource> clockSource

beatsPerMeasure

public final DiscreteParameter beatsPerMeasure

bpm

public final BoundedParameter bpm

trigger

public final BooleanParameter trigger

enabled

public final BooleanParameter enabled

tap

public final BooleanParameter tap

nudgeUp

public final BooleanParameter nudgeUp

nudgeDown

public final BooleanParameter nudgeDown

period

public final MutableParameter period

Constructor Detail

Tempo

public Tempo(LX lx)

Method Detail

handleOscMessage

public boolean handleOscMessage(OscMessage message,
                                String[] parts,
                                int index)

Description copied from class: LXComponent

Handles an OSC message sent to this component. By default this method handles registered components and parameters, but subclasses may override this method to handle different types of OSC messages.

Specified by:

handleOscMessage in interface LXOscComponent

Overrides:

handleOscMessage in class LXComponent

Parameters:

message - Full OSC message object

parts - The OSC address pattern, broken into an array of parts

index - Which index into the parts array corresponds to this component's children

Returns:

true if the OSC message was handled and should be considered consumed, false otherwise

getLabel

public String getLabel()

Description copied from class: LXComponent

Accessor for the user-facing label of this component. Objects that implement the LXComponent.Renamable interface may allow the user to change this value.

Specified by:

getLabel in interface LXPath

Overrides:

getLabel in class LXComponent

Returns:

Label for this component

onParameterChanged

public void onParameterChanged(LXParameter p)

Description copied from class: LXComponent

Subclasses are free to override this if desired. It will automatically fire for any listenable parameter that is registered with this component.

Specified by:

onParameterChanged in interface LXParameterListener

Overrides:

onParameterChanged in class LXComponent

Parameters:

p - Parameter that has a value change

addListener

public Tempo addListener(Tempo.Listener listener)

removeListener

public Tempo removeListener(Tempo.Listener listener)

beat

public boolean beat()

Method to indicate when we are on-beat, assuming quarter-notes being given one beat.

Returns:

true if we are on a quarter-note beat

beatCount

public int beatCount()

Gets the count of the current beat we are on

Returns:

Beat count

getCompositeBasis

public double getCompositeBasis()

Gets the composite basis of the tempo, which is the beatCount combined with the current basis cycle.

Returns:

Number of full beats completed since beginning of tempo

getBasis

public double getBasis(Tempo.Division division,
                       boolean mod)

Gets the basis of the tempo, relative to a division. If specified, the modulus is automatically taken against 1.

Parameters:

division - Tempo division

mod - Whether to take modulus against 1

Returns:

Basis

getBasis

public double getBasis(Tempo.Division division)

Gets the basis of the tempo, relative to a tempo division. The result is between 0 and 1.

Parameters:

division - Tempo division

Returns:

Relative tempo basis from 0-1

measure

public boolean measure()

Method to indicate the start of a measure.

Returns:

true if we are on a measure-beat

basis

public double basis()

Indicates phase of the current beat. On the beat the value will be 0, then ramp up to 1 before the next beat triggers.

Returns:

value from 0-1 indicating phase of beat

basisf

public double basisf()

ramp

@Deprecated
public double ramp()

Deprecated.

Indicates phase of the current beat. On the beat the value will be 0, then ramp up to 1 before the next beat triggers. This is deprecated, should use basis() instead.

Returns:

value from 0-1 indicating phase of beat

rampf

@Deprecated
public float rampf()

Deprecated.

Indicates beat phase in floating point. This is deprecated, should use basisf() instead.

Returns:

value from 0-1 indicating phase of beat

bpm

public double bpm()

Returns the current tempo in Beats Per Minute

Returns:

Current tempo

bpmf

public float bpmf()

Returns the tempo in floating point

Returns:

Current tempo in float

setBpm

public Tempo setBpm(double bpm)

Sets the BPM to the given value

Parameters:

bpm - Number of beats per minute

Returns:

this

adjustBpm

public Tempo adjustBpm(double amount)

Adjust the BPM by the given amount

Parameters:

amount - Amount to adjust BPM by

Returns:

this

setPeriod

public Tempo setPeriod(double beatMillis)

Sets the period of one beat

Parameters:

beatMillis - Milliseconds in a beat

Returns:

this

trigger

public void trigger()

Re-triggers the metronome, so that it immediately beats. Also resetting the beat count to be at the beginning of a measure.

trigger

public void trigger(int beat)

Triggers the metronome, setting the beat count to the given explicit value

Parameters:

beat - Beat count

trigger

public void trigger(boolean resetBeat)

Triggers a beat, optionally resetting the beat count

Parameters:

resetBeat - True if the beat count should be reset to 0

tap

public void tap()

Adjusts the tempo in realtime by tapping. Whenever tap() is invoked the time between previous taps is averaged to compute a new tempo. At least three taps are required to compute a tempo. Otherwise, tapping just re-triggers the beat. It is better to use the trigger() method directly if this is all that is desired.

tap

public void tap(long now)

Adjusts the tempo, specifying an exact timestamp in milliseconds of when the tap event occurred.

Parameters:

now - Timestamp of event, should be equivalent to System.currentTimeMillis()

loop

public void loop(double deltaMs)

Specified by:

loop in interface LXLoopTask

Overrides:

loop in class LXModulatorComponent