@jpdutoit/squelchy 0.0.5 → 0.0.6

package/index.d.ts

@@ -270,17 +270,29 @@ export declare const Hat: {
 	create(ctx: BaseAudioContext): VoiceInstance;
 };
 /**
- * Gate + pitch CV for driving patchable modules (Envelope trig, V/Oct inputs).
- * `gate` goes to the hit's velocity at `time`, back to 0 after `duration`;
- * `pitch` holds the note (absolute key position, 69 = A4), typed as the
- * library's pitch signal like every other V/OCT output. Both are
- * ConstantSourceNodes.
+ * Gate, pitch and velocity CV for driving patchable modules, like a
+ * MIDI-to-CV interface: `gate` into an Envelope's trigger, `pitch` into V/Oct
+ * inputs, `velocity` into whatever should follow how hard the note was hit
+ * (a VCA's gain, a filter's cutoff CV, an envelope depth).
+ *
+ * - `gate` is a fixed-height gate, like Eurorack: 1 while a note is held, 0
+ *   otherwise, whatever the velocity. (Gate inputs open above 0.5, so a gate
+ *   carrying velocity would silence every soft note.)
+ * - `pitch` holds the note (absolute key position, 69 = A4), typed as the
+ *   library's pitch signal like every other V/OCT output.
+ * - `velocity` is the hit's velocity 0..1, set at note-on and held until the
+ *   next note, so the release tail keeps the level it was played at. 0 until
+ *   the first note.
+ *
+ * All three are ConstantSourceNodes.
  */
 export interface NoteCvInstance {
-	/** Gate CV: the hit's velocity while a note is held, 0 otherwise. */
+	/** Gate CV: 1 while a note is held, 0 otherwise — every hit opens it, whatever its velocity. */
 	gate: ConstantSourceNode;
 	/** Pitch CV: the current note (69 = A4), held between notes. */
 	pitch: ConstantSourceNode & Signal<Note>;
+	/** Velocity CV: the last note's velocity (0..1), held until the next note. */
+	velocity: ConstantSourceNode;
 	trigger(time: Seconds, hit?: Partial<Hit<Note>>): void;
 	dispose(): void;
 }
