Package 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.modulator.LXModulator

LXModulator.Device, LXModulator.Global, LXModulator.Placeholder, LXModulator.ResetButton, LXModulator.TriggerButton

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

LXComponent.Author, LXComponent.Description, LXComponent.Hidden, LXComponent.Name, LXComponent.PluginRequired, LXComponent.Renamable, LXComponent.Tags

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

LXNormalizedParameter.OscMode

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

LXParameter.Collection, LXParameter.Formatter, LXParameter.Monitor, LXParameter.MultiMonitor, LXParameter.Polarity, LXParameter.Units

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

LXSerializable.Utils

Field Summary

Fields

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

Fields inherited from class heronarts.lx.modulator.LXModulator

crashed, midiFilter, midiSource

Fields inherited from class heronarts.lx.LXRunnableComponent

reset, runMs, running, trigger

Fields inherited from class heronarts.lx.LXComponent

childArrays, children, internalParameters, KEY_CHILDREN, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_INTERNAL, KEY_PARAMETER_PATH, KEY_PARAMETERS, KEY_PATH, KEY_RESET, label, legacyInternalParameters, legacyParameters, lx, modulationColor, modulationControlsExpanded, modulationsExpanded, parameters, presetFile

Fields inherited from interface heronarts.lx.LXPath

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	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
DecibelMeter(String label, LXAudioBuffer buffer, heronarts.lx.audio.DecibelMeter.Parameters params)
DecibelMeter(String label, LXAudioBuffer buffer, CompoundParameter gain, CompoundParameter range, CompoundParameter attack, CompoundParameter release)

Method Summary

Modifier and Type	Method	Description
static double	amplitudeToDecibels(double amplitude)	Converts an amplitude (normalized 0-1, typically RMS) to decibels, negative value up to 0dbFS
protected double	computeValue(double deltaMs)	Implementation method to advance the modulator's internal state.
int	getBufferSize()
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
int	getSampleRate()
double	getSquare()
float	getSquaref()
protected void	onAudioFrame()	Compute new values when a frame of audio input is received.
protected void	onStop()	Optional subclass method when stop happens.
final 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

autostart, disableAutoStart, getCrash, getCrashStackTrace, getFormatter, getIndex, getOscAddress, getOscPath, getPath, getPolarity, getUnits, getValue, isMappingSource, loop, onSetValue, run, setComponent, setFormatter, setIndex, setMappingSource, setPolarity, setUnits, setValue, setValue, updateValue

Methods inherited from class heronarts.lx.LXRunnableComponent

isRunning, onParameterChanged, onReset, onStart, onTrigger, postRun, reset, start, stop, toggle, trigger

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addInternalParameters, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, assertDisposed, contains, copyParameters, dispose, getCategory, getChild, getComponentDescription, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscLabel, getParameter, getParameters, getParent, handleOscMessage, hasParameter, isSnapshotControl, isValidOscParameter, load, loadParameters, loadPreset, removeParameter, removeParameter, removeParameter, removeParameter, save, savePreset, setDescription, setParent, toOscQuery, toOscQuery, toOscQuery, 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.LXNormalizedParameter

getBaseNormalized, getBaseNormalizedf, getOscMode, getValueFromNormalized, isWrappable

Methods inherited from interface heronarts.lx.osc.LXOscComponent

getOscAddress, handleOscMessage

Methods inherited from interface heronarts.lx.parameter.LXParameter

dispose, getBaseValue, getBaseValuef, getFormatter, getLabel, getParentParameter, getPolarity, getUnits, getValue, getValuef, isMappable, reset, setComponent, setFormatter, setMappable, setValue

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, getDescription, getParent, getPath, isDescendant

Field Details

LOG_10

protected static final double LOG_10

RATIO_20_LOG10

protected static final double RATIO_20_LOG10

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 double attackGain

releaseGain

protected double releaseGain

Constructor Details

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

DecibelMeter

public DecibelMeter(String label,
 LXAudioBuffer buffer,
 heronarts.lx.audio.DecibelMeter.Parameters params)

DecibelMeter

public DecibelMeter(String label,
 LXAudioBuffer buffer,
 CompoundParameter gain,
 CompoundParameter range,
 CompoundParameter attack,
 CompoundParameter release)

Method Details

setBuffer

public final DecibelMeter setBuffer(LXAudioBuffer buffer)

getBufferSize

public int getBufferSize()

getSampleRate

public int getSampleRate()

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

amplitudeToDecibels

public static double amplitudeToDecibels(double amplitude)

Converts an amplitude (normalized 0-1, typically RMS) to decibels, negative value up to 0dbFS

Parameters:

amplitude - Normalized amplitude, 0-1

Returns:

Decibel value, negative infinity -> max 0dBFS

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

onAudioFrame

protected void onAudioFrame()

Compute new values when a frame of audio input is received. This is called by the thread that has filled the audio buffer.

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

onStop

protected void onStop()

Description copied from class: LXRunnableComponent

Optional subclass method when stop happens.

Overrides:

onStop in class LXRunnableComponent

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