Code Monkey home page Code Monkey logo

rnnoise-wasm's Introduction

@timephy/rnnoise-wasm

This library implements the RNNoise noise suppression library as a WASM module for use in web frontends.

This repository contains the necessary utilities to build RNNoise using a Docker build environment, compile it to WASM with Emscripten, and export a JavaScript library from the contained TypeScript source code.

Forked from @jitsi/rnnoise-wasm

This library was originally forked from @jitsi/rnnoise-wasm.

Changes

Resources

How to use

import { NoiseSuppressorWorklet_Name } from "@timephy/rnnoise-wasm"
// This is an example how to get the script path using Vite, may be different when using other build tools
// NOTE: `?worker&url` is important (`worker` to generate a working script, `url` to get its url to load it)
import NoiseSuppressorWorklet from "@timephy/rnnoise-wasm/NoiseSuppressorWorklet?worker&url"

async function example() {
    // Load the NoiseSuppressorWorklet into the AudioContext
    const ctx = new AudioContext()
    await ctx.audioWorklet.addModule(NoiseSuppressorWorklet)

    // Instantiate the Worklet as a Node
    const noiseSuppressionNode = new AudioWorkletNode(ctx, NoiseSuppressorWorklet_Name)

    // Setup the node graph
    const stream = new MediaStream() // containing the microphone track
    const source = ctx.createMediaStreamSource(stream)
    source
        .connect(noiseSuppressionNode) // pass audio through noise suppression
        .connect(ctx.destination) // playback audio on output device
}

Build

Prerequisites

  • node - tested version v10.16.3
  • npm - tested version v6.9.0
  • docker - tested version 19.03.1

Building

Building is straightforward, run:

# To build RNNoise, compile it into WASM, and build TypeScript
npm run build

The repository already has a pre-compiled WASM under the src/generated folder, running the above command will replace it with the newly compiled binaries and glue wasm .js file respectively.

In order to facilitate the build with docker the following prebuilt image is used emscripten/emsdk however, it is slightly altered by installing autotools components necessary for building rnnoise.

In summary the build process consists of three steps:

  1. build:dockerfile - pulls in emscripten/emsdk which is then altered and saved. Any subsequent build is going to check if the images was already installed and use that, so if one wants to make changes to the Dockerfile be sure to first delete the build image from your local docker repo.
  2. build:emscripten - mounts the repo to the docker image from step one and runs build.sh on it. The bash script contains all the steps necessary for building rnnoise as a wasm module.
  3. build:typescript - exports the TypeScript source code to JavaScript and type declaration files

rnnoise-wasm's People

Contributors

timephy avatar andrei-gavrilescu avatar saghul avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.