MCPcopy Index your code
hub / github.com/chrisguttandin/web-audio-beat-detector

github.com/chrisguttandin/web-audio-beat-detector @v8.2.37

Chat with this repo
repository ↗ · DeepWiki ↗ · release v8.2.37 ↗ · + Follow
9 symbols 34 edges 12 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

logo

web-audio-beat-detector

A beat detection utility which is using the Web Audio API.

version

This module is based on the technique explained by Joe Sullivan in his article Beat Detection Using JavaScript and the Web Audio API. It retrieves the beats as BPM of a given AudioBuffer. The algorithm used is not as complex (and expensive to compute) as many others. But it yields surprisingly good results especially for electronic music.

Usage

The web-audio-beat-detector module is available on npm and can be installed as usual.

npm install web-audio-beat-detector

You can then import its public function analyze() like this:

import { analyze } from 'web-audio-beat-detector';

The analyze() function expects an AudioBuffer as its first parameter and it returns a Promise which eventually resolves with the tempo of that buffer as a number. An example usage might look like this:

analyze(audioBuffer)
    .then((tempo) => {
        // the tempo could be analyzed
    })
    .catch((err) => {
        // something went wrong
    });

Additionally you can also import the guess() function like this:

import { guess } from 'web-audio-beat-detector';

The guess() function expects an AudioBuffer as well and also returns a Promise. The Promise will resolve with an object containing the estimated BPM (the rounded tempo) and the offset of the first beat in seconds.

guess(audioBuffer)
    .then(({ bpm, offset, tempo }) => {
        // the bpm and offset could be guessed
        // the tempo is the same as the one returned by analyze()
    })
    .catch((err) => {
        // something went wrong
    });

analyze() and guess() do both support offset and duration as optional arguments. When specified these two values are used to select only a part of the given AudioBuffer. There usage is the same as described in the documentation of the AudioBufferSourceNode.start() method.

By default the bpm are expected to be between 90 and 180 bpm. This can be changed by specifying the tempoSettings. These can be passed as the last argument to analyze() or guess().

// with an offset and duration
analyze(audioBuffer, 1, 10, { maxTempo: 120, minTempo: 60 });
// with no other arguments
analyze(audioBuffer, { maxTempo: 120, minTempo: 60 });

Acknowledgement

A more comprehensive implementation has been done by José M. Pérez. It comes with an UI to search for tracks on Spotify which can then be analyzed. He also wrote a blog post (Detecting tempo of a song using browser's Audio API) about it.

Core symbols most depended-on inside this repo

loadFixtureAsAudioBuffer
called by 4
test/helper/load-fixture.js
analyze
called by 2
src/module.ts
guess
called by 2
src/module.ts
createLoadOrReturnBroker
called by 1
src/factories/load-or-return-broker.ts
readFile
called by 0
config/rollup/bundle.mjs
readlink
called by 0
config/rollup/bundle.mjs
stat
called by 0
config/rollup/bundle.mjs
isFile
called by 0
config/rollup/bundle.mjs

Shape

Function 9

Languages

TypeScript100%

Modules by API surface

config/rollup/bundle.mjs4 symbols
src/module.ts2 symbols
test/helper/load-fixture.js1 symbols
src/factories/load-or-return-broker.ts1 symbols
config/webpack/worker-es2019.js1 symbols

For agents

$ claude mcp add web-audio-beat-detector \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page