@jpdutoit/squelchy 0.0.5 → 0.0.6

package/docs/modules.json

@@ -179,6 +179,24 @@
         "name": "Audio Input",
         "description": "Audio signal for lo-fi bit and sample rate reduction.",
         "target": "AudioNode"
+      },
+      "modBits": {
+        "signal": "modulation",
+        "name": "Bit Depth CV",
+        "description": "Added to the BITS knob, in bits (+1 = one more bit). Sweeps smoothly between depths; the result stays within 1–16.",
+        "target": "AudioParam"
+      },
+      "modRate": {
+        "signal": "modulation",
+        "name": "Sample Rate CV",
+        "description": "Added to the RATE knob (+0.1 = 10% of the original rate). The result stays within 1–100%.",
+        "target": "AudioParam"
+      },
+      "modMix": {
+        "signal": "modulation",
+        "name": "Mix CV",
+        "description": "Added to the MIX knob (+0.1 = 10% wetter).",
+        "target": "AudioParam"
       }
     },
     "outputs": {
@@ -192,7 +210,7 @@
     "params": {
       "bits": {
         "name": "Bit Depth",
-        "description": "Number of bits for quantization. Lower = crunchier, more lo-fi.",
+        "description": "Number of bits for quantization. Lower = crunchier, more lo-fi. 1 bit = two levels: a hard full-scale square at the input's pitch.",
         "type": "number",
         "unit": "factor",
         "default": 8,
@@ -274,7 +292,7 @@
       },
       "depth": {
         "name": "Modulation Depth",
-        "description": "How much the delay time is modulated. More = wider detuning. Scaled onto the LFO gain, so it is set-only (no single AudioParam carries it 1:1).",
+        "description": "How far each delay line swings around its 5.66 ms centre: ±4 ms at 1. About 0.46 matches a Juno-60's Chorus I/II swing; more = wider detuning. Scaled onto the LFO gain, so it is set-only (no single AudioParam carries it 1:1).",
         "type": "number",
         "unit": "factor",
         "default": 0.5,
@@ -380,7 +398,7 @@
     "panel": "COMP",
     "import": "import { Compressor } from '@jpdutoit/squelchy';",
     "summary": "Dynamics Compressor",
-    "description": "Reduces dynamic range by attenuating loud signals. Threshold sets where compression begins, ratio controls intensity.",
+    "description": "Feed-forward peak compressor with zero latency: turns loud signals down by RATIO above THRS, with attack and release that mean exactly what they say. Stereo signals get one linked gain, so the image never moves. A KEY input (side-chain) lets another signal do the squeezing.",
     "categories": [
       "Dynamics"
     ],
@@ -390,6 +408,12 @@
         "name": "Audio Input",
         "description": "Audio signal to compress.",
         "target": "AudioNode"
+      },
+      "key": {
+        "signal": "audio",
+        "name": "Key (Side-chain) Input",
+        "description": "What the compressor listens to when KEY is set to EXT, e.g. a kick drum to duck a bass. Ignored on INT.",
+        "target": "AudioNode"
       }
     },
     "outputs": {
@@ -403,7 +427,7 @@
     "params": {
       "threshold": {
         "name": "Threshold",
-        "description": "Level above which compression kicks in. Lower = more compression.",
+        "description": "Peak level (dBFS) above which compression kicks in. Lower = more compression. With a soft KNEE it eases in from half the knee width below.",
         "type": "Decibels",
         "unit": "dB",
         "default": -24,
@@ -424,18 +448,18 @@
       },
       "attack": {
         "name": "Attack",
-        "description": "How fast compression responds to loud signals.",
+        "description": "How fast compression grabs a loud signal: the gain reduction gets 63% of the way in this time (nearly all of it in 3×), however hard you hit it.",
         "type": "Seconds",
         "unit": "s",
         "default": 0.003,
-        "min": 0.001,
+        "min": 0.0001,
         "max": 1,
         "scale": "log",
         "automatable": true
       },
       "release": {
         "name": "Release",
-        "description": "How fast compression releases after signal drops.",
+        "description": "How fast compression lets go once the signal drops: the gain reduction falls 63% of the way back in this time (nearly all of it in 3×).",
         "type": "Seconds",
         "unit": "s",
         "default": 0.25,
@@ -446,7 +470,7 @@
       },
       "knee": {
         "name": "Knee",
-        "description": "Width of the transition zone around the threshold. 0 = hard knee (abrupt), 40 = soft knee (gradual).",
+        "description": "Width of the transition zone centred on the threshold. 0 = hard knee (abrupt), 40 = soft knee (gradual).",
         "type": "Decibels",
         "unit": "dB",
         "default": 10,
@@ -462,6 +486,17 @@
         "default": 0,
         "min": 0,
         "max": 30,
+        "automatable": true
+      },
+      "keySource": {
+        "name": "Key Source",
+        "description": "What the compressor listens to. INT: the signal it is compressing. EXT: whatever is patched into KEY (side-chain), e.g. a kick that ducks a bass or pad. The gain still lands on IN.",
+        "type": "\"internal\" | \"external\"",
+        "default": "internal",
+        "options": [
+          "internal",
+          "external"
+        ],
         "automatable": false
       }
     }
@@ -585,7 +620,7 @@
     "panel": "DIM",
     "import": "import { Dimension } from '@jpdutoit/squelchy';",
     "summary": "Dimension Expander",
-    "description": "Roland Dimension-D inspired stereo widener. Adds subtle modulation to create spacious, wide stereo images. Classic 80s lush pad sound.",
+    "description": "Roland Dimension D-style stereo widener: the dry signal plus two short antiphase-modulated delay lines, each cross-fed inverted into the opposite channel. Wide and moving in stereo, clean and unwarbled in mono.",
     "categories": [
       "Effects"
     ],
@@ -612,6 +647,16 @@
       }
     },
     "params": {
+      "width": {
+        "name": "Stereo Width",
+        "description": "Adjusts stereo image. 0=mono, 1=normal, 2=extra wide. Split across a four-gain matrix, so it is set-only (no single AudioParam carries it).",
+        "type": "number",
+        "unit": "factor",
+        "default": 1.5,
+        "min": 0,
+        "max": 2,
+        "automatable": false
+      },
       "rate": {
         "name": "Rate",
         "description": "Widening LFO speed, driven directly by the oscillator frequency. modRate sums into the same AudioParam.",
@@ -624,7 +669,7 @@
       },
       "depth": {
         "name": "Modulation Depth",
-        "description": "Amount of chorus-like modulation for that classic 80s wide sound. Scaled onto the LFO gains, so it is set-only (no single AudioParam carries it 1:1).",
+        "description": "How far the two BBD-style delay lines sweep (full = 1.65–5.35 ms, in antiphase). The dry signal stays in both channels, so this adds movement and width, not vibrato. Scaled onto the LFO gains, so it is set-only (no single AudioParam carries it 1:1).",
         "type": "number",
         "unit": "factor",
         "default": 0.3,
@@ -1213,14 +1258,14 @@
       },
       "resonance": {
         "name": "Resonance",
-        "description": "Sharpness of the formant peaks, scaled per band. Higher values sound more pronounced and vocal.",
+        "description": "Sharpness of the formant peaks. 6 = the bandwidths of a real voice (F1 ≈ 50–80 Hz wide); every band is 6/RES times that, so 1 is soft and blurred, 20 rings like a talk box. Loudness holds across the range.",
         "type": "number",
         "unit": "factor",
         "default": 6,
         "min": 1,
         "max": 20,
         "scale": "sqrt",
-        "automatable": false
+        "automatable": true
       },
       "mix": {
         "name": "Dry/Wet Mix",
@@ -1303,6 +1348,12 @@
         "name": "Audio Input",
         "description": "Audio signal to be gated.",
         "target": "AudioNode"
+      },
+      "key": {
+        "signal": "audio",
+        "name": "Key Input",
+        "description": "What opens the gate when KEY is set to EXT, e.g. a clock, a gate or a hi-hat. Ignored on INT.",
+        "target": "AudioNode"
       }
     },
     "outputs": {
@@ -1322,7 +1373,7 @@
         "default": -40,
         "min": -60,
         "max": 0,
-        "automatable": false
+        "automatable": true
       },
       "range": {
         "name": "Range",
@@ -1332,7 +1383,7 @@
         "default": 0.8,
         "min": 0,
         "max": 1,
-        "automatable": false
+        "automatable": true
       },
       "attack": {
         "name": "Attack",
@@ -1355,6 +1406,17 @@
         "max": 0.5,
         "scale": "log",
         "automatable": true
+      },
+      "keySource": {
+        "name": "Key Source",
+        "description": "What opens the gate. INT: the signal being gated. EXT: whatever is patched into KEY, e.g. a clock or hi-hat that chops a pad into rhythm.",
+        "type": "\"internal\" | \"external\"",
+        "default": "internal",
+        "options": [
+          "internal",
+          "external"
+        ],
+        "automatable": false
       }
     }
   },
