aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJorge E. Moreira <jemoreira@google.com>2020-07-09 15:17:15 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>2020-07-09 15:17:15 +0000
commitf7dd50f6503c57d445e678c509b989ea825ae1db (patch)
tree634acb66126553f683ad3abacd49aa4e63c5e990 /README
parente3f2bc5c19b94f992c5b98f73c0618f721426d23 (diff)
parent1654b9d6653d3c34d753e2911a6fc9c04dac933a (diff)
downloadrnnoise-f7dd50f6503c57d445e678c509b989ea825ae1db.tar.gz
Merge remote-tracking branch 'aosp/upstream-master' am: 0bd76d957c am: 8f7d2e1166 am: f88d51ab47 am: 1654b9d665
Original change: https://android-review.googlesource.com/c/platform/external/rnnoise/+/1354027 Change-Id: Iab48cee23379297cd12055d19d998279cb6cab0e
Diffstat (limited to 'README')
-rw-r--r--README17
1 files changed, 17 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..88fc79c
--- /dev/null
+++ b/README
@@ -0,0 +1,17 @@
+RNNoise is a noise suppression library based on a recurrent neural network.
+
+To compile, just type:
+% ./autogen.sh
+% ./configure
+% make
+
+Optionally:
+% make install
+
+While it is meant to be used as a library, a simple command-line tool is
+provided as an example. It operates on RAW 16-bit (machine endian) mono
+PCM files sampled at 48 kHz. It can be used as:
+
+./examples/rnnoise_demo <number of channels> <maximum attenuation> < input.raw > output.raw
+
+The output is also a 16-bit raw PCM file.