blob: 4158a9be023c38e829b84d058f58ca13502f75bd [file] [log] [blame]
Gregor Richards02105922018-09-20 21:58:31 -04001RNNoise is a noise suppression library based on a recurrent neural network.
Jean-Marc Valin3d260c42017-09-01 17:45:11 -04002
3To compile, just type:
Jan3d2acb82017-10-03 14:14:06 +02004% ./autogen.sh
Jean-Marc Valin3d260c42017-09-01 17:45:11 -04005% ./configure
6% make
7
8Optionally:
9% make install
10
11While it is meant to be used as a library, a simple command-line tool is
12provided as an example. It operates on RAW 16-bit (machine endian) mono
13PCM files sampled at 48 kHz. It can be used as:
14
Danielius Visockas40a38162021-01-22 16:22:28 +020015./examples/rnnoise_demo <noisy speech> <output denoised>
Jean-Marc Valin3d260c42017-09-01 17:45:11 -040016
17The output is also a 16-bit raw PCM file.
Petter Reinholdtsenbd7a29c2021-01-18 09:36:04 +010018
19The latest version of the source is available from
20https://gitlab.xiph.org/xiph/rnnoise . The github repository
21is a convenience copy.