ref: 3cc247773294861e50209f6e4f11224dd89112fb
parent: 7595cb4dabfec9a40ad02cfdb926f872c9bc39b4
author: Paul Batchelor <[email protected]>
date: Fri Jan 1 07:48:04 EST 2021
updates to docs
--- /dev/null
+++ b/modules/data/bigverb.lua
@@ -1,0 +1,62 @@
+sptbl["bigverb"] = {+
+ files = {+ module = "bigverb.c",
+ header = "bigverb.h",
+ example = "ex_bigverb.c",
+ },
+
+ func = {+ create = "sp_bigverb_create",
+ destroy = "sp_bigverb_destroy",
+ init = "sp_bigverb_init",
+ compute = "sp_bigverb_compute",
+ },
+
+ params = {+ optional = {+ {+ name = "feedback",
+ type = "SPFLOAT",
+ description = "Value between 0-1 that sets feedback value. The larger the value, the longer the decay.",
+ default = 0.97
+ },
+ {+ name = "lpfreq",
+ type = "SPFLOAT",
+ description ="low pass cutoff frequency.",
+ default = 10000
+ },
+ }
+ },
+
+ modtype = "module",
+
+ description = [[Reverberation algorithm.]],
+
+ ninputs = 2,
+ noutputs = 2,
+
+ inputs = {+ {+ name = "input_1",
+ description = "First input."
+ },
+ {+ name = "input_2",
+ description = "Second input."
+ },
+ },
+
+ outputs = {+ {+ name = "out_1",
+ description = "Channel 1 output. Most likely for the left channel."
+ },
+ {+ name = "out_2",
+ description = "Channel 2 output. Mose likely for the right channel."
+ },
+ }
+
+}
--- /dev/null
+++ b/modules/data/dcblocker.lua
@@ -1,0 +1,39 @@
+sptbl["dcblocker"] = {+
+ files = {+ module = "dcblocker.c",
+ header = "dcblocker.h",
+ },
+
+ func = {+ create = "sp_dcblocker_create",
+ destroy = "sp_dcblocker_destroy",
+ init = "sp_dcblocker_init",
+ compute = "sp_dcblocker_compute",
+ },
+
+ params = {+ },
+
+ modtype = "module",
+
+ description = [[A simple DC block filter]],
+
+ ninputs = 1,
+ noutputs = 1,
+
+ inputs = {+ {+ name = "in",
+ description = "Signal input"
+ },
+ },
+
+ outputs = {+ {+ name = "out",
+ description = "Signal output"
+ },
+ }
+
+}
--- /dev/null
+++ b/modules/data/fmpair.lua
@@ -1,0 +1,80 @@
+sptbl["fmpair"] = {+
+ files = {+ module = "fmpair.c",
+ header = "fmpair.h",
+ example = "ex_fmpair.c",
+ },
+
+ func = {+ create = "sp_fmpair_create",
+ destroy = "sp_fmpair_destroy",
+ init = "sp_fmpair_init",
+ compute = "sp_fmpair_compute",
+ },
+
+ params = {+ mandatory = {+ {+ name = "tbl",
+ type = "sp_ftbl *",
+ description = "Wavetable to read from. Note: the size of this table must be a power of 2.",
+ default = "N/A"
+ },
+ },
+ optional = {+ {+ name = "freq",
+ type = "SPFLOAT",
+ description = "Frequency (in Hz)",
+ default = 440
+ },
+ {+ name = "amp",
+ type = "SPFLOAT",
+ description ="Amplitude (typically a value between 0 and 1).",
+ default = 0.4
+ },
+ {+ name = "car",
+ type = "SPFLOAT",
+ description ="Carrier frequency, expressed as a ratio number in C:M ratio. Typically an integer.",
+ default = 1
+ },
+ {+ name = "mod",
+ type = "SPFLOAT",
+ description ="Modulator frequency, expressed as a ratio number in C:M ratio. Typically an integer.",
+ default = 1
+ },
+ {+ name = "indx",
+ type = "SPFLOAT",
+ description ="Modulation index. Most commercial synthesizers have a range from 0-8, but there's nothing stopping you from going beyond that.",
+ default = 8
+ },
+ }
+ },
+
+ modtype = "module",
+
+ description = [[FM oscilator pair with linear interpolation]],
+
+ ninputs = 0,
+ noutputs = 1,
+
+ inputs = {+ {+ name = "dummy",
+ description = "This does nothing."
+ },
+ },
+
+ outputs = {+ {+ name = "out",
+ description = "Signal out."
+ },
+ }
+
+}
--- a/modules/data/paulstretch.lua
+++ b/modules/data/paulstretch.lua
@@ -11,6 +11,25 @@
destroy = "sp_paulstretch_destroy",
init = "sp_paulstretch_init",
compute = "sp_paulstretch_compute",
+ other = {+ sp_paulstretch_wavin = {+ description = "stretches input from a wav file via drwav. Use in place of sp_paulstretch_compute.",
+ args = {+ {+ name = "wav",
+ type = "drwav *",
+ description = "a drwav instance opened for reading",
+ default = "N/A"
+ },
+ {+ name = "out",
+ type = "SPFLOAT *",
+ description = "signal output",
+ default = "N/A"
+ }
+ }
+ }
+ }
},
params = {--- /dev/null
+++ b/modules/data/peakeq.lua
@@ -1,0 +1,64 @@
+sptbl["peakeq"] = {+
+ files = {+ module = "peakeq.c",
+ header = "peakeq.h",
+ example = "ex_peakeq.c",
+ },
+
+ func = {+ create = "sp_peakeq_create",
+ destroy = "sp_peakeq_destroy",
+ init = "sp_peakeq_init",
+ compute = "sp_peakeq_compute",
+ },
+
+ params = {+
+ optional = {+ {+ name = "freq",
+ type = "SPFLOAT",
+ description = "The center frequency of the filter",
+ default = 1000
+ },
+ {+ name = "bw",
+ type = "SPFLOAT",
+ description ="The peak/notch bandwidth in Hertz",
+ default = 125
+ },
+ {+ name = "gain",
+ type = "SPFLOAT",
+ description ="The peak/notch gain",
+ default = 2
+ },
+ }
+ },
+
+ modtype = "module",
+
+ description = [[2nd order tunable equalization filter
+
+ This provides a peak/notch filter for building parametric/graphic equalizers. With gain above 1, there will be a peak at the center frequency with a width dependent on bw. If gain is less than 1, a notch is formed around the center frequency (freq).
+ ]],
+
+ ninputs = 1,
+ noutputs = 1,
+
+ inputs = {+ {+ name = "input",
+ description = "Signal input."
+ },
+ },
+
+ outputs = {+ {+ name = "output",
+ description = "Signal output."
+ },
+ }
+
+}