RNNoise (models)

.gitattributes

@@ -47,3 +47,5 @@ libs/rnnoise-bin/releases/7f449bf8/librnnoise-windows-x86-64.dll filter=lfs diff
 libs/rnnoise-bin/releases/7f449bf8/librnnoise-windows-x86.dll filter=lfs diff=lfs merge=lfs -text
 models/ailia-models/code/babble_15dB.wav filter=lfs diff=lfs merge=lfs -text
 models/ailia-models/code/denoised.wav filter=lfs diff=lfs merge=lfs -text
+models/rnnoise-wrapper/weights_5h_b_500k.hdf5 filter=lfs diff=lfs merge=lfs -text
+models/rnnoise-wrapper/weights_5h_ru_500k.hdf5 filter=lfs diff=lfs merge=lfs -text

models/arnndn-models/README.md

@@ -0,0 +1,4 @@
+This are model files to be used with FFmpeg arnndn filter.
+
+std.rnnn is one originally bundled with Xiph RNNoise implementation.
+others are created by Gregor Richards.

models/arnndn-models/source.txt

@@ -0,0 +1 @@
+https://github.com/richardpl/arnndn-models

models/rnnoise-models/README.md

@@ -0,0 +1,19 @@
+# rnnoise-models
+
+This repository contains the tools and information used to create the various
+neural network models in rnnoise-nu. With the exception of the tools/ directory
+and this file, none of this work is creative and thus none of it is subject to
+copyright.
+
+Note that the name of each model is not meaningful.
+
+## Model information
+
+The following table maps expected signal (horizontal) against expected noise
+(vertical). Note that "voice" is distinct from "speech" by the presence of
+non-speech human sounds, such as laughter.
+
+|                   | General               | Voice                 | Speech                |
+| ----------------- | --------------------- | --------------------- | --------------------- |
+| General           | marathon-prescription | leavened-quisling     | orig                  |
+| Recording         | conjoined-burgers     | beguiling-drafter     | somnolent-hogwash     |

models/rnnoise-models/beguiling-drafter-2018-08-30/info.txt

@@ -0,0 +1,44 @@
+SUITE: beguiling-drafter-2018-08-30
+
+INTENT:
+
+Voice in a reasonable recording environment. Fans, AC, computers, etc.
+
+
+SIGNAL:
+
+voice
+    hamlet-002-act-1-scene-1.1626
+        http://etc.usf.edu/lit2go/94/hamlet/1626/
+    human_rights_un_chi_nf.mp3
+        https://librivox.org/universal-declaration-of-human-rights-by-united-nations-volume-02/
+    human_rights_un_cze_msed.mp3
+        https://librivox.org/universal-declaration-of-human-rights-by-united-nations-volume-02/
+    huntingofthesnark_01_carrol_128kb
+        https://librivox.org/the-hunting-of-the-snark-by-lewis-carroll-3/
+    teacupclub_01_armstrong_128kb
+        https://librivox.org/the-teacup-club-by-eliza-armstrong/
+    warletters_01_allan_128kb.mp3
+        https://librivox.org/war-letters-from-a-young-queenslander-by-robert-marshall-allen/
+    TSPspeech
+        http://www-mmsp.ece.mcgill.ca/Documents/Data/
+
+sounds
+    cough
+        https://freesound.org/ sounds: 205012 222644 252240 323532 342587 343880 343885 343986 369295 391284 401334 407839 419781 425777 87412
+    laugh
+        https://freesound.org/ sounds: 167578 189278 263775 319346 343934 344043 344064 367680 381275 383237 393353 401214 433921 73123
+
+
+./chopper voice/hamlet-002-act-1-scene-1.1626.raw voice/human_rights_un_chi_nf.raw sounds/cough.raw voice/human_rights_un_cze_msed.raw voice/huntingofthesnark_01_carrol_128kb.raw sounds/laugh.raw voice/teacupclub_01_armstrong_128kb.raw voice/warletters_01_allan_128kb.raw voice/TSPspeech.raw
+
+
+NOISE:
+
+rnnoise_contributions (only "other" and "none" samples)
+    https://people.xiph.org/~jm/demo/rnnoise/rnnoise_contributions.tar.gz
+
+
+COUNT: 13212874 (x87)
+
+NOTE: All files processed into correct raws through ffmpeg: ffmpeg -i in -f s16le -ac 1 -ar 48000 out.raw

