-
Notifications
You must be signed in to change notification settings - Fork 237
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
18 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,45 @@ | ||
| #VST Noise Suppression Plugin | ||
| # VST Noise Suppression Plugin | ||
|
|
||
| A real-time noise suppression VST plugin for voice based on [Xiph's RNNoise](https://github.com/xiph/rnnoise). [More info about the base library](https://people.xiph.org/~jm/demo/rnnoise/). | ||
| A real-time noise suppression VST and LV2 plugin for voice based on [Xiph's RNNoise](https://github.com/xiph/rnnoise). [More info about the base library](https://people.xiph.org/~jm/demo/rnnoise/). | ||
|
|
||
| ##About | ||
| ## About | ||
|
|
||
| The plugin is meant to suppress a wide range of noise origins ([from original paper](https://arxiv.org/pdf/1709.08243.pdf)): computer fans, office, crowd, airplane, car, train, construction. | ||
|
|
||
| From my tests mild background noise is always suppressed, loud sounds, like clicking of mechanical keyboard, are suppressed while there is no voice however they are only reduced in volume when voice is present. | ||
|
|
||
| The plugin is made to work with 1 channel, 16 bit, 48000 Hz audio input. Other sample rates may work, or not... | ||
|
|
||
| ## How-to | ||
|
|
||
| ### Windows + Equalizer APO | ||
| To check or change mic settings go to "Recording devices" -> "Recording" -> "Properties" of the target mic -> "Advanced". | ||
|
|
||
| To enable the plugin in Equalizer APO select "Plugins" -> "VST Plugin" and specify the plugin dll. | ||
|
|
||
| ##Status | ||
| ### Linux | ||
|
|
||
| Testing required. | ||
|
|
||
| ## Status | ||
|
|
||
| The plugin is tested with Equalizer APO v1.2 x64 (open source system-wide equalizer for Windows). It is a minimal proof-of-concept work. | ||
|
|
||
| I'm not associated with the original work in any way and have only superficial understanding of it. The original author will probably create something better out of their work but for now I don't see any analogs with similar capabilities so I have created a usable one. | ||
|
|
||
| ##Developing | ||
| ## Developing | ||
|
|
||
| The plugin is built with gcc in mingw environment for x32 and x64 architectures, the current cmake project is made for such environment and may need changes in order to support other ones. | ||
|
|
||
| VST sdk files aren't shipped here due to their license. You need to download VST sdk and copy several files to src/pluginterfaces/vst2.x/ and to src/vst2.x/. You can find sdk [here](https://www.steinberg.net/en/company/developers.html). | ||
|
|
||
| ##Future | ||
| LV2 sdk files are | ||
|
|
||
| ## ☑ TODO | ||
|
|
||
| * It would be great to create lv2 plugin to be used on Linux (there was already an [attempt](https://github.com/lucianodato/speech-denoiser) to do this). | ||
| * Try to train the net with data for specific cases and see if will do better for them. | ||
| - [X] Create LV2 plugin. | ||
| - [ ] Try to train the net with data for specific cases and see if will do better for them. | ||
|
|
||
| ##License | ||
| ## License | ||
|
|
||
| This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details. |