@thi.ng/dsp 4.2.27 → 4.3.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-12-22T21:47:07Z
+- **Last updated**: 2023-01-10T15:20:19Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [4.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/dsp@4.3.0) (2023-01-10)
+
+#### 🚀 Features
+
+- add FilterFeedbackDelay ([d69b3bc](https://github.com/thi-ng/umbrella/commit/d69b3bc))
+
 ### [4.2.17](https://github.com/thi-ng/umbrella/tree/@thi.ng/dsp@4.2.17) (2022-10-17)
 
 #### 🩹 Bug fixes

package/README.md

@@ -25,6 +25,7 @@ This project is part of the
     - [Filter responses](#filter-responses)
     - [Delay](#delay)
     - [Feedback delay](#feedback-delay)
+    - [Filtered feedback delay](#filtered-feedback-delay)
     - [Wave shaping](#wave-shaping)
     - [Foldback distortion](#foldback-distortion)
   - [FFT](#fft)
@@ -83,7 +84,7 @@ For Node.js REPL:
 const dsp = await import("@thi.ng/dsp");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 6.84 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 6.88 KB
 
 ## Dependencies
 
@@ -480,6 +481,13 @@ for various other effects, filters etc.
 Variation of `delay()` which adds a portion of the delayed value to each
 new input and stores result in delay line.
 
+#### Filtered feedback delay
+
+[Source](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/filter-delay.ts)
+
+Variation of `feedbackDelay()` which processes feedback via given filter /
+`IProc`, e.g. to create dub style filter delays.
+
 #### Wave shaping
 
 [Source](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/waveshaper.ts)
@@ -581,4 +589,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-© 2015 - 2022 Karsten Schmidt // Apache License 2.0
+© 2015 - 2023 Karsten Schmidt // Apache License 2.0

package/feedback-delay.d.ts

@@ -3,6 +3,9 @@ import { Delay } from "./delay.js";
  * Extension of {@link Delay} which adds sum delayed value multiplied
  * with `feedback` for each new input.
  *
+ * @remarks
+ * Also see {@link filterFeedbackDelay} for filtered version.
+ *
  * @param n - delay length
  * @param feedback - feedback factor (default: 0.5)
  */

package/feedback-delay.js

@@ -4,6 +4,9 @@ import { Delay } from "./delay.js";
  * Extension of {@link Delay} which adds sum delayed value multiplied
  * with `feedback` for each new input.
  *
+ * @remarks
+ * Also see {@link filterFeedbackDelay} for filtered version.
+ *
  * @param n - delay length
  * @param feedback - feedback factor (default: 0.5)
  */

package/filter-delay.d.ts

@@ -0,0 +1,20 @@
+import type { IProc } from "./api.js";
+import { Delay } from "./delay.js";
+/**
+ * Extension of {@link feedbackDelay} with additional filter/proc
+ * possibility for the feedback itself (e.g. a low pass filter).
+ *
+ * @param n - delay length
+ * @param filter - IProc applied to feedback
+ * @param feedback - feedback factor (default: 0.5)
+ */
+export declare const filterFeedbackDelay: (n: number, filter: IProc<number, number>, feedback?: number) => FilterFeedbackDelay;
+export declare class FilterFeedbackDelay extends Delay<number> {
+    filter: IProc<number, number>;
+    protected _feedback: number;
+    constructor(n: number, filter: IProc<number, number>, _feedback?: number);
+    next(x: number): number;
+    feedback(): number;
+    setFeedback(feedback: number): void;
+}
+//# sourceMappingURL=filter-delay.d.ts.map

package/filter-delay.js

@@ -0,0 +1,28 @@
+import { clamp01 } from "@thi.ng/math/interval";
+import { Delay } from "./delay.js";
+/**
+ * Extension of {@link feedbackDelay} with additional filter/proc
+ * possibility for the feedback itself (e.g. a low pass filter).
+ *
+ * @param n - delay length
+ * @param filter - IProc applied to feedback
+ * @param feedback - feedback factor (default: 0.5)
+ */
+export const filterFeedbackDelay = (n, filter, feedback) => new FilterFeedbackDelay(n, filter, feedback);
+export class FilterFeedbackDelay extends Delay {
+    constructor(n, filter, _feedback = 0.5) {
+        super(n, 0);
+        this.filter = filter;
+        this._feedback = _feedback;
+        this.setFeedback(_feedback);
+    }
+    next(x) {
+        return super.next(x + this.filter.next(this._buf[this._rpos] * this._feedback));
+    }
+    feedback() {
+        return this._feedback;
+    }
+    setFeedback(feedback) {
+        this._feedback = clamp01(feedback);
+    }
+}

package/index.d.ts

@@ -18,6 +18,7 @@ export * from "./dcblock.js";
 export * from "./delay.js";
 export * from "./feedback-delay.js";
 export * from "./fft.js";
+export * from "./filter-delay.js";
 export * from "./filter-response.js";
 export * from "./foldback.js";
 export * from "./impulse-train.js";

package/index.js

@@ -18,6 +18,7 @@ export * from "./dcblock.js";
 export * from "./delay.js";
 export * from "./feedback-delay.js";
 export * from "./fft.js";
+export * from "./filter-delay.js";
 export * from "./filter-response.js";
 export * from "./foldback.js";
 export * from "./impulse-train.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/dsp",
-  "version": "4.2.27",
+  "version": "4.3.0",
   "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.6.2",
-    "@thi.ng/checks": "^3.3.6",
-    "@thi.ng/errors": "^2.2.7",
-    "@thi.ng/math": "^5.3.18",
-    "@thi.ng/random": "^3.3.20",
-    "@thi.ng/transducers": "^8.3.28"
+    "@thi.ng/api": "^8.6.3",
+    "@thi.ng/checks": "^3.3.7",
+    "@thi.ng/errors": "^2.2.8",
+    "@thi.ng/math": "^5.4.0",
+    "@thi.ng/random": "^3.3.21",
+    "@thi.ng/transducers": "^8.3.30"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.33.7",
-    "@thi.ng/testament": "^0.3.8",
+    "@thi.ng/testament": "^0.3.9",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
     "typedoc": "^0.23.22",
@@ -154,6 +154,9 @@
     "./fft": {
       "default": "./fft.js"
     },
+    "./filter-delay": {
+      "default": "./filter-delay.js"
+    },
     "./filter-response": {
       "default": "./filter-response.js"
     },
@@ -272,5 +275,5 @@
     ],
     "year": 2015
   },
-  "gitHead": "bc6f7f5e2765bb96fe64db804eaf4b2443b47fc6\n"
+  "gitHead": "3f0b3e2a7c82aefc7e46fb4338369836b5e1b8cf\n"
 }