models/rnnoise-models/beguiling-drafter-2018-08-30/weights.hdf5.xz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9fb07c7cf2a8e704c4e1323565c17b2ef1cde8844deb39760f5f04bfbabc7d92
+size 972256

models/rnnoise-models/conjoined-burgers-2018-08-28/info.txt

@@ -0,0 +1,52 @@
+SUITE: conjoined-burgers-2018-08-28
+
+INTENT:
+
+General use in a reasonable recording environment. Fans, AC, computers, etc.
+
+
+SIGNAL:
+
+voice
+    hamlet-002-act-1-scene-1.1626
+        http://etc.usf.edu/lit2go/94/hamlet/1626/
+    human_rights_un_chi_nf.mp3
+        https://librivox.org/universal-declaration-of-human-rights-by-united-nations-volume-02/
+    human_rights_un_cze_msed.mp3
+        https://librivox.org/universal-declaration-of-human-rights-by-united-nations-volume-02/
+    huntingofthesnark_01_carrol_128kb
+        https://librivox.org/the-hunting-of-the-snark-by-lewis-carroll-3/
+    teacupclub_01_armstrong_128kb
+        https://librivox.org/the-teacup-club-by-eliza-armstrong/
+    warletters_01_allan_128kb.mp3
+        https://librivox.org/war-letters-from-a-young-queenslander-by-robert-marshall-allen/
+    TSPspeech
+        http://www-mmsp.ece.mcgill.ca/Documents/Data/
+
+sounds
+    cough
+        https://freesound.org/ sounds: 205012 222644 252240 323532 342587 343880 343885 343986 369295 391284 401334 407839 419781 425777 87412
+    laugh
+        https://freesound.org/ sounds: 167578 189278 263775 319346 343934 344043 344064 367680 381275 383237 393353 401214 433921 73123
+
+music
+    Danse Macabre
+    Gymnopedie No 1
+    Local Forecast
+    Secret of Tiki Island
+    Unpromised
+        https://incompetech.com/music/royalty-free/
+
+
+./chopper voice/hamlet-002-act-1-scene-1.1626.raw voice/human_rights_un_chi_nf.raw sounds/cough.raw voice/human_rights_un_cze_msed.raw voice/huntingofthesnark_01_carrol_128kb.raw sounds/laugh.raw voice/teacupclub_01_armstrong_128kb.raw voice/warletters_01_allan_128kb.raw voice/TSPspeech.raw sounds/cough.raw music/Danse\ Macabre.raw music/Gymnopedie\ No\ 1.raw music/Local\ Forecast.raw sounds/laugh.raw music/Secret\ of\ Tiki\ Island.raw music/Unpromised.raw
+
+
+NOISE:
+
+rnnoise_contributions (only "other" and "none" samples)
+    https://people.xiph.org/~jm/demo/rnnoise/rnnoise_contributions.tar.gz
+
+
+COUNT: 13212874 (x87)
+
+NOTE: All files processed into correct raws through ffmpeg: ffmpeg -i in -f s16le -ac 1 -ar 48000 out.raw

models/rnnoise-models/conjoined-burgers-2018-08-28/newweights9i.hdf5.xz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:34b17aa8fbae7784def7be6389dd3efdd563587d94fca6a0a84bf62ed64717e3
+size 134

models/rnnoise-models/leavened-quisling-2018-08-31/info.txt

