@logue/reverb 0.4.2 → 0.5.0

package/src/Reverb.ts

@@ -1,360 +0,0 @@
-import Meta from './Meta';
-import OptionInterface from './interfaces/OptionInterface';
-import {NoiseType} from './NoiseType';
-
-/**
- * JS reverb effect class
- *
- * @author    Logue <logue@hotmail.co.jp>
- * @copyright 2019-2021 Masashi Yoshikawa <https://logue.dev/> All rights reserved.
- * @license   MIT
- * @see       {@link https://github.com/logue/Reverb.js}
- *            {@link https://github.com/web-audio-components/simple-reverb}
- */
-export default class Reverb {
-  /** バージョン */
-  public readonly version: string;
-  /** ビルド日時 */
-  public readonly build: string;
-  /** AudioContext */
-  private readonly ctx: AudioContext;
-  /** ウェットレベル（エフェクターをかけたレベル） */
-  private readonly wetGainNode: GainNode;
-  /** ドライレベル（原音レベル） */
-  private readonly dryGainNode: GainNode;
-  /** インパルス応答用フィルタ */
-  private readonly filterNode: BiquadFilterNode;
-  /** 畳み込みノード */
-  private readonly convolverNode: ConvolverNode;
-  /** 出力ノード */
-  private readonly outputNode: GainNode;
-  /** 変数 */
-  private readonly _options: OptionInterface;
-  /** 接続済みフラグ */
-  private isConnected: boolean;
-
-  /**
-   * constructor
-   * @param ctx Root AudioContext
-   * @param options Configure
-   */
-  constructor(ctx: AudioContext, options: OptionInterface | undefined) {
-    // バージョン情報など
-    this.version = Meta.version;
-    this.build = Meta.date;
-    // マスターのAudioContextを取得
-    this.ctx = ctx;
-    // デフォルト値をマージ
-    this._options = {...optionDefaults, ...options} as const;
-    // 初期化
-    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.buildImpulse();
-  }
-
-  /**
-   * connect
-   * @param sourceNode 原音ノード
-   */
-  public connect(sourceNode: AudioNode): AudioNode {
-    // 畳み込みノードをウェットレベルに接続
-    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
-   * @param sourceNode 原音のノード
-   */
-  public disconnect(sourceNode: AudioNode | undefined): AudioNode | undefined {
-    // 初期状態ではノードがつながっていないためエラーになる
-    if (this.isConnected) {
-      // 畳み込みノードをウェットレベルから切断
-      this.convolverNode.disconnect(this.filterNode);
-      // フィルタノードをウェットレベルから切断
-      this.filterNode.disconnect(this.wetGainNode);
-    }
-    // 接続済みフラグを解除
-    this.isConnected = false;
-
-    // そのままノードを返す（他のAPIに似せるため）
-    return sourceNode;
-  }
-
-  /**
-   * Dry/Wet ratio
-   * @param mix
-   */
-  public mix(mix: number): void {
-    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;
-    console.debug(`Reverb.js: Set dry/wet ratio to ${mix * 100}%`);
-  }
-
-  /**
-   * Set Impulse Response time length (second)
-   * @param value
-   */
-  public time(value: number): void {
-    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();
-    console.info(`Reverb.js: Set inpulse response time length to ${value}sec.`);
-  }
-
-  /**
-   * Impulse response decay rate.
-   * @param value
-   */
-  public decay(value: number): void {
-    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();
-    console.debug(`Reverb.js: Set inpulse response decay level to ${value}.`);
-  }
-
-  /**
-   * Impulse response delay time. (NOT deley effect)
-   * @param value
-   */
-  public delay(value: number): void {
-    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();
-    console.debug(`Reverb.js: Set inpulse response delay time to ${value}sec.`);
-  }
-
-  /**
-   * Reverse the impulse response.
-   * @param reverse
-   */
-  public reverse(reverse: boolean): void {
-    this._options.reverse = reverse;
-    this.buildImpulse();
-    console.debug(
-      `Reverb.js: Inpulse response is ${reverse ? '' : 'not '}reversed.`
-    );
-  }
-
-  /**
-   * Filter type.
-   * @param type
-   */
-  public filterType(type: BiquadFilterType): void {
-    this.filterNode.type = this._options.filterType = type;
-    console.debug(`Set filter type to ${type}`);
-  }
-
-  /**
-   * Filter frequency.
-   * @param freq
-   */
-  public filterFreq(freq: number): void {
-    if (!this.inRange(freq, 20, 5000)) {
-      throw new RangeError(
-        'Reverb.js: Filter frequrncy must be between 20 and 5000.'
-      );
-    }
-    this._options.filterFreq = freq;
-    this.filterNode.frequency.value = this._options.filterFreq;
-    console.debug(`Set filter frequency to ${freq}Hz.`);
-  }
-
-  /**
-   * Filter quality.
-   * @param q
-   */
-  public filterQ(q: number): void {
-    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;
-    console.debug(`Set filter quality to ${q}.`);
-  }
-
-  /**
-   * Inpulse Response Noise algorithm.
-   * @param type
-   */
-  public setNoise(type: NoiseType) {
-    this._options.noise = type;
-    this.buildImpulse();
-    console.debug(`Set Noise type to ${type}.`);
-  }
-
-  /**
-   * return true if in range, otherwise false
-   * @private
-   * @param x Target value
-   * @param min Minimum value
-   * @param max Maximum value
-   * @return
-   */
-  private inRange(x: number, min: number, max: number): boolean {
-    return (x - min) * (x - max) <= 0;
-  }
-
-  /**
-   * Utility function for building an impulse response
-   * from the module parameters.
-   * @private
-   */
-  private buildImpulse(): void {
-    // インパルス応答生成ロジック
-
-    /** サンプリングレート */
-    const rate: number = this.ctx.sampleRate;
-    /** インパルス応答の演奏時間 */
-    const duration: number = Math.max(rate * this._options.time, 1);
-    /** インパルス応答が始まるまでの遅延時間 */
-    const delayDuration: number = rate * this._options.delay;
-    /** インパルス応答バッファ（今の所ステレオのみ） */
-    const impulse: AudioBuffer = this.ctx.createBuffer(2, duration, rate);
-    /** 左チャンネル */
-    const impulseL: Float32Array = new Float32Array(duration);
-    /** 右チャンネル*/
-    const impulseR: Float32Array = new Float32Array(duration);
-
-    /** 一時計算用 */
-    const b = [0, 0, 0, 0, 0, 0, 0];
-
-    for (let i = 0; i < duration; i++) {
-      /** @type {number} 減衰率 */
-      let n = 0;
-
-      if (i < delayDuration) {
-        // Delay Effect
-        impulseL[i] = 0;
-        impulseR[i] = 0;
-        n = this._options.reverse
-          ? duration - (i - delayDuration)
-          : i - delayDuration;
-      } else {
-        n = this._options.reverse ? duration - i : i;
-      }
-
-      switch (this._options.noise) {
-        default:
-        case NoiseType.WHITE:
-          // White Noise
-          impulseL[i] = Reverb.whiteNoise();
-          impulseR[i] = Reverb.whiteNoise();
-          break;
-        case NoiseType.PINK:
-          // ピンクノイズ生成処理
-          // http://noisehack.com/generate-noise-web-audio-api/
-          b[0] = 0.99886 * b[0] + Reverb.whiteNoise() * 0.0555179;
-          b[1] = 0.99332 * b[1] + Reverb.whiteNoise() * 0.0750759;
-          b[2] = 0.969 * b[2] + Reverb.whiteNoise() * 0.153852;
-          b[3] = 0.8665 * b[3] + Reverb.whiteNoise() * 0.3104856;
-          b[4] = 0.55 * b[4] + Reverb.whiteNoise() * 0.5329522;
-          b[5] = -0.7616 * b[5] - Reverb.whiteNoise() * 0.016898;
-
-          impulseL[i] =
-            b[0] +
-            b[1] +
-            b[2] +
-            b[3] +
-            b[4] +
-            b[5] +
-            b[6] +
-            Reverb.whiteNoise() * 0.5362;
-
-          impulseR[i] =
-            b[0] +
-            b[1] +
-            b[2] +
-            b[3] +
-            b[4] +
-            b[5] +
-            b[6] +
-            Reverb.whiteNoise() * 0.5362;
-
-          // ゲイン補償処理
-          impulseL[i] *= 0.11;
-          impulseR[i] *= 0.11;
-
-          b[6] = Reverb.whiteNoise() * 0.115926;
-          break;
-        case NoiseType.BROWN:
-          // ブラウンノイズ生成処理
-          impulseL[i] = (b[0] + 0.02 * Reverb.whiteNoise()) / 1.02;
-          b[0] = impulseL[i];
-          impulseR[i] = (b[1] + 0.02 * Reverb.whiteNoise()) / 1.02;
-          b[1] = impulseR[i];
-
-          // ゲイン補償処理
-          impulseL[i] *= 3.5;
-          impulseR[i] *= 3.5;
-          break;
-      }
-      // 音を減衰させる
-      impulseL[i] *= (1 - n / duration) ** this._options.decay;
-      impulseR[i] *= (1 - n / duration) ** this._options.decay;
-    }
-
-    // インパルス応答のバッファに生成したWaveTableを代入
-    impulse.getChannelData(0).set(impulseL);
-    impulse.getChannelData(1).set(impulseR);
-
-    this.convolverNode.buffer = impulse;
-  }
-  /**
-   * Generate white noise
-   */
-  private static whiteNoise(): number {
-    // TODO: この乱数は本当に偏り無いのだろうか？
-    return Math.random() * 2 - 1;
-  }
-}
-
-/**
- * デフォルト値
- */
-const optionDefaults: OptionInterface = {
-  noise: 1,
-  decay: 5,
-  delay: 0,
-  reverse: false,
-  time: 3,
-  filterType: 'lowpass',
-  filterFreq: 2200,
-  filterQ: 1,
-  mix: 0.5,
-};

package/src/interfaces/MetaInterface.ts

@@ -1,9 +0,0 @@
-/**
- * メタ情報インターフェース
- */
-export default interface MetaInterface {
-  /** @type バージョン */
-  version: string;
-  /** @type ビルド日時 */
-  date: string;
-}

package/src/interfaces/OptionInterface.ts

@@ -1,25 +0,0 @@
-import {NoiseType} from '../NoiseType';
-
-/**
- * オプションのインターフェース
- */
-export default interface OptionInterface {
-  /** @type ノイズ種別 */
-  noise: NoiseType;
-  /** @type ディケイ */
-  decay: number;
-  /** @type ディレイ */
-  delay: number;
-  /** @type フィルタ周波数(Hz) */
-  filterFreq: number;
-  /** @type フィルタ品質 */
-  filterQ: number;
-  /** @type {BiquadFilterType?} フィルタの種類 */
-  filterType: BiquadFilterType;
-  /** @type ドライ／ウェット比 */
-  mix: number;
-  /** @type レスポンス応答を反転 */
-  reverse: boolean;
-  /** @type レスポンス応答の時間（秒） */
-  time: number;
-}

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-  "extends": "./node_modules/gts/tsconfig-google.json",
-  "compilerOptions": {
-    "esModuleInterop": true,
-    "module": "commonjs",
-    "outDir": "build",
-    "rootDir": ".",
-    "lib": [
-      "dom"
-    ],
-    "target": "esnext",
-  },
-  "include": [
-    "src/**/*.ts",
-    "test/**/*.ts"
-  ]
-}

