Skip to content

Commit

Permalink
Fix README.md formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
werman committed Jan 21, 2018
1 parent c14d686 commit bf7e9f9
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#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/).

##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.

Expand All @@ -14,23 +14,23 @@ To check or change mic settings go to "Recording devices" -> "Recording" -> "Pro

To enable the plugin in Equalizer APO select "Plugins" -> "VST Plugin" and specify the plugin dll.

##Status
## 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
## Future

* 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.

##License
## License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.
This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

0 comments on commit bf7e9f9

Please sign in to comment.