@@ -0,0 +1,47 @@
+SUITE: leavened-quisling-2018-08-31
+
+INTENT:
+
+Voice in a noisy recording environment.
+
+
+SIGNAL:
+
+voice
+    hamlet-002-act-1-scene-1.1626
+        http://etc.usf.edu/lit2go/94/hamlet/1626/
+    human_rights_un_chi_nf.mp3
+        https://librivox.org/universal-declaration-of-human-rights-by-united-nations-volume-02/
+    human_rights_un_cze_msed.mp3
+        https://librivox.org/universal-declaration-of-human-rights-by-united-nations-volume-02/
+    huntingofthesnark_01_carrol_128kb
+        https://librivox.org/the-hunting-of-the-snark-by-lewis-carroll-3/
+    teacupclub_01_armstrong_128kb
+        https://librivox.org/the-teacup-club-by-eliza-armstrong/
+    warletters_01_allan_128kb.mp3
+        https://librivox.org/war-letters-from-a-young-queenslander-by-robert-marshall-allen/
+    TSPspeech
+        http://www-mmsp.ece.mcgill.ca/Documents/Data/
+
+sounds
+    cough
+        https://freesound.org/ sounds: 205012 222644 252240 323532 342587 343880 343885 343986 369295 391284 401334 407839 419781 425777 87412
+    laugh
+        https://freesound.org/ sounds: 167578 189278 263775 319346 343934 344043 344064 367680 381275 383237 393353 401214 433921 73123
+
+
+./chopper voice/hamlet-002-act-1-scene-1.1626.raw voice/human_rights_un_chi_nf.raw sounds/cough.raw voice/human_rights_un_cze_msed.raw voice/huntingofthesnark_01_carrol_128kb.raw sounds/laugh.raw voice/teacupclub_01_armstrong_128kb.raw voice/warletters_01_allan_128kb.raw voice/TSPspeech.raw
+
+
+NOISE:
+
+rnnoise_contributions
+    https://people.xiph.org/~jm/demo/rnnoise/rnnoise_contributions.tar.gz
+
+
+./noise-chopper *.raw
+
+
+COUNT: 10000000 (x87)
+
+NOTE: All files processed into correct raws through ffmpeg: ffmpeg -i in -f s16le -ac 1 -ar 48000 out.raw

models/rnnoise-models/leavened-quisling-2018-08-31/weights.hdf5.xz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:299f77c57f81ec722576480079723473b7cd2a53724adb6c34ddd7506acf8638
+size 970328

models/rnnoise-models/marathon-prescription-2018-08-29/info.txt

@@ -0,0 +1,55 @@
+SUITE: marathon-prescription-2018-08-29
+
+INTENT:
+
+General use in a noisy recording environment.
+
+
+SIGNAL:
+
+voice
+    hamlet-002-act-1-scene-1.1626
+        http://etc.usf.edu/lit2go/94/hamlet/1626/
+    human_rights_un_chi_nf.mp3
+        https://librivox.org/universal-declaration-of-human-rights-by-united-nations-volume-02/
+    human_rights_un_cze_msed.mp3
+        https://librivox.org/universal-declaration-of-human-rights-by-united-nations-volume-02/
+    huntingofthesnark_01_carrol_128kb
+        https://librivox.org/the-hunting-of-the-snark-by-lewis-carroll-3/
+    teacupclub_01_armstrong_128kb
+        https://librivox.org/the-teacup-club-by-eliza-armstrong/
+    warletters_01_allan_128kb.mp3
+        https://librivox.org/war-letters-from-a-young-queenslander-by-robert-marshall-allen/
+    TSPspeech
+        http://www-mmsp.ece.mcgill.ca/Documents/Data/
+
+sounds
+    cough
+        https://freesound.org/ sounds: 205012 222644 252240 323532 342587 343880 343885 343986 369295 391284 401334 407839 419781 425777 87412
+    laugh
+        https://freesound.org/ sounds: 167578 189278 263775 319346 343934 344043 344064 367680 381275 383237 393353 401214 433921 73123
+
+music
+    Danse Macabre
+    Gymnopedie No 1
+    Local Forecast
+    Secret of Tiki Island
+    Unpromised
+        https://incompetech.com/music/royalty-free/
+
+
+./chopper voice/hamlet-002-act-1-scene-1.1626.raw voice/human_rights_un_chi_nf.raw sounds/cough.raw voice/human_rights_un_cze_msed.raw voice/huntingofthesnark_01_carrol_128kb.raw sounds/laugh.raw voice/teacupclub_01_armstrong_128kb.raw voice/warletters_01_allan_128kb.raw voice/TSPspeech.raw sounds/cough.raw music/Danse\ Macabre.raw music/Gymnopedie\ No\ 1.raw music/Local\ Forecast.raw sounds/laugh.raw music/Secret\ of\ Tiki\ Island.raw music/Unpromised.raw
+
+
+NOISE:
+
+rnnoise_contributions
+    https://people.xiph.org/~jm/demo/rnnoise/rnnoise_contributions.tar.gz
+
+
+./noise-chopper *.raw
+
+
+COUNT: 10000000 (x87)
+
+NOTE: All files processed into correct raws through ffmpeg: ffmpeg -i in -f s16le -ac 1 -ar 48000 out.raw

