tone 15.5.0 → 15.5.2

package/Tone/effect/Tremolo.ts

@@ -1,13 +1,12 @@
 import { Gain } from "../core/context/Gain.js";
-import { Degrees, Frequency, NormalRange, Time } from "../core/type/Units.js";
+import { Degrees, Frequency, NormalRange } from "../core/type/Units.js";
 import { optionsFromArguments } from "../core/util/Defaults.js";
 import { readOnly } from "../core/util/Interface.js";
 import { Signal } from "../signal/Signal.js";
-import { LFO } from "../source/oscillator/LFO.js";
 import { ToneOscillatorType } from "../source/oscillator/OscillatorInterface.js";
-import { StereoEffect, StereoEffectOptions } from "./StereoEffect.js";
+import { LFOStereoEffect, LFOStereoEffectOptions } from "./LFOStereoEffect.js";
 
-export interface TremoloOptions extends StereoEffectOptions {
+export interface TremoloOptions extends LFOStereoEffectOptions {
 	frequency: Frequency;
 	type: ToneOscillatorType;
 	depth: NormalRange;
@@ -26,19 +25,9 @@ export interface TremoloOptions extends StereoEffectOptions {
  *
  * @category Effect
  */
-export class Tremolo extends StereoEffect<TremoloOptions> {
+export class Tremolo extends LFOStereoEffect<TremoloOptions> {
 	readonly name: string = "Tremolo";
 
-	/**
-	 * The tremolo LFO in the left channel
-	 */
-	private _lfoL: LFO;
-
-	/**
-	 * The tremolo LFO in the left channel
-	 */
-	private _lfoR: LFO;
-
 	/**
 	 * Where the gain is multiplied
 	 */
@@ -49,11 +38,6 @@ export class Tremolo extends StereoEffect<TremoloOptions> {
 	 */
 	private _amplitudeR: Gain;
 
-	/**
-	 * The frequency of the tremolo.
-	 */
-	readonly frequency: Signal<"frequency">;
-
 	/**
 	 * The depth of the effect. A depth of 0, has no effect
 	 * on the amplitude, and a depth of 1 makes the amplitude
@@ -74,25 +58,16 @@ export class Tremolo extends StereoEffect<TremoloOptions> {
 		]);
 		super(options);
 
-		this._lfoL = new LFO({
-			context: this.context,
-			type: options.type,
-			min: 1,
-			max: 0,
-		});
-		this._lfoR = new LFO({
-			context: this.context,
-			type: options.type,
-			min: 1,
-			max: 0,
-		});
+		// invert the lfo min/max so it moves from full gain to 0 gain
+		this._lfoL.min = 1;
+		this._lfoL.max = 0;
+		this._lfoR.min = 1;
+		this._lfoR.max = 0;
+		this.type = options.type;
+
 		this._amplitudeL = new Gain({ context: this.context });
 		this._amplitudeR = new Gain({ context: this.context });
-		this.frequency = new Signal({
-			context: this.context,
-			value: options.frequency,
-			units: "frequency",
-		});
+
 		this.depth = new Signal({
 			context: this.context,
 			value: options.depth,
@@ -104,13 +79,12 @@ export class Tremolo extends StereoEffect<TremoloOptions> {
 		this.connectEffectRight(this._amplitudeR);
 		this._lfoL.connect(this._amplitudeL.gain);
 		this._lfoR.connect(this._amplitudeR.gain);
-		this.frequency.fan(this._lfoL.frequency, this._lfoR.frequency);
 		this.depth.fan(this._lfoR.amplitude, this._lfoL.amplitude);
 		this.spread = options.spread;
 	}
 
 	static getDefaults(): TremoloOptions {
-		return Object.assign(StereoEffect.getDefaults(), {
+		return Object.assign(LFOStereoEffect.getDefaults(), {
 			frequency: 10,
 			type: "sine" as const,
 			depth: 0.5,
@@ -118,44 +92,6 @@ export class Tremolo extends StereoEffect<TremoloOptions> {
 		});
 	}
 
-	/**
-	 * Start the tremolo.
-	 */
-	start(time?: Time): this {
-		this._lfoL.start(time);
-		this._lfoR.start(time);
-		return this;
-	}
-
-	/**
-	 * Stop the tremolo.
-	 */
-	stop(time?: Time): this {
-		this._lfoL.stop(time);
-		this._lfoR.stop(time);
-		return this;
-	}
-
-	/**
-	 * Sync the effect to the transport.
-	 */
-	sync(): this {
-		this._lfoL.sync();
-		this._lfoR.sync();
-		this.context.transport.syncSignal(this.frequency);
-		return this;
-	}
-
-	/**
-	 * Unsync the filter from the transport
-	 */
-	unsync(): this {
-		this._lfoL.unsync();
-		this._lfoR.unsync();
-		this.context.transport.unsyncSignal(this.frequency);
-		return this;
-	}
-
 	/**
 	 * The oscillator type.
 	 */
@@ -181,11 +117,8 @@ export class Tremolo extends StereoEffect<TremoloOptions> {
 
 	dispose(): this {
 		super.dispose();
-		this._lfoL.dispose();
-		this._lfoR.dispose();
 		this._amplitudeL.dispose();
 		this._amplitudeR.dispose();
-		this.frequency.dispose();
 		this.depth.dispose();
 		return this;
 	}

package/Tone/effect/Vibrato.ts

@@ -66,15 +66,17 @@ export class Vibrato extends Effect<VibratoOptions> {
 			max: options.maxDelay,
 			frequency: options.frequency,
 			phase: -90, // offset the phase so the resting position is in the center
-		})
-			.start()
-			.connect(this._delayNode.delayTime);
+		}).connect(this._delayNode.delayTime);
 		this.frequency = this._lfo.frequency;
 		this.depth = this._lfo.amplitude;
 
 		this.depth.value = options.depth;
 		readOnly(this, ["frequency", "depth"]);
 		this.effectSend.chain(this._delayNode, this.effectReturn);
+
+		this._onContextRunning(() => {
+			this._lfo.start();
+		});
 	}
 
 	static getDefaults(): VibratoOptions {

package/Tone/signal/ToneConstantSource.ts

@@ -49,24 +49,16 @@ export class ToneConstantSource<
 		);
 		super(options);
 
-		const isSuspended =
-			!this.context.isOffline && this.context.state !== "running";
-
-		if (!isSuspended) {
-			this._source = this.context.createConstantSource();
-			connect(this._source, this._gainNode);
-		} else {
-			this.context.on("statechange", this._contextStarted);
-		}
+		this._onContextRunning(() => this._contextStarted());
 
 		this.offset = new Param({
 			context: this.context,
 			convert: options.convert,
-			param: isSuspended
+			param: !this._source
 				? // placeholder param until the context is started
 					this.context.createGain().gain
-				: this._source?.offset,
-			swappable: isSuspended,
+				: this._source.offset,
+			swappable: !this._source,
 			units: options.units,
 			value: options.offset,
 			minValue: options.minValue,
@@ -85,17 +77,14 @@ export class ToneConstantSource<
 	/**
 	 * Once the context is started, kick off source.
 	 */
-	private readonly _contextStarted = (state: AudioContextState) => {
-		if (state !== "running") {
-			return;
-		}
+	private _contextStarted() {
 		this._source = this.context.createConstantSource();
 		connect(this._source, this._gainNode);
-		this.offset.setParam(this._source.offset);
+		this.offset?.setParam(this._source.offset);
 		if (this.state === "started") {
 			this._source.start(0);
 		}
-	};
+	}
 
 	/**
 	 * Start the source node at the given time
@@ -123,7 +112,6 @@ export class ToneConstantSource<
 		}
 		this._source?.disconnect();
 		this.offset.dispose();
-		this.context.off("statechange", this._contextStarted);
 		return this;
 	}
 }

package/Tone/signal/WaveShaper.ts

@@ -66,14 +66,9 @@ export class WaveShaper extends SignalOperator<WaveShaperOptions> {
 		);
 		super(options);
 
-		if (
-			isArray(options.mapping) ||
-			options.mapping instanceof Float32Array
-		) {
-			this.curve = Float32Array.from(options.mapping);
-		} else if (isFunction(options.mapping)) {
-			this.setMap(options.mapping, options.length);
-		}
+		this._onContextRunning(() => {
+			this.initCurve(options.mapping, options.length);
+		});
 	}
 
 	static getDefaults(): WaveShaperOptions {
@@ -82,6 +77,18 @@ export class WaveShaper extends SignalOperator<WaveShaperOptions> {
 		});
 	}
 
+	/**
+	 * Set the curve for the first time. This is run only after the audio context is
+	 * running to avoid any context warnings.
+	 */
+	private initCurve(mapping?: WaveShaperMapping, length?: number): void {
+		if (isArray(mapping) || mapping instanceof Float32Array) {
+			this.curve = Float32Array.from(mapping);
+		} else if (isFunction(mapping)) {
+			this.setMap(mapping, length);
+		}
+	}
+
 	/**
 	 * Uses a mapping function to set the value of the curve.
 	 * @param mapping The function used to define the values.

package/Tone/version.ts

@@ -1 +1 @@
-export const version: string = "15.5.0";
+export const version: string = "15.5.2";