@thi.ng/dsp 4.7.61 → 4.7.62

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2025-01-29T16:25:48Z
+- **Last updated**: 2025-02-13T16:03:11Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/addg.d.ts

@@ -1,12 +1,11 @@
 import type { IGen } from "./api.js";
 /**
- * Creates a new {@link IGen} using given `step` gen and `start
- * (default: 0) value, producing: `y(t) = step(t) + y(t-1)`.
+ * Creates a new {@link IGen} using given `step` gen and `start` (default: 0)
+ * value, producing: `y(t) = step(t) + y(t-1)`.
  *
  * @remarks
- * Note this is different to {@link sum}, which merely sums given
- * argument gens for each step, but doesn't for a reduction like this
- * gen.
+ * Note this is different to {@link sum}, which merely sums given argument gens
+ * for each step, but doesn't for a reduction like this gen.
  *
  * @example
  * ```ts tangle:../export/addg.ts

package/adsr.d.ts

@@ -19,7 +19,7 @@ export interface ADSROpts {
      */
     d: number;
     /**
-     * Sustain level/gain (in [0..1] range). Default: 1
+     * Sustain level/gain (in `[0,1]` range). Default: 1
      */
     s: number;
     /**
@@ -48,26 +48,26 @@ export interface ADSROpts {
     gain: number;
 }
 /**
- * Time based ADSR envelope gen with customizable exponential attack,
- * decay and release curves.
+ * Time based ADSR envelope gen with customizable exponential attack, decay and
+ * release curves.
  *
  * @remarks
- * The attack, decay and release options are to be given in samples
- * (`num = time_in_seconds * sample_rate`). Unless the sustain length
- * (`slen` opt) is finite (default: ∞), the release phase of the
- * envelope MUST be triggered manually by calling {@link ADSR.release}.
- * If only attack & decay phases are required, initialize the sustain
- * level to zero and configure `dcurve` to adjust falloff shape.
+ * The attack, decay and release options are to be given in samples (`num =
+ * time_in_seconds * sample_rate`). Unless the sustain length (`slen` opt) is
+ * finite (default: ∞), the release phase of the envelope MUST be triggered
+ * manually by calling {@link ADSR.release}. If only attack & decay phases are
+ * required, initialize the sustain level to zero and configure `dcurve` to
+ * adjust falloff shape.
  *
- * The envelope can be re-used & restarted by calling
- * {@link ADSR.reset}. This will move the internal state back to the
- * beginning of the attack phase and start producing a new envelope with
- * current settings. Note: Any changes done to the envelope parameters
- * are only guaranteed to be fully applied after reset.
+ * The envelope can be re-used & restarted by calling {@link ADSR.reset}. This
+ * will move the internal state back to the beginning of the attack phase and
+ * start producing a new envelope with current settings. Note: Any changes done
+ * to the envelope parameters are only guaranteed to be fully applied after
+ * reset.
  *
- * The `acurve` and `dcurve` options can be used to control the
- * exponential curvature of the attack, decay and release phases.
- * Recommended range [0.0001 - 100] (curved -> linear).
+ * The `acurve` and `dcurve` options can be used to control the exponential
+ * curvature of the attack, decay and release phases. Recommended range
+ * `[0.0001,100]` (curved -> linear).
  *
  * @param opts -
  */

package/anti-alias.d.ts

