@audio/onset

中文文档
1.0.3发布于 2026/09/29MITTypeScriptES Module近 30 天下载 1.1万

Onset detection — spectral-flux and energy-flux onset detection functions (ODFs) + adaptive peak picking

原始使用文档
文档目录5 节
  1. spectralFlux(data, opts?)
  2. energyFlux(data, opts?)
  3. peakPick(odf, opts?)
  4. ODF
  5. Notes

@audio/onset

Onset detection — where notes and hits begin. Onset detection functions (ODFs) plus adaptive peak picking.

Two ODFs and a picker. Compute an ODF over the signal, then peak-pick it into onset times. Classical, deterministic, no model weights.

import { spectralFlux, peakPick } from '@audio/onset'

let { odf, hopSize, fs } = spectralFlux(signal, { fs: 48000 })
let onsets = peakPick(odf, { hopSize, fs })   // Float64Array of onset times (seconds)

spectralFlux(data, opts?)

STFT magnitude → sum of positive bin-to-bin differences. Broadband; catches tonal and percussive onsets alike. opts: fs (44100), frameSize (2048, power of 2), hopSize (512). Returns { odf, nFrames, hopSize, frameSize, fs }.

energyFlux(data, opts?)

Per-frame RMS energy → positive first differences. Cheaper, favours percussive/energy onsets (Klapuri, ICMC 1999). Same options and return shape as spectralFlux.

peakPick(odf, opts?)

Adaptive threshold: a frame is an onset if it exceeds delta × the local-mean ODF and is a local maximum. opts: hopSize/fs (time conversion), windowSize (8 frames), delta (1.4). Returns onset times in seconds.

ODF

A symbol key for handing a precomputed ODF result to a downstream tempo/beat pass, avoiding a second STFT.

Notes

FFT via fourier-transform, windows via window-function. Powers @audio/beat's tempo/tracking. MIT.

版本与发布记录

@audio/onset 共发布 4 个版本,首次发布于 2026/07/09;过去 12 个月发布了 4 个版本。

版本发布日期距今
1.0.3latest2026/09/291 个月前
1.0.22026/09/271 个月前
1.0.12026/07/113 个月前
1.0.02026/07/093 个月前

关于 @audio/onset 的常见问题

@audio/onset 是什么?

Onset detection — spectral-flux and energy-flux onset detection functions (ODFs) + adaptive peak picking

如何安装 @audio/onset?

在项目目录运行 npm install @audio/onset,或使用 pnpm add / yarn add / bun add。

@audio/onset 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@audio/onset 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@audio/onset 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@audio/onset 可以商用吗?

@audio/onset 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@audio/onset 的下载量有多少?

根据 npm 官方下载统计,@audio/onset 在 2026/10/07 – 2026/11/05 这 30 天内被下载 11,002 次,日均约 367 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@audio/onset 还在维护吗?

最新版本 1.0.3 发布于 2026/09/29(1 个月前);至今共发布 4 个版本,其中过去 12 个月发布了 4 个;首次发布于 2026/07/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。