Tone.js/Tone/effect/Effect.ts

import { CrossFade } from "../component/channel/CrossFade";
import { Gain } from "../core/context/Gain";
import { InputNode, ToneAudioNode, ToneAudioNodeOptions } from "../core/context/ToneAudioNode";
import { readOnly } from "../core/util/Interface";
import { Signal } from "../signal/Signal";

export interface EffectOptions extends ToneAudioNodeOptions {
	wet: NormalRange;
}
/**
 * 	@class  Effect is the base class for effects. Connect the effect between
 * 	        the effectSend and effectReturn GainNodes, then control the amount of
 * 	        effect which goes to the output using the wet control.
 *
 *  @constructor
 *  @extends {Tone.AudioNode}
 *  @param {NormalRange|Object} [wet] The starting wet value.
 */
export abstract class Effect<Options extends EffectOptions>
extends ToneAudioNode<Options> {

	name = "Effect";

	/**
	 *  the drywet knob to control the amount of effect
	 */
	private _dryWet: CrossFade = new CrossFade({ context : this.context });

	/**
	 *  The wet control is how much of the effected
	 *  will pass through to the output. 1 = 100% effected
	 *  signal, 0 = 100% dry signal.
	 */
	wet: Signal<NormalRange> = this._dryWet.fade;

	/**
	 *  connect the effectSend to the input of hte effect
	 */
	protected effectSend: Gain = new Gain({ context : this.context });

	/**
	 *  connect the output of the effect to the effectReturn
	 */
	protected effectReturn: Gain = new Gain({ context : this.context });

	/**
	 * The effect input node
	 */
	input: Gain = new Gain({ context : this.context });

	/**
	 * The effect output
	 */
	output = this._dryWet;

	protected _internalChannels: ToneAudioNode[] = [this.input, this.output, this.effectReturn, this.effectSend];

	constructor(options: EffectOptions) {
		super(options);

		// connections
		this.input.fan(this._dryWet.a, this.effectSend);
		this.effectReturn.connect(this._dryWet.b);
		this.wet.setValueAtTime(options.wet, 0);
		readOnly(this, "wet");
	}

	static getDefaults(): EffectOptions {
		return Object.assign(ToneAudioNode.getDefaults(), {
			wet : 1,
		});
	}

	/**
	 *  chains the effect in between the effectSend and effectReturn
	 */
	protected connectEffect(effect: InputNode): this {
		this.effectSend.chain(effect, this.effectReturn);
		return this;
	}

	dispose(): this {
		super.dispose();
		this._dryWet.dispose();
		this.effectSend.dispose();
		this.effectReturn.dispose();
		this.wet.dispose();
		return this;
	}
}