@thi.ng/dsp 4.4.4 → 4.5.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-09-06T13:36:28Z
+- **Last updated**: 2023-09-15T12:33:37Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,13 @@ 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.5.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/dsp@4.5.0) (2023-09-15)
+
+#### 🚀 Features
+
+- update saw/squareAdditive() ([d11488c](https://github.com/thi-ng/umbrella/commit/d11488c))
+  - add opt arg to disable Gibbs-effect handling
+
 ## [4.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/dsp@4.4.0) (2023-08-24)
 
 #### 🚀 Features

package/README.md

@@ -84,7 +84,7 @@ For Node.js REPL:
 const dsp = await import("@thi.ng/dsp");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 6.93 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 6.92 KB
 
 ## Dependencies
 

package/anti-alias.d.ts

@@ -2,7 +2,7 @@ import type { FnN2 } from "@thi.ng/api";
 /**
  * Reference:
  * - https://en.wikipedia.org/wiki/Gibbs_phenomenon
- * - http://www.musicdsp.org/files/bandlimited.pdf
+ * - https://web.archive.org/web/20031210115616/http://www.musicdsp.org/files/bandlimited.pdf
  *
  * [Interactive graph](https://www.desmos.com/calculator/irugw6gnhy)
  *

package/anti-alias.js

@@ -2,7 +2,7 @@ import { HALF_PI } from "@thi.ng/math/api";
 /**
  * Reference:
  * - https://en.wikipedia.org/wiki/Gibbs_phenomenon
- * - http://www.musicdsp.org/files/bandlimited.pdf
+ * - https://web.archive.org/web/20031210115616/http://www.musicdsp.org/files/bandlimited.pdf
  *
  * [Interactive graph](https://www.desmos.com/calculator/irugw6gnhy)
  *

package/osc-additive.d.ts

@@ -16,17 +16,29 @@ import type { StatelessOscillator } from "./api.js";
  */
 export declare const additive: (osc: StatelessOscillator, freqFn: Fn<number, number>, ampFn: Fn<number, number>, n: number) => StatelessOscillator;
 /**
+ * Returns a {@link StatelessOscillator} which constructs a square waveform from
+ * `n` partials. If `useGibbs` is true (default), also applies {@link gibbs} to
+ * each partial.
+ *
+ * @remarks
  * Interactive graph of this oscillator:
  * https://www.desmos.com/calculator/irugw6gnhy
  *
- * @param n - number of octaves
+ * @param n - number of partials
+ * @param useGibbs -
  */
-export declare const squareAdditive: (n?: number) => StatelessOscillator;
+export declare const squareAdditive: (n?: number, useGibbs?: boolean) => StatelessOscillator;
 /**
+ * Returns a {@link StatelessOscillator} which constructs a sawtooth waveform
+ * from `n` partials. If `useGibbs` is true (default), also applies
+ * {@link gibbs} to each partial.
+ *
+ * @remarks
  * Interactive graph of this oscillator:
  * https://www.desmos.com/calculator/irugw6gnhy
  *
- * @param n - number of octaves
+ * @param n - number of partials
+ * @param useGibbs -
  */
-export declare const sawAdditive: (n?: number) => StatelessOscillator;
+export declare const sawAdditive: (n?: number, useGibbs?: boolean) => StatelessOscillator;
 //# sourceMappingURL=osc-additive.d.ts.map

package/osc-additive.js

@@ -31,16 +31,28 @@ export const additive = (osc, freqFn, ampFn, n) => {
     };
 };
 /**
+ * Returns a {@link StatelessOscillator} which constructs a square waveform from
+ * `n` partials. If `useGibbs` is true (default), also applies {@link gibbs} to
+ * each partial.
+ *
+ * @remarks
  * Interactive graph of this oscillator:
  * https://www.desmos.com/calculator/irugw6gnhy
  *
- * @param n - number of octaves
+ * @param n - number of partials
+ * @param useGibbs -
  */
-export const squareAdditive = (n = 8) => additive(sin, (i) => 2 * (i - 1) + 1, (i) => (1 / (2 * (i - 1) + 1)) * gibbs(n, i), n);
+export const squareAdditive = (n = 8, useGibbs = true) => additive(sin, (i) => 2 * (i - 1) + 1, (i) => (1 / (2 * (i - 1) + 1)) * (useGibbs ? gibbs(n, i) : 1), n);
 /**
+ * Returns a {@link StatelessOscillator} which constructs a sawtooth waveform
+ * from `n` partials. If `useGibbs` is true (default), also applies
+ * {@link gibbs} to each partial.
+ *
+ * @remarks
  * Interactive graph of this oscillator:
  * https://www.desmos.com/calculator/irugw6gnhy
  *
- * @param n - number of octaves
+ * @param n - number of partials
+ * @param useGibbs -
  */
-export const sawAdditive = (n = 8) => additive(sin, identity, (i) => (1 / i) * gibbs(n, i), n);
+export const sawAdditive = (n = 8, useGibbs = true) => additive(sin, identity, (i) => (1 / i) * (useGibbs ? gibbs(n, i) : 1), n);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/dsp",
-  "version": "4.4.4",
+  "version": "4.5.0",
   "description": "Composable signal generators, oscillators, filters, FFT, spectrum, windowing & related DSP utils",
   "type": "module",
   "module": "./index.js",
@@ -39,7 +39,7 @@
     "@thi.ng/errors": "^2.3.5",
     "@thi.ng/math": "^5.6.1",
     "@thi.ng/random": "^3.6.4",
-    "@thi.ng/transducers": "^8.6.5"
+    "@thi.ng/transducers": "^8.7.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.36.4",
@@ -275,5 +275,5 @@
     ],
     "year": 2015
   },
-  "gitHead": "1bbef970bab7f7def0700e587cf0471e1e1ef9f3\n"
+  "gitHead": "b2ef5a1b8932d067af4ec2fc7da03d59d6868dc7\n"
 }