@thi.ng/dsp 4.1.5 → 4.2.2

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-03-11T12:13:49Z
+- **Last updated**: 2022-05-07T11:33:35Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,16 @@ 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.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/dsp@4.2.0) (2022-04-07)
+
+#### 🚀 Features
+
+- add opt Osc() ctor phase arg, fix [#340](https://github.com/thi-ng/umbrella/issues/340) ([f798c9d](https://github.com/thi-ng/umbrella/commit/f798c9d))
+  - update osc() factory fn
+  - update Osc.setFreq() signatures
+  - add tests
+  - add/update docs
+
 ## [4.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/dsp@4.1.0) (2021-11-17)
 
 #### 🚀 Features

package/README.md

@@ -86,7 +86,7 @@ node --experimental-repl-await
 > const dsp = await import("@thi.ng/dsp");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 7.54 KB
+Package sizes (gzipped, pre-treeshake): ESM: 7.56 KB
 
 ## Dependencies
 

package/osc.d.ts

@@ -1,29 +1,28 @@
 import { AGen } from "./agen.js";
 import type { IGen, StatelessOscillator } from "./api.js";
 /**
- * Higher order oscillator gen, wrapping a {@link StatelessOscillator}
- * function and supporting either constant or {@link IGen}-based
- * frequency and amplitude, thus allowing for FM/AM modulation.
- * Furthermore, a constant `dc` offset (center value) can be specified
- * (default: 0).
+ * Higher order oscillator gen, wrapping a {@link StatelessOscillator} function
+ * and supporting either constant or {@link IGen}-based frequency and amplitude,
+ * thus allowing for FM/AM modulation. Furthermore, a constant `dc` offset
+ * (center value) and/or start `phase` can be specified (both default to: 0).
  *
  * @remarks
- * If `freq` is a number, it must be given as normalized frequency. If
- * `freq` is an `IGen`, it must be configured to produce normalized
- * frequency values (e.g. if using an `Osc` by setting its `amp` to a
- * normalized freq and its `dc` offset to `baseFreq * TAU`). Also see
- * {@link fmodOsc} for syntax sugar.
+ * If `freq` is a number, it must be given as normalized frequency (same for
+ * `phase`). If `freq` is an `IGen`, it must be configured to produce normalized
+ * frequency values (e.g. if using an `Osc` by setting its `amp` to a normalized
+ * freq and its `dc` offset to `baseFreq * TAU`). Also see {@link fmodOsc} for
+ * syntax sugar. The `phase` arg is only used if `freq` is NOT an `IGen`.
  *
- * The oscillator initializes to zero and its
- * {@link @thi.ng/api#IDeref.deref} value is only available / valid
- * after the first invocation of {@link IGen.next}.
+ * The oscillator initializes to zero and its {@link @thi.ng/api#IDeref.deref}
+ * value is only available / valid after the first invocation of
+ * {@link IGen.next}.
  *
  * @param osc - stateless osc
  * @param freq - normalized freq
  * @param amp - amplitude
  * @param dc - DC offset / center value
  */
-export declare const osc: (osc: StatelessOscillator, freq: IGen<number> | number, amp?: number | IGen<number> | undefined, dc?: number | undefined) => Osc;
+export declare const osc: (osc: StatelessOscillator, freq: IGen<number> | number, amp?: number | IGen<number> | undefined, dc?: number | undefined, phase?: number | undefined) => Osc;
 /**
  * Syntax sugar for creating frequency modulated `Osc` gens.
  *
@@ -52,9 +51,10 @@ export declare class Osc extends AGen<number> {
     protected _dc: number;
     protected _phase: IGen<number>;
     protected _amp: IGen<number>;
-    constructor(_osc: StatelessOscillator, freq: IGen<number> | number, amp?: IGen<number> | number, _dc?: number);
+    constructor(_osc: StatelessOscillator, freq: IGen<number> | number, amp?: IGen<number> | number, _dc?: number, phase?: number);
     next(): number;
-    setFreq(freq: IGen<number> | number, phase?: number): void;
+    setFreq(freq: IGen<number>): void;
+    setFreq(freq: number, phase?: number): void;
     setAmp(amp: IGen<number> | number): void;
 }
 //# sourceMappingURL=osc.d.ts.map

package/osc.js

@@ -4,29 +4,28 @@ import { AGen } from "./agen.js";
 import { Const } from "./const.js";
 import { sum } from "./sum.js";
 /**
- * Higher order oscillator gen, wrapping a {@link StatelessOscillator}
- * function and supporting either constant or {@link IGen}-based
- * frequency and amplitude, thus allowing for FM/AM modulation.
- * Furthermore, a constant `dc` offset (center value) can be specified
- * (default: 0).
+ * Higher order oscillator gen, wrapping a {@link StatelessOscillator} function
+ * and supporting either constant or {@link IGen}-based frequency and amplitude,
+ * thus allowing for FM/AM modulation. Furthermore, a constant `dc` offset
+ * (center value) and/or start `phase` can be specified (both default to: 0).
  *
  * @remarks
- * If `freq` is a number, it must be given as normalized frequency. If
- * `freq` is an `IGen`, it must be configured to produce normalized
- * frequency values (e.g. if using an `Osc` by setting its `amp` to a
- * normalized freq and its `dc` offset to `baseFreq * TAU`). Also see
- * {@link fmodOsc} for syntax sugar.
+ * If `freq` is a number, it must be given as normalized frequency (same for
+ * `phase`). If `freq` is an `IGen`, it must be configured to produce normalized
+ * frequency values (e.g. if using an `Osc` by setting its `amp` to a normalized
+ * freq and its `dc` offset to `baseFreq * TAU`). Also see {@link fmodOsc} for
+ * syntax sugar. The `phase` arg is only used if `freq` is NOT an `IGen`.
  *
- * The oscillator initializes to zero and its
- * {@link @thi.ng/api#IDeref.deref} value is only available / valid
- * after the first invocation of {@link IGen.next}.
+ * The oscillator initializes to zero and its {@link @thi.ng/api#IDeref.deref}
+ * value is only available / valid after the first invocation of
+ * {@link IGen.next}.
  *
  * @param osc - stateless osc
  * @param freq - normalized freq
  * @param amp - amplitude
  * @param dc - DC offset / center value
  */
-export const osc = (osc, freq, amp, dc) => new Osc(osc, freq, amp, dc);
+export const osc = (osc, freq, amp, dc, phase) => new Osc(osc, freq, amp, dc, phase);
 /**
  * Syntax sugar for creating frequency modulated `Osc` gens.
  *
@@ -51,18 +50,18 @@ export const osc = (osc, freq, amp, dc) => new Osc(osc, freq, amp, dc);
  */
 export const modOsc = (osc, freq, fmod, amod = 1) => new Osc(osc, sum(fmod, isNumber(freq) ? add(freq) : freq), amod);
 export class Osc extends AGen {
-    constructor(_osc, freq, amp = 1, _dc = 0) {
+    constructor(_osc, freq, amp = 1, _dc = 0, phase = 0) {
         super(0);
         this._osc = _osc;
         this._dc = _dc;
-        this.setFreq(freq);
+        isNumber(freq) ? this.setFreq(freq, phase) : this.setFreq(freq);
         this.setAmp(amp);
     }
     next() {
         return (this._val = this._osc(this._phase.next(), 1, this._amp.next(), this._dc));
     }
-    setFreq(freq, phase = 0) {
-        this._phase = isNumber(freq) ? new Add(freq, phase) : freq;
+    setFreq(freq, phase) {
+        this._phase = isNumber(freq) ? new Add(freq, phase || 0) : freq;
     }
     setAmp(amp) {
         this._amp = isNumber(amp) ? new Const(amp) : amp;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/dsp",
-  "version": "4.1.5",
+  "version": "4.2.2",
   "description": "Composable signal generators, oscillators, filters, FFT, spectrum, windowing & related DSP utils",
   "type": "module",
   "module": "./index.js",
@@ -34,20 +34,20 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.3.4",
-    "@thi.ng/checks": "^3.1.4",
-    "@thi.ng/errors": "^2.1.4",
-    "@thi.ng/math": "^5.3.0",
-    "@thi.ng/random": "^3.2.4",
-    "@thi.ng/transducers": "^8.3.0"
+    "@thi.ng/api": "^8.3.6",
+    "@thi.ng/checks": "^3.1.6",
+    "@thi.ng/errors": "^2.1.6",
+    "@thi.ng/math": "^5.3.2",
+    "@thi.ng/random": "^3.3.0",
+    "@thi.ng/transducers": "^8.3.3"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.19.4",
-    "@thi.ng/testament": "^0.2.4",
+    "@microsoft/api-extractor": "^7.23.1",
+    "@thi.ng/testament": "^0.2.7",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.22.13",
-    "typescript": "^4.6.2"
+    "typedoc": "^0.22.15",
+    "typescript": "^4.6.4"
   },
   "keywords": [
     "allpass",
@@ -92,178 +92,178 @@
   ],
   "exports": {
     ".": {
-      "import": "./index.js"
+      "default": "./index.js"
     },
     "./add": {
-      "import": "./add.js"
+      "default": "./add.js"
     },
     "./addg": {
-      "import": "./addg.js"
+      "default": "./addg.js"
     },
     "./adsr": {
-      "import": "./adsr.js"
+      "default": "./adsr.js"
     },
     "./agen": {
-      "import": "./agen.js"
+      "default": "./agen.js"
     },
     "./allpass": {
-      "import": "./allpass.js"
+      "default": "./allpass.js"
     },
     "./alt": {
-      "import": "./alt.js"
+      "default": "./alt.js"
     },
     "./anti-alias": {
-      "import": "./anti-alias.js"
+      "default": "./anti-alias.js"
     },
     "./api": {
-      "import": "./api.js"
+      "default": "./api.js"
     },
     "./aproc": {
-      "import": "./aproc.js"
+      "default": "./aproc.js"
     },
     "./biquad": {
-      "import": "./biquad.js"
+      "default": "./biquad.js"
     },
     "./bounce": {
-      "import": "./bounce.js"
+      "default": "./bounce.js"
     },
     "./complex": {
-      "import": "./complex.js"
+      "default": "./complex.js"
     },
     "./const": {
-      "import": "./const.js"
+      "default": "./const.js"
     },
     "./convert": {
-      "import": "./convert.js"
+      "default": "./convert.js"
     },
     "./cosine": {
-      "import": "./cosine.js"
+      "default": "./cosine.js"
     },
     "./curve": {
-      "import": "./curve.js"
+      "default": "./curve.js"
     },
     "./dcblock": {
-      "import": "./dcblock.js"
+      "default": "./dcblock.js"
     },
     "./delay": {
-      "import": "./delay.js"
+      "default": "./delay.js"
     },
     "./feedback-delay": {
-      "import": "./feedback-delay.js"
+      "default": "./feedback-delay.js"
     },
     "./fft": {
-      "import": "./fft.js"
+      "default": "./fft.js"
     },
     "./filter-response": {
-      "import": "./filter-response.js"
+      "default": "./filter-response.js"
     },
     "./foldback": {
-      "import": "./foldback.js"
+      "default": "./foldback.js"
     },
     "./impulse-train": {
-      "import": "./impulse-train.js"
+      "default": "./impulse-train.js"
     },
     "./impulse": {
-      "import": "./impulse.js"
+      "default": "./impulse.js"
     },
     "./integrator": {
-      "import": "./integrator.js"
+      "default": "./integrator.js"
     },
     "./iterable": {
-      "import": "./iterable.js"
+      "default": "./iterable.js"
     },
     "./line": {
-      "import": "./line.js"
+      "default": "./line.js"
     },
     "./madd": {
-      "import": "./madd.js"
+      "default": "./madd.js"
     },
     "./mapg": {
-      "import": "./mapg.js"
+      "default": "./mapg.js"
     },
     "./mix": {
-      "import": "./mix.js"
+      "default": "./mix.js"
     },
     "./mul": {
-      "import": "./mul.js"
+      "default": "./mul.js"
     },
     "./multiplex": {
-      "import": "./multiplex.js"
+      "default": "./multiplex.js"
     },
     "./onepole": {
-      "import": "./onepole.js"
+      "default": "./onepole.js"
     },
     "./osc-additive": {
-      "import": "./osc-additive.js"
+      "default": "./osc-additive.js"
     },
     "./osc-cos": {
-      "import": "./osc-cos.js"
+      "default": "./osc-cos.js"
     },
     "./osc-dsf": {
-      "import": "./osc-dsf.js"
+      "default": "./osc-dsf.js"
     },
     "./osc-mix": {
-      "import": "./osc-mix.js"
+      "default": "./osc-mix.js"
     },
     "./osc-parabolic": {
-      "import": "./osc-parabolic.js"
+      "default": "./osc-parabolic.js"
     },
     "./osc-rect": {
-      "import": "./osc-rect.js"
+      "default": "./osc-rect.js"
     },
     "./osc-saw": {
-      "import": "./osc-saw.js"
+      "default": "./osc-saw.js"
     },
     "./osc-sin": {
-      "import": "./osc-sin.js"
+      "default": "./osc-sin.js"
     },
     "./osc-tri": {
-      "import": "./osc-tri.js"
+      "default": "./osc-tri.js"
     },
     "./osc-wavetable": {
-      "import": "./osc-wavetable.js"
+      "default": "./osc-wavetable.js"
     },
     "./osc": {
-      "import": "./osc.js"
+      "default": "./osc.js"
     },
     "./pink-noise": {
-      "import": "./pink-noise.js"
+      "default": "./pink-noise.js"
     },
     "./pipe": {
-      "import": "./pipe.js"
+      "default": "./pipe.js"
     },
     "./power": {
-      "import": "./power.js"
+      "default": "./power.js"
     },
     "./product": {
-      "import": "./product.js"
+      "default": "./product.js"
     },
     "./reciprocal": {
-      "import": "./reciprocal.js"
+      "default": "./reciprocal.js"
     },
     "./serial": {
-      "import": "./serial.js"
+      "default": "./serial.js"
     },
     "./sincos": {
-      "import": "./sincos.js"
+      "default": "./sincos.js"
     },
     "./sum": {
-      "import": "./sum.js"
+      "default": "./sum.js"
     },
     "./svf": {
-      "import": "./svf.js"
+      "default": "./svf.js"
     },
     "./sweep": {
-      "import": "./sweep.js"
+      "default": "./sweep.js"
     },
     "./waveshaper": {
-      "import": "./waveshaper.js"
+      "default": "./waveshaper.js"
     },
     "./white-noise": {
-      "import": "./white-noise.js"
+      "default": "./white-noise.js"
     },
     "./window": {
-      "import": "./window.js"
+      "default": "./window.js"
     }
   },
   "thi.ng": {
@@ -272,5 +272,5 @@
     ],
     "year": 2015
   },
-  "gitHead": "0fc692a3225c068aacafdc4cb6140cf603c67ad8\n"
+  "gitHead": "e23901b8582af71d8a29e0ce4929f15ac509f9e5\n"
 }