@audio/mir-key

中文文档
1.0.2发布于 2026/10/13MITTypeScriptES Module零依赖近 30 天下载 1844

Krumhansl–Kessler major and minor key profiles

原始使用文档

@audio/mir-key

Key detection — Krumhansl–Schmuckler: Pearson correlation between a chroma vector and each of 24 rotated Krumhansl–Kessler (1982) major/minor key profiles. Highest correlation wins.

npm install @audio/mir-key

import key, { KK_MAJOR, KK_MINOR } from '@audio/mir-key'

let r = key(chromaVec)
// { tonic: 0..11, mode: 'major'|'minor', label: 'C'|'Am'|…, confidence: -1..1, scores: [{label, score}, …] }

scores holds all 24 candidates sorted descending by correlation — scores[0] is the winner (confidence mirrors its score).

input accepts a single 12-D chroma vector, or an array of chroma frames (averaged across frames first) — pass a chromagram directly to key a whole passage instead of one instant.

Options: - profile — { major: number[12], minor: number[12] } override for the reference key profiles (default Krumhansl–Kessler KK_MAJOR/KK_MINOR, also exported directly)

Use when: a single global-key estimate is enough; for time-varying tonality, run key() over a sliding window of chroma frames.

Part of @audio/mir.

版本与发布记录

@audio/mir-key 共发布 3 个版本,首次发布于 2026/07/09;过去 12 个月发布了 3 个版本。

版本发布日期距今
1.0.2latest2026/10/1326 天前
1.0.12026/07/113 个月前
1.0.02026/07/094 个月前

关于 @audio/mir-key 的常见问题

@audio/mir-key 是什么?

Krumhansl–Kessler major and minor key profiles

如何安装 @audio/mir-key?

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

@audio/mir-key 支持 TypeScript 吗?

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

@audio/mir-key 支持 ESM 还是 CommonJS?

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

@audio/mir-key 需要什么版本的 Node.js?

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

@audio/mir-key 可以商用吗?

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

@audio/mir-key 的下载量有多少?

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

@audio/mir-key 还在维护吗?

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