heronarts.lx.audio

Class DecibelMeter

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.LXRunnableComponent

heronarts.lx.modulator.LXModulator

heronarts.lx.audio.DecibelMeter

All Implemented Interfaces:

LXComponent.Renamable, LXLoopTask, LXPath, LXSerializable, LXOscComponent, LXNormalizedParameter, LXParameter, LXParameterListener

Direct Known Subclasses:

GraphicMeter

public class DecibelMeter
extends LXModulator
implements LXNormalizedParameter, LXOscComponent

A DecibelMeter is a modulator that returns the level of an audio signal. Gain may be applied to the signal. A decibel range is given in which values are normalized from 0 to 1. Raw decibel values can be accessed if desired.

Nested Class Summary

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

LXComponent.Placeholder, LXComponent.Renamable

Nested classes/interfaces inherited from interface heronarts.lx.parameter.LXParameter

LXParameter.Formatter, LXParameter.Polarity, LXParameter.Units

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field and Description
CompoundParameter	attack Meter attack time, in milliseconds
protected float	attackGain
protected LXAudioBuffer	buffer
CompoundParameter	gain Gain of the meter, in decibels
protected static double	LOG_10
CompoundParameter	range Range of the meter, in decibels.
CompoundParameter	release Meter release time, in milliseconds
protected float	releaseGain

Fields inherited from class heronarts.lx.LXRunnableComponent

runMs, running, trigger

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
DecibelMeter(LXAudioBuffer buffer) Default constructor, creates a meter with unity gain and 72dB dynamic range
DecibelMeter(String label, LXAudioBuffer buffer) Default constructor, creates a meter with unity gain and 72dB dynamic range

Method Summary

Modifier and Type	Method and Description
protected double	computeValue(double deltaMs) Implementation method to advance the modulator's internal state.
double	getDecibels()
float	getDecibelsf()
double	getExponent() Gets the exponent used for scaling this parameter across its normalized range.
double	getNormalized() Gets the value of the parameter in a normalized space from 0 to 1
float	getNormalizedf() Gets the value of the parameter in a normalized space as a float
double	getPeak()
float	getPeakf()
float	getRaw() Return raw underlying levels, no attack/gain smoothing
double	getSquare()
float	getSquaref()
DecibelMeter	setBuffer(LXAudioBuffer buffer)
LXNormalizedParameter	setNormalized(double value) Sets the value or the parameter in normalized space from 0 to 1

Methods inherited from class heronarts.lx.modulator.LXModulator

getDescription, getFormatter, getIndex, getOscAddress, getOscPath, getPath, getPolarity, getUnits, getValue, getValuef, onSetValue, run, setComponent, setDescription, setFormatter, setIndex, setPolarity, setUnits, setValue, setValue, updateValue

Methods inherited from class heronarts.lx.LXRunnableComponent

isRunning, loop, onParameterChanged, onReset, onStart, onStop, reset, start, stop, toggle, trigger

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addParameter, addParameter, contains, copyParameters, dispose, getChild, getComponentName, getComponentName, getComponentName, getId, getLabel, getLX, getOscLabel, getParameter, getParameters, getParent, handleOscMessage, 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.parameter.LXParameter

dispose, getDescription, getFormatter, getLabel, getPolarity, getUnits, getValue, getValuef, isMappable, reset, setComponent, setMappable, setValue

Methods inherited from interface heronarts.lx.LXPath

get, get, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getComponent, getComponent, getParameter, getParameter, getParent, getPath

Methods inherited from interface heronarts.lx.osc.LXOscComponent

getOscAddress, handleOscMessage

Field Detail

LOG_10

protected static final double LOG_10

buffer

protected LXAudioBuffer buffer

gain

public final CompoundParameter gain

Gain of the meter, in decibels

range

public final CompoundParameter range

Range of the meter, in decibels.

attack

public final CompoundParameter attack

Meter attack time, in milliseconds

release

public final CompoundParameter release

Meter release time, in milliseconds

attackGain

protected float attackGain

releaseGain

protected float releaseGain

Constructor Detail

DecibelMeter

public DecibelMeter(LXAudioBuffer buffer)

Default constructor, creates a meter with unity gain and 72dB dynamic range

Parameters:

buffer - Audio buffer to meter

DecibelMeter

public DecibelMeter(String label,
                    LXAudioBuffer buffer)

Default constructor, creates a meter with unity gain and 72dB dynamic range

Parameters:

label - Label

buffer - Audio buffer to meter

Method Detail

setBuffer

public DecibelMeter setBuffer(LXAudioBuffer buffer)

getExponent

public double getExponent()

Description copied from interface: LXNormalizedParameter

Gets the exponent used for scaling this parameter across its normalized range. Default is 1 which means linear scaling.

Specified by:

getExponent in interface LXNormalizedParameter

Returns:

scaling exponent

getRaw

public float getRaw()

Return raw underlying levels, no attack/gain smoothing

Returns:

Raw RMS value

getDecibels

public double getDecibels()

Returns:

Raw decibel value of the meter

getDecibelsf

public float getDecibelsf()

Returns:

Raw decibel value of the meter as a float

getSquare

public double getSquare()

Returns:

A value for the audio meter from 0 to 1 with quadratic scaling

getSquaref

public float getSquaref()

Returns:

Quadratic scaled value as a float

computeValue

protected double computeValue(double deltaMs)

Description copied from class: LXModulator

Implementation method to advance the modulator's internal state. Subclasses must provide and update value appropriately.

Specified by:

computeValue in class LXModulator

Parameters:

deltaMs - Number of milliseconds to advance by

Returns:

Computed value

setNormalized

public LXNormalizedParameter setNormalized(double value)

Description copied from interface: LXNormalizedParameter

Sets the value or the parameter in normalized space from 0 to 1

Specified by:

setNormalized in interface LXNormalizedParameter

Parameters:

value - The normalized value, from 0 to 1

Returns:

this, for method chaining

getPeak

public double getPeak()

getPeakf

public float getPeakf()

getNormalized

public double getNormalized()

Description copied from interface: LXNormalizedParameter

Gets the value of the parameter in a normalized space from 0 to 1

Specified by:

getNormalized in interface LXNormalizedParameter

Returns:

Value of parameter, normalized to range from 0 to 1

getNormalizedf

public float getNormalizedf()

Description copied from interface: LXNormalizedParameter

Gets the value of the parameter in a normalized space as a float

Specified by:

getNormalizedf in interface LXNormalizedParameter

Returns:

Normalized value of parameter, in range from 0 to 1