@thi.ng/dsp 4.6.19 → 4.7.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2023-12-19T11:01:47Z
+- **Last updated**: 2023-12-28T23:24:38Z
 - **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.7.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/dsp@4.7.0) (2023-12-28)
+
+#### 🚀 Features
+
+- add squareSin() oscillator ([f7f1b1a](https://github.com/thi-ng/umbrella/commit/f7f1b1a))
+
 ## [4.6.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/dsp@4.6.0) (2023-09-28)
 
 #### 🚀 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: 7.52 KB
+Package sizes (brotli'd, pre-treeshake): ESM: 7.57 KB
 
 ## Dependencies
 
@@ -253,6 +253,7 @@ Diagram of the FM/AM osc with some low pass filters applied:
 - [saw](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/osc-saw.ts)
 - [sawAdditive](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/osc-additive.ts)
 - [squareAdditive](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/osc-additive.ts)
+- [squareSin](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/osc-square-sin.ts)
 - [sin](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/osc-sin.ts)
 - [tri](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/osc-tri.ts)
 - [wavetable](https://github.com/thi-ng/umbrella/blob/develop/packages/dsp/src/osc-wavetable.ts)

package/index.d.ts

@@ -39,6 +39,7 @@ export * from "./osc-dsf.js";
 export * from "./osc-mix.js";
 export * from "./osc-parabolic.js";
 export * from "./osc-rect.js";
+export * from "./osc-square-sin.js";
 export * from "./osc-saw.js";
 export * from "./osc-sin.js";
 export * from "./osc-tri.js";

package/index.js

@@ -39,6 +39,7 @@ export * from "./osc-dsf.js";
 export * from "./osc-mix.js";
 export * from "./osc-parabolic.js";
 export * from "./osc-rect.js";
+export * from "./osc-square-sin.js";
 export * from "./osc-saw.js";
 export * from "./osc-sin.js";
 export * from "./osc-tri.js";

package/osc-square-sin.d.ts

@@ -0,0 +1,14 @@
+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
+ * 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
+ *
+ * @param squareness
+ */
+export declare const squareSin: (squareness: number) => StatelessOscillator;
+//# sourceMappingURL=osc-square-sin.d.ts.map

package/osc-square-sin.js

@@ -0,0 +1,11 @@
+import { TAU } from "@thi.ng/math/api";
+const squareSin = (squareness) => {
+  squareness = 1 - squareness;
+  return (phase, freq, amp = 1, dc = 0) => {
+    const y = Math.sin(phase * freq * TAU);
+    return dc + amp * Math.sign(y) * Math.abs(y) ** squareness;
+  };
+};
+export {
+  squareSin
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/dsp",
-  "version": "4.6.19",
+  "version": "4.7.0",
   "description": "Composable signal generators, oscillators, filters, FFT, spectrum, windowing & related DSP utils",
   "type": "module",
   "module": "./index.js",
@@ -32,22 +32,23 @@
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
     "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts",
     "pub": "yarn npm publish --access public",
-    "test": "bun test"
+    "test": "bun test",
+    "tool:diagrams": "bun tools/generate-diagrams.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.14",
-    "@thi.ng/checks": "^3.4.14",
-    "@thi.ng/errors": "^2.4.8",
-    "@thi.ng/math": "^5.7.9",
-    "@thi.ng/random": "^3.6.20",
-    "@thi.ng/transducers": "^8.8.17"
+    "@thi.ng/api": "^8.9.15",
+    "@thi.ng/checks": "^3.4.15",
+    "@thi.ng/errors": "^2.4.9",
+    "@thi.ng/math": "^5.7.10",
+    "@thi.ng/random": "^3.6.22",
+    "@thi.ng/transducers": "^8.8.19"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.38.3",
-    "esbuild": "^0.19.8",
+    "@microsoft/api-extractor": "^7.39.0",
+    "esbuild": "^0.19.10",
     "rimraf": "^5.0.5",
     "typedoc": "^0.25.4",
-    "typescript": "^5.3.2"
+    "typescript": "^5.3.3"
   },
   "keywords": [
     "allpass",
@@ -223,6 +224,9 @@
     "./osc-sin": {
       "default": "./osc-sin.js"
     },
+    "./osc-square-sin": {
+      "default": "./osc-square-sin.js"
+    },
     "./osc-tri": {
       "default": "./osc-tri.js"
     },
@@ -284,5 +288,5 @@
     ],
     "year": 2015
   },
-  "gitHead": "0d9265be7be13eccf0ef75eaedbfd42626339279\n"
+  "gitHead": "775c664723cd87d6ac5909cedf91195317add287\n"
 }