tone 14.9.16 → 15.0.0

package/Tone/source/oscillator/Oscillator.ts

@@ -1,17 +1,29 @@
-import { AudioRange, Degrees, Frequency, Radians, Time } from "../../core/type/Units";
-import { deepEquals, optionsFromArguments } from "../../core/util/Defaults";
-import { readOnly } from "../../core/util/Interface";
-import { isDefined } from "../../core/util/TypeCheck";
-import { Signal } from "../../signal/Signal";
-import { Source } from "../Source";
 import {
-	generateWaveform, ToneOscillatorConstructorOptions, ToneOscillatorInterface,
-	ToneOscillatorOptions, ToneOscillatorType
-} from "./OscillatorInterface";
-import { ToneOscillatorNode } from "./ToneOscillatorNode";
-import { assertRange } from "../../core/util/Debug";
-import { clamp } from "../../core/util/Math";
-export { ToneOscillatorOptions, ToneOscillatorType } from "./OscillatorInterface";
+	AudioRange,
+	Degrees,
+	Frequency,
+	Radians,
+	Time,
+} from "../../core/type/Units.js";
+import { deepEquals, optionsFromArguments } from "../../core/util/Defaults.js";
+import { readOnly } from "../../core/util/Interface.js";
+import { isDefined } from "../../core/util/TypeCheck.js";
+import { Signal } from "../../signal/Signal.js";
+import { Source } from "../Source.js";
+import {
+	generateWaveform,
+	ToneOscillatorConstructorOptions,
+	ToneOscillatorInterface,
+	ToneOscillatorOptions,
+	ToneOscillatorType,
+} from "./OscillatorInterface.js";
+import { ToneOscillatorNode } from "./ToneOscillatorNode.js";
+import { assertRange } from "../../core/util/Debug.js";
+import { clamp } from "../../core/util/Math.js";
+export {
+	ToneOscillatorOptions,
+	ToneOscillatorType,
+} from "./OscillatorInterface.js";
 /**
  * Oscillator supports a number of features including
  * phase rotation, multiple oscillator types (see Oscillator.type),
@@ -22,8 +34,10 @@ export { ToneOscillatorOptions, ToneOscillatorType } from "./OscillatorInterface
  * const osc = new Tone.Oscillator(440, "sine").toDestination().start();
  * @category Source
  */
