@logue/reverb 0.5.1 → 0.5.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2021 Masashi Yoshikawa <https://logue.dev>
+Copyright (c) 2019-2022 Masashi Yoshikawa <https://logue.dev>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,6 +1,10 @@
 # Reverb.js
 
-[![npm version](https://badge.fury.io/js/%40logue%2Freverb.svg)](https://badge.fury.io/js/%40logue%2Freverb)
+[![jsdelivr CDN](https://data.jsdelivr.com/v1/package/npm/@logue/reverb/badge)](https://www.jsdelivr.com/package/npm/@logue/reverb)
+[![NPM Downloads](https://img.shields.io/npm/dm/vuetify-swatches.svg?style=flat)](https://www.npmjs.com/package/@logue/reverb)
+[![Open in unpkg](https://img.shields.io/badge/Open%20in-unpkg-blue)](https://uiwjs.github.io/npm-unpkg/#/pkg/@logue/reverb/file/README.md)
+[![npm version](https://img.shields.io/npm/v/@logue/reverb.svg)](https://www.npmjs.com/package/@logue/reverb)
+[![Open in Gitpod](https://shields.io/badge/Open%20in-Gitpod-green?logo=Gitpod)](https://gitpod.io/#https://github.com/logue/Reverb.js)
 
 Append reverb effect to audio source.
 
@@ -8,22 +12,22 @@ This script is originally a spin out of [sf2synth.js](https://github.com/logue/s
 
 ## Sample
 
-* <https://logue.dev/Reverb.js/>
-* <https://logue.dev/Reverb.js/localaudio.html>
+- <https://logue.dev/Reverb.js/>
+- <https://logue.dev/Reverb.js/localaudio.html>
 
 ## Syntax
 
 ```js
 const reverb = new Reverb(ctx, {
-  noise: 0,                 // Inpulse Response Noise algorithm (0: White noise, 1: Pink noise, 2: Brown noise)
-  decay: 5,                 // Amount of IR (Inpulse Response) decay. 0~100
-  delay: 0,                 // Delay time o IR. (NOT delay effect) 0~100 [sec]
-  filterFreq: 2200,         // Filter frequency. 20~5000 [Hz]
-  filterQ: 1,               // Filter quality. 0~10
-  filterType: 'lowpass',    // Filter type. 'bandpass' etc. See https://developer.mozilla.org/en-US/docs/Web/API/BiquadFilterNode/type .
-  mix: 0.5,                 // Dry (Original Sound) and Wet (Effected sound) raito. 0~1
-  reverse: false,           // Reverse IR.
-  time: 3                   // Time length of IR. 0~50 [sec]
+  noise: 0, // Inpulse Response Noise algorithm (0: White noise, 1: Pink noise, 2: Brown noise)
+  decay: 5, // Amount of IR (Inpulse Response) decay. 0~100
+  delay: 0, // Delay time o IR. (NOT delay effect) 0~100 [sec]
+  filterFreq: 2200, // Filter frequency. 20~5000 [Hz]
+  filterQ: 1, // Filter quality. 0~10
+  filterType: 'lowpass', // Filter type. 'bandpass' etc. See https://developer.mozilla.org/en-US/docs/Web/API/BiquadFilterNode/type .
+  mix: 0.5, // Dry (Original Sound) and Wet (Effected sound) raito. 0~1
+  reverse: false, // Reverse IR.
+  time: 3, // Time length of IR. 0~50 [sec]
 });
 ```
 
@@ -60,10 +64,10 @@ sourceNode.play();
 
 ## Reference
 
-* [Web Audio API](https://www.w3.org/TR/webaudio/)
-  * [Web Audio API日本語訳](https://g200kg.github.io/web-audio-api-ja/)
-* [コンボルバーの使い方](https://www.g200kg.com/jp/docs/webaudio/convolver.html)
-* [WebAudioの闇](https://qiita.com/zprodev/items/7fcd8335d7e8e613a01f)
+- [Web Audio API](https://www.w3.org/TR/webaudio/)
+  - [Web Audio API 日本語訳](https://g200kg.github.io/web-audio-api-ja/)
+- [コンボルバーの使い方](https://www.g200kg.com/jp/docs/webaudio/convolver.html)
+- [WebAudio の闇](https://qiita.com/zprodev/items/7fcd8335d7e8e613a01f)
 
 ## License
 

package/{types → dist}/Meta.d.ts

@@ -1,4 +1,4 @@
 import type MetaInterface from '@/interfaces/MetaInterface';
 declare const meta: MetaInterface;
 export default meta;
-// # sourceMappingURL=Meta.d.ts.map
+//# sourceMappingURL=Meta.d.ts.map

package/{types → dist}/NoiseType.d.ts

@@ -1,14 +1,14 @@
 /** Impulse response noise generation algorithm */
 declare const Noise: {
-  /** White noise */
-  readonly WHITE: 'white';
-  /** Pink noise */
-  readonly PINK: 'pink';
-  /** Brown Noise */
-  readonly BROWN: 'brown';
+    /** White noise */
+    readonly WHITE: "white";
+    /** Pink noise */
+    readonly PINK: "pink";
+    /** Brown Noise */
+    readonly BROWN: "brown";
 };
 /** Noise Type */
 export declare type NoiseType = typeof Noise[keyof typeof Noise];
 /** Noise */
 export default Noise;
-// # sourceMappingURL=NoiseType.d.ts.map
+//# sourceMappingURL=NoiseType.d.ts.map

package/dist/Reverb.d.ts

@@ -0,0 +1,118 @@
+import type OptionInterface from './interfaces/OptionInterface';
+import { type NoiseType } from './NoiseType';
+/**
+ * JS reverb effect class
+ *
+ * @license MIT
+ * @author Logue {@link logue@hotmail.co.jp}
+ * @copyright 2019-2022 Masashi Yoshikawa {@link https://logue.dev/} All rights reserved.
+ * @see {@link https://github.com/logue/Reverb.js}
+ */
+export default class Reverb {
+    /** Version strings */
+    readonly version: string;
+    /** Build date */
+    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 nodse */
+    private readonly outputNode;
+    /** Option */
+    private readonly _options;
+    /** Connected flag */
+    private isConnected;
+    /**
+     * Constructor
+     *
+     * @param ctx - Root AudioContext
+     * @param options - Configure
+     */
+    constructor(ctx: AudioContext, options: OptionInterface | undefined);
+    /**
+     * 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 | undefined): 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;
+    /**
+     * Inpulse Response Noise algorithm.
+     *
+     * @param type - IR noise algorithm type.
+     */
+    setNoise(type: NoiseType): void;
+    /**
+     * Return true if in range, otherwise false
+     *
+     * @param x - Target value
+     * @param min - Minimum value
+     * @param max - Maximum value
+     */
+    private inRange;
+    /** Utility function for building an impulse response from the module parameters. */
+    private buildImpulse;
+    /** Generate white noise */
+    private static whiteNoise;
+}
+//# sourceMappingURL=Reverb.d.ts.map

package/dist/interfaces/MetaInterface.d.ts

@@ -0,0 +1,8 @@
+/** Meta Information Interface */
+export default interface MetaInterface {
+    /** Version */
+    version: string;
+    /** Build Date */
+    date: string;
+}
+//# sourceMappingURL=MetaInterface.d.ts.map

package/dist/interfaces/OptionInterface.d.ts

@@ -0,0 +1,25 @@
+import { NoiseType } from '../NoiseType';
+/** Reverb Option */
+export default interface OptionInterface {
+    /** Types of impulse response noise generation algorithms */
+    noise: NoiseType;
+    /** 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;
+}
+//# sourceMappingURL=OptionInterface.d.ts.map

package/dist/reverb.es.js

@@ -1,6 +1,6 @@
 const meta = {
-  version: "0.5.0",
-  date: "2022-02-21T09:25:39.234Z"
+  version: "0.5.2",
+  date: "2022-03-31T15:54:38.559Z"
 };
 const Noise = {
   WHITE: "white",

package/dist/reverb.umd.js

@@ -1,4 +1,4 @@
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e="undefined"!=typeof globalThis?globalThis:e||self).Reverb=t()}(this,(function(){"use strict";const e="0.5.0",t="2022-02-21T09:25:39.234Z",i="white",s="pink",o="brown";
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):(e="undefined"!=typeof globalThis?globalThis:e||self).Reverb=t()}(this,(function(){"use strict";const e="0.5.2",t="2022-03-31T15:54:38.559Z",i="white",s="pink",o="brown";
 /**
    * JS reverb effect class
    *

package/package.json

@@ -1,11 +1,10 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@logue/reverb",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "Reverb effect.",
   "files": [
-    "dist",
-    "types"
+    "dist"
   ],
   "main": "./dist/reverb.umd.js",
   "module": "./dist/reverb.es.js",
@@ -15,7 +14,7 @@
       "require": "./dist/reverb.umd.js"
     }
   },
-  "types": "./types/Reverb.d.ts",
+  "types": "./dist/Reverb.d.ts",
   "directories": {
     "doc": "docs"
   },
@@ -45,32 +44,33 @@
   "sideEffects": false,
   "scripts": {
     "dev": "vite",
-    "build": "tsc && vite build",
+    "build": "vite build & tsc",
     "build:clean": "rimraf dist",
     "lint": "eslint . --fix --cache --cache-location ./node_modules/.vite/vite-plugin-eslint && prettier . --write",
     "prepare": "husky install"
   },
   "devDependencies": {
-    "@types/node": "^17.0.18",
-    "@typescript-eslint/eslint-plugin": "^5.12.0",
-    "@typescript-eslint/parser": "^5.12.0",
-    "eslint": "^8.9.0",
+    "@modyqyw/vite-plugin-eslint": "^1.2.0",
+    "@types/eslint": "^8.4.1",
+    "@types/node": "^17.0.23",
+    "@typescript-eslint/eslint-plugin": "^5.17.0",
+    "@typescript-eslint/parser": "^5.17.0",
+    "eslint": "^8.12.0",
     "eslint-config-google": "^0.14.0",
-    "eslint-config-prettier": "^8.4.0",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-import-resolver-alias": "^1.1.2",
-    "eslint-import-resolver-typescript": "^2.5.0",
+    "eslint-import-resolver-typescript": "^2.7.0",
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-tsdoc": "^0.2.14",
     "husky": "^7.0.4",
-    "lint-staged": "^12.3.4",
-    "prettier": "^2.5.1",
-    "prettier-plugin-jsdoc": "^0.3.30",
+    "lint-staged": "^12.3.7",
+    "prettier": "^2.6.1",
+    "prettier-plugin-jsdoc": "^0.3.34",
     "prettier-plugin-md-nocjsp": "^1.2.0",
     "rimraf": "^3.0.2",
-    "typescript": "^4.5.5",
-    "vite": "^2.8.4",
-    "vite-plugin-eslint": "^1.3.0"
+    "typescript": "^4.6.3",
+    "vite": "^2.9.1"
   },
   "husky": {
     "hooks": {

package/types/Reverb.d.ts

@@ -1,118 +0,0 @@
-import type OptionInterface from './interfaces/OptionInterface';
-import { type NoiseType } from './NoiseType';
-/**
- * JS reverb effect class
- *
- * @license MIT
- * @author Logue {@link logue@hotmail.co.jp}
- * @copyright 2019-2022 Masashi Yoshikawa {@link https://logue.dev/} All rights reserved.
- * @see {@link https://github.com/logue/Reverb.js}
- */
-export default class Reverb {
-  /** Version strings */
-  readonly version: string;
-  /** Build date */
-  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 nodse */
-  private readonly outputNode;
-  /** Option */
-  private readonly _options;
-  /** Connected flag */
-  private isConnected;
-  /**
-   * Constructor
-   *
-   * @param ctx - Root AudioContext
-   * @param options - Configure
-   */
-  constructor(ctx: AudioContext, options: OptionInterface | undefined);
-  /**
-   * 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 | undefined): 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;
-  /**
-   * Inpulse Response Noise algorithm.
-   *
-   * @param type - IR noise algorithm type.
-   */
-  setNoise(type: NoiseType): void;
-  /**
-   * Return true if in range, otherwise false
-   *
-   * @param x - Target value
-   * @param min - Minimum value
-   * @param max - Maximum value
-   */
-  private inRange;
-  /** Utility function for building an impulse response from the module parameters. */
-  private buildImpulse;
-  /** Generate white noise */
-  private static whiteNoise;
-}
-// # sourceMappingURL=Reverb.d.ts.map

package/types/interfaces/MetaInterface.d.ts

@@ -1,8 +0,0 @@
-/** Meta Information Interface */
-export default interface MetaInterface {
-  /** Version */
-  version: string;
-  /** Build Date */
-  date: string;
-}
-// # sourceMappingURL=MetaInterface.d.ts.map

package/types/interfaces/OptionInterface.d.ts

@@ -1,25 +0,0 @@
-import { NoiseType } from '../NoiseType';
-/** Reverb Option */
-export default interface OptionInterface {
-  /** Types of impulse response noise generation algorithms */
-  noise: NoiseType;
-  /** 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;
-}
-// # sourceMappingURL=OptionInterface.d.ts.map