Skip to main content

energyband

energyband(
@startcutofffrequency 0
@stopcutofffrequency 100
@samplerate 44100
@mode 0
) -> llll

Generates audio descriptor to compute energy in a given frequency band of a spectrum including both start and stop cutoff frequencies. See analyze.

The resulting buffer will be updated with the following keys:

  • energyband
info

energyband 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

  • @startcutofffrequency [int]: start frequency from which to sum the energy. (default: 0).
  • @stopcutofffrequency [int]: stop frequency to which to sum the energy. (default: 100).
  • @samplerate [int]: audio sampling rate. (default: 44100).
  • @mode [int]: analysis mode. (default: 0).
    • 0: global
    • 1: time series
    • 2: time-tagged time series
    • 3: buffer

Output

energyband descriptor [llll]


Usage

energyband is meant to be used with the analyze function:

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