models/rnnoise-models/marathon-prescription-2018-08-29/newweights9i.hdf5.xz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:117030e468a340129897e7d7de793a071f7a7293a2faf2a11d07e131aa3ba95f
+size 972476

models/rnnoise-models/somnolent-hogwash-2018-09-01/info.txt

@@ -0,0 +1,40 @@
+SUITE: somnolent-hogwash-2018-09-01
+
+INTENT:
+
+Speech in a reasonable recording environment. Fans, AC, computers, etc. Note
+that "speech" means speech, not other human sounds; laughter, coughing, etc are
+not included.
+
+
+SIGNAL:
+
+voice
+    hamlet-002-act-1-scene-1.1626
+        http://etc.usf.edu/lit2go/94/hamlet/1626/
+    human_rights_un_chi_nf.mp3
+        https://librivox.org/universal-declaration-of-human-rights-by-united-nations-volume-02/
+    human_rights_un_cze_msed.mp3
+        https://librivox.org/universal-declaration-of-human-rights-by-united-nations-volume-02/
+    huntingofthesnark_01_carrol_128kb
+        https://librivox.org/the-hunting-of-the-snark-by-lewis-carroll-3/
+    teacupclub_01_armstrong_128kb
+        https://librivox.org/the-teacup-club-by-eliza-armstrong/
+    warletters_01_allan_128kb.mp3
+        https://librivox.org/war-letters-from-a-young-queenslander-by-robert-marshall-allen/
+    TSPspeech
+        http://www-mmsp.ece.mcgill.ca/Documents/Data/
+
+
+./chopper voice/hamlet-002-act-1-scene-1.1626.raw voice/human_rights_un_chi_nf.raw voice/human_rights_un_cze_msed.raw voice/huntingofthesnark_01_carrol_128kb.raw voice/teacupclub_01_armstrong_128kb.raw voice/warletters_01_allan_128kb.raw voice/TSPspeech.raw
+
+
+NOISE:
+
+rnnoise_contributions (only "other" and "none" samples)
+    https://people.xiph.org/~jm/demo/rnnoise/rnnoise_contributions.tar.gz
+
+
+COUNT: 13212874 (x87)
+
+NOTE: All files processed into correct raws through ffmpeg: ffmpeg -i in -f s16le -ac 1 -ar 48000 out.raw

models/rnnoise-models/somnolent-hogwash-2018-09-01/weights.hdf5.xz

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ecd811e9fa72e11b470a0455f9c7878004384a77c013247eb19f581f94d33ae7
+size 973500

models/rnnoise-models/source.txt

@@ -0,0 +1 @@
+https://github.com/sparrowli/rnnoise-models

