@logue/reverb 1.2.2 → 1.2.6

package/dist/Reverb.iife.js

@@ -3,248 +3,350 @@
  *
  * @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.2
+ * @version 1.2.6
  * @see {@link https://github.com/logue/Reverb.js}
  */
 
 var Reverb = (function (random, coloredNoise, transducers) {
-    'use strict';
+  'use strict';
 
-    /** 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: random.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: random.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.6",
+    date: "2023-02-15T04:55:52.436Z"
+  };
 
-    // This file is auto-generated by the build system.
-    const meta = {
-        version: '1.2.2',
-        date: '2022-12-22T02:11:59.486Z',
-    };
+  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 {
-      static version = meta.version;
-      static build = meta.date;
-      ctx;
-      wetGainNode;
-      dryGainNode;
-      filterNode;
-      convolverNode;
-      outputNode;
-      options;
-      isConnected;
-      noise = coloredNoise.white;
-      constructor(ctx, options) {
-        this.ctx = ctx;
-        this.options = { ...defaults, ...options };
-        this.wetGainNode = this.ctx.createGain();
-        this.dryGainNode = this.ctx.createGain();
-        this.filterNode = this.ctx.createBiquadFilter();
-        this.convolverNode = this.ctx.createConvolver();
-        this.outputNode = this.ctx.createGain();
+  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 = coloredNoise.white;
+    /**
+     * Constructor
+     *
+     * @param ctx - Root AudioContext
+     * @param options - Configure
+     */
+    constructor(ctx, options) {
+      this.ctx = ctx;
+      this.options = { ...defaults, ...options };
+      this.wetGainNode = this.ctx.createGain();
+      this.dryGainNode = this.ctx.createGain();
+      this.filterNode = this.ctx.createBiquadFilter();
+      this.convolverNode = this.ctx.createConvolver();
+      this.outputNode = this.ctx.createGain();
+      this.isConnected = false;
+      this.filterType(this.options.filterType);
+      this.setNoise(this.options.noise);
+      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;
-        this.filterType(this.options.filterType);
-        this.setNoise(this.options.noise);
-        this.buildImpulse();
-        this.mix(this.options.mix);
-      }
-      connect(sourceNode) {
-        if (this.isConnected && this.options.once) {
-          this.isConnected = false;
-          return this.outputNode;
-        }
-        this.convolverNode.connect(this.filterNode);
-        this.filterNode.connect(this.wetGainNode);
-        sourceNode.connect(this.convolverNode);
-        sourceNode.connect(this.dryGainNode).connect(this.outputNode);
-        sourceNode.connect(this.wetGainNode).connect(this.outputNode);
-        this.isConnected = true;
         return this.outputNode;
       }
-      disconnect(sourceNode) {
-        if (this.isConnected) {
-          this.convolverNode.disconnect(this.filterNode);
-          this.filterNode.disconnect(this.wetGainNode);
-        }
-        this.isConnected = false;
-        return sourceNode;
-      }
-      mix(mix) {
-        if (!this.inRange(mix, 0, 1)) {
-          throw new RangeError("[Reverb.js] Dry/Wet ratio must be between 0 to 1.");
-        }
-        this.options.mix = mix;
-        this.dryGainNode.gain.value = 1 - this.options.mix;
-        this.wetGainNode.gain.value = this.options.mix;
-      }
-      time(value) {
-        if (!this.inRange(value, 1, 50)) {
-          throw new RangeError(
-            "[Reverb.js] Time length of inpulse response must be less than 50sec."
-          );
-        }
-        this.options.time = value;
-        this.buildImpulse();
-      }
-      decay(value) {
-        if (!this.inRange(value, 0, 100)) {
-          throw new RangeError(
-            "[Reverb.js] Inpulse Response decay level must be less than 100."
-          );
-        }
-        this.options.decay = value;
-        this.buildImpulse();
-      }
-      delay(value) {
-        if (!this.inRange(value, 0, 100)) {
-          throw new RangeError(
-            "[Reverb.js] Inpulse Response delay time must be less than 100."
-          );
-        }
-        this.options.delay = value;
-        this.buildImpulse();
-      }
-      reverse(reverse) {
-        this.options.reverse = reverse;
-        this.buildImpulse();
-      }
-      filterType(type = "allpass") {
-        this.filterNode.type = this.options.filterType = type;
-      }
-      filterFreq(freq) {
-        if (!this.inRange(freq, 20, 2e4)) {
-          throw new RangeError(
-            "[Reverb.js] Filter frequrncy must be between 20 and 20000."
-          );
-        }
-        this.options.filterFreq = freq;
-        this.filterNode.frequency.value = this.options.filterFreq;
+      this.convolverNode.connect(this.filterNode);
+      this.filterNode.connect(this.wetGainNode);
+      sourceNode.connect(this.convolverNode);
+      sourceNode.connect(this.dryGainNode).connect(this.outputNode);
+      sourceNode.connect(this.wetGainNode).connect(this.outputNode);
+      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);
+        this.filterNode.disconnect(this.wetGainNode);
       }
-      filterQ(q) {
-        if (!this.inRange(q, 0, 10)) {
-          throw new RangeError(
-            "[Reverb.js] Filter quality value must be between 0 and 10."
-          );
-        }
-        this.options.filterQ = q;
-        this.filterNode.Q.value = this.options.filterQ;
+      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.");
       }
-      peaks(p) {
-        this.options.peaks = p;
-        this.buildImpulse();
+      this.options.mix = mix;
+      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(
+          "[Reverb.js] Time length of inpulse response must be less than 50sec."
+        );
       }
-      scale(s) {
-        this.options.scale = s;
-        this.buildImpulse();
+      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(
+          "[Reverb.js] Inpulse Response decay level must be less than 100."
+        );
       }
-      randomAlgorithm(a) {
-        this.options.randomAlgorithm = a;
-        this.buildImpulse();
+      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(
+          "[Reverb.js] Inpulse Response delay time must be less than 100."
+        );
       }
-      setNoise(type) {
-        this.options.noise = type;
-        switch (type) {
-          case Noise.BLUE:
-            this.noise = coloredNoise.blue;
-            break;
-          case Noise.GREEN:
-            this.noise = coloredNoise.green;
-            break;
-          case Noise.PINK:
-            this.noise = coloredNoise.pink;
-            break;
-          case Noise.RED:
-          case Noise.BROWN:
-            this.noise = coloredNoise.red;
-            break;
-          case Noise.VIOLET:
-            this.noise = coloredNoise.violet;
-            break;
-          default:
-            this.noise = coloredNoise.white;
-        }
-        this.buildImpulse();
+      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(
+          "[Reverb.js] Filter frequrncy must be between 20 and 20000."
+        );
       }
-      setRandomAlgorythm(algorithm) {
-        this.options.randomAlgorithm = algorithm;
-        this.buildImpulse();
+      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(
+          "[Reverb.js] Filter quality value must be between 0 and 10."
+        );
       }
-      inRange(x, min, max) {
-        return (x - min) * (x - max) <= 0;
+      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"]:
+          this.noise = coloredNoise.blue;
+          break;
+        case Noise["GREEN"]:
+          this.noise = coloredNoise.green;
+          break;
+        case Noise["PINK"]:
+          this.noise = coloredNoise.pink;
+          break;
+        case Noise["RED"]:
+        case Noise["BROWN"]:
+          this.noise = coloredNoise.red;
+          break;
+        case Noise["VIOLET"]:
+          this.noise = coloredNoise.violet;
+          break;
+        default:
+          this.noise = coloredNoise.white;
       }
-      buildImpulse() {
-        const rate = this.ctx.sampleRate;
-        const duration = Math.max(rate * this.options.time, 1);
-        const delayDuration = rate * this.options.delay;
-        const impulse = this.ctx.createBuffer(2, duration, rate);
-        const impulseL = new Float32Array(duration);
-        const impulseR = new Float32Array(duration);
-        const noiseL = this.getNoise(duration);
-        const noiseR = this.getNoise(duration);
-        for (let i = 0; i < duration; i++) {
-          let n = 0;
-          if (i < delayDuration) {
-            impulseL[i] = 0;
-            impulseR[i] = 0;
-            n = this.options.reverse ? duration - (i - delayDuration) : i - delayDuration;
-          } else {
-            n = this.options.reverse ? duration - i : i;
-          }
-          impulseL[i] = noiseL[i] * (1 - n / duration) ** this.options.decay;
-          impulseR[i] = noiseR[i] * (1 - n / duration) ** this.options.decay;
+      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);
+      const delayDuration = rate * this.options.delay;
+      const impulse = this.ctx.createBuffer(2, duration, rate);
+      const impulseL = new Float32Array(duration);
+      const impulseR = new Float32Array(duration);
+      const noiseL = this.getNoise(duration);
+      const noiseR = this.getNoise(duration);
+      for (let i = 0; i < duration; i++) {
+        let n = 0;
+        if (i < delayDuration) {
+          impulseL[i] = 0;
+          impulseR[i] = 0;
+          n = this.options.reverse ? duration - (i - delayDuration) : i - delayDuration;
+        } else {
+          n = this.options.reverse ? duration - i : i;
         }
-        impulse.getChannelData(0).set(impulseL);
-        impulse.getChannelData(1).set(impulseR);
-        this.convolverNode.buffer = impulse;
-      }
-      getNoise(duration) {
-        return [
-          ...transducers.take(
-            duration,
-            this.noise(
-              this.options.peaks,
-              this.options.scale,
-              this.options.randomAlgorithm
-            )
-          )
-        ];
+        impulseL[i] = noiseL[i] * (1 - n / duration) ** this.options.decay;
+        impulseR[i] = noiseR[i] * (1 - n / duration) ** this.options.decay;
       }
+      impulse.getChannelData(0).set(impulseL);
+      impulse.getChannelData(1).set(impulseR);
+      this.convolverNode.buffer = impulse;
     }
-    if (!window.Reverb) {
-      window.Reverb = Reverb;
+    /**
+     * Noise source
+     *
+     * @param duration - length of IR.
+     */
+    getNoise(duration) {
+      return [
+        ...transducers.take(
+          duration,
+          this.noise(
+            this.options.peaks,
+            this.options.scale,
+            this.options.randomAlgorithm
+          )
+        )
+      ];
     }
+  }
+  if (!window.Reverb) {
+    window.Reverb = Reverb;
+  }
 
-    return Reverb;
+  return Reverb;
 
 })(random, colordNoise, transducers);