rnnoise-nodejs's Introduction

rnnoise-nodejs

Node.js bindings to Xiph's RNNoise denoising C library.

RNNoise is a project showing how deep learning (Recurrent Neural Networks/RNNs) can be applied to noise suppression.

Announcement

Jan 2021:

I have been working on a new project that will bring this technology to you. A sneak peak at the new deep noise suppression and source separation model and audio output quality:

Watch on YouTube.

This is the 2020 state-of-the art noise suppression for real-time and offline use-cases. It works best in real-world environment where the background noise is low to medium. Of course it is not working well in super noisy environment like construction site. The model is suitable for many work-from-home environments such as home or cafe. We're currently working to bring this technology to desktop app for Mac OSX and Ubuntu (linux). Programming language SDK for Node.js and Go is also in the work. REST API is available (upon request) for integration with other use-cases.

Feb 2021:

The new project has 3 components:

PyTorch deep learning model

Node.js bindings for the PyTorch traced (JIT) model in C++

JavaScript port of PyTorch C++ library (libtorch)

Development of component 1 and 3 is completed.

Install

Node.js versions supported: 8, 10

Use

const rnnoise = require("rnnoise");

const denoisedBufLength = rnnoise.suppress(
  "babble_15dB.wav",
  "babble_15dB_dn.wav"
);

console.log(`Denoised buffer length: ${denoisedBufLength} bytes`);

API

Noise Suppression Functions

rnnoise.suppress(input: string, output: string)

suppress operates on 16-bit RAW audio format (machine endian) mono PCM files sampled at 48 kHz. The output is also a 16-bit RAW PCM file.

input is a required string of the path to RAW PCM file input.
output is a required string of the path to output RAW PCM file.

Developer

Working on project with submodules

We keep a rnnoise Git repo as a subdirectory in this Git repo. So, please clone this repo by using Git submodule:

git clone --recursive https://github.com/cedrickchee/rnnoise-nodejs.git

Expand License

The code in this repository, including all code samples, is released under the MIT license.

rnnoise-nodejs's People

Contributors

Stargazers

Watchers

rnnoise-nodejs's Issues

it´s possible to run this on realtime?

2 questions
1 its possible to run this on realtime using a mic input?
2 its possible to training with this library?

Error when installing

Hello @cedrickchee,

I'm trying to install this NPM module but I got this error when I ran npm i --save :

node-pre-gyp WARN Using needle for node-pre-gyp https download 
node-pre-gyp ERR! install error 
node-pre-gyp ERR! stack Error: 404 status code downloading tarball https://github.com/cedrickchee/rnnoise-nodejs/releases/download/0.1.8/node-v83-linux-x64.tar.gz
node-pre-gyp ERR! stack     at PassThrough.<anonymous> (/home/nowis/Documents/_CODE/jarvis-msbf-nlpjs/stt-srv/sandbox/DeepSpeech-examples/nodejs_wav/node_modules/rnnoise/node_modules/node-pre-gyp/lib/install.js:142:27)
node-pre-gyp ERR! stack     at PassThrough.emit (events.js:327:22)
node-pre-gyp ERR! stack     at ClientRequest.<anonymous> (/home/nowis/Documents/_CODE/jarvis-msbf-nlpjs/stt-srv/sandbox/DeepSpeech-examples/nodejs_wav/node_modules/needle/lib/needle.js:508:9)
node-pre-gyp ERR! stack     at Object.onceWrapper (events.js:422:26)
node-pre-gyp ERR! stack     at ClientRequest.emit (events.js:315:20)
node-pre-gyp ERR! stack     at HTTPParser.parserOnIncomingClient [as onIncoming] (_http_client.js:641:27)
node-pre-gyp ERR! stack     at HTTPParser.parserOnHeadersComplete (_http_common.js:126:17)
node-pre-gyp ERR! stack     at TLSSocket.socketOnData (_http_client.js:509:22)
node-pre-gyp ERR! stack     at TLSSocket.emit (events.js:315:20)
node-pre-gyp ERR! stack     at addChunk (internal/streams/readable.js:309:12)
node-pre-gyp ERR! System Linux 5.8.0-41-generic
node-pre-gyp ERR! command "/home/nowis/.nvm/versions/node/v14.15.4/bin/node" "/home/nowis/Documents/_CODE/jarvis-msbf-nlpjs/stt-srv/sandbox/DeepSpeech-examples/nodejs_wav/node_modules/rnnoise/node_modules/.bin/node-pre-gyp" "install" "--update-binary" "--fallback-to-build=false"
node-pre-gyp ERR! cwd /home/nowis/Documents/_CODE/jarvis-msbf-nlpjs/stt-srv/sandbox/DeepSpeech-examples/nodejs_wav/node_modules/rnnoise
node-pre-gyp ERR! node -v v14.15.4
node-pre-gyp ERR! node-pre-gyp -v v0.14.0
node-pre-gyp ERR! not ok 
404 status code downloading tarball https://github.com/cedrickchee/rnnoise-nodejs/releases/download/0.1.8/node-v83-linux-x64.tar.gz
neon ERR! spawn cargo ENOENT

Error: spawn cargo ENOENT
    at Process.ChildProcess._handle.onexit (internal/child_process.js:269:19)
    at onErrorNT (internal/child_process.js:465:16)
    at processTicksAndRejections (internal/process/task_queues.js:80:21)
npm WARN [email protected] No repository field.
npm WARN [email protected] license should be a valid SPDX license expression