forked from ricky0123/vad
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
26 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,40 @@ | ||
| # Voice Activity Detection for Javascript | ||
| # Real-Time Voice Activity Detection for Node.JS | ||
|
|
||
| [](https://www.npmjs.com/package/@ricky0123/vad-web) | ||
| [](https://www.npmjs.com/package/@ricky0123/vad-node) | ||
| [](https://www.npmjs.com/package/@ricky0123/vad-react) | ||
| This is a fork of [@ricky0123/vad](https://github.com/ricky0123/vad) which adds `RealTimeVAD` by building on top of `NonRealTimeVAD` provided. | ||
|
|
||
| > Run callbacks on segments of audio with user speech in a few lines of code | ||
| ## Quick Start | ||
|
|
||
| This package aims to provide an accurate, user-friendly voice activity detector (VAD) that runs in the browser. It also has limited support for node. By using this package, you can prompt the user for microphone permissions, start recording audio, send segments of audio with speech to your server for processing, or show a certain animation or indicator when the user is speaking. | ||
| To use the VAD via a script tag in the browser, include the following script tags: | ||
|
|
||
| * See a live [demo](https://www.vad.ricky0123.com) | ||
| * Join us on [Discord](https://discord.gg/4WPeGEaSpF)! | ||
| * Browse or contribute to [documentation](https://wiki.vad.ricky0123.com/) | ||
| * If you would like to contribute, I have started writing some documentation on how to get started hacking on these packages [here](https://wiki.vad.ricky0123.com/en/docs/developer/hacking). If you have any questions, you can open an issue here or leave a message on Discord. | ||
| * **NEW**: Please fill out this [survey](https://uaux2a2ppfv.typeform.com/to/iJG2gCQv) to let me know what you are building with these packages and how you are using them! | ||
| ```js | ||
| const vad = /** import */; | ||
|
|
||
| Under the hood, these packages run [Silero VAD](https://github.com/snakers4/silero-vad) [[1]](#1) using [ONNX Runtime Web](https://github.com/microsoft/onnxruntime/tree/main/js/web) / [ONNX Runtime Node.js](https://github.com/microsoft/onnxruntime/tree/main/js/node). Thanks a lot to those folks for making this possible. | ||
| const options = { | ||
| sampleRate: 16000, // Sample rate of input audio | ||
| minBufferDuration: 1, // minimum audio buffer to store | ||
| maxBufferDuration: 5, // maximum audio buffer to store | ||
| overlapDuration: 0.1, // how much of the previous buffer exists in the new buffer | ||
| silenceThreshold: 0.5, // threshold for ignoring pauses in speech | ||
| }; | ||
|
|
||
| ## Sponsorship | ||
| const rtvad = new vad.RealTimeVAD(/** options */); | ||
|
|
||
| Please contribute to the project financially - especially if your commercial product relies on this package. [](https://github.com/sponsors/ricky0123) | ||
| rtvad.init(); | ||
|
|
||
| ## Quick Start | ||
| rtvad.on("start", ({ start }) => { | ||
| // speech segment start | ||
| }); | ||
|
|
||
| To use the VAD via a script tag in the browser, include the following script tags: | ||
| rtvad.on("data", ({ audio, start, end}) => { | ||
| // speech segment data | ||
| // start & end here are provided by @ricky0123/vad, this is NOT the same as emitted start & end | ||
| }); | ||
|
|
||
| ```html | ||
| <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/ort.js"></script> | ||
| <script src="https://cdn.jsdelivr.net/npm/@ricky0123/[email protected]/dist/bundle.min.js"></script> | ||
| <script> | ||
| async function main() { | ||
| const myvad = await vad.MicVAD.new({ | ||
| onSpeechStart: () => { | ||
| console.log("Speech start detected") | ||
| }, | ||
| onSpeechEnd: (audio) => { | ||
| // do something with `audio` (Float32Array of audio samples at sample rate 16000)... | ||
| } | ||
| }) | ||
| myvad.start() | ||
| } | ||
| main() | ||
| </script> | ||
| ``` | ||
| rtvad.on("end", ({ end }) => { | ||
| // speech segment end | ||
| }); | ||
|
|
||
| Documentation for bundling the voice activity detector for the browser or using it in node or React projects can be found on [vad.ricky0123.com](https://www.vad.ricky0123.com). | ||
| ``` | ||
|
|
||
| ## References | ||
|
|
||
|
|
||