From 512541026b53eed24f15c2cf8821c916578f9be9 Mon Sep 17 00:00:00 2001
From: annieversary <annnnnie@protonmail.com>
Date: Tue, 3 Aug 2021 12:41:53 +0200
Subject: [PATCH] [readme] add info about plugins and some other stuff

---
 README.md | 62 +++++++++++++++++++++++++++++++++++++++----------------
 1 file changed, 44 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 6c908bd..9864718 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,10 @@ as of now no plugin has ui, so they all just have a few sliders with whatever lo
 
 ## building a plugin
 
+because steinberg is an incredibly nice company, i can't actually distribute vst2 plugin binaries without a license, which they don't give out anymore :)
+
+so you're gonna have to build the plugins yourself, but don't worry cause it's relatively easy! (i think)
+
 ### macos
 
 to build a plugin, first run:
@@ -32,32 +36,32 @@ alternatively, you can run:
 ./macos.sh packagename
 ```
 
-this will generate `Packagename.vst` in `build` and copy it directly for you
+this will do all three steps directly for you
 
 ### other platforms
 
-no idea what you have to do for other platforms, refer to the `vst-rs` [docs](https://github.com/rustaudio/vst-rs). i think you can just build and take the `.so` or `.dll`, but don't quote me on that
+no idea what you have to do for other platforms, refer to the `vst-rs` [docs](https://github.com/rustaudio/vst-rs). i think you can just build with `cargo b --package package_name --release` and take the `.so` or `.dll`, but don't quote me on that
 
 PRs are welcome for more build instructions
 
-i also might delete the `build` folder from the repo,
-
 ## plugin list
 
 the following is the current list of plugins
 
-- basic_gain: simple gain plugin
-- noted: output midi at regular intervals
-- sosten: granular sustain plugin
-- quinoa: [WIP] granular synthesis plugin
-- XLowpass: reimplementation of [Airwindows XLowpass](http://www.airwindows.com/xlowpass/)
-- multidim: randomized midi note generator
-- robotuna: automatic pitch correction
-- hysteria: hysteresis nonlinear effect
-- threebandeq: 3 band eq
-- threebandwidth: 3 band stereo widener
-- tritu: say-goodbye-to-your-audio distortion
-- threebandfolding: 3 band wave folding distortion
+- `basic_gain`: simple gain plugin
+- `noted`: output midi at regular intervals
+- `sosten`: granular sustain plugin
+- `quinoa`: [WIP] granular synthesis plugin
+- `XLowpass`: reimplementation of [Airwindows XLowpass](http://www.airwindows.com/xlowpass/)
+- `multidim`: randomized midi note generator
+- `robotuna`: automatic pitch correction
+- `hysteria`: hysteresis nonlinear effect
+- `threebandeq`: 3 band eq
+- `threebandwidth`: 3 band stereo widener
+- `tritu`: say-goodbye-to-your-audio distortion
+- `threebandfolding`: 3 band wave folding distortion
+- `double_reverse_delta_inverter`: idk, a weird distortion
+- `transmute_pitch`: pitch to midi converter
 
 ### basic_gain
 
@@ -93,7 +97,7 @@ since this needs a ui so we can select a file to play, and i still don't know ho
 
 ### XLowpass
 
-XLowpass just reimplements [Airwindows XLowpass](http://www.airwindows.com/xlowpass/) in rust. it's a lowpass distortion filter
+XLowpass reimplements [Airwindows XLowpass](http://www.airwindows.com/xlowpass/) in rust. it's a lowpass distortion filter
 
 parameters:
 - `gain`
@@ -187,9 +191,31 @@ parameters:
 
 bands work as they do in `threebandeq`. the `folding freq` parameters control the frequency of the wavefolding. higher is more distortion. use values over 40 if you want to hear white noise
 
+### double-reverse delta inverter
+
+weird kinda distortion that makes loud things quiet and makes quiet things loud
+
+parameters: 
+- `dry/wet`: dry/wet control
+
+yeah there's not many params in this one, the implementation is pretty straightforward. it does weird things: a square wave of amplitude 1 will just be completely eliminated, while sine waves are distorted
+
+the effect is reversible (it's an [involution](https://en.wikipedia.org/wiki/Involution_(mathematics))), so if you add this plugin twice in a row you get the original signal back. this means you can apply drdi to your audio, apply some other effect, and apply drdi again to get some fun stuff
+
+### transmute midi
+
+analyzes pitch of incoming audio and sends out the corresponding midi note
+
+params: 
+- `passthrough`: how much of the original audio to be let through
+
+latency should be close to 1024 samples, which is around 20ms i think. the pitch detection is not excellent and it's monophonic, so if you have a noisy input or a bunch of notes at the same time it's anyone's guess what the midi output will be. there's also no pitch bending or anything fancy like that, so it'll jump around notes even if the input has portamento. 
+
+aside from that, it works well enough on my quick tests
+
 ## contributing
 
-issues and prs are welcome, but please open an issue before making any big pr, i don't wanna have to reject a pr where you have put a lot of effort on
+issues and prs are welcome, but please open an issue before making any big pr, i don't wanna have to reject a pr where you have put a lot of effort on. if you are fine with that, ig go ahead i'm not your mum
 
 ## license