xref: /aosp_15_r20/external/rnnoise/README (revision 1295d6828459cc82c3c29cc5d7d297215250a74b)
1*1295d682SXin LiRNNoise is a noise suppression library based on a recurrent neural network.
2*1295d682SXin Li
3*1295d682SXin LiTo compile, just type:
4*1295d682SXin Li% ./autogen.sh
5*1295d682SXin Li% ./configure
6*1295d682SXin Li% make
7*1295d682SXin Li
8*1295d682SXin LiOptionally:
9*1295d682SXin Li% make install
10*1295d682SXin Li
11*1295d682SXin LiWhile it is meant to be used as a library, a simple command-line tool is
12*1295d682SXin Liprovided as an example. It operates on RAW 16-bit (machine endian) mono
13*1295d682SXin LiPCM files sampled at 48 kHz. It can be used as:
14*1295d682SXin Li
15*1295d682SXin Li./examples/rnnoise_demo <noisy speech> <output denoised>
16*1295d682SXin Li
17*1295d682SXin LiThe output is also a 16-bit raw PCM file.
18*1295d682SXin Li
19*1295d682SXin LiThe latest version of the source is available from
20*1295d682SXin Lihttps://gitlab.xiph.org/xiph/rnnoise .  The github repository
21*1295d682SXin Liis a convenience copy.
22