@@ -1523,7 +1585,7 @@
       },
       "crossover": {
         "name": "Crossover Frequency",
-        "description": "Frequency where signal splits into low and high bands. Only the lowpass moves; the high band is derived (input − LP) and follows. modCrossover sums into the same AudioParam.",
+        "description": "Frequency where signal splits into low and high bands (−6 dB point of a Linkwitz-Riley 2nd-order pair: both bands 12 dB/oct, summing flat). One audio-rate value drives both filters, so modCrossover moves the split, not just one side.",
         "type": "Hz",
         "unit": "Hz",
         "default": 800,
@@ -1696,7 +1758,7 @@
     "panel": "LO-FI",
     "import": "import { LoFi } from '@jpdutoit/squelchy';",
     "summary": "Lo-Fi Processor",
-    "description": "Lo-fi processor with saturation, lowpass filtering, vinyl noise, and pitch wobble. Perfect for vintage, degraded textures.",
+    "description": "Vintage degradation: asymmetric tape-style saturation (quiet signals keep their level), a lowpass, vinyl hiss and crackle that never loops, and slow wow. Perfect for worn, dusty textures.",
     "categories": [
       "Distortion",
       "Vintage"
@@ -1726,7 +1788,7 @@
     "params": {
       "drive": {
         "name": "Saturation",
-        "description": "Amount of warm tape-like saturation and compression. Rebuilds the waveshaper curve, so it is set-only (no single AudioParam carries it).",
+        "description": "How hard the signal hits an asymmetric tape-style curve (−18 dB clean … +24 dB heavy). Quiet signals keep their level; loud peaks round off with warm even harmonics. Set-only (it reshapes the curve).",
         "type": "number",
         "unit": "factor",
         "default": 0.3,
@@ -1746,23 +1808,23 @@
       },
       "noise": {
         "name": "Vinyl Noise",
-        "description": "Amount of background crackle and hiss for authentic vinyl character. Scaled onto the noise gain, so it is set-only (no single AudioParam carries it 1:1).",
+        "description": "Level of the vinyl surface noise: steady hiss (about −44 dBFS at full) plus random dust ticks and pops. Never repeats.",
         "type": "number",
         "unit": "factor",
         "default": 0.2,
         "min": 0,
         "max": 1,
-        "automatable": false
+        "automatable": true
       },
       "wobble": {
         "name": "Wobble",
-        "description": "Pitch instability like a worn tape or warped record. Scaled onto the wobble-LFO gain, so it is set-only (no single AudioParam carries it 1:1).",
+        "description": "Wow like a worn tape or warped record: a slow 0.73 Hz pitch drift, about ±16 cents at full. Adds WOB × 2 ms of average delay; none at 0.",
         "type": "number",
         "unit": "factor",
         "default": 0.1,
         "min": 0,
         "max": 1,
-        "automatable": false
+        "automatable": true
       }
     }
   },
@@ -1811,6 +1873,16 @@
         "min": 0,
         "max": 2,
         "automatable": true
+      },
+      "width": {
+        "name": "Stereo Width",
+        "description": "Overall stereo width multiplier applied after side gain. 0=mono, 1=normal, 2=wide.",
+        "type": "number",
+        "unit": "factor",
+        "default": 1,
+        "min": 0,
+        "max": 2,
+        "automatable": true
       }
     }
   },