models/rnnoise-models/tools/TSPspeech.raw.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+set -e
+[ -d TSPspeech ] || (
+    mkdir -p TSPspeech
+    cd TSPspeech
+    7z x ../TSPspeech.iso
+)
+for i in `seq -w 01 10`
+do
+    for j in TSPspeech/48k/*/*$i.wav
+    do
+        [ ! -e "$j" ] || ffmpeg -i "$j" -f s16le -ac 1 -ar 48000 -
+    done
+done > TSPspeech.raw

models/rnnoise-models/tools/chopper.c

@@ -0,0 +1,82 @@
+/*
+ * Copyright (c) 2018 Gregor Richards
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+ * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
+ * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+ * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 
+ */
+
+#include <fcntl.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <sys/types.h>
+#include <unistd.h>
+
+#define CHOP_SZ 384000
+
+int main(int argc, char **argv)
+{
+    int *fds;
+    int i;
+    ssize_t rd, total;
+    short buf[CHOP_SZ];
+
+    fds = malloc((argc-1)*sizeof(int));
+    if (fds == NULL) {
+        perror("malloc");
+        exit(1);
+    }
+
+    /* Open each file */
+    for (i = 1; i < argc; i++) {
+        int fd = open(argv[i], O_RDONLY);
+        if (fd < 0) {
+            perror(argv[i]);
+            exit(1);
+        }
+        fds[i-1] = fd;
+    }
+
+    /* Loop over the input */
+    while (1) {
+        char haveInput = 0;
+
+        /* Loop over each file */
+        for (i = 0; i < argc - 1; i++) {
+            int fd = fds[i];
+            if (fd < 0) continue;
+            haveInput = 1;
+
+            /* Take an appropriate chunk */
+            total = 0;
+            while (total < sizeof(buf)) {
+                rd = read(fd, ((char *) buf) + total, sizeof(buf) - total);
+                if (rd <= 0) {
+                    close(fd);
+                    fds[i] = -1;
+                    break;
+                }
+                total += rd;
+            }
+            if (total == 0 || (total%sizeof(short)) != 0)
+                continue;
+
+            /* Write it out */
+            write(1, buf, total);
+        }
+
+        /* Stop if they were all ended */
+        if (!haveInput)
+            break;
+    }
+
+    return 0;
+}

models/rnnoise-models/tools/noise-chopper.c

@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) 2018 Gregor Richards
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+ * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
+ * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+ * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 
+ */
+
+#include <fcntl.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <sys/types.h>
+#include <unistd.h>
+
+#define TOTAL_SZ (10000000LL * 480)
+
+int main(int argc, char **argv)
+{
+    FILE *fh;
+    int i;
+    short *buf = NULL;
+    long perFileSz = TOTAL_SZ / (argc-1);
+    long fileSz;
+    size_t rd;
+
+    buf = malloc(perFileSz * sizeof(short));
+    if (!buf) {
+        perror("malloc");
+        return 1;
+    }
+
+    /* Loop over the input */
+    for (i = 1; i < argc; i++) {
+        /* Seek to the middle */
+        fh = fopen(argv[i], "rb");
+        fseek(fh, 0, SEEK_END);
+        fileSz = ftell(fh) / sizeof(short);
+        if (fileSz > perFileSz)
+            fseek(fh, (fileSz / 2 - perFileSz / 2) * sizeof(short), SEEK_SET);
+        else
+            fseek(fh, 0, SEEK_SET);
+
+        /* Read it in */
+        rd = fread(buf, sizeof(short), perFileSz, fh);
+        fclose(fh);
+
+        /* And write it out */
+        write(1, buf, rd * sizeof(short));
+    }
+
+    return 0;
+}

