@thi.ng/dsp 4.3.17 → 4.3.20

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-08-04T10:58:19Z
+- **Last updated**: 2023-08-12T13:14:08Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -1,6 +1,7 @@
 <!-- This file is generated - DO NOT EDIT! -->
+<!-- Please see: https://github.com/thi-ng/umbrella/blob/develop/CONTRIBUTING.md#changes-to-readme-files -->
 
-# ![@thi.ng/dsp](https://media.thi.ng/umbrella/banners-20220914/thing-dsp.svg?5dc8dc3b)
+# ![@thi.ng/dsp](https://media.thi.ng/umbrella/banners-20230807/thing-dsp.svg?5dc8dc3b)
 
 [![npm version](https://img.shields.io/npm/v/@thi.ng/dsp.svg)](https://www.npmjs.com/package/@thi.ng/dsp)
 ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/dsp.svg)
@@ -49,12 +50,11 @@ Partially ported from other thi.ng projects (e.g.
 
 [Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Bdsp%5D+in%3Atitle)
 
-Even though this library is now at v2.0.0 and still retains most of the
-features from earlier versions, all recently added features (IGen's,
-IProc's, composition ops etc.) should be considered "beta" and are
-likely to undergo further (hopefully not too drastic) changes in the
-near future. Also, pending outcomes of ongoing experiments, some aspects
-might be ported to WASM.
+Even though this library is now at v2.0.0 and still retains most of the features
+from earlier versions, all recently added features (IGen's, IProc's, composition
+ops etc.) should be considered "beta" and are likely to undergo further
+(hopefully not too drastic) changes in the near future. Also, pending outcomes
+of ongoing experiments, some aspects might be ported to WASM.
 
 ## Support packages
 
@@ -107,6 +107,7 @@ A selection:
 |:-----------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------|:------------------------------------------------------|:-----------------------------------------------------------------------------------|
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/fft-synth.png" width="240"/>       | Interactive inverse FFT toy synth                   | [Demo](https://demo.thi.ng/umbrella/fft-synth/)       | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/fft-synth)       |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/fiber-basics.png" width="240"/>    | Fiber-based cooperative multitasking basics         | [Demo](https://demo.thi.ng/umbrella/fiber-basics/)    | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/fiber-basics)    |
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/fiber-zoom.png" width="240"/>      | Fiber-based cooperative multitasking basics         | [Demo](https://demo.thi.ng/umbrella/fiber-zoom/)      | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/fiber-zoom)      |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/poly-spline.png" width="240"/>     | Polygon to cubic curve conversion & visualization   | [Demo](https://demo.thi.ng/umbrella/poly-spline/)     | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/poly-spline)     |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/rasterize-blend.jpg" width="240"/> | Steering behavior drawing with alpha-blended shapes | [Demo](https://demo.thi.ng/umbrella/rasterize-blend/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/rasterize-blend) |
 | <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/webgl-cubemap.jpg" width="240"/>   | WebGL cube maps with async texture loading          | [Demo](https://demo.thi.ng/umbrella/webgl-cubemap/)   | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/webgl-cubemap)   |
@@ -118,17 +119,15 @@ A selection:
 
 ### IGen
 
-The following unit generators are infinite data sources based on the
-[`IGen`
+The following unit generators are infinite data sources based on the [`IGen`
 interface](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/api.ts)
-with most being resettable too. The interface is similar to ES6
-iterators in that the next value can be obtained by calling `.next()`,
-however since `IGen`s are always infinite, there's no need to [wrap the
-result
+with most being resettable too. The interface is similar to ES6 iterators in
+that the next value can be obtained by calling `.next()`, however since `IGen`s
+are always infinite, there's no need to [wrap the result
 value](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol)
-as is done with ES6 iterables. Furthermore, all gens defined in this
-package do implement `Symbol.iterator` and so can actually be used as
-standard iterables as well.
+as is done with ES6 iterables. Furthermore, all gens defined in this package do
+implement `Symbol.iterator` and so can actually be used as standard iterables as
+well.
 
 `IGen` also implements the
 [`IDeref`](https://github.com/thi-ng/umbrella/blob/develop/packages/api/src/api/deref.ts)
@@ -185,10 +184,10 @@ import { take } from "@thi.ng/transducers";
 ```
 
 - [add](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/add.ts) - adder
-- [adsr](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/add.ts) - timebased ADSR / AD envelope generator
+- [adsr](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/adsr.ts) - timebased ADSR / AD envelope generator
 - [alt](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/alt.ts) - alternating values
 - [constant](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/const.ts) - constant value
-- [cosine](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/cosp.ts) - trig-free cosine osc
+- [cosine](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/cosine.ts) - trig-free cosine osc
 - [curve](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/curve.ts) - timebased exponential gain/decay (factory for `madd`)
 - [impulse](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/impulse.ts) - impulse gen
 - [impulseTrain](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/impulse-train.ts) - timebased cyclic impulse
@@ -199,7 +198,7 @@ import { take } from "@thi.ng/transducers";
 - [reciprocal](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/reciprocal.ts) - fractional sequence (1, 1/2, 1/3, 1/4 etc.)
 - [sincos](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/sincos.ts) - trig-free sin/cos LFO
 - [sweep](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/sweep.ts) - freq sweep gen w/ phase accumulation for oscillators
-- [whiteNoise](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/pink-noise.ts) - white noise
+- [whiteNoise](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/white-noise.ts) - white noise
 
 #### Higher order generators
 
@@ -261,18 +260,25 @@ Diagram of the FM/AM osc with some low pass filters applied:
 
 ### IProc
 
-The second fundamental interface in this package, similar to `IGen` and
-used to implement processors & transformers of input values (e.g those
-generated by the various `IGen`s available). `IProc` implementations have a
-`.next(x)` method, where `x` is the next input to be processed.
+The second fundamental interface in this package, similar to `IGen` and used to
+implement processors & transformers of input values (e.g those generated by the
+various `IGen`s available). `IProc` implementations have a `.next(x)` method,
+where `x` is the next input to be processed.
 
-The package also provides several approaches to compose multi-step
-processing pipelines (see section further below). Furthermore, all
-implementations in this package implement the [@thi.ng/transducers
-`IXform`
+The package also provides several approaches to compose multi-step processing
+pipelines (see section further below). Furthermore, all implementations in this
+package implement the [@thi.ng/transducers `IXform`
 interface](https://github.com/thi-ng/umbrella/tree/develop/packages/transducers/README.md#IXform-interface)
 and so can be directly used in transducer pipelines too.
 
+Additional higher order `IProc` implementations:
+
+- [bounce](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/bounce.ts) - sum multiple inputs
+- [mix](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/mix.ts) - linear interpolation of 2 inputs
+- [multiplex](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/multiplex.ts) - process 1 input into multiple outs
+- [pipe](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/pipe.ts) - `IGen` & multiple `IProc` pipeline setup
+- [serial](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/serial.ts) - serial processing of multiple `IProc`
+
 ```ts
 import { comp, push, take, transduce } from "@thi.ng/transducers";
 
@@ -310,7 +316,9 @@ const sig = new Float32Array(
 fs.writeFileSync("sig.raw", Buffer.from(sig.buffer));
 ```
 
-The raw audio file can then be converted to WAV via `ffmpeg`:
+Use the [@thi.ng/dsp-io-wav
+package](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp-io-wav/)
+to export as WAV, or alternatively use `ffmpeg` for conversion:
 
 ```bash
 ffmpeg -f f32le -ar 48k -ac 1 -i sig.raw sig.wav -y
@@ -318,8 +326,8 @@ ffmpeg -f f32le -ar 48k -ac 1 -i sig.raw sig.wav -y
 
 #### Filters
 
-The following diagrams show various combinations of oscillator signals
-and their filtered responses (with different cutoff/center frequencies).
+The following diagrams show various combinations of oscillator signals and their
+filtered responses (with different cutoff/center frequencies).
 
 All diagrams were generated with [this
 script](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/tools/generate-diagrams.ts).
@@ -388,7 +396,7 @@ High shelf (gain = -6dB):
 
 ##### State variable filter
 
-[Source](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/biquad.ts)
+[Source](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/svf.ts)
 
 - `svfLP` - low pass, resonance
 - `svfHP` - high pass, resonance
@@ -427,10 +435,10 @@ Allpass:
 
 Using the [Filter response
 utils](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/filter-response.ts),
-the following filter types can be evaluated for analyzing their impact
-on specific frequencies (or frequency bands). Any type implementing
-[`IFilter`](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/api.ts#L50)
-can be used, currently:
+the following filter types can be evaluated for analyzing their impact on
+specific frequencies (or frequency bands). Any type implementing
+[`IFilter`](https://docs.thi.ng/umbrella/dsp/interfaces/FilterConfig.html) can
+be used, currently:
 
 - 1-pole
 - DC-block
@@ -471,16 +479,16 @@ Basic filter response plot:
 
 [Source](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/delay.ts)
 
-Ringbuffer / delay line for arbitrary values and support for single &
-multi-taps at any relative positions. Useful fundamental building block
-for various other effects, filters etc.
+Ringbuffer / delay line for arbitrary values and support for single & multi-taps
+at any relative positions. Useful fundamental building block for various other
+effects, filters etc.
 
 #### Feedback delay
 
 [Source](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/feedback-delay.ts)
 
-Variation of `delay()` which adds a portion of the delayed value to each
-new input and stores result in delay line.
+Variation of `delay()` which adds a portion of the delayed value to each new
+input and stores result in delay line.
 
 #### Filtered feedback delay
 
@@ -493,7 +501,8 @@ Variation of `feedbackDelay()` which processes feedback via given filter /
 
 [Source](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/waveshaper.ts)
 
-This operator remaps inputs via a user provided function. The following shaping functions are provided:
+This operator remaps inputs via a user provided function. The following shaping
+functions are provided:
 
 - `waveshapeTan` - arctan based (soft-clip/distortion)
 - `waveshapeSigmoid` - sigmoid based, similar to above
@@ -516,9 +525,10 @@ Sine:
 
 #### Foldback distortion
 
-[Source](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/waveshaper.ts)
+[Source](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/foldback.ts)
 
-Recursively folds input into `[-thresh .. +thresh]` interval and amplifies it with `amp` (default: 1/thresh).
+Recursively folds input into `[-thresh .. +thresh]` interval and amplifies it
+with `amp` (default: 1/thresh).
 
 Use the [interactive calculator @
 Desmos](https://www.desmos.com/calculator/lkyf2ag3ta) to experiment.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/dsp",
-  "version": "4.3.17",
+  "version": "4.3.20",
   "description": "Composable signal generators, oscillators, filters, FFT, spectrum, windowing & related DSP utils",
   "type": "module",
   "module": "./index.js",
@@ -34,16 +34,16 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.0",
-    "@thi.ng/checks": "^3.4.0",
-    "@thi.ng/errors": "^2.3.0",
-    "@thi.ng/math": "^5.5.1",
-    "@thi.ng/random": "^3.5.1",
-    "@thi.ng/transducers": "^8.5.0"
+    "@thi.ng/api": "^8.9.3",
+    "@thi.ng/checks": "^3.4.3",
+    "@thi.ng/errors": "^2.3.3",
+    "@thi.ng/math": "^5.5.4",
+    "@thi.ng/random": "^3.6.0",
+    "@thi.ng/transducers": "^8.5.3"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.36.3",
-    "@thi.ng/testament": "^0.3.18",
+    "@microsoft/api-extractor": "^7.36.4",
+    "@thi.ng/testament": "^0.3.21",
     "rimraf": "^5.0.1",
     "tools": "^0.0.1",
     "typedoc": "^0.24.8",
@@ -275,5 +275,5 @@
     ],
     "year": 2015
   },
-  "gitHead": "9fa3f7f8169efa30e3c71b43c82f77393581c3b5\n"
+  "gitHead": "399f8c53d66b9b763d16c21bb59f145df5f59514\n"
 }