package/webpack.config.ts

@@ -1,97 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import * as webpack from 'webpack';
-import * as path from 'path';
-import * as fs from 'fs';
-import TerserPlugin from 'terser-webpack-plugin';
-import WebpackDevServer from 'webpack-dev-server';
-
-declare module 'webpack' {
-  interface Configuration {
-    /**
-     * Can be used to configure the behaviour of webpack-dev-server when
-     * the webpack config is passed to webpack-dev-server CLI.
-     */
-    devServer?: WebpackDevServer.Configuration;
-  }
-}
-
-// バージョン情報など
-const pjson = require('./package.json');
-// 現在の時刻（ビルド時刻）
-const build: string = new Date().toISOString();
-
-// Meta.tsを書き込む
-fs.writeFileSync(
-  path.resolve(path.join(__dirname, 'src/Meta.ts')),
-  `import MetaInterface from './interfaces/MetaInterface';
-
-// This file is auto-generated by the build system.
-const meta: MetaInterface = {
-  version: '${pjson.version}',
-  date: '${build}',
-};
-export default meta;
-`
-);
-
-module.exports = (env: any, argv: any): webpack.Configuration => {
-  const isProduction: boolean = argv.mode === 'production';
-  const banner = `${pjson.name} v${pjson.version} | ${pjson.author.name} | license: ${pjson.license} | build: ${build}`;
-
-  return {
-    mode: isProduction ? 'production' : 'development',
-    target: 'node',
-    devtool: !isProduction ? 'source-map' : false,
-    devServer: {
-      contentBase: 'docs',
-      open: false,
-    },
-    entry: {
-      reverb: './src/Reverb.ts',
-    },
-    output: {
-      path: path.resolve(__dirname, 'bin'),
-      filename: !isProduction ? '[name].js' : '[name].min.js',
-      library: 'Reverb',
-      libraryTarget: 'umd',
-      umdNamedDefine: true,
-      globalObject: "(typeof self !== 'undefined' ? self : this)",
-    },
-    optimization: {
-      minimize: isProduction,
-      minimizer: [
-        new TerserPlugin({
-          terserOptions: {
-            ecma: 2016,
-            compress: {drop_console: true},
-            output: {
-              comments: false,
-              beautify: false,
-            },
-          },
-        }),
-      ],
-      splitChunks: {
-        minSize: 0,
-      },
-      concatenateModules: false,
-    },
-    module: {
-      rules: [
-        {
-          test: /\.tsx?$/,
-          loader: 'ts-loader',
-        },
-      ],
-    },
-    resolve: {
-      modules: [`${__dirname}/src`, 'node_modules'],
-      extensions: ['webpack.ts', '.ts', '.tsx'],
-    },
-    plugins: [
-      new webpack.BannerPlugin({
-        banner: banner,
-      }),
-    ],
-  };
-};