@@ -414,7 +426,7 @@ export type AutoPanProps = {
 };
 export declare const AutoPan: LibModule<AutoPanParams, AutoPanInputs, AutoPanOutputs, AutoPanProps>;
 export interface BitcrusherParams {
-	/** Bit Depth. Number of bits for quantization. Lower = crunchier, more lo-fi. Range 1–16. Default 8. */
+	/** Bit Depth. Number of bits for quantization. Lower = crunchier, more lo-fi. 1 bit = two levels: a hard full-scale square at the input's pitch. Range 1–16. Default 8. */
 	bits?: number;
 	/** Sample Rate. Sample rate reduction factor. 1 = original, lower = more aliased and crunchy. Creates the classic "staircase" sample-and-hold effect. Range 0.01–1 (log). Default 0.5. */
 	rate?: number;
@@ -423,6 +435,9 @@ export interface BitcrusherParams {
 }
 export type BitcrusherInputs = {
 	"in": AudioNode;
+	"modBits": AudioParam;
+	"modRate": AudioParam;
+	"modMix": AudioParam;
 };
 export type BitcrusherOutputs = {
 	"out": AudioNode;
@@ -431,6 +446,9 @@ export type BitcrusherOutputs = {
 export type BitcrusherProps = {
 	"in": AudioNode;
 	"out": AudioNode;
+	"modBits": AudioParam;
+	"modRate": AudioParam;
+	"modMix": AudioParam;
 	readonly params: {
 		/** Bit Depth. Native AudioParam — value is the param value 1:1. */
 		"bits": AudioParam;
@@ -444,7 +462,7 @@ export declare const Bitcrusher: LibModule<BitcrusherParams, BitcrusherInputs, B
 export interface ChorusParams {
 	/** Rate. Chorus sweep LFO speed, driven directly by the oscillator frequency. modRate sums into the same AudioParam. Range 0.1–5 Hz. Default 1.5. */
 	rate?: Hz;
-	/** Modulation Depth. 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). Range 0–1. Default 0.5. */
+	/** Modulation Depth. 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). Range 0–1. Default 0.5. */
 	depth?: number;
 	/** Dry/Wet Mix. Balance between original and chorused signal, driven by one ConstantSource (dry = 1 − mix·0.5, wet = mix — the antiphase voices already carry half the width at mix 1). Range 0–1. Default 0.5. */
 	mix?: number;
@@ -506,21 +524,24 @@ export type CombFilterProps = {
 };
 export declare const CombFilter: LibModule<CombFilterParams, CombFilterInputs, CombFilterOutputs, CombFilterProps>;
 export interface CompressorParams {
-	/** Threshold. Level above which compression kicks in. Lower = more compression. Range -60–0 dB. Default -24. */
+	/** Threshold. Peak level (dBFS) above which compression kicks in. Lower = more compression. With a soft KNEE it eases in from half the knee width below. Range -60–0 dB. Default -24. */
 	threshold?: Decibels;
 	/** Ratio. How much to reduce signal above threshold. 4:1 = every 4dB over becomes 1dB. Range 1–20 (log). Default 4. */
 	ratio?: number;
-	/** Attack. How fast compression responds to loud signals. Range 0.001–1 s (log). Default 0.003. */
+	/** Attack. 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. Range 0.0001–1 s (log). Default 0.003. */
 	attack?: Seconds;
-	/** Release. How fast compression releases after signal drops. Range 0.01–1 s (log). Default 0.25. */
+	/** Release. 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×). Range 0.01–1 s (log). Default 0.25. */
 	release?: Seconds;
-	/** Knee. Width of the transition zone around the threshold. 0 = hard knee (abrupt), 40 = soft knee (gradual). Range 0–40 dB. Default 10. */
+	/** Knee. Width of the transition zone centred on the threshold. 0 = hard knee (abrupt), 40 = soft knee (gradual). Range 0–40 dB. Default 10. */
 	knee?: Decibels;
 	/** Makeup Gain. Boosts the output level to compensate for gain reduction. Up to +30 dB. Range 0–30 dB. Default 0. */
 	makeup?: Decibels;
+	/** Key Source. 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. Default "internal". */
+	keySource?: "internal" | "external";
 }
 export type CompressorInputs = {
 	"in": AudioNode;
+	"key": AudioNode;
 };
 export type CompressorOutputs = {
 	"out": AudioNode;
@@ -528,6 +549,7 @@ export type CompressorOutputs = {
 /** Port properties on the instance: slug → native connect target (same as input()/output()). */
 export type CompressorProps = {
 	"in": AudioNode;
+	"key": AudioNode;
 	"out": AudioNode;
 	readonly params: {
 		/** Threshold. Native AudioParam — value is dB 1:1. */
@@ -540,6 +562,8 @@ export type CompressorProps = {
 		"release": AudioParam;
 		/** Knee. Native AudioParam — value is dB 1:1. */
 		"knee": AudioParam;
+		/** Makeup Gain. Native AudioParam — value is dB 1:1. */
+		"makeup": AudioParam;
 	};
 };
 export declare const Compressor: LibModule<CompressorParams, CompressorInputs, CompressorOutputs, CompressorProps>;
@@ -596,9 +620,11 @@ export type DelayProps = {
 };
 export declare const Delay: LibModule<DelayParams, DelayInputs, DelayOutputs, DelayProps>;
 export interface DimensionParams {
+	/** Stereo Width. 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). Range 0–2. Default 1.5. */
+	width?: number;
 	/** Rate. Widening LFO speed, driven directly by the oscillator frequency. modRate sums into the same AudioParam. Range 0.1–5 Hz. Default 0.5. */
 	rate?: Hz;
-	/** Modulation Depth. 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). Range 0–1. Default 0.3. */
+	/** Modulation Depth. 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). Range 0–1. Default 0.3. */
 	depth?: number;
 }
 export type DimensionInputs = {
@@ -846,7 +872,7 @@ export declare const Flanger: LibModule<FlangerParams, FlangerInputs, FlangerOut
 export interface FormantParams {
 	/** Vowel Morph. Position along the A-E-I-O-U vowel formant chain. 0 = A, 5 wraps back to A; fractional values interpolate between neighbouring vowels. Range 0–5. Default 0. */
 	morph?: number;
-	/** Resonance. Sharpness of the formant peaks, scaled per band. Higher values sound more pronounced and vocal. Range 1–20 (sqrt). Default 6. */
+	/** Resonance. 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. Range 1–20 (sqrt). Default 6. */
 	resonance?: number;
 	/** Dry/Wet Mix. Balance between the original signal and the formant-filtered output. 0 = dry, 1 = fully wet. Range 0–1. Default 1. */
 	mix?: number;
@@ -863,7 +889,10 @@ export type FormantProps = {
 	"in": AudioNode;
 	"out": AudioNode;
 	"modVowel": AudioNode;
-	readonly params: Record<never, never>;
+	readonly params: {
+		/** Resonance. Native AudioParam — value is the param value 1:1. */
+		"resonance": AudioParam;
+	};
 };
 export declare const Formant: LibModule<FormantParams, FormantInputs, FormantOutputs, FormantProps>;
 export interface FrequencyShifterParams {
@@ -901,9 +930,12 @@ export interface GateParams {
 	attack?: Seconds;
 	/** Release. How fast the gate closes when signal falls below threshold. Range 0.01–0.5 s (log). Default 0.1. */
 	release?: Seconds;
+	/** Key Source. 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. Default "internal". */
+	keySource?: "internal" | "external";
 }
 export type GateInputs = {
 	"in": AudioNode;
+	"key": AudioNode;
 };
 export type GateOutputs = {
 	"out": AudioNode;
@@ -911,8 +943,13 @@ export type GateOutputs = {
 /** Port properties on the instance: slug → native connect target (same as input()/output()). */
 export type GateProps = {
 	"in": AudioNode;
+	"key": AudioNode;
 	"out": AudioNode;
 	readonly params: {
+		/** Threshold. Native AudioParam — value is dB 1:1. */
+		"threshold": AudioParam;
+		/** Range. Native AudioParam — value is the param value 1:1. */
+		"range": AudioParam;
 		/** Attack. Native AudioParam — value is s 1:1. */
 		"attack": AudioParam;
 		/** Release. Native AudioParam — value is s 1:1. */
@@ -971,7 +1008,7 @@ export interface HarmonicTremoloParams {
 	rate?: Hz;
 	/** Modulation Depth. Intensity of the volume modulation. Split across the low- and high-band LFO gains, so it is set-only (no single AudioParam carries it). Range 0–1. Default 0.7. */
 	depth?: number;
-	/** Crossover Frequency. 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. Range 200–2000 Hz. Default 800. */
+	/** Crossover Frequency. 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. Range 200–2000 Hz. Default 800. */
 	crossover?: Hz;
 }
 export type HarmonicTremoloInputs = {
@@ -1065,13 +1102,13 @@ export type LfoProps = {
 };
 export declare const Lfo: LibModule<LfoParams, LfoInputs, LfoOutputs, LfoProps>;
 export interface LoFiParams {
-	/** Saturation. Amount of warm tape-like saturation and compression. Rebuilds the waveshaper curve, so it is set-only (no single AudioParam carries it). Range 0–1. Default 0.3. */
+	/** Saturation. 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). Range 0–1. Default 0.3. */
 	drive?: number;
 	/** Cutoff. Lowpass filter frequency. Lower = more muffled, vintage sound. Range 500–8000 Hz. Default 4000. */
 	cutoff?: Hz;
-	/** Vinyl Noise. 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). Range 0–1. Default 0.2. */
+	/** Vinyl Noise. Level of the vinyl surface noise: steady hiss (about −44 dBFS at full) plus random dust ticks and pops. Never repeats. Range 0–1. Default 0.2. */
 	noise?: number;
-	/** Wobble. 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). Range 0–1. Default 0.1. */
+	/** Wobble. 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. Range 0–1. Default 0.1. */
 	wobble?: number;
 }
 export type LoFiInputs = {
@@ -1089,6 +1126,10 @@ export type LoFiProps = {
 	readonly params: {
 		/** Cutoff. Native AudioParam — value is Hz 1:1. */
 		"cutoff": AudioParam;
+		/** Vinyl Noise. Native AudioParam — value is the param value 1:1. */
+		"noise": AudioParam;
+		/** Wobble. Native AudioParam — value is the param value 1:1. */
+		"wobble": AudioParam;
 	};
 };
 export declare const LoFi: LibModule<LoFiParams, LoFiInputs, LoFiOutputs, LoFiProps>;
@@ -1097,6 +1138,8 @@ export interface MidSideParams {
 	midGain?: number;
 	/** Side Gain. Controls the stereo edges/differences between left and right. Range 0–2. Default 1. */
 	sideGain?: number;
+	/** Stereo Width. Overall stereo width multiplier applied after side gain. 0=mono, 1=normal, 2=wide. Range 0–2. Default 1. */
+	width?: number;
 }
 export type MidSideInputs = {
 	"in": AudioNode;
@@ -1113,6 +1156,8 @@ export type MidSideProps = {
 		"midGain": AudioParam;
 		/** Side Gain. Native AudioParam — value is the param value 1:1. */
 		"sideGain": AudioParam;
+		/** Stereo Width. Native AudioParam — value is the param value 1:1. */
+		"width": AudioParam;
 	};
 };
 export declare const MidSide: LibModule<MidSideParams, MidSideInputs, MidSideOutputs, MidSideProps>;
@@ -1239,11 +1284,11 @@ export declare const PingPong: LibModule<PingPongParams, PingPongInputs, PingPon
 export interface ResonatorParams {
 	/** Root Pitch Offset. Semitones added to the V/OCT input. Unpatched the input is silent, so this is the root note itself: 57 = A3 (220 Hz). Driven by a keyboard or sequencer, 0 tracks the incoming notes. Every partial follows. Range -48–108 semitones. Default 57. */
 	offset?: Semitones;
-	/** Structure. Harmonic spacing of the resonator partials. Left = standard harmonic series, center = bell-like, right = metallic/inharmonic. Range 0–1. Default 0. */
+	/** Structure. Harmonic spacing of the resonator partials. Left = standard harmonic series, center = bell-like, right = metallic/inharmonic. Loudness holds across the knob. Range 0–1. Default 0. */
 	structure?: number;
 	/** Damping. Decay time of the modes, exponential across the knob: at A3 the ring lasts ~10 s at 0, ~0.45 s at the centre and ~20 ms at 1 (T60 ≈ 2.2·Q/f, Q 1000 → 2). Upper partials fade faster than the root, as on a real string. Loudness holds across the range — less damping spreads the same strike over a longer ring instead of making it quieter. Range 0–1. Default 0.5. */
 	damping?: number;
-	/** Dry/Wet Mix. Balance between original and resonated signal. Range 0–1. Default 0.5. */
+	/** Dry/Wet Mix. 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. Range 0–1. Default 1. */
 	mix?: number;
 }
 export type ResonatorInputs = {
@@ -1347,9 +1392,9 @@ export type RotaryProps = {
 };
 export declare const Rotary: LibModule<RotaryParams, RotaryInputs, RotaryOutputs, RotaryProps>;
 export interface SaturatorParams {
-	/** Drive. How hard to push into saturation. Adds harmonics and soft compression. Range 0–1. Default 0.5. */
+	/** Drive. 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). Range 0–1. Default 0.5. */
 	drive?: number;
-	/** Warmth. Low frequency emphasis for a thicker, analog-like tone. Range 0–1. Default 0.5. */
+	/** Warmth. Low-shelf boost below 300 Hz, up to +6 dB, after the saturation. A tone control for low-end weight, not more distortion. Range 0–1. Default 0.5. */
 	warmth?: number;
 	/** Dry/Wet Mix. Balance between clean and saturated signal. Range 0–1. Default 1. */
 	mix?: number;
@@ -1456,6 +1501,8 @@ export declare const SpringReverb: LibModule<SpringReverbParams, SpringReverbInp
 export interface StereoSpreadParams {
 	/** Spread Amount. Controls the micro-delay time for Haas widening (0–5ms). More spread = wider perceived stereo image. Range 0–1. Default 0.7. */
 	spread?: number;
+	/** Dry/Wet. Balance between mono (0%) and widened (200%) high frequencies. Range 0–2. Default 1. */
+	width?: number;
 	/** Crossover Frequency. Frequency above which Haas spreading is applied. Lows below this stay centered for mono compatibility. Range 200–2000 Hz (log). Default 800. */
 	center?: Hz;
 }
@@ -1469,7 +1516,10 @@ export type StereoSpreadOutputs = {
 export type StereoSpreadProps = {
 	"in": AudioNode;
 	"out": AudioNode;
-	readonly params: Record<never, never>;
+	readonly params: {
+		/** Dry/Wet. Native AudioParam — value is the param value 1:1. */
+		"width": AudioParam;
+	};
 };
 export declare const StereoSpread: LibModule<StereoSpreadParams, StereoSpreadInputs, StereoSpreadOutputs, StereoSpreadProps>;
 export interface SubharmonicParams {
@@ -1710,7 +1760,7 @@ export interface WahParams {
 	resonance?: number;
 	/** Auto-Wah Rate. Speed of the automatic wah sweep in Hz. Range 0.1–10 Hz (log). Default 1. */
 	rate?: Hz;
-	/** Modulation Depth. How much the frequency sweeps. Full depth ≈ 3 octaves. Range 0–1. Default 0.6. */
+	/** Modulation Depth. How much the frequency sweeps. Full depth = 3 octaves top to bottom (±1.5 octaves around the center). Range 0–1. Default 0.6. */
 	depth?: number;
 }
 export type WahInputs = {