Skip to main content

larm

larm(
@attacktime 10
@power 1.5
@releasetime 1500
@samplerate 44100
@mode 0
) -> llll

Generates an audio descriptor to estimate the long-term loudness of a buffer.

The resulting buffer will be updated with the following keys:

  • larm
info

larm is a mirror implementation of the same algorithm in the Essentia library. For more details on the algorithm, please check the Essentia Algorithms reference.


Arguments

  • @attacktime [int]: Attack time of the first order lowpass in the attack phase. (default: 10).
  • @power [int/float]: Power used for averaging. (default: 1.5).
  • @releasetime [int]: Release time of the first order lowpass in the release phase. (default: 1500).
  • @samplerate [int]: Sampling rate. (default: 44100).
  • @mode [int]: Analysis mode. (default: 0).
    • 0: Global
    • 1: Time series
    • 2: Time-tagged time series
    • 3: Buffer

Output

Larm descriptor [llll]


Usage

larm is meant to be used with the analyze function:

$buffer = importaudio('singing.wav'); ## input buffer
$descr = larm(); ## generate larm audio descriptor
$buffer.view('before analysis');
$buffer = $buffer.analyze($descr); ## apply analysis
$buffer.view('after analysis')