@@ -1,6 +1,7 @@
 import type { FnN2 } from "@thi.ng/api";
 /**
- * Reference:
+ * References:
+ *
  * - https://en.wikipedia.org/wiki/Gibbs_phenomenon
  * - https://web.archive.org/web/20031210115616/http://www.musicdsp.org/files/bandlimited.pdf
  *

package/curve.d.ts

@@ -1,17 +1,17 @@
 import { MAdd } from "./madd.js";
 /**
- * Returns new {@link MAdd} gen, producing an exponential curve (with
- * adjustable curvature) between `start` and `end` values over `num`
- * steps. This is the exponential equivalent of {@link line}.
+ * Returns new {@link MAdd} gen, producing an exponential curve (with adjustable
+ * curvature) between `start` and `end` values over `num` steps. This is the
+ * exponential equivalent of {@link line}.
  *
  * @remarks
- * Unless `skipFirst` is true (default: false), the `end` value is only
- * reached at `num + 1` steps. Unless `clampEnd` is true (default:
- * false), the curve will NOT stop at `end` but continue indefinitely if
- * more values are requested from the generator.
+ * Unless `skipFirst` is true (default: false), the `end` value is only reached
+ * at `num + 1` steps. Unless `clampEnd` is true (default: false), the curve
+ * will NOT stop at `end` but continue indefinitely if more values are requested
+ * from the generator.
  *
- * The curvature can be controlled via the logarithmic `rate` param.
- * Recommended range [0.0001 - 10000] (curved -> linear). Default: 0.1
+ * The curvature can be controlled via the logarithmic `rate` param. Recommended
+ * range `[0.0001,10000]` (curved -> linear). Default: 0.1
  *
  * Also see {@link madd}.
  *

package/fft.d.ts

@@ -113,8 +113,8 @@ export declare const scaleFFT: (complex: ComplexArray, scale: number) => Complex
  * By default assumes a rectangular window and the resulting scale factor of 2 /
  * N.
  *
- * References:
- * - https://holometer.fnal.gov/GH_FFT.pdf
+ * Reference:
+ * https://holometer.fnal.gov/GH_FFT.pdf
  *
  * @param complex -
  * @param window -
@@ -129,8 +129,8 @@ export declare const normalizeFFT: (complex: ComplexArray, window?: number | Num
  * By default assumes a rectangular window and the resulting scale factor of N /
  * 2.
  *
- * References:
- * - https://holometer.fnal.gov/GH_FFT.pdf
+ * Reference:
+ * https://holometer.fnal.gov/GH_FFT.pdf
  *
  * @param complex -
  * @param window -
@@ -145,8 +145,8 @@ export declare const denormalizeFFT: (complex: ComplexArray, window?: number | N
  * {@link spectrumPhase}. The `eps` value might have to be adjusted and should
  * be approx. `max(spectrumMag(fft))/10000`.
  *
- * References:
- * - https://www.gaussianwaves.com/2015/11/interpreting-fft-results-obtaining-magnitude-and-phase-information/
+ * Reference:
+ * https://www.gaussianwaves.com/2015/11/interpreting-fft-results-obtaining-magnitude-and-phase-information/
  *
  * @param complex -
  * @param eps -

package/foldback.d.ts

@@ -4,8 +4,7 @@ import { AProc } from "./aproc.js";
  * amplifies it with `amp` (default: 1/thresh).
  *
  * @remarks
- * Reference:
- * - https://www.desmos.com/calculator/lkyf2ag3ta
+ * [Interactive graph](https://www.desmos.com/calculator/lkyf2ag3ta)
  *
  * @param thresh - fold threshold
  * @param amp - post amplifier

package/osc-additive.d.ts

@@ -6,8 +6,8 @@ import type { StatelessOscillator } from "./api.js";
  *
  * @remarks
  * The `freqFn` and `ampFn` functions are used to compute respective frequency
- * and amplitude factors for each of the `n` requested harmonics (given in [i,n]
- * range).
+ * and amplitude factors for each of the `n` requested harmonics (given in
+ * `[i,n]` range).
  *
  * @param osc -
  * @param freqFn -
@@ -21,8 +21,7 @@ export declare const additive: (osc: StatelessOscillator, freqFn: Fn<number, num
  * each partial.
  *
  * @remarks
- * Interactive graph of this oscillator:
- * https://www.desmos.com/calculator/irugw6gnhy
+ * [Interactive graph of this oscillator](https://www.desmos.com/calculator/irugw6gnhy)
  *
  * @param n - number of partials
  * @param useGibbs -
@@ -34,8 +33,7 @@ export declare const squareAdditive: (n?: number, useGibbs?: boolean) => Statele
  * {@link gibbs} to each partial.
  *
  * @remarks
- * Interactive graph of this oscillator:
- * https://www.desmos.com/calculator/irugw6gnhy
+ * [Interactive graph of this oscillator](https://www.desmos.com/calculator/irugw6gnhy)
  *
  * @param n - number of partials
  * @param useGibbs -

package/osc-dsf.d.ts

@@ -5,19 +5,18 @@ import type { StatelessOscillator } from "./api.js";
  * `y(t) = (1-a^2) * sin(2πt) / (1 + a^2 - 2a * cos(b * 2πt))`
  *
  * @remarks
- * `alpha` should be in [0..1) interval, `beta` is used as factor for
- * the base `freq` and used for the cosine modulation term. The default
- * config for both params is 0.5, 1.0 respectively, creating a waveform
- * similar to a bandlimited sawtooth. If both params are zero, the
- * result is a pure sine.
+ * `alpha` should be in `[0,1)` interval, `beta` is used as factor for the base
+ * `freq` and used for the cosine modulation term. The default config for both
+ * params is 0.5, 1.0 respectively, creating a waveform similar to a bandlimited
+ * sawtooth. If both params are zero, the result is a pure sine.
  *
- * Note: Higher `alpha` values cause an increasing number (and
- * amplitude) of spikes in the waveform. Therefore, the higher the
- * `alpha`, the lower `amp` should be to avoid excessive out-of-range
- * values.
+ * Note: Higher `alpha` values cause an increasing number (and amplitude) of
+ * spikes in the waveform. Therefore, the higher the `alpha`, the lower `amp`
+ * should be to avoid excessive out-of-range values.
  *
  * References:
- * - https://www.desmos.com/calculator/klvl9oszfm
+ *
+ * - [Interactive graph](https://www.desmos.com/calculator/klvl9oszfm)
  * - https://ccrma.stanford.edu/files/papers/stanm5.pdf
  *
  * @param phase -

package/osc-mix.d.ts

@@ -1,18 +1,17 @@
 import type { StatelessOscillator } from "./api.js";
 /**
- * HOF oscillator. Takes 2 stateless oscillator fns and returns new
- * oscillator function which produces an interpolated result of both.
- * The returned function takes an additional `mix` arg ([0..1] range)
- * control contributions of either oscillator (default: 0.5 aka 50/50
- * ratio).
+ * HOF oscillator. Takes 2 stateless oscillator fns and returns new oscillator
+ * function which produces an interpolated result of both. The returned function
+ * takes an additional `mix` arg (`[0,1]` range) control contributions of either
+ * oscillator (default: 0.5 aka 50/50 ratio).
  *
  * @param osc1 -
  * @param osc2 -
  */
 export declare const mixOsc: (osc1: StatelessOscillator, osc2: StatelessOscillator) => StatelessOscillator;
 /**
- * Similar to {@link mixOsc}, but with `mix` arg ([0..1] range)
- * directly given to HOF and not changeable after.
+ * Similar to {@link mixOsc}, but with `mix` arg (`[0,1]` range) directly given
+ * to HOF and not changeable after.
  *
  * @param osc1 -
  * @param osc2 -

package/osc-parabolic.d.ts

@@ -3,8 +3,7 @@ import type { StatelessOscillator } from "./api.js";
  * Parabolic waveform oscillator.
  *
  * @remarks
- * Reference:
- * - https://www.desmos.com/calculator/gsobpc8hsy
+ * [Interactive graph](https://www.desmos.com/calculator/gsobpc8hsy)
  *
  * @param phase -
  * @param freq -

package/osc-rect.d.ts

@@ -1,8 +1,8 @@
 import type { StatelessOscillator } from "./api.js";
 export declare const rect: StatelessOscillator;
 /**
- * Higher order version of {@link rect} with pre-configured `duty` width
- * (in the (0..1) range).
+ * Higher order version of {@link rect} with pre-configured `duty` width (in the
+ * `(0,1)` range).
  *
  * @param duty -
  */

