Skip to main content

flux​

flux(
    @halfrectify 0
    @norm 'L2'
    @mode 0
) -> llll

Generates audio descriptor to compute the spectral flux of a buffer. See analyze.

The resulting buffer will be updated with the following keys:

  • flux
info

flux 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​

  • @halfrectify [int]: half-rectify the differences in each spectrum bin. (default: 0).
    • 0: off
    • 1: on
  • @norm [symbol]: norm to use for difference computation. (default: 'L2').
    • 'L1': L1 norm
    • 'L2': L2 norm
  • @mode [int]: analysis mode. (default: 0).
    • 0: global
    • 1: time series
    • 2: time-tagged time series
    • 3: buffer

Output​

flux descriptor [llll]

Usage​

flux is meant to be used with the analyze function:

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