models/rnnoise-models/tools/sounds.raw.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+for i in cough laugh
+do
+    touch $i.raw
+    SZ=`wc -c $i.raw | cut -d' ' -f1`
+    while [ "$SZ" -lt 300000000 ]
+    do
+        cat $i/*.raw >> $i.raw
+        SZ=`wc -c $i.raw | cut -d' ' -f1`
+    done
+done

models/rnnoise-wrapper/README.md

@@ -0,0 +1,142 @@
+# RNNoise Wrapper
+
+Это простая обёртка на Python для шумоподавления [RNNoise](https://github.com/xiph/rnnoise). Поддерживается только Python 3. Код основан на [issue от snakers4](https://github.com/xiph/rnnoise/issues/69) из репозитория RNNoise, за что ему отдельное спасибо.
+
+[RNNoise](https://jmvalin.ca/demo/rnnoise/) - это рекуррентная нейронная сеть с ячейками GRU, предназначенная для подаления шума в аудиозаписи в реальном времени (работает даже на Raspberry Pi). Стандартная модель обучена на 6.4Гб зашумленных аудиозаписей и полностью готова к использованию.
+
+RNNoise написан на C и имеет методы для шумоподавления одного фрейма длиной 10 миллисекунд. Фрейм должен быть с частотой дискретизации 48000Гц, моно, 16 бит.
+
+**RNNoise_Wrapper** упрощает работу с RNNoise:
+
+- избавляет от необходимости самому извлекать фреймы/кадры из аудиозаписи
+- снимает ограничения на параметры обрабатываемой wav аудиозаписи
+- скрывает все нюансы работы с библиотекой на C
+- избавляет от необходимости вручную компилировать RNNoise (только для Linux)
+- добавляет 2 новых бинарных файла с более качественными моделями, которые поставляются вместе с пакетом (только для Linux)
+
+**RNNoise_Wrapper содержит 2 новые более качественные модели** (обученные веса и скомпилированные бинарники RNNoise для Linux). Для обучения использовался датасет от [Microsoft DNS Challenge](https://github.com/microsoft/DNS-Challenge).
+
+1. **librnnoise_5h_ru_500k** — обучена на 5 часах русской речи (с подмешиванием эмоциональной речи и пения на английском языке), полученной скриптом из репозитория с датасетом. Обученные веса находятся в [`train_logs/weights_5h_ru_500k.hdf5`](https://github.com/Desklop/RNNoise_Wrapper/tree/master/train_logs/weights_5h_ru_500k.hdf5), скомпилированный RNNoise в [`rnnoise_wrapper/libs/librnnoise_5h_ru_500k.so.0.4.1`](https://github.com/Desklop/RNNoise_Wrapper/tree/master/rnnoise_wrapper/libs/librnnoise_5h_ru_500k.so.0.4.1) (только для Linux)
+
+2. **librnnoise_5h_b_500k** — обучена на 5 часах смешанной речи на английском, русском, немецком, французском, итальянском, испанском языках и мандаринского наречия китайского языка (с подмешиванием эмоциональной речи и пения на английском языке). Датасет для каждого языка предварительно был обрезан по самому наименьшему из них (меньше всего данных для русского языка, около 47 часов). Финальная обучающая выборка получена скриптом из репозитория с датасетом. Обученные веса находятся в [`train_logs/weights_5h_b_500k.hdf5`](https://github.com/Desklop/RNNoise_Wrapper/tree/master/train_logs/weights_5h_b_500k.hdf5), скомпилированный RNNoise в [`rnnoise_wrapper/libs/librnnoise_5h_b_500k.so.0.4.1`](https://github.com/Desklop/RNNoise_Wrapper/tree/master/rnnoise_wrapper/libs/librnnoise_5h_b_500k.so.0.4.1) (только для Linux)
+
+3. **librnnoise_default** — стандартная модель от авторов [RNNoise](https://jmvalin.ca/demo/rnnoise/)
+
+Модели `librnnoise_5h_ru_500k` и `librnnoise_5h_b_500k` имеют **практически одинаковое качество** шумоподавления. `librnnoise_5h_ru_500k` больше всего **подходит для работы с русской речью**, а `librnnoise_5h_b_500k` — **для смешанной речи** либо речи на не русском языке, она более универсальна.
+
+Сравнительные примеры работы новых моделей со стандартной доступны в [`test_audio/comparative_tests`](https://github.com/Desklop/RNNoise_Wrapper/tree/master/test_audio/comparative_tests).
+
+Данн��я обёртка на CPU Intel i7-10510U **работает в 28-30 раз быстрее реального времени** при шумоподавлении целой аудиозаписи, и **в 18-20 раз быстрее реального времени** при работе в потоковом режиме (т.е. обработки фрагментов аудио длиной 20 мс). При этом было задействовано только 1 ядро, нагрузка на которое составила около 80-100%.
+
+## Установка
+
+Данная обёртка имеет следующие зависимости: [pydub](https://github.com/jiaaro/pydub) и [numpy](https://github.com/numpy/numpy).
+
+Установка с помощью pip:
+
+```bash
+pip install git+https://github.com/Desklop/RNNoise_Wrapper
+```
+
+**ВНИМАНИЕ!** Перед использованием обёртки, RNNoise необходимо скомпилировать. Если вы используете **Linux или Mac**, вы можете использовать **заранее скомпилированный RNNoise** (в ОС Ubuntu 19.10 64 bit), который **поставляется с пакетом** (он так же работает в Google Colaboratory). Если стандартный бинарный файл у вас не работает, попробуйте вручную скомпилировать RNNoise. Для этого необходимо сначала подготовить вашу ОС (предполагается, что `gcc` уже установлен):
+
+```bash
+sudo apt-get install autoconf libtool
+```
+
+И выполнить:
+
+```bash
+git clone https://github.com/Desklop/RNNoise_Wrapper
+cd RNNoise_Wrapper
+./compile_rnnoise.sh
+```
+
+После этого в папке `rnnoise_wrapper/libs` появится файл `librnnoise_default.so.0.4.1`. Путь к данному бинарному файлу нужно передать при создании объекта класса RNNoise из данной обёртки (подробнее см. ниже).
+
+Если вы используете **Windows**, то вам нужно **вручную скомпилировать RNNoise**. Вышеописанная инструкция не будет работать, **воспользуйтесь** данными **ссылками**: [один](https://github.com/xiph/rnnoise/issues/34), [два](https://github.com/jagger2048/rnnoise-windows). После компиляции путь к бинарному файлу нужно передать при создании объекта класса RNNoise из данной обёртки (подробнее см. ниже).
+
+## Использование
+
+### **1. В коде Python**
+
+**Подавление шума в аудиозаписи** `test.wav` и сохранение результата как `test_denoised.wav`:
+
+```python
+from rnnoise_wrapper import RNNoise
+
+denoiser = RNNoise()
+
+audio = denoiser.read_wav('test.wav')
+denoised_audio = denoiser.filter(audio)
+denoiser.write_wav('test_denoised.wav', denoised_audio)
+```
+
+**Подавление шума в потоковом аудио** (размер буфера равен 20 миллисекунд, т.е. 2 фрейма) (в примере используется имитация потока путём обработки аудиозаписи `test.wav` по частям с сохранением результата как `test_denoised_stream.wav`):
+
+```python
+audio = denoiser.read_wav('test.wav')
+
+denoised_audio = b''
+buffer_size_ms = 20
+
+for i in range(buffer_size_ms, len(audio), buffer_size_ms):
+    denoised_audio += denoiser.filter(audio[i-buffer_size_ms:i].raw_data, sample_rate=audio.frame_rate)
+if len(audio) % buffer_size_ms != 0:
+    denoised_audio += denoiser.filter(audio[len(audio)-(len(audio)%buffer_size_ms):].raw_data, sample_rate=audio.frame_rate)
+
+denoiser.write_wav('test_denoised_stream.wav', denoised_audio, sample_rate=audio.frame_rate)
+```
+
+**Больше примеров работы с обёрткой** можно найти в [`rnnoise_wrapper_functional_tests.py`](https://github.com/Desklop/RNNoise_Wrapper/blob/master/rnnoise_wrapper_functional_tests.py) и [`rnnoise_wrapper_comparative_test.py`](https://github.com/Desklop/RNNoise_Wrapper/blob/master/rnnoise_wrapper_comparative_test.py).
+
+Класс [RNNoise](https://github.com/Desklop/RNNoise_Wrapper/blob/master/rnnoise_wrapper/rnnoise_wrapper.py#L29) содержит следующие методы:
+
+- [`read_wav()`](https://github.com/Desklop/RNNoise_Wrapper/blob/master/rnnoise_wrapper/rnnoise_wrapper.py#L256): принимает имя .wav аудиозаписи, приводит её в поддерживаемый формат (16 бит, моно) и возвращает объект `pydub.AudioSegment` с аудиозаписью
+- [`write_wav()`](https://github.com/Desklop/RNNoise_Wrapper/blob/master/rnnoise_wrapper/rnnoise_wrapper.py#L277): принимает имя .wav аудиозаписи, объект `pydub.AudioSegment` (или байтовую строку с аудиоданными без заголовков wav) и сохраняет аудиозапись под переданным именем
+- [`filter()`](https://github.com/Desklop/RNNoise_Wrapper/blob/master/rnnoise_wrapper/rnnoise_wrapper.py#L150): принимает объект `pydub.AudioSegment` (или байтовую строку с аудиоданными без заголовков wav), приводит его к частоте дискретизации 48000 Гц, **разбивает аудиозапись на фреймы** (длиной 10 миллисекунд), **очищает их от шума и возвращает** объект `pydub.AudioSegment` (или байтовую строку без заголовков wav) с сохранением исходной частоты дискретизации
+- [`filter_frame()`](https://github.com/Desklop/RNNoise_Wrapper/blob/master/rnnoise_wrapper/rnnoise_wrapper.py#L128): очистка только одного фрейма (длиной 10 мс, 16 бит, моно, 48000 Гц) от шума (обращение напрямую к бинарному файлу библиотеки RNNoise)
+
+Подробная информация о поддерживаемых аргументах и работе каждого метода находится в комментариях в исходном коде этих методов.
+
+**По умолчанию используется модель `librnnoise_5h_b_500k`**. При создании объекта класса `RNNoise` из обёртки с помощью аргумента `f_name_lib` можно указать другую модель (бинарник RNNoise):
+
+- **`librnnoise_5h_ru_500k`** или **`librnnoise_default`** для использования одной из комплектных моделей
+- полное/частичное имя/путь к скомпилированному бинарному файлу RNNoise
+
+```python
+denoiser_def = RNNoise(f_name_lib='librnnoise_5h_ru_500k')
+denoiser_new = RNNoise(f_name_lib='path/to/librnnoise.so.0.4.1')
+```
+
+**Особенности основного метода `filter()`:**
+
+- для максимально качественной работы необходима аудиозапись длиной минимум 1 секунда, на которой присутсвует как голос, так и шум (причём шум в идеале должен быть до и после голоса). В противном случае качество шумоподавления будет хуже
+- в случае, если передаются части одной аудиозаписи (шумоподавление потоково аудио), то их длина должна быть не менее `10` мс и кратна `10` (т.к. библиотека RNNoise поддерживает только фреймы длиной `10` мс). Такой вариант работы на качество шумоподавления не влияет
+- если последний фрейм переданной аудиозаписи меньше `10` мс (или передана часть аудио длиной меньше `10` мс), то он дополняется нулями до необходимого размера. Из-за этого возможно небольшое увеличение длины итоговой аудиозаписи после шумоподавления
+- библиотека RNNoise дополнительно для каждого фрейма возвращает вероятность наличия голоса в этом фрейме (в виде числа от `0` до `1`) и с помощью аргумента `voice_prob_threshold` можно отфильтровать фреймы по этому значению. Если вероятность ниже, чем `voice_prob_threshold`, то фрейм будет удалён из аудиозаписи
+
+### **2. В качестве инструмента командной строки**
+
+```bash
+python3 -m rnnoise_wrapper.cli -i input.wav -o output.wav
+```
+
+или
+
+```bash
+rnnoise_wrapper -i input.wav -o output.wav
+```
+
+Где:
+
+- `input.wav` - имя исходной .wav аудиозаписи
+- `output.wav` - имя .wav аудиофайла, в который будет сохранена аудиозапись после шумоподавления
+
+## Обучение
+
+Инструкция по обучению RNNoise на своих данных находится в [`TRAINING.md`](https://github.com/Desklop/RNNoise_Wrapper/tree/master/TRAINING.md).
+
+---
+
+Если у вас возникнут вопросы или вы хотите сотрудничать, можете написать мне на почту: vladsklim@gmail.com или в [LinkedIn](https://www.linkedin.com/in/vladklim/).

models/rnnoise-wrapper/languages.txt

@@ -0,0 +1,2 @@
+RU                              train_logs/weights_5h_ru_500k.hdf5       rnnoise_wrapper/libs/librnnoise_5h_ru_500k.so.0.4.1
+DE, ES, EN, FR, IT, RU, ZH      train_logs/weights_5h_b_500k.hdf5        rnnoise_wrapper/libs/librnnoise_5h_b_500k.so.0.4.1

models/rnnoise-wrapper/source.txt

@@ -0,0 +1 @@
+https://github.com/dbklim/RNNoise_Wrapper

models/rnnoise-wrapper/weights_5h_b_500k.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:eb2d2e150f96a37ef694608d6cb4ccfeea1e6f74a043f0fa3c90cf97141dd52e
+size 1104400

models/rnnoise-wrapper/weights_5h_ru_500k.hdf5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:31196c145c2605adf0f863e3bbc448cea61e31ca8551f5652baed28c9a076cf2
+size 1104400