rmichon
commented
6 years ago Hey Bart! Yes, that would be great! In order for this to be added to the libraries, some standards should be respected so your code integrates with what's already out there. First, each function should be documented by declaring this before the function itself:
//--------------------`(co.)compressor_mono`-------------------
// Description
//
// #### Usage
//
// ```
// _ : compressor_mono(ratio,thresh,att,rel) : _
// ```
//
// Where:
//
// * `ratio`: compression ratio (1 = no compression, >1 means compression)
// * `thresh`: dB level threshold above which compression kicks in (0 dB = max level)
// * `att`: attack time = time constant (sec) when level & compression going up
// * `rel`: release time = time constant (sec) coming out of compression
//
// #### References
//
// * Potential references.
//------------------------------------------------------------This system is used to generate the documentation of the libraries so this format should be meticulously respected. All the functions that are "exposed" to the users (i.e., at the root level of the library) should be documented that way: there's no "hidden functions" in the Faust libs. Then you must decide where the functions exposed to the users are going to be declared: which libraries (if a function is not a compressor, then it shouldn't be in the compressor lib), which section of the library (do we need to create new sections?), etc. If a function is only used once by another function and should be "hidden", then it should be declared inside the function that's using it using with{}. Examples (.dsp) files should go in the examples folder of the Faust repo. Just have a look at the source code of the Faust libs to get an idea of how this should be organized...
Beside that, comments within the code are more than welcome, of course and GPLv3 should be fine unless someone objects, @orlarey?
Ideally, to make our life easier, it would be great if you could send us a reformatted version of your system organized in the same way as in the Faust repo. Or you could fork the Faust repo and then we could merge your version with the current master-dev branch. It's up to you...
magnetophon
josmithiii
sletz
I'd like to add most of faustCompressors to the library.
If possible, I'd like it to include proper comment and explanation, in particular for the
slidingReducefunction that lays at the base of it, because without, that code is unreadable. I had trouble understanding my own code, using the comments I wrote 2 years ago, so I re-wrote them.My questions are:
ps: Thanks @rmichon for encouraging me to add this to the libs. I still postponed it for way too long afterwards, mainly because of the above issues...