package/osc-square-sin.d.ts

@@ -1,12 +1,12 @@
 import type { StatelessOscillator } from "./api.js";
 /**
  * Returns a {@link StatelessOscillator} function with adjustable waveform based
- * on given `squareness` param (in [0..1) interval). If `squareness = 0` the
+ * on given `squareness` param (in `[0,1)` interval). If `squareness = 0` the
  * waveform will be a perfect sine. Higher values morph the waveform
  * increasingly into a square wave.
  *
  * @remarks
- * Interactive graph: https://www.desmos.com/calculator/nbvd97m3kl
+ * [Interactive graph](https://www.desmos.com/calculator/nbvd97m3kl)
  *
  * @param squareness
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/dsp",
-  "version": "4.7.61",
+  "version": "4.7.62",
   "description": "Composable signal generators, oscillators, filters, FFT, spectrum, windowing & related DSP utils",
   "type": "module",
   "module": "./index.js",
@@ -40,16 +40,16 @@
     "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.11.19",
-    "@thi.ng/checks": "^3.6.22",
-    "@thi.ng/errors": "^2.5.25",
-    "@thi.ng/math": "^5.11.19",
-    "@thi.ng/random": "^4.1.10",
-    "@thi.ng/transducers": "^9.2.17"
+    "@thi.ng/api": "^8.11.20",
+    "@thi.ng/checks": "^3.6.23",
+    "@thi.ng/errors": "^2.5.26",
+    "@thi.ng/math": "^5.11.20",
+    "@thi.ng/random": "^4.1.11",
+    "@thi.ng/transducers": "^9.2.18"
   },
   "devDependencies": {
-    "esbuild": "^0.24.2",
-    "typedoc": "^0.27.6",
+    "esbuild": "^0.25.0",
+    "typedoc": "^0.27.7",
     "typescript": "^5.7.3"
   },
   "keywords": [
@@ -292,5 +292,5 @@
     "year": 2015,
     "screenshot": "dsp/dsf-allpass1.png"
   },
-  "gitHead": "fc1d498e8d4b690db873c30cc594352a804e7a65\n"
+  "gitHead": "9a0b33253fef092aaf301decf6ecd54317874d4c\n"
 }

package/pan.d.ts

@@ -3,7 +3,7 @@ import { AProc } from "./aproc.js";
 import type { NumericArray } from "@thi.ng/api";
 /**
  * Positions and converts a mono signal into a stereo signal using given `pos`
- * in the [-1..1] range to control the panning (-1 = left, +1 = right).
+ * in the `[-1,1]` range to control the panning (-1 = left, +1 = right).
  *
  * @remarks
  * Reference:

package/pink-noise.d.ts

@@ -17,6 +17,7 @@ export type PNoiseCoeffs = Tuple<number, 5>;
  * is scale relative to the sum of given `amp` values.
  *
  * References:
+ *
  * - http://web.archive.org/web/20160513114217/http://home.earthlink.net/~ltrammell/tech/newpink.htm
  * - http://web.archive.org/web/20160515145318if_/http://home.earthlink.net/~ltrammell/tech/pinkalg.htm
  * - https://www.musicdsp.org/en/latest/Synthesis/220-trammell-pink-noise-c-class.html

package/power.d.ts

@@ -43,6 +43,7 @@ export declare const invPowerScale: (scale: number | NumericArray, base?: number
  *
  * @remarks
  * References:
+ *
  * - http://www.it.uom.gr/teaching/linearalgebra/NumericalRecipiesInC/c13-4.pdf
  * - http://www.hep.ucl.ac.uk/~rjn/saltStuff/fftNormalisation.pdf
  *
@@ -54,6 +55,7 @@ export declare const powerSumSquared: (window: NumericArray | ComplexArray) => n
  *
  * @remarks
  * References:
+ *
  * - http://www.it.uom.gr/teaching/linearalgebra/NumericalRecipiesInC/c13-4.pdf
  * - http://www.hep.ucl.ac.uk/~rjn/saltStuff/fftNormalisation.pdf
  *
@@ -66,6 +68,7 @@ export declare const powerMeanSquared: (window: NumericArray | ComplexArray) =>
  *
  * @remarks
  * References:
+ *
  * - http://www.it.uom.gr/teaching/linearalgebra/NumericalRecipiesInC/c13-4.pdf
  * - http://www.hep.ucl.ac.uk/~rjn/saltStuff/fftNormalisation.pdf
  *

package/sincos.d.ts

@@ -2,16 +2,16 @@ import type { ICopy, IReset } from "@thi.ng/api";
 import { AGen } from "./agen.js";
 /**
  * Generator of sine & cosine values of given frequency in the form of
- * [sin,cos] tuples. Start phase always zero.
+ * `[sin,cos]` tuples. Start phase always zero.
  *
  * @remarks
- * Implementation based on a self-oscillating SVF (state-variable
- * filter) without using any trig functions. Therefore, ~30% faster, but
- * precision only useful for very low (< ~2Hz) frequencies. Due to
- * floating point error accumulation, phase & amplitude drift will occur
- * for higher frequencies.
+ * Implementation based on a self-oscillating SVF (state-variable filter)
+ * without using any trig functions. Therefore, ~30% faster, but precision only
+ * useful for very low (< ~2Hz) frequencies. Due to floating point error
+ * accumulation, phase & amplitude drift will occur for higher frequencies.
  *
  * References:
+ *
  * - http://www.earlevel.com/main/2003/03/02/the-digital-state-variable-filter/
  *
  * @param freq - normalized freq

package/svf.d.ts

@@ -11,7 +11,7 @@ export declare const svfAllpass: (fc: number, q?: number) => SVF;
  * Multi-type state variable filter w/ trapezoidal integration, after
  * Andrew Simper.
  *
- * Reference:
+ * References:
  *
  * - https://cytomic.com/files/dsp/SvfLinearTrapOptimised2.pdf
  * - https://en.wikipedia.org/wiki/Trapezoidal_rule

package/waveshaper.d.ts

@@ -2,16 +2,14 @@ import type { Fn2 } from "@thi.ng/api";
 import { AProc } from "./aproc.js";
 export type WaveShaperFn = Fn2<number, number, number>;
 /**
- * Customizable wave shaper for user defined shaping function supporting
- * one (optional, implementation specific) adjustable curve parameter.
- * By default uses {@link waveshapeTan} and supports configurable
- * curvature. Post-amplification is applied to the transformed result
- * value (see remarks).
+ * Customizable wave shaper for user defined shaping function supporting one
+ * (optional, implementation specific) adjustable curve parameter. By default
+ * uses {@link waveshapeTan} and supports configurable curvature.
+ * Post-amplification is applied to the transformed result value (see remarks).
  *
  * @remarks
- * If `amp` is `true` (default), the curve will be normalized such that
- * input values in the [-1 .. 1] range will be mapped to the same output
- * interval.
+ * If `amp` is `true` (default), the curve will be normalized such that input
+ * values in the `[-1,1]` range will be mapped to the same output interval.
  *
  * The following wave shaping functions are supplied by default:
  *
@@ -19,8 +17,7 @@ export type WaveShaperFn = Fn2<number, number, number>;
  * - {@link waveshapeSigmoid}
  * - {@link waveshapeSin}
  *
- * Interactive graph:
- * - https://www.desmos.com/calculator/hg4i7o836i
+ * [Interactive graph](https://www.desmos.com/calculator/hg4i7o836i)
  *
  * @param thresh - fold threshold
  * @param amp - post amplifier / autogain flag