index :: an

an.onset~

onset detector

available since version: 0.9

---

information

Onset detector based on aubio library

arguments:

• BS buffer size
  type: int
  units: samp
  

• METHOD detection method
  type: symbol
  

• HS hop size (by default buffer_size/2)
  type: int
  units: samp
  

methods:

• reset reset onset last frame and total frames counters
  

properties:

• @bs (initonly) Get/set buffer size
  type: int
  units: samp
  min value: 64
  default: 1024
  

• @hs Get/set hop size. 0 means @bs/2
  type: int
  units: samp
  min value: 0
  default: 0
  

• @method Get/set onset method. Default is hfc.
  type: symbol
  enum: specflux, phase, energy, hfc, kl, complex, default, specdiff, wphase, rolloff, spread, kurtosis, skewness, complexdomain, decrease, slope, centroid
  default: default
  

• @hfc Get/set alias to @method hfc. High Frequency Content onset detection
  type: alias
  

• @energy Get/set alias to @method energy. Energy based onset detection function
  type: alias
  

• @complex Get/set alias to @method complex. Complex Domain Method onset detection function
  type: alias
  

• @phase Get/set alias to @method phase. Phase Based Method onset detection function
  type: alias
  

• @wphase Get/set alias to @method phase. Weighted Phase Deviation onset detection function
  type: alias
  

• @specdiff Get/set alias to @method specdiff. Spectral difference method onset detection function
  type: alias
  

• @kl Get/set alias to @method kl. Kullback-Liebler onset detection function
  type: alias
  

• @mkl Get/set alias to @method mkl. Modified Kullback-Liebler onset detection function
  type: alias
  

• @specflux Get/set alias to @method specflux. Spectral Flux
  type: alias
  

• @threshold Get/set peak picking threshold
  type: float
  default: 0.058
  

• @speedlim Get/set minimum interval between two consecutive onsets
  type: float
  units: ms
  min value: 1
  default: 50
  

• @silence Get/set onset detection silence threshold
  type: float
  units: db
  range: -80..0
  default: -70
  

• @compression Get/set lambda logarithmic compression factor, 0 to disable
  type: float
  min value: 0
  default: 1
  

• @awhitening Get/set adaptive whitening
  type: bool
  default: 0
  

• @delay Get/set constant system delay to take back from detection time
  type: float
  units: ms
  min value: 0
  default: 49.9093
  

• @active Get/set audio processing state
  type: bool
  default: 1
  

inlets:

• input signal
  type: audio

outlets:

• bang if onset detected
  type: control
• float: time of the latest onset detected in milliseconds from starting of measuring. You can reset start time with 'reset' message
  type: control

keywords:

onset

See also: [an.onset]

Authors: Serge Poltavsky

License: GPL3 or later