@@ -2093,7 +2165,7 @@
     "panel": "RESO",
     "import": "import { Resonator } from '@jpdutoit/squelchy';",
     "summary": "Resonator",
-    "description": "Modal resonator: five tuned second-order modes that ring when struck. The whole partial series tracks the root note and the V/OCT input exponentially; STRUCT sets the spacing, DAMP the decay time.",
+    "description": "Modal resonator: five tuned second-order modes that ring when struck. The whole partial series tracks the root note and the V/OCT input exponentially; STRUCT sets the spacing, DAMP the decay time. A strike starts every mode at the same level and the higher ones fade first; the same hit is equally loud on every note, at every STRUCT and DAMP setting.",
     "categories": [
       "Filters"
     ],
@@ -2138,7 +2210,7 @@
       },
       "structure": {
         "name": "Structure",
-        "description": "Harmonic spacing of the resonator partials. Left = standard harmonic series, center = bell-like, right = metallic/inharmonic.",
+        "description": "Harmonic spacing of the resonator partials. Left = standard harmonic series, center = bell-like, right = metallic/inharmonic. Loudness holds across the knob.",
         "type": "number",
         "unit": "factor",
         "default": 0,
@@ -2158,10 +2230,10 @@
       },
       "mix": {
         "name": "Dry/Wet Mix",
-        "description": "Balance between original and resonated signal.",
+        "description": "Balance between the input and the ringing modes. Fully wet by default, like a hardware resonator: at 1 you hear only the modes; turn it down to keep the original transient under the ring.",
         "type": "number",
         "unit": "factor",
-        "default": 0.5,
+        "default": 1,
         "min": 0,
         "max": 1,
         "automatable": true
@@ -2173,7 +2245,7 @@
     "panel": "REVERB",
     "import": "import { Reverb } from '@jpdutoit/squelchy';",
     "summary": "Reverb Effect",
-    "description": "Algorithmic Schroeder/FDN reverb: four damped comb filters cross-mixed through a Hadamard matrix, with separate mid and side output taps — a stereo tail that stays exactly mono-compatible, and a stereo input keeps its image. Decay sets RT60 and updates smoothly — nothing is re-rendered when you turn a knob.",
+    "description": "Algorithmic FDN reverb: sixteen damped delay lines cross-mixed through a slowly rotating matrix, so long tails stay smooth and never hum at fixed bass pitches. Left and right have their own lines and taps, so a stereo input keeps its image and a mono one gets a wide, decorrelated tail. Decay sets RT60 and updates smoothly, and nothing is re-rendered when you turn a knob.",
     "categories": [
       "Time"
     ],
@@ -2358,7 +2430,7 @@
     "panel": "SAT",
     "import": "import { Saturator } from '@jpdutoit/squelchy';",
     "summary": "Tape Saturator",
-    "description": "Adds warm analog-style harmonic saturation. Drive pushes into soft clipping, warmth adds low-end emphasis. Subtle grit to heavy crunch.",
+    "description": "Tape-style saturation aligned like a tape machine: quiet signals pass at the same level, loud peaks round off into warm odd harmonics and soft compression. DRIVE moves the knee (tone, not volume), WARMTH adds low-end weight. Subtle glue to heavy crunch.",
     "categories": [
       "Distortion"
     ],
@@ -2381,7 +2453,7 @@
     "params": {
       "drive": {
         "name": "Drive",
-        "description": "How hard to push into saturation. Adds harmonics and soft compression.",
+        "description": "How hard the signal hits the tape curve, from −12 dB (clean) to +24 dB (heavy). The output is trimmed back by the same amount, like a tape machine aligned to its operating level: quiet signals pass at unity, loud peaks round off into harmonics and soft compression. DRIVE changes the tone, not the volume. Set-only (it reshapes the curve).",
         "type": "number",
         "unit": "factor",
         "default": 0.5,
@@ -2391,7 +2463,7 @@
       },
       "warmth": {
         "name": "Warmth",
-        "description": "Low frequency emphasis for a thicker, analog-like tone.",
+        "description": "Low-shelf boost below 300 Hz, up to +6 dB, after the saturation. A tone control for low-end weight, not more distortion.",
         "type": "number",
         "unit": "factor",
         "default": 0.5,
@@ -2485,7 +2557,7 @@
     "panel": "LIMIT",
     "import": "import { SoftLimiter } from '@jpdutoit/squelchy';",
     "summary": "Soft Limiter",
-    "description": "Gentle brickwall limiting with soft knee. Prevents clipping while preserving dynamics. Use ceiling control to set maximum output level.",
+    "description": "Static soft-clip limiter: a smooth curve rounds peaks off toward the ceiling, so the output never exceeds it. No attack or release; it shapes the waveform instantly instead of riding the gain, so pushing it hard adds saturation. Use the ceiling control to set the maximum output level.",
     "categories": [
       "Dynamics"
     ],
@@ -2650,6 +2722,16 @@
         "max": 1,
         "automatable": false
       },
+      "width": {
+        "name": "Dry/Wet",
+        "description": "Balance between mono (0%) and widened (200%) high frequencies.",
+        "type": "number",
+        "unit": "factor",
+        "default": 1,
+        "min": 0,
+        "max": 2,
+        "automatable": true
+      },
       "center": {
         "name": "Crossover Frequency",
         "description": "Frequency above which Haas spreading is applied. Lows below this stay centered for mono compatibility.",
@@ -3261,7 +3343,7 @@
       },
       "depth": {
         "name": "Modulation Depth",
-        "description": "How much the frequency sweeps. Full depth ≈ 3 octaves.",
+        "description": "How much the frequency sweeps. Full depth = 3 octaves top to bottom (±1.5 octaves around the center).",
         "type": "number",
         "unit": "factor",
         "default": 0.6,