@logue/reverb 1.5.2 → 1.6.0

package/README.md

@@ -16,6 +16,45 @@ This script is originally a spin out of [sf2synth.js](https://github.com/logue/s
 - <https://logue.dev/Reverb.js/>
 - <https://logue.dev/Reverb.js/localaudio.html>
 
+## Installation
+
+```bash
+pnpm install @logue/reverb @thi.ng/colored-noise @thi.ng/transducers @thi.ng/random
+```
+
+## Usage
+
+```js
+import Reverb from '@logue/reverb';
+
+// Setup Audio Context
+const ctx = new window.AudioContext();
+
+// iOS fix.
+document.addEventListener('touchstart', initAudioContext);
+function initAudioContext() {
+  document.removeEventListener('touchstart', initAudioContext);
+  // wake up AudioContext
+  const emptySource = ctx.createBufferSource();
+  emptySource.start();
+  emptySource.stop();
+}
+
+// Setup Reverb Class
+const reverb = new Reverb(ctx, {});
+
+// put Audio data to audio buffer source
+const sourceNode = ctx.createBufferSource();
+sourceNode.buffer = [AudioBuffer];
+
+// Connect Reverb
+reverb.connect(sourceNode);
+sourceNode.connect(ctx.destination);
+
+// fire
+sourceNode.play();
+```
+
 ## Syntax
 
 ```js
@@ -56,37 +95,6 @@ const reverb = new Reverb(ctx, {
 });
 ```
 
-## Usage
-
-```js
-// Setup Audio Context
-const ctx = new window.AudioContext();
-
-// iOS fix.
-document.addEventListener('touchstart', initAudioContext);
-function initAudioContext() {
-  document.removeEventListener('touchstart', initAudioContext);
-  // wake up AudioContext
-  const emptySource = ctx.createBufferSource();
-  emptySource.start();
-  emptySource.stop();
-}
-
-// Setup Reverb Class
-const reverb = new Reverb(ctx, {});
-
-// put Audio data to audio buffer source
-const sourceNode = ctx.createBufferSource();
-sourceNode.buffer = [AudioBuffer];
-
-// Connect Reverb
-reverb.connect(sourceNode);
-sourceNode.connect(ctx.destination);
-
-// fire
-sourceNode.play();
-```
-
 ## Testing
 
 This project includes a comprehensive test suite to ensure reliability and code quality.

package/dist/Reverb.d.ts

@@ -1,141 +1,185 @@
-import { default as OptionInterface } from './interfaces/OptionInterface';
+import { ColoredNoiseOpts } from '@thi.ng/colored-noise';
 import { INorm } from '@thi.ng/random';
-import { NoiseType } from './NoiseType';
+
+/** Noise Type */
+export type NoiseType = "blue" | "brown" | "green" | "pink" | "red" | "violet" | "white";
+declare const NoiseType: Record<NoiseType, (opts?: Partial<ColoredNoiseOpts>) => Generator<number, void, unknown>>;
+/** Reverb Option */
+export interface OptionInterface {
+	/**
+	 * IR (Inpulse Response) colord noise algorithm (BLUE, GREEN, PINK, RED, VIOLET, WHITE)
+	 * @see {@link https://github.com/thi-ng/umbrella/tree/develop/packages/colored-noise}
+	 */
+	noise: NoiseType;
+	/** IR source noise scale */
+	scale: number;
+	/** Number of IR source noise peaks */
+	peaks: number;
+	/**
+	 * Randam noise algorythm
+	 * @see {@link https://github.com/thi-ng/umbrella/tree/develop/packages/random}
+	 */
+	randomAlgorithm: INorm;
+	/** Decay */
+	decay: number;
+	/** Delay until impulse response is generated */
+	delay: number;
+	/** Filter frequency applied to impulse response[Hz] */
+	filterFreq: number;
+	/** Filter quality for impulse response */
+	filterQ: number;
+	/** Filter type for impulse response */
+	filterType: BiquadFilterType;
+	/** Dry/Wet ratio */
+	mix: number;
+	/** Invert the impulse response */
+	reverse?: boolean;
+	/** Impulse response length */
+	time: number;
+	/** Prevents multiple effectors from being connected. */
+	once: boolean;
+}
 /**
  * Reverb effect class
  */
-export default class Reverb {
-    /** Version strings */
-    static readonly version: string;
-    /** Build date */
-    static readonly build: string;
-    /** AudioContext */
-    private readonly ctx;
-    /** Wet Level (Reverberated node) */
-    private readonly wetGainNode;
-    /** Dry Level (Original sound node) */
-    private readonly dryGainNode;
-    /** Impulse response filter */
-    private readonly filterNode;
-    /** Convolution node for applying impulse response */
-    private readonly convolverNode;
-    /** Output gain node */
-    private readonly outputNode;
-    /** Option */
-    private readonly options;
-    /** Connected flag */
-    private isConnected;
-    /** Noise Generator */
-    private noise;
-    /**
-     * Map of noise types to their respective generator functions.
-     */
-    private readonly noiseMap;
-    /**
-     * Constructor
-     *
-     * @param ctx - Root AudioContext
-     * @param options - Configure
-     */
-    constructor(ctx: AudioContext, options?: Partial<OptionInterface>);
-    /**
-     * Connect the node for the reverb effect to the original sound node.
-     *
-     * @param sourceNode - Input source node
-     */
-    connect(sourceNode: AudioNode): AudioNode;
-    /**
-     * Disconnect the reverb node
-     *
-     * @param sourceNode - Input source node
-     */
-    disconnect(sourceNode?: AudioNode): AudioNode | undefined;
-    /**
-     * Dry/Wet ratio
-     *
-     * @param mix - Ratio (0~1)
-     */
-    mix(mix: number): void;
-    /**
-     * Set Impulse Response time length (second)
-     *
-     * @param value - IR length
-     */
-    time(value: number): void;
-    /**
-     * Impulse response decay rate.
-     *
-     * @param value - Decay value
-     */
-    decay(value: number): void;
-    /**
-     * Delay before reverberation starts
-     *
-     * @param value - Time[ms]
-     */
-    delay(value: number): void;
-    /**
-     * Reverse the impulse response.
-     *
-     * @param reverse - Reverse IR
-     */
-    reverse(reverse: boolean): void;
-    /**
-     * Filter for impulse response
-     *
-     * @param type - Filiter Type
-     */
-    filterType(type?: BiquadFilterType): void;
-    /**
-     * Filter frequency applied to impulse response
-     *
-     * @param freq - Frequency
-     */
-    filterFreq(freq: number): void;
-    /**
-     * Filter quality.
-     *
-     * @param q - Quality
-     */
-    filterQ(q: number): void;
-    /**
-     * set IR source noise peaks
-     *
-     * @param p - Peaks
-     */
-    peaks(p: number): void;
-    /**
-     * set IR source noise scale.
-     *
-     * @param s - Scale
-     */
-    scale(s: number): void;
-    /**
-     * Noise source
-     *
-     * @param duration - length of IR.
-     */
-    private getNoise;
-    /**
-     * Inpulse Response Noise algorithm.
-     *
-     * @param type - IR noise algorithm type.
-     */
-    setNoise(type: NoiseType): void;
-    /**
-     * Set the random number algorithm used for noise generation.
-     *
-     * @param algorithm - Random algorithm implementing {@link INorm}
-     */
-    setRandomAlgorithm(algorithm: INorm): void;
-    /**
-     * Return true if in range, otherwise false
-     *
-     * @param x - Target value
-     * @param min - Minimum value
-     * @param max - Maximum value
-     */
-    private static inRange;
-    /** Builds the impulse response buffer from the current options. */
-    private buildImpulse;
+declare class Reverb {
+	/** Version strings */
+	static readonly version: string;
+	/** Build date */
+	static readonly build: string;
+	/** AudioContext */
+	private readonly ctx;
+	/** Wet Level (Reverberated node) */
+	private readonly wetGainNode;
+	/** Dry Level (Original sound node) */
+	private readonly dryGainNode;
+	/** Impulse response filter */
+	private readonly filterNode;
+	/** Convolution node for applying impulse response */
+	private readonly convolverNode;
+	/** Output gain node */
+	private readonly outputNode;
+	/** Option */
+	private readonly options;
+	/** Connected flag */
+	private isConnected;
+	/** Noise Generator */
+	private noise;
+	/**
+	 * Map of noise types to their respective generator functions.
+	 */
+	private readonly noiseMap;
+	/**
+	 * Constructor
+	 *
+	 * @param ctx - Root AudioContext
+	 * @param options - Configure
+	 */
+	constructor(ctx: AudioContext, options?: Partial<OptionInterface>);
+	/**
+	 * Connect the node for the reverb effect to the original sound node.
+	 *
+	 * @param sourceNode - Input source node
+	 */
+	connect(sourceNode: AudioNode): AudioNode;
+	/**
+	 * Disconnect the reverb node
+	 *
+	 * @param sourceNode - Input source node
+	 */
+	disconnect(sourceNode?: AudioNode): AudioNode | undefined;
+	/**
+	 * Dry/Wet ratio
+	 *
+	 * @param mix - Ratio (0~1)
+	 */
+	mix(mix: number): void;
+	/**
+	 * Set Impulse Response time length (second)
+	 *
+	 * @param value - IR length
+	 */
+	time(value: number): void;
+	/**
+	 * Impulse response decay rate.
+	 *
+	 * @param value - Decay value
+	 */
+	decay(value: number): void;
+	/**
+	 * Delay before reverberation starts
+	 *
+	 * @param value - Time[ms]
+	 */
+	delay(value: number): void;
+	/**
+	 * Reverse the impulse response.
+	 *
+	 * @param reverse - Reverse IR
+	 */
+	reverse(reverse: boolean): void;
+	/**
+	 * Filter for impulse response
+	 *
+	 * @param type - Filiter Type
+	 */
+	filterType(type?: BiquadFilterType): void;
+	/**
+	 * Filter frequency applied to impulse response
+	 *
+	 * @param freq - Frequency
+	 */
+	filterFreq(freq: number): void;
+	/**
+	 * Filter quality.
+	 *
+	 * @param q - Quality
+	 */
+	filterQ(q: number): void;
+	/**
+	 * set IR source noise peaks
+	 *
+	 * @param p - Peaks
+	 */
+	peaks(p: number): void;
+	/**
+	 * set IR source noise scale.
+	 *
+	 * @param s - Scale
+	 */
+	scale(s: number): void;
+	/**
+	 * Noise source
+	 *
+	 * @param duration - length of IR.
+	 */
+	private getNoise;
+	/**
+	 * Inpulse Response Noise algorithm.
+	 *
+	 * @param type - IR noise algorithm type.
+	 */
+	setNoise(type: NoiseType): void;
+	/**
+	 * Set the random number algorithm used for noise generation.
+	 *
+	 * @param algorithm - Random algorithm implementing {@link INorm}
+	 */
+	setRandomAlgorithm(algorithm: INorm): void;
+	/**
+	 * Return true if in range, otherwise false
+	 *
+	 * @param x - Target value
+	 * @param min - Minimum value
+	 * @param max - Maximum value
+	 */
+	private static inRange;
+	/** Builds the impulse response buffer from the current options. */
+	private buildImpulse;
 }
+
+export {
+	Reverb as default,
+};
+
+export {};