documentation

[trebmuh]

Hi @jeremysalwen and thanks for kn0ck0ut-lv2!

I was looking for "how to use it" documentation and found back some information from st3pan0va's times here : https://web.archive.org/web/20130929114530/http://www.freewebs.com/st3pan0va/

That said, it does look that you made quite big progress from there. Could you please explain the differences, in particular what the following controls do ?

• decay
• window size
• overlap factor
• phase compensation
• how to use the "latency"

It'd be great to have the documentation right here in this repo with the code.

Anyway, thanks for kn0ck0ut.

[jeremysalwen]

Hi trebmuh, you're quite right that not much has been changed from stepanova's original version. The differences are all listed in readme.txt.

If you want to add some documentation, I'd be happy to accept a pr.

• knockout works by masking out frequencies that appear in both the left and right channels. The decay control determines how long after a sound occurs in both channels that it is still masked out. Higher values may block out more sound, but may also introduce "reverse-echo" artifacts.
• window size determines how large a window of sound is used for frequency calculations. Larger windows will result in more accurate masking by frequency, but less accurate masking by time.
• Phase compensation is an experimental idea I introduced, which prevents masking frequencies if they are out of phase between the two channels. It may improve or reduce the quality of the result.
• Latency is an output port of the plugin. It tells the effective delay of the plugin, which allows for latency compensation. Some LV2 hosts may support using it automatically.