@logue/reverb 1.2.3 → 1.2.7

package/README.md

@@ -97,4 +97,4 @@ sourceNode.play();
 
 ## License
 
-[MIT](LICENSE)
+©2019-2023 by Logue. Licensed under the [MIT License](LICENSE).

package/dist/Reverb.es.js

@@ -3,9 +3,9 @@
  *
  * @description JavaScript Reverb effect class
  * @author Logue <logue@hotmail.co.jp>
- * @copyright 2019-2022 By Masashi Yoshikawa All rights reserved.
+ * @copyright 2019-2023 By Masashi Yoshikawa All rights reserved.
  * @license MIT
- * @version 1.2.3
+ * @version 1.2.7
  * @see {@link https://github.com/logue/Reverb.js}
  */
 
@@ -13,59 +13,73 @@ import { SYSTEM } from '@thi.ng/random';
 import { white, violet, red, pink, green, blue } from '@thi.ng/colored-noise';
 import { take } from '@thi.ng/transducers';
 
-/** Impulse response noise generation algorithm */
-const Noise = {
-    /** Blue noise */
-    BLUE: 'blue',
-    /** Green noise */
-    GREEN: 'green',
-    /** Pink noise */
-    PINK: 'pink',
-    /** Red noise */
-    RED: 'red',
-    /** Violet noise */
-    VIOLET: 'violet',
-    /** White noise */
-    WHITE: 'white',
-    /** Brown noise (same as red noise) */
-    BROWN: 'red',
+const defaults = {
+  noise: "white",
+  scale: 1,
+  peaks: 2,
+  randomAlgorithm: SYSTEM,
+  decay: 2,
+  delay: 0,
+  reverse: false,
+  time: 2,
+  filterType: "allpass",
+  filterFreq: 2200,
+  filterQ: 1,
+  mix: 0.5,
+  once: false
 };
 
-/** デフォルト値 */
-const defaults = {
-    noise: Noise.WHITE,
-    scale: 1,
-    peaks: 2,
-    randomAlgorithm: SYSTEM,
-    decay: 2,
-    delay: 0,
-    reverse: false,
-    time: 2,
-    filterType: 'allpass',
-    filterFreq: 2200,
-    filterQ: 1,
-    mix: 0.5,
-    once: false,
+const meta = {
+  version: "1.2.7",
+  date: "2023-03-10T12:40:23.409Z"
 };
 
-// This file is auto-generated by the build system.
-const meta = {
-    version: '1.2.3',
-    date: '2023-01-03T08:14:36.986Z',
+const Noise = {
+  /** Blue noise */
+  BLUE: "blue",
+  /** Green noise */
+  GREEN: "green",
+  /** Pink noise */
+  PINK: "pink",
+  /** Red noise */
+  RED: "red",
+  /** Violet noise */
+  VIOLET: "violet",
+  /** White noise */
+  WHITE: "white",
+  /** Brown noise (same as red noise) */
+  BROWN: "red"
 };
 
 class Reverb {
+  /** Version strings */
   static version = meta.version;
+  /** Build date */
   static build = meta.date;
+  /** AudioContext */
   ctx;
+  /** Wet Level (Reverberated node) */
   wetGainNode;
+  /** Dry Level (Original sound node) */
   dryGainNode;
+  /** Impulse response filter */
   filterNode;
+  /** Convolution node for applying impulse response */
   convolverNode;
+  /** Output gain node */
   outputNode;
+  /** Option */
   options;
+  /** Connected flag */
   isConnected;
+  /** Noise Generator */
   noise = white;
+  /**
+   * Constructor
+   *
+   * @param ctx - Root AudioContext
+   * @param options - Configure
+   */
   constructor(ctx, options) {
     this.ctx = ctx;
     this.options = { ...defaults, ...options };
@@ -80,6 +94,11 @@ class Reverb {
     this.buildImpulse();
     this.mix(this.options.mix);
   }
+  /**
+   * Connect the node for the reverb effect to the original sound node.
+   *
+   * @param sourceNode - Input source node
+   */
   connect(sourceNode) {
     if (this.isConnected && this.options.once) {
       this.isConnected = false;
@@ -93,6 +112,11 @@ class Reverb {
     this.isConnected = true;
     return this.outputNode;
   }
+  /**
+   * Disconnect the reverb node
+   *
+   * @param sourceNode - Input source node
+   */
   disconnect(sourceNode) {
     if (this.isConnected) {
       this.convolverNode.disconnect(this.filterNode);
@@ -101,6 +125,11 @@ class Reverb {
     this.isConnected = false;
     return sourceNode;
   }
+  /**
+   * Dry/Wet ratio
+   *
+   * @param mix - Ratio (0~1)
+   */
   mix(mix) {
     if (!this.inRange(mix, 0, 1)) {
       throw new RangeError("[Reverb.js] Dry/Wet ratio must be between 0 to 1.");
@@ -109,6 +138,11 @@ class Reverb {
     this.dryGainNode.gain.value = 1 - this.options.mix;
     this.wetGainNode.gain.value = this.options.mix;
   }
+  /**
+   * Set Impulse Response time length (second)
+   *
+   * @param value - IR length
+   */
   time(value) {
     if (!this.inRange(value, 1, 50)) {
       throw new RangeError(
@@ -118,6 +152,11 @@ class Reverb {
     this.options.time = value;
     this.buildImpulse();
   }
+  /**
+   * Impulse response decay rate.
+   *
+   * @param value - Decay value
+   */
   decay(value) {
     if (!this.inRange(value, 0, 100)) {
       throw new RangeError(
@@ -127,6 +166,11 @@ class Reverb {
     this.options.decay = value;
     this.buildImpulse();
   }
+  /**
+   * Delay before reverberation starts
+   *
+   * @param value - Time[ms]
+   */
   delay(value) {
     if (!this.inRange(value, 0, 100)) {
       throw new RangeError(
@@ -136,13 +180,28 @@ class Reverb {
     this.options.delay = value;
     this.buildImpulse();
   }
+  /**
+   * Reverse the impulse response.
+   *
+   * @param reverse - Reverse IR
+   */
   reverse(reverse) {
     this.options.reverse = reverse;
     this.buildImpulse();
   }
+  /**
+   * Filter for impulse response
+   *
+   * @param type - Filiter Type
+   */
   filterType(type = "allpass") {
     this.filterNode.type = this.options.filterType = type;
   }
+  /**
+   * Filter frequency applied to impulse response
+   *
+   * @param freq - Frequency
+   */
   filterFreq(freq) {
     if (!this.inRange(freq, 20, 2e4)) {
       throw new RangeError(
@@ -152,6 +211,11 @@ class Reverb {
     this.options.filterFreq = freq;
     this.filterNode.frequency.value = this.options.filterFreq;
   }
+  /**
+   * Filter quality.
+   *
+   * @param q - Quality
+   */
   filterQ(q) {
     if (!this.inRange(q, 0, 10)) {
       throw new RangeError(
@@ -161,35 +225,55 @@ class Reverb {
     this.options.filterQ = q;
     this.filterNode.Q.value = this.options.filterQ;
   }
+  /**
+   * set IR source noise peaks
+   *
+   * @param p - Peaks
+   */
   peaks(p) {
     this.options.peaks = p;
     this.buildImpulse();
   }
+  /**
+   * set IR source noise scale.
+   *
+   * @param s - Scale
+   */
   scale(s) {
     this.options.scale = s;
     this.buildImpulse();
   }
+  /**
+   * set IR source noise generator.
+   *
+   * @param a - Algorithm
+   */
   randomAlgorithm(a) {
     this.options.randomAlgorithm = a;
     this.buildImpulse();
   }
+  /**
+   * Inpulse Response Noise algorithm.
+   *
+   * @param type - IR noise algorithm type.
+   */
   setNoise(type) {
     this.options.noise = type;
     switch (type) {
-      case Noise.BLUE:
+      case Noise["BLUE"]:
         this.noise = blue;
         break;
-      case Noise.GREEN:
+      case Noise["GREEN"]:
         this.noise = green;
         break;
-      case Noise.PINK:
+      case Noise["PINK"]:
         this.noise = pink;
         break;
-      case Noise.RED:
-      case Noise.BROWN:
+      case Noise["RED"]:
+      case Noise["BROWN"]:
         this.noise = red;
         break;
-      case Noise.VIOLET:
+      case Noise["VIOLET"]:
         this.noise = violet;
         break;
       default:
@@ -197,13 +281,26 @@ class Reverb {
     }
     this.buildImpulse();
   }
+  /**
+   * Set Random Algorythm
+   *
+   * @param algorithm - Algorythm
+   */
   setRandomAlgorythm(algorithm) {
     this.options.randomAlgorithm = algorithm;
     this.buildImpulse();
   }
+  /**
+   * Return true if in range, otherwise false
+   *
+   * @param x - Target value
+   * @param min - Minimum value
+   * @param max - Maximum value
+   */
   inRange(x, min, max) {
     return (x - min) * (x - max) <= 0;
   }
+  /** Utility function for building an impulse response from the module parameters. */
   buildImpulse() {
     const rate = this.ctx.sampleRate;
     const duration = Math.max(rate * this.options.time, 1);
@@ -229,6 +326,11 @@ class Reverb {
     impulse.getChannelData(1).set(impulseR);
     this.convolverNode.buffer = impulse;
   }
+  /**
+   * Noise source
+   *
+   * @param duration - length of IR.
+   */
   getNoise(duration) {
     return [
       ...take(