Tone.js/Tone/effect/StereoEffect.ts
Yotam Mann aaf880c925
Using web-test-runner for tests, updating import paths (#1242)
* WIP moving tests to web-test-runner

* updating thresholds

* Adding file extensions

* Testing integrations

* linting

* fixing dep

* moving back to root dir

* prettier all of the files

* updating eslint rules to use with prettier

* remove import package

* moving tsignore around

* removing unneeded ignores

* all tests run on puppeteer, no need for testing guards

* linting

* import type syntax

* cleaning up

* Update package.json
2024-05-03 14:31:14 -04:00

104 lines
2.5 KiB
TypeScript

import { EffectOptions } from "./Effect.js";
import {
connect,
connectSeries,
OutputNode,
ToneAudioNode,
} from "../core/context/ToneAudioNode.js";
import { CrossFade } from "../component/channel/CrossFade.js";
import { Signal } from "../signal/Signal.js";
import { Split } from "../component/channel/Split.js";
import { Gain } from "../core/context/Gain.js";
import { Merge } from "../component/channel/Merge.js";
import { readOnly } from "../core/util/Interface.js";
export type StereoEffectOptions = EffectOptions;
/**
* Base class for Stereo effects.
*/
export class StereoEffect<
Options extends StereoEffectOptions,
> extends ToneAudioNode<Options> {
readonly name: string = "StereoEffect";
readonly input: Gain;
readonly output: CrossFade;
/**
* the drywet knob to control the amount of effect
*/
private _dryWet: CrossFade;
/**
* The wet control, i.e. how much of the effected
* will pass through to the output.
*/
readonly wet: Signal<"normalRange">;
/**
* Split it
*/
protected _split: Split;
/**
* the stereo effect merger
*/
protected _merge: Merge;
constructor(options: StereoEffectOptions) {
super(options);
this.input = new Gain({ context: this.context });
// force mono sources to be stereo
this.input.channelCount = 2;
this.input.channelCountMode = "explicit";
this._dryWet = this.output = new CrossFade({
context: this.context,
fade: options.wet,
});
this.wet = this._dryWet.fade;
this._split = new Split({ context: this.context, channels: 2 });
this._merge = new Merge({ context: this.context, channels: 2 });
// connections
this.input.connect(this._split);
// dry wet connections
this.input.connect(this._dryWet.a);
this._merge.connect(this._dryWet.b);
readOnly(this, ["wet"]);
}
/**
* Connect the left part of the effect
*/
protected connectEffectLeft(...nodes: OutputNode[]): void {
this._split.connect(nodes[0], 0, 0);
connectSeries(...nodes);
connect(nodes[nodes.length - 1], this._merge, 0, 0);
}
/**
* Connect the right part of the effect
*/
protected connectEffectRight(...nodes: OutputNode[]): void {
this._split.connect(nodes[0], 1, 0);
connectSeries(...nodes);
connect(nodes[nodes.length - 1], this._merge, 0, 1);
}
static getDefaults(): StereoEffectOptions {
return Object.assign(ToneAudioNode.getDefaults(), {
wet: 1,
});
}
dispose(): this {
super.dispose();
this._dryWet.dispose();
this._split.dispose();
this._merge.dispose();
return this;
}
}