-export class Oscillator extends Source<ToneOscillatorOptions> implements ToneOscillatorInterface {
-
+export class Oscillator
+	extends Source<ToneOscillatorOptions>
+	implements ToneOscillatorInterface
+{
 	readonly name: string = "Oscillator";
 
 	/**
@@ -71,11 +85,19 @@ export class Oscillator extends Source<ToneOscillatorOptions> implements ToneOsc
 	 * @param type The oscillator type. Read more about type below.
 	 */
 	constructor(frequency?: Frequency, type?: ToneOscillatorType);
-	constructor(options?: Partial<ToneOscillatorConstructorOptions>)
+	constructor(options?: Partial<ToneOscillatorConstructorOptions>);
 	constructor() {
-
-		super(optionsFromArguments(Oscillator.getDefaults(), arguments, ["frequency", "type"]));
-		const options = optionsFromArguments(Oscillator.getDefaults(), arguments, ["frequency", "type"]);
+		super(
+			optionsFromArguments(Oscillator.getDefaults(), arguments, [
+				"frequency",
+				"type",
+			])
+		);
+		const options = optionsFromArguments(
+			Oscillator.getDefaults(),
+			arguments,
+			["frequency", "type"]
+		);
 
 		this.frequency = new Signal<"frequency">({
 			context: this.context,
@@ -96,7 +118,8 @@ export class Oscillator extends Source<ToneOscillatorOptions> implements ToneOsc
 		this._type = options.type;
 
 		if (options.partialCount && options.type !== "custom") {
-			this._type = this.baseType + options.partialCount.toString() as ToneOscillatorType;
+			this._type = (this.baseType +
+				options.partialCount.toString()) as ToneOscillatorType;
 		}
 		this.phase = options.phase;
 	}
@@ -205,19 +228,36 @@ export class Oscillator extends Source<ToneOscillatorOptions> implements ToneOsc
 	 * the oscillator values when they have already been computed
 	 * with the same values.
 	 */
-	private _getCachedPeriodicWave(): { real: Float32Array; imag: Float32Array; partials: number[]; wave: PeriodicWave } | undefined {
+	private _getCachedPeriodicWave():
+		| {
+				real: Float32Array;
+				imag: Float32Array;
+				partials: number[];
+				wave: PeriodicWave;
+		  }
+		| undefined {
 		if (this._type === "custom") {
-			const oscProps = Oscillator._periodicWaveCache.find(description => {
-				return description.phase === this._phase &&
-					deepEquals(description.partials, this._partials);
-			});
+			const oscProps = Oscillator._periodicWaveCache.find(
+				(description) => {
+					return (
+						description.phase === this._phase &&
+						deepEquals(description.partials, this._partials)
+					);
+				}
+			);
 			return oscProps;
 		} else {
-			const oscProps = Oscillator._periodicWaveCache.find(description => {
-				return description.type === this._type &&
-					description.phase === this._phase;
-			});
-			this._partialCount = oscProps ? oscProps.partialCount : this._partialCount;
+			const oscProps = Oscillator._periodicWaveCache.find(
+				(description) => {
+					return (
+						description.type === this._type &&
+						description.phase === this._phase
+					);
+				}
+			);
+			this._partialCount = oscProps
+				? oscProps.partialCount
+				: this._partialCount;
 			return oscProps;
 		}
 	}
@@ -227,7 +267,8 @@ export class Oscillator extends Source<ToneOscillatorOptions> implements ToneOsc
 	}
 	set type(type) {
 		this._type = type;
-		const isBasicType = ["sine", "square", "sawtooth", "triangle"].indexOf(type) !== -1;
+		const isBasicType =
+			["sine", "square", "sawtooth", "triangle"].indexOf(type) !== -1;
 		if (this._phase === 0 && isBasicType) {
 			this._wave = undefined;
 			this._partialCount = 0;
@@ -248,7 +289,10 @@ export class Oscillator extends Source<ToneOscillatorOptions> implements ToneOsc
 				}
 			} else {
 				const [real, imag] = this._getRealImaginary(type, this._phase);
-				const periodicWave = this.context.createPeriodicWave(real, imag);
+				const periodicWave = this.context.createPeriodicWave(
+					real,
+					imag
+				);
 				this._wave = periodicWave;
 				if (this._oscillator !== null) {
 					this._oscillator.setPeriodicWave(this._wave);
@@ -271,11 +315,18 @@ export class Oscillator extends Source<ToneOscillatorOptions> implements ToneOsc
 	}
 
 	get baseType(): OscillatorType {
-		return (this._type as string).replace(this.partialCount.toString(), "") as OscillatorType;
+		return (this._type as string).replace(
+			this.partialCount.toString(),
+			""
+		) as OscillatorType;
 	}
 	set baseType(baseType) {
-		if (this.partialCount && this._type !== "custom" && baseType !== "custom") {
-			this.type = baseType + this.partialCount as ToneOscillatorType;
+		if (
+			this.partialCount &&
+			this._type !== "custom" &&
+			baseType !== "custom"
+		) {
+			this.type = (baseType + this.partialCount) as ToneOscillatorType;
 		} else {
 			this.type = baseType;
 		}
@@ -287,7 +338,9 @@ export class Oscillator extends Source<ToneOscillatorOptions> implements ToneOsc
 	set partialCount(p) {
 		assertRange(p, 0);
 		let type = this._type;
-		const partial = /^(sine|triangle|square|sawtooth)(\d+)$/.exec(this._type);
+		const partial = /^(sine|triangle|square|sawtooth)(\d+)$/.exec(
+			this._type
+		);
 		if (partial) {
 			type = partial[1] as OscillatorType;
 		}
@@ -295,13 +348,13 @@ export class Oscillator extends Source<ToneOscillatorOptions> implements ToneOsc
 			if (p === 0) {
 				this.type = type;
 			} else {
-				this.type = type + p.toString() as ToneOscillatorType;
+				this.type = (type + p.toString()) as ToneOscillatorType;
 			}
 		} else {
 			// extend or shorten the partials array
 			const fullPartials = new Float32Array(p);
 			// copy over the partials array
-			this._partials.forEach((v, i) => fullPartials[i] = v);
+			this._partials.forEach((v, i) => (fullPartials[i] = v));
 			this._partials = Array.from(fullPartials);
 			this.type = this._type;
 		}
@@ -312,7 +365,10 @@ export class Oscillator extends Source<ToneOscillatorOptions> implements ToneOsc
 	 * on the oscillator type.
 	 * @returns [real: Float32Array, imaginary: Float32Array]
 	 */
-	private _getRealImaginary(type: ToneOscillatorType, phase: Radians): Float32Array[] {
+	private _getRealImaginary(
+		type: ToneOscillatorType,
+		phase: Radians
+	): Float32Array[] {
 		const fftSize = 4096;
 		let periodicWaveSize = fftSize / 2;
 
@@ -347,20 +403,23 @@ export class Oscillator extends Source<ToneOscillatorOptions> implements ToneOsc
 			let b;
 			switch (type) {
 				case "sine":
-					b = (n <= partialCount) ? 1 : 0;
+					b = n <= partialCount ? 1 : 0;
 					this._partials[n - 1] = b;
 					break;
 				case "square":
-					b = (n & 1) ? 2 * piFactor : 0;
+					b = n & 1 ? 2 * piFactor : 0;
 					this._partials[n - 1] = b;
 					break;
 				case "sawtooth":
-					b = piFactor * ((n & 1) ? 1 : -1);
+					b = piFactor * (n & 1 ? 1 : -1);
 					this._partials[n - 1] = b;
 					break;
 				case "triangle":
 					if (n & 1) {
-						b = 2 * (piFactor * piFactor) * ((((n - 1) >> 1) & 1) ? -1 : 1);
+						b =
+							2 *
+							(piFactor * piFactor) *
+							(((n - 1) >> 1) & 1 ? -1 : 1);
 					} else {
 						b = 0;
 					}
@@ -386,11 +445,16 @@ export class Oscillator extends Source<ToneOscillatorOptions> implements ToneOsc
 	/**
 	 * Compute the inverse FFT for a given phase.
 	 */
-	private _inverseFFT(real: Float32Array, imag: Float32Array, phase: Radians): number {
+	private _inverseFFT(
+		real: Float32Array,
+		imag: Float32Array,
+		phase: Radians
+	): number {
 		let sum = 0;
 		const len = real.length;
 		for (let i = 0; i < len; i++) {
-			sum += real[i] * Math.cos(i * phase) + imag[i] * Math.sin(i * phase);
+			sum +=
+				real[i] * Math.cos(i * phase) + imag[i] * Math.sin(i * phase);
 		}
 		return sum;
 	}
@@ -406,9 +470,16 @@ export class Oscillator extends Source<ToneOscillatorOptions> implements ToneOsc
 		const testPositions = 32;
 		// check for peaks in 16 places
 		for (let i = 0; i < testPositions; i++) {
-			maxValue = Math.max(this._inverseFFT(real, imag, (i / testPositions) * twoPi), maxValue);
+			maxValue = Math.max(
+				this._inverseFFT(real, imag, (i / testPositions) * twoPi),
+				maxValue
+			);
 		}
-		return clamp(-this._inverseFFT(real, imag, this._phase) / maxValue, -1, 1);
+		return clamp(
+			-this._inverseFFT(real, imag, this._phase) / maxValue,
+			-1,
+			1
+		);
 	}
 
 	get partials(): number[] {
@@ -426,7 +497,7 @@ export class Oscillator extends Source<ToneOscillatorOptions> implements ToneOsc
 		return this._phase * (180 / Math.PI);
 	}
 	set phase(phase) {
-		this._phase = phase * Math.PI / 180;
+		this._phase = (phase * Math.PI) / 180;
 		// reset the type
 		this.type = this._type;
 	}

package/Tone/source/oscillator/OscillatorInterface.ts

@@ -4,11 +4,11 @@ import {
 	Degrees,
 	Frequency,
 	Positive,
-} from "../../core/type/Units";
-import { Omit } from "../../core/util/Interface";
-import { Signal } from "../../signal/Signal";
-import { SourceOptions } from "../Source";
-import { OfflineContext } from "../../core/context/OfflineContext";
+} from "../../core/type/Units.js";
+import { Omit } from "../../core/util/Interface.js";
+import { Signal } from "../../signal/Signal.js";
+import { SourceOptions } from "../Source.js";
+import { OfflineContext } from "../../core/context/OfflineContext.js";
 
 /**
  * The common interface of all Oscillators
@@ -489,7 +489,10 @@ export type OmniOscillatorOptions =
 	| OmniAMPartialsOscillatorOptions
 	| ToneOscillatorConstructorOptions;
 
-type OmitSourceOptions<T extends BaseOscillatorOptions> = Omit<T, "frequency" | "detune" | "context">;
+type OmitSourceOptions<T extends BaseOscillatorOptions> = Omit<
+	T,
+	"frequency" | "detune" | "context"
+>;
 
 /**
  * The settable options for the omni oscillator inside of the source which excludes certain attributes that are defined by the parent class

package/Tone/source/oscillator/PWMOscillator.test.ts

@@ -1,27 +1,29 @@
 import { expect } from "chai";
-import { BasicTests } from "test/helper/Basic";
-import { CompareToFile } from "test/helper/CompareToFile";
-import { connectFrom } from "test/helper/Connect";
-import { OscillatorTests } from "test/helper/OscillatorTests";
-import { SourceTests } from "test/helper/SourceTests";
-import { PWMOscillator } from "./PWMOscillator";
+import { BasicTests } from "../../../test/helper/Basic.js";
+import { CompareToFile } from "../../../test/helper/CompareToFile.js";
+import { connectFrom } from "../../../test/helper/Connect.js";
+import { OscillatorTests } from "../../../test/helper/OscillatorTests.js";
+import { SourceTests } from "../../../test/helper/SourceTests.js";
+import { PWMOscillator } from "./PWMOscillator.js";
 
 describe("PWMOscillator", () => {
-
 	// run the common tests
 	BasicTests(PWMOscillator);
 	SourceTests(PWMOscillator);
 	OscillatorTests(PWMOscillator);
 
 	it("matches a file", () => {
-		return CompareToFile(() => {
-			const osc = new PWMOscillator().toDestination();
-			osc.start(0.1);
-		}, "pwmOscillator.wav", 0.01);
+		return CompareToFile(
+			() => {
+				const osc = new PWMOscillator().toDestination();
+				osc.start(0.1);
+			},
+			"pwmOscillator.wav",
+			0.01
+		);
 	});
 
 	context("Modulation Frequency", () => {
-
 		it("can set the modulation frequency", () => {
 			const pwm = new PWMOscillator();
 			pwm.modulationFrequency.value = 0.2;
@@ -34,7 +36,6 @@ describe("PWMOscillator", () => {
 			connectFrom().connect(pwm.modulationFrequency);
 			pwm.dispose();
 		});
-
 	});
 
 	context("Types", () => {

package/Tone/source/oscillator/PWMOscillator.ts

@@ -1,14 +1,18 @@
-import { Degrees, Frequency, Seconds, Time } from "../../core/type/Units";
-import { optionsFromArguments } from "../../core/util/Defaults";
-import { readOnly } from "../../core/util/Interface";
-import { Multiply } from "../../signal/Multiply";
-import { Signal } from "../../signal/Signal";
-import { Source } from "../Source";
-import { Oscillator } from "./Oscillator";
-import { generateWaveform, PWMOscillatorOptions, ToneOscillatorInterface } from "./OscillatorInterface";
-import { PulseOscillator } from "./PulseOscillator";
-
-export { PWMOscillatorOptions } from "./OscillatorInterface";
+import { Degrees, Frequency, Seconds, Time } from "../../core/type/Units.js";
+import { optionsFromArguments } from "../../core/util/Defaults.js";
+import { readOnly } from "../../core/util/Interface.js";
+import { Multiply } from "../../signal/Multiply.js";
+import { Signal } from "../../signal/Signal.js";
+import { Source } from "../Source.js";
+import { Oscillator } from "./Oscillator.js";
+import {
+	generateWaveform,
+	PWMOscillatorOptions,
+	ToneOscillatorInterface,
+} from "./OscillatorInterface.js";
+import { PulseOscillator } from "./PulseOscillator.js";
+
+export { PWMOscillatorOptions } from "./OscillatorInterface.js";
 
 /**
  * PWMOscillator modulates the width of a Tone.PulseOscillator
@@ -21,8 +25,10 @@ export { PWMOscillatorOptions } from "./OscillatorInterface";
  * }, 0.1, 1);
  * @category Source
  */
-export class PWMOscillator extends Source<PWMOscillatorOptions> implements ToneOscillatorInterface {
-
+export class PWMOscillator
+	extends Source<PWMOscillatorOptions>
+	implements ToneOscillatorInterface
+{
 	readonly name: string = "PWMOscillator";
 
 	readonly sourceType = "pwm";
@@ -71,8 +77,17 @@ export class PWMOscillator extends Source<PWMOscillatorOptions> implements ToneO
 	constructor(frequency?: Frequency, modulationFrequency?: Frequency);
 	constructor(options?: Partial<PWMOscillatorOptions>);
 	constructor() {
-		super(optionsFromArguments(PWMOscillator.getDefaults(), arguments, ["frequency", "modulationFrequency"]));
-		const options = optionsFromArguments(PWMOscillator.getDefaults(), arguments, ["frequency", "modulationFrequency"]);
+		super(
+			optionsFromArguments(PWMOscillator.getDefaults(), arguments, [
+				"frequency",
+				"modulationFrequency",
+			])
+		);
+		const options = optionsFromArguments(
+			PWMOscillator.getDefaults(),
+			arguments,
+			["frequency", "modulationFrequency"]
+		);
 
 		this._pulse = new PulseOscillator({
 			context: this.context,

package/Tone/source/oscillator/PulseOscillator.test.ts

@@ -1,25 +1,28 @@
 import { expect } from "chai";
-import { BasicTests } from "test/helper/Basic";
-import { CompareToFile } from "test/helper/CompareToFile";
-import { Offline } from "test/helper/Offline";
-import { OscillatorTests } from "test/helper/OscillatorTests";
-import { SourceTests } from "test/helper/SourceTests";
-import { PulseOscillator } from "./PulseOscillator";
+import { BasicTests } from "../../../test/helper/Basic.js";
+import { CompareToFile } from "../../../test/helper/CompareToFile.js";
+import { Offline } from "../../../test/helper/Offline.js";
+import { OscillatorTests } from "../../../test/helper/OscillatorTests.js";
+import { SourceTests } from "../../../test/helper/SourceTests.js";
+import { PulseOscillator } from "./PulseOscillator.js";
 
 describe("PulseOscillator", () => {
-
 	// run the common tests
 	BasicTests(PulseOscillator);
 	SourceTests(PulseOscillator);
 	OscillatorTests(PulseOscillator);
 
 	it("matches a file", () => {
-		return CompareToFile(() => {
-			const osc = new PulseOscillator({
-				width: 0.2,
-			}).toDestination();
-			osc.start(0);
-		}, "pulseOscillator.wav", 0.03);
+		return CompareToFile(
+			() => {
+				const osc = new PulseOscillator({
+					width: 0.2,
+				}).toDestination();
+				osc.start(0);
+			},
+			"pulseOscillator.wav",
+			0.03
+		);
 	});
 
 	context("Phase Rotation", () => {
@@ -62,11 +65,9 @@ describe("PulseOscillator", () => {
 				});
 			});
 		});
-
 	});
 
 	context("Width", () => {
-
 		it("can set the width", () => {
 			const osc = new PulseOscillator({
 				width: 0.2,

package/Tone/source/oscillator/PulseOscillator.ts

@@ -1,14 +1,24 @@
-import { Gain } from "../../core/context/Gain";
-import { AudioRange, Degrees, Frequency, Seconds, Time } from "../../core/type/Units";
-import { optionsFromArguments } from "../../core/util/Defaults";
-import { readOnly } from "../../core/util/Interface";
-import { Signal } from "../../signal/Signal";
-import { WaveShaper } from "../../signal/WaveShaper";
-import { Source } from "../Source";
-import { Oscillator } from "./Oscillator";
-import { generateWaveform, PulseOscillatorOptions, ToneOscillatorInterface } from "./OscillatorInterface";
-
-export { PulseOscillatorOptions } from "./OscillatorInterface";
+import { Gain } from "../../core/context/Gain.js";
+import {
+	AudioRange,
+	Degrees,
+	Frequency,
+	Seconds,
+	Time,
+} 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 { WaveShaper } from "../../signal/WaveShaper.js";
+import { Source } from "../Source.js";
+import { Oscillator } from "./Oscillator.js";
+import {
+	generateWaveform,
+	PulseOscillatorOptions,
+	ToneOscillatorInterface,
+} from "./OscillatorInterface.js";
+
+export { PulseOscillatorOptions } from "./OscillatorInterface.js";
 
 /**
  * PulseOscillator is an oscillator with control over pulse width,
@@ -45,8 +55,10 @@ export { PulseOscillatorOptions } from "./OscillatorInterface";
  * }, 0.1, 1);
  * @category Source
  */
-export class PulseOscillator extends Source<PulseOscillatorOptions> implements ToneOscillatorInterface {
-
+export class PulseOscillator
+	extends Source<PulseOscillatorOptions>
+	implements ToneOscillatorInterface
+{
 	readonly name: string = "PulseOscillator";
 
 	/**
@@ -86,7 +98,7 @@ export class PulseOscillator extends Source<PulseOscillatorOptions> implements T
 	 */
 	private _thresh = new WaveShaper({
 		context: this.context,
-		mapping: val => val <= 0 ? -1 : 1,
+		mapping: (val) => (val <= 0 ? -1 : 1),
 	});
 
 	/**
@@ -96,9 +108,17 @@ export class PulseOscillator extends Source<PulseOscillatorOptions> implements T
 	constructor(frequency?: Frequency, width?: AudioRange);
 	constructor(options?: Partial<PulseOscillatorOptions>);
 	constructor() {
-
-		super(optionsFromArguments(PulseOscillator.getDefaults(), arguments, ["frequency", "width"]));
-		const options = optionsFromArguments(PulseOscillator.getDefaults(), arguments, ["frequency", "width"]);
+		super(
+			optionsFromArguments(PulseOscillator.getDefaults(), arguments, [
+				"frequency",
+				"width",
+			])
+		);
+		const options = optionsFromArguments(
+			PulseOscillator.getDefaults(),
+			arguments,
+			["frequency", "width"]
+		);
 
 		this.width = new Signal({
 			context: this.context,
@@ -199,9 +219,9 @@ export class PulseOscillator extends Source<PulseOscillatorOptions> implements T
 	}
 
 	/**
-	 * *Internal use* The carrier oscillator type is fed through the 
+	 * *Internal use* The carrier oscillator type is fed through the
 	 * waveshaper node to create the pulse. Using different carrier oscillators
-	 * changes oscillator's behavior. 
+	 * changes oscillator's behavior.
 	 */
 	set carrierType(type: "triangle" | "sine") {
 		this._triangle.type = type;