tone 14.9.16 → 15.0.0

package/Tone/component/dynamics/Gate.test.ts

@@ -1,32 +1,34 @@
-import { Gate } from "./Gate";
-import { BasicTests } from "test/helper/Basic";
-import { Offline } from "test/helper/Offline";
-import { Signal } from "Tone/signal/Signal";
-import { Oscillator } from "Tone/source/oscillator/Oscillator";
-import { CompareToFile } from "test/helper/CompareToFile";
+import { Gate } from "./Gate.js";
+import { BasicTests } from "../../../test/helper/Basic.js";
+import { Offline } from "../../../test/helper/Offline.js";
+import { Signal } from "../../signal/Signal.js";
+import { Oscillator } from "../../source/oscillator/Oscillator.js";
+import { CompareToFile } from "../../../test/helper/CompareToFile.js";
 import { expect } from "chai";
 
 describe("Gate", () => {
-
 	BasicTests(Gate);
 
-	it("matches a file", () => {
-		return CompareToFile(() => {
-			const gate = new Gate(-10, 0.1).toDestination();
-			const osc = new Oscillator().connect(gate);
-			osc.start(0);
-			osc.volume.value = -100;
-			osc.volume.exponentialRampToValueAtTime(0, 0.5);
-		}, "gate.wav", 0.18);
+	it.only("matches a file", () => {
+		return CompareToFile(
+			() => {
+				const gate = new Gate(-10, 0.1).toDestination();
+				const osc = new Oscillator().connect(gate);
+				osc.start(0);
+				osc.volume.value = -100;
+				osc.volume.exponentialRampToValueAtTime(0, 0.5);
+			},
+			"gate.wav",
+			0.18
+		);
 	});
 
 	context("Signal Gating", () => {
-
 		it("handles getter/setter as Object", () => {
 			const gate = new Gate();
 			const values = {
 				smoothing: 0.2,
-				threshold: -20
+				threshold: -20,
 			};
 			gate.set(values);
 			expect(gate.get().smoothing).to.be.closeTo(0.2, 0.001);
@@ -37,7 +39,7 @@ describe("Gate", () => {
 		it("can be constructed with an object", () => {
 			const gate = new Gate({
 				smoothing: 0.3,
-				threshold: -5
+				threshold: -5,
 			});
 			expect(gate.smoothing).to.be.closeTo(0.3, 0.001);
 			expect(gate.threshold).to.be.closeTo(-5, 0.1);
@@ -69,4 +71,3 @@ describe("Gate", () => {
 		});
 	});
 });
-

package/Tone/component/dynamics/Gate.ts

@@ -1,10 +1,13 @@
-import { ToneAudioNode, ToneAudioNodeOptions } from "../../core/context/ToneAudioNode";
-import { Decibels, Time } from "../../core/type/Units";
-import { GreaterThan } from "../../signal/GreaterThan";
-import { Gain } from "../../core/context/Gain";
-import { Follower } from "../analysis/Follower";
-import { optionsFromArguments } from "../../core/util/Defaults";
-import { dbToGain, gainToDb } from "../../core/type/Conversions";
+import {
+	ToneAudioNode,
+	ToneAudioNodeOptions,
+} from "../../core/context/ToneAudioNode.js";
+import { Decibels, Time } from "../../core/type/Units.js";
+import { GreaterThan } from "../../signal/GreaterThan.js";
+import { Gain } from "../../core/context/Gain.js";
+import { Follower } from "../analysis/Follower.js";
+import { optionsFromArguments } from "../../core/util/Defaults.js";
+import { dbToGain, gainToDb } from "../../core/type/Conversions.js";
 
 export interface GateOptions extends ToneAudioNodeOptions {
 	threshold: Decibels;
@@ -24,7 +27,6 @@ export interface GateOptions extends ToneAudioNodeOptions {
  * @category Component
  */
 export class Gate extends ToneAudioNode<GateOptions> {
-
 	readonly name: string = "Gate";
 
 	readonly input: ToneAudioNode;
@@ -52,8 +54,18 @@ export class Gate extends ToneAudioNode<GateOptions> {
 	constructor(threshold?: Decibels, smoothing?: Time);
 	constructor(options?: Partial<GateOptions>);
 	constructor() {
-		super(Object.assign(optionsFromArguments(Gate.getDefaults(), arguments, ["threshold", "smoothing"])));
-		const options = optionsFromArguments(Gate.getDefaults(), arguments, ["threshold", "smoothing"]);
+		super(
+			Object.assign(
+				optionsFromArguments(Gate.getDefaults(), arguments, [
+					"threshold",
+					"smoothing",
+				])
+			)
+		);
+		const options = optionsFromArguments(Gate.getDefaults(), arguments, [
+			"threshold",
+			"smoothing",
+		]);
 
 		this._follower = new Follower({
 			context: this.context,
@@ -75,7 +87,7 @@ export class Gate extends ToneAudioNode<GateOptions> {
 	static getDefaults(): GateOptions {
 		return Object.assign(ToneAudioNode.getDefaults(), {
 			smoothing: 0.1,
-			threshold: -40
+			threshold: -40,
 		});
 	}
 
@@ -90,7 +102,7 @@ export class Gate extends ToneAudioNode<GateOptions> {
 	}
 
 	/**
-	 * The attack/decay speed of the gate. 
+	 * The attack/decay speed of the gate.
 	 * @see {@link Follower.smoothing}
 	 */
 	get smoothing(): Time {

package/Tone/component/dynamics/Limiter.test.ts

@@ -1,14 +1,12 @@
-import { Limiter } from "./Limiter";
-import { BasicTests } from "test/helper/Basic";
-import { PassAudio } from "test/helper/PassAudio";
+import { Limiter } from "./Limiter.js";
+import { BasicTests } from "../../../test/helper/Basic.js";
+import { PassAudio } from "../../../test/helper/PassAudio.js";
 import { expect } from "chai";
 
 describe("Limiter", () => {
-
 	BasicTests(Limiter);
 
 	context("Limiting", () => {
-
 		it("passes the incoming signal through", () => {
 			return PassAudio((input) => {
 				const limiter = new Limiter().toDestination();
@@ -40,4 +38,3 @@ describe("Limiter", () => {
 		});
 	});
 });
-

package/Tone/component/dynamics/Limiter.ts

@@ -1,9 +1,14 @@
-import { InputNode, OutputNode, ToneAudioNode, ToneAudioNodeOptions } from "../../core/context/ToneAudioNode";
-import { Decibels } from "../../core/type/Units";
-import { optionsFromArguments } from "../../core/util/Defaults";
-import { Compressor } from "./Compressor";
-import { Param } from "../../core/context/Param";
-import { readOnly } from "../../core/util/Interface";
+import {
+	InputNode,
+	OutputNode,
+	ToneAudioNode,
+	ToneAudioNodeOptions,
+} from "../../core/context/ToneAudioNode.js";
+import { Decibels } from "../../core/type/Units.js";
+import { optionsFromArguments } from "../../core/util/Defaults.js";
+import { Compressor } from "./Compressor.js";
+import { Param } from "../../core/context/Param.js";
+import { readOnly } from "../../core/util/Interface.js";
 
 export interface LimiterOptions extends ToneAudioNodeOptions {
 	threshold: Decibels;
@@ -12,7 +17,7 @@ export interface LimiterOptions extends ToneAudioNodeOptions {
 /**
  * Limiter will limit the loudness of an incoming signal.
  * Under the hood it's composed of a {@link Compressor} with a fast attack
- * and release and max compression ratio. 
+ * and release and max compression ratio.
  *
  * @example
  * const limiter = new Tone.Limiter(-20).toDestination();
@@ -21,7 +26,6 @@ export interface LimiterOptions extends ToneAudioNodeOptions {
  * @category Component
  */
 export class Limiter extends ToneAudioNode<LimiterOptions> {
-
 	readonly name: string = "Limiter";
 
 	readonly input: InputNode;
@@ -32,7 +36,7 @@ export class Limiter extends ToneAudioNode<LimiterOptions> {
 	 */
 	private _compressor: Compressor;
 
-	readonly threshold: Param<"decibels">
+	readonly threshold: Param<"decibels">;
 
 	/**
 	 * @param threshold The threshold above which the gain reduction is applied.
@@ -40,16 +44,27 @@ export class Limiter extends ToneAudioNode<LimiterOptions> {
 	constructor(threshold?: Decibels);
 	constructor(options?: Partial<LimiterOptions>);
 	constructor() {
-		super(Object.assign(optionsFromArguments(Limiter.getDefaults(), arguments, ["threshold"])));
-		const options = optionsFromArguments(Limiter.getDefaults(), arguments, ["threshold"]);
+		super(
+			Object.assign(
+				optionsFromArguments(Limiter.getDefaults(), arguments, [
+					"threshold",
+				])
+			)
+		);
+		const options = optionsFromArguments(Limiter.getDefaults(), arguments, [
+			"threshold",
+		]);
 
-		this._compressor = this.input = this.output = new Compressor({
-			context: this.context,
-			ratio: 20,
-			attack: 0.003,
-			release: 0.01,
-			threshold: options.threshold
-		});
+		this._compressor =
+			this.input =
+			this.output =
+				new Compressor({
+					context: this.context,
+					ratio: 20,
+					attack: 0.003,
+					release: 0.01,
+					threshold: options.threshold,
+				});
 
 		this.threshold = this._compressor.threshold;
 		readOnly(this, "threshold");
@@ -57,13 +72,13 @@ export class Limiter extends ToneAudioNode<LimiterOptions> {
 
 	static getDefaults(): LimiterOptions {
 		return Object.assign(ToneAudioNode.getDefaults(), {
-			threshold: -12
+			threshold: -12,
 		});
 	}
 
 	/**
 	 * A read-only decibel value for metering purposes, representing the current amount of gain
-	 * reduction that the compressor is applying to the signal. 
+	 * reduction that the compressor is applying to the signal.
 	 */
 	get reduction(): Decibels {
 		return this._compressor.reduction;

package/Tone/component/dynamics/MidSideCompressor.test.ts

@@ -1,14 +1,12 @@
-import { MidSideCompressor } from "./MidSideCompressor";
-import { BasicTests } from "test/helper/Basic";
-import { PassAudio } from "test/helper/PassAudio";
+import { MidSideCompressor } from "./MidSideCompressor.js";
+import { BasicTests } from "../../../test/helper/Basic.js";
+import { PassAudio } from "../../../test/helper/PassAudio.js";
 import { expect } from "chai";
 
 describe("MidSideCompressor", () => {
-
 	BasicTests(MidSideCompressor);
 
 	context("Compression", () => {
-
 		it("passes the incoming signal through", () => {
 			return PassAudio((input) => {
 				const comp = new MidSideCompressor().toDestination();
@@ -26,8 +24,8 @@ describe("MidSideCompressor", () => {
 				side: {
 					release: 0.5,
 					attack: 0.03,
-					knee: 20
-				}
+					knee: 20,
+				},
 			};
 			comp.set(values);
 			expect(comp.get()).to.have.keys(["mid", "side"]);
@@ -45,8 +43,8 @@ describe("MidSideCompressor", () => {
 				side: {
 					release: 0.5,
 					attack: 0.03,
-					knee: 20
-				}
+					knee: 20,
+				},
 			});
 			expect(comp.mid.ratio.value).be.closeTo(16, 0.01);
 			expect(comp.mid.threshold.value).be.closeTo(-30, 0.01);
@@ -56,4 +54,3 @@ describe("MidSideCompressor", () => {
 		});
 	});
 });
-

package/Tone/component/dynamics/MidSideCompressor.ts

@@ -1,9 +1,14 @@
-import { InputNode, OutputNode, ToneAudioNode, ToneAudioNodeOptions } from "../../core/context/ToneAudioNode";
-import { Compressor, CompressorOptions } from "./Compressor";
-import { optionsFromArguments } from "../../core/util/Defaults";
-import { MidSideSplit } from "../channel/MidSideSplit";
-import { MidSideMerge } from "../channel/MidSideMerge";
-import { readOnly, RecursivePartial } from "../../core/util/Interface";
+import {
+	InputNode,
+	OutputNode,
+	ToneAudioNode,
+	ToneAudioNodeOptions,
+} from "../../core/context/ToneAudioNode.js";
+import { Compressor, CompressorOptions } from "./Compressor.js";
+import { optionsFromArguments } from "../../core/util/Defaults.js";
+import { MidSideSplit } from "../channel/MidSideSplit.js";
+import { MidSideMerge } from "../channel/MidSideMerge.js";
+import { readOnly, RecursivePartial } from "../../core/util/Interface.js";
 
 export interface MidSideCompressorOptions extends ToneAudioNodeOptions {
 	mid: Omit<CompressorOptions, keyof ToneAudioNodeOptions>;
@@ -12,12 +17,11 @@ export interface MidSideCompressorOptions extends ToneAudioNodeOptions {
 
 /**
  * MidSideCompressor applies two different compressors to the {@link mid}
- * and {@link side} signal components of the input. 
+ * and {@link side} signal components of the input.
  * @see {@link MidSideSplit} and {@link MidSideMerge}.
  * @category Component
  */
 export class MidSideCompressor extends ToneAudioNode<MidSideCompressorOptions> {
-
 	readonly name: string = "MidSideCompressor";
 
 	readonly input: InputNode;
@@ -45,13 +49,28 @@ export class MidSideCompressor extends ToneAudioNode<MidSideCompressorOptions> {
 
 	constructor(options?: RecursivePartial<MidSideCompressorOptions>);
 	constructor() {
-		super(Object.assign(optionsFromArguments(MidSideCompressor.getDefaults(), arguments)));
-		const options = optionsFromArguments(MidSideCompressor.getDefaults(), arguments);
+		super(
+			Object.assign(
+				optionsFromArguments(MidSideCompressor.getDefaults(), arguments)
+			)
+		);
+		const options = optionsFromArguments(
+			MidSideCompressor.getDefaults(),
+			arguments
+		);
 
-		this._midSideSplit = this.input = new MidSideSplit({ context: this.context });
-		this._midSideMerge = this.output = new MidSideMerge({ context: this.context });
-		this.mid = new Compressor(Object.assign(options.mid, { context: this.context }));
-		this.side = new Compressor(Object.assign(options.side, { context: this.context }));
+		this._midSideSplit = this.input = new MidSideSplit({
+			context: this.context,
+		});
+		this._midSideMerge = this.output = new MidSideMerge({
+			context: this.context,
+		});
+		this.mid = new Compressor(
+			Object.assign(options.mid, { context: this.context })
+		);
+		this.side = new Compressor(
+			Object.assign(options.side, { context: this.context })
+		);
 
 		this._midSideSplit.mid.chain(this.mid, this._midSideMerge.mid);
 		this._midSideSplit.side.chain(this.side, this._midSideMerge.side);
@@ -65,15 +84,15 @@ export class MidSideCompressor extends ToneAudioNode<MidSideCompressorOptions> {
 				threshold: -24,
 				release: 0.03,
 				attack: 0.02,
-				knee: 16
+				knee: 16,
 			},
 			side: {
 				ratio: 6,
 				threshold: -30,
 				release: 0.25,
 				attack: 0.03,
-				knee: 10
-			}
+				knee: 10,
+			},
 		});
 	}
 

package/Tone/component/dynamics/MultibandCompressor.test.ts

@@ -1,14 +1,12 @@
-import { MultibandCompressor } from "./MultibandCompressor";
-import { BasicTests } from "test/helper/Basic";
-import { PassAudio } from "test/helper/PassAudio";
+import { MultibandCompressor } from "./MultibandCompressor.js";
+import { BasicTests } from "../../../test/helper/Basic.js";
+import { PassAudio } from "../../../test/helper/PassAudio.js";
 import { expect } from "chai";
 
 describe("MultibandCompressor", () => {
-
 	BasicTests(MultibandCompressor);
 
 	context("Compression", () => {
-
 		it("passes the incoming signal through", () => {
 			return PassAudio((input) => {
 				const comp = new MultibandCompressor().toDestination();
@@ -26,11 +24,17 @@ describe("MultibandCompressor", () => {
 				high: {
 					release: 0.5,
 					attack: 0.03,
-					knee: 20
-				}
+					knee: 20,
+				},
 			};
 			comp.set(values);
-			expect(comp.get()).to.have.keys(["low", "mid", "high", "lowFrequency", "highFrequency"]);
+			expect(comp.get()).to.have.keys([
+				"low",
+				"mid",
+				"high",
+				"lowFrequency",
+				"highFrequency",
+			]);
 			expect(comp.get().mid.ratio).be.closeTo(16, 0.01);
 			expect(comp.get().high.release).be.closeTo(0.5, 0.01);
 			comp.dispose();
@@ -51,4 +55,3 @@ describe("MultibandCompressor", () => {
 		});
 	});
 });
-

package/Tone/component/dynamics/MultibandCompressor.ts

@@ -1,11 +1,15 @@
-import { InputNode, ToneAudioNode, ToneAudioNodeOptions } from "../../core/context/ToneAudioNode";
-import { Compressor, CompressorOptions } from "./Compressor";
-import { optionsFromArguments } from "../../core/util/Defaults";
-import { readOnly, RecursivePartial } from "../../core/util/Interface";
-import { Frequency } from "../../core/type/Units";
-import { MultibandSplit } from "../channel/MultibandSplit";
-import { Signal } from "../../signal/Signal";
-import { Gain } from "../../core/context/Gain";
+import {
+	InputNode,
+	ToneAudioNode,
+	ToneAudioNodeOptions,
+} from "../../core/context/ToneAudioNode.js";
+import { Compressor, CompressorOptions } from "./Compressor.js";
+import { optionsFromArguments } from "../../core/util/Defaults.js";
+import { readOnly, RecursivePartial } from "../../core/util/Interface.js";
+import { Frequency } from "../../core/type/Units.js";
+import { MultibandSplit } from "../channel/MultibandSplit.js";
+import { Signal } from "../../signal/Signal.js";
+import { Gain } from "../../core/context/Gain.js";
 
 export interface MultibandCompressorOptions extends ToneAudioNodeOptions {
 	mid: Omit<CompressorOptions, keyof ToneAudioNodeOptions>;
@@ -16,7 +20,7 @@ export interface MultibandCompressorOptions extends ToneAudioNodeOptions {
 }
 
 /**
- * A compressor with separate controls over low/mid/high dynamics. 
+ * A compressor with separate controls over low/mid/high dynamics.
  * @see {@link Compressor} and {@link MultibandSplit}
  *
  * @example
@@ -30,7 +34,6 @@ export interface MultibandCompressorOptions extends ToneAudioNodeOptions {
  * @category Component
  */
 export class MultibandCompressor extends ToneAudioNode<MultibandCompressorOptions> {
-
 	readonly name: string = "MultibandCompressor";
 
 	readonly input: InputNode;
@@ -68,20 +71,36 @@ export class MultibandCompressor extends ToneAudioNode<MultibandCompressorOption
 
 	constructor(options?: RecursivePartial<MultibandCompressorOptions>);
 	constructor() {
-		super(Object.assign(optionsFromArguments(MultibandCompressor.getDefaults(), arguments)));
-		const options = optionsFromArguments(MultibandCompressor.getDefaults(), arguments);
+		super(
+			Object.assign(
+				optionsFromArguments(
+					MultibandCompressor.getDefaults(),
+					arguments
+				)
+			)
+		);
+		const options = optionsFromArguments(
+			MultibandCompressor.getDefaults(),
+			arguments
+		);
 
 		this._splitter = this.input = new MultibandSplit({
 			context: this.context,
 			lowFrequency: options.lowFrequency,
-			highFrequency: options.highFrequency
+			highFrequency: options.highFrequency,
 		});
 		this.lowFrequency = this._splitter.lowFrequency;
 		this.highFrequency = this._splitter.highFrequency;
 		this.output = new Gain({ context: this.context });
-		this.low = new Compressor(Object.assign(options.low, { context: this.context }));
-		this.mid = new Compressor(Object.assign(options.mid, { context: this.context }));
-		this.high = new Compressor(Object.assign(options.high, { context: this.context }));
+		this.low = new Compressor(
+			Object.assign(options.low, { context: this.context })
+		);
+		this.mid = new Compressor(
+			Object.assign(options.mid, { context: this.context })
+		);
+		this.high = new Compressor(
+			Object.assign(options.high, { context: this.context })
+		);
 
 		// connect the compressor
 		this._splitter.low.chain(this.low, this.output);
@@ -100,21 +119,21 @@ export class MultibandCompressor extends ToneAudioNode<MultibandCompressorOption
 				threshold: -30,
 				release: 0.25,
 				attack: 0.03,
-				knee: 10
+				knee: 10,
 			},
 			mid: {
 				ratio: 3,
 				threshold: -24,
 				release: 0.03,
 				attack: 0.02,
-				knee: 16
+				knee: 16,
 			},
 			high: {
 				ratio: 3,
 				threshold: -24,
 				release: 0.03,
 				attack: 0.02,
-				knee: 16
+				knee: 16,
 			},
 		});
 	}

package/Tone/component/envelope/AmplitudeEnvelope.test.ts

@@ -1,19 +1,17 @@
 import { expect } from "chai";
-import { BasicTests } from "test/helper/Basic";
-import { CompareToFile } from "test/helper/CompareToFile";
-import { connectFrom, connectTo } from "test/helper/Connect";
-import { Offline } from "test/helper/Offline";
-import { Signal } from "Tone/signal/Signal";
-import { Oscillator } from "Tone/source/oscillator/Oscillator";
-import { AmplitudeEnvelope } from "./AmplitudeEnvelope";
-import { Envelope } from "./Envelope";
+import { BasicTests } from "../../../test/helper/Basic.js";
+import { CompareToFile } from "../../../test/helper/CompareToFile.js";
+import { connectFrom, connectTo } from "../../../test/helper/Connect.js";
+import { Offline } from "../../../test/helper/Offline.js";
+import { Signal } from "../../signal/Signal.js";
+import { Oscillator } from "../../source/oscillator/Oscillator.js";
+import { AmplitudeEnvelope } from "./AmplitudeEnvelope.js";
+import { Envelope } from "./Envelope.js";
 
 describe("AmplitudeEnvelope", () => {
-
 	BasicTests(AmplitudeEnvelope);
 
 	context("Comparisons", () => {
-
 		it("matches a file", () => {
 			return CompareToFile(() => {
 				const ampEnv = new AmplitudeEnvelope({
@@ -29,41 +27,47 @@ describe("AmplitudeEnvelope", () => {
 		});
 
 		it("matches a file with multiple retriggers", () => {
-			return CompareToFile(() => {
-				const ampEnv = new AmplitudeEnvelope({
-					attack: 0.1,
-					decay: 0.2,
-					release: 0.2,
-					sustain: 0.1,
-				}).toDestination();
-				const osc = new Oscillator().start(0).connect(ampEnv);
-				ampEnv.triggerAttack(0);
-				ampEnv.triggerAttack(0.3);
-			}, "ampEnvelope2.wav", 0.004);
+			return CompareToFile(
+				() => {
+					const ampEnv = new AmplitudeEnvelope({
+						attack: 0.1,
+						decay: 0.2,
+						release: 0.2,
+						sustain: 0.1,
+					}).toDestination();
+					const osc = new Oscillator().start(0).connect(ampEnv);
+					ampEnv.triggerAttack(0);
+					ampEnv.triggerAttack(0.3);
+				},
+				"ampEnvelope2.wav",
+				0.004
+			);
 		});
 
 		it("matches a file with ripple attack/release", () => {
-			return CompareToFile(() => {
-				const ampEnv = new AmplitudeEnvelope({
-					attack: 0.5,
-					attackCurve: "ripple",
-					decay: 0.2,
-					release: 0.3,
-					releaseCurve: "ripple",
-					sustain: 0.1,
-				}).toDestination();
-				const osc = new Oscillator().start(0).connect(ampEnv);
-				ampEnv.triggerAttack(0);
-				ampEnv.triggerRelease(0.7);
-				ampEnv.triggerAttack(1);
-				ampEnv.triggerRelease(1.6);
-			}, "ampEnvelope3.wav", 0.002);
+			return CompareToFile(
+				() => {
+					const ampEnv = new AmplitudeEnvelope({
+						attack: 0.5,
+						attackCurve: "ripple",
+						decay: 0.2,
+						release: 0.3,
+						releaseCurve: "ripple",
+						sustain: 0.1,
+					}).toDestination();
+					const osc = new Oscillator().start(0).connect(ampEnv);
+					ampEnv.triggerAttack(0);
+					ampEnv.triggerRelease(0.7);
+					ampEnv.triggerAttack(1);
+					ampEnv.triggerRelease(1.6);
+				},
+				"ampEnvelope3.wav",
+				0.002
+			);
 		});
-
 	});
 
 	context("Envelope", () => {
-
 		it("extends envelope", () => {
 			const ampEnv = new AmplitudeEnvelope();
 			expect(ampEnv).to.be.instanceOf(Envelope);