tone 14.9.16 → 15.0.0

package/Tone/instrument/FMSynth.test.ts

@@ -1,20 +1,23 @@
 import { expect } from "chai";
-import { FMSynth } from "./FMSynth";
-import { BasicTests } from "test/helper/Basic";
-import { InstrumentTest } from "test/helper/InstrumentTests";
-import { CompareToFile } from "test/helper/CompareToFile";
-import { Offline } from "test/helper/Offline";
+import { FMSynth } from "./FMSynth.js";
+import { BasicTests } from "../../test/helper/Basic.js";
+import { InstrumentTest } from "../../test/helper/InstrumentTests.js";
+import { CompareToFile } from "../../test/helper/CompareToFile.js";
+import { Offline } from "../../test/helper/Offline.js";
 
 describe("FMSynth", () => {
-
 	BasicTests(FMSynth);
 	InstrumentTest(FMSynth, "C4");
 
 	it("matches a file", () => {
-		return CompareToFile(() => {
-			const synth = new FMSynth().toDestination();
-			synth.triggerAttackRelease("G4", 0.1, 0.05);
-		}, "fmSynth.wav", 0.06);
+		return CompareToFile(
+			() => {
+				const synth = new FMSynth().toDestination();
+				synth.triggerAttackRelease("G4", 0.1, 0.05);
+			},
+			"fmSynth.wav",
+			0.08
+		);
 	});
 
 	context("API", () => {
@@ -28,7 +31,7 @@ describe("FMSynth", () => {
 		it("invokes the onsilence callback", (done) => {
 			Offline(() => {
 				const synth = new FMSynth({
-					onsilence: () => done()
+					onsilence: () => done(),
 				});
 				synth.triggerAttackRelease("C3", 0.2, 0);
 			}, 2);
@@ -51,8 +54,8 @@ describe("FMSynth", () => {
 		it("can be constructed with an options object", () => {
 			const fmSynth = new FMSynth({
 				envelope: {
-					release: 0.3
-				}
+					release: 0.3,
+				},
 			});
 			expect(fmSynth.envelope.release).to.equal(0.3);
 			fmSynth.dispose();
@@ -62,7 +65,7 @@ describe("FMSynth", () => {
 			const fmSynth = new FMSynth();
 			fmSynth.set({
 				harmonicity: 1.5,
-				detune: 1200
+				detune: 1200,
 			});
 			expect(fmSynth.get().harmonicity).to.equal(1.5);
 			expect(fmSynth.get().detune).to.be.closeTo(1200, 1);

package/Tone/instrument/FMSynth.ts

@@ -1,8 +1,8 @@
-import { Positive } from "../core/type/Units";
-import { optionsFromArguments } from "../core/util/Defaults";
-import { RecursivePartial } from "../core/util/Interface";
-import { Multiply } from "../signal/Multiply";
-import { ModulationSynth, ModulationSynthOptions } from "./ModulationSynth";
+import { Positive } from "../core/type/Units.js";
+import { optionsFromArguments } from "../core/util/Defaults.js";
+import { RecursivePartial } from "../core/util/Interface.js";
+import { Multiply } from "../signal/Multiply.js";
+import { ModulationSynth, ModulationSynthOptions } from "./ModulationSynth.js";
 
 export interface FMSynthOptions extends ModulationSynthOptions {
 	modulationIndex: Positive;
@@ -17,7 +17,7 @@ export interface FMSynthOptions extends ModulationSynthOptions {
  * @example
  * const fmSynth = new Tone.FMSynth().toDestination();
  * fmSynth.triggerAttackRelease("C5", "4n");
- * 
+ *
  * @category Instrument
  */
 

package/Tone/instrument/Instrument.ts

@@ -1,9 +1,13 @@
-import { Volume } from "../component/channel/Volume";
-import { Param } from "../core/context/Param";
-import { OutputNode, ToneAudioNode, ToneAudioNodeOptions } from "../core/context/ToneAudioNode";
-import { Decibels, Frequency, NormalRange, Time } from "../core/type/Units";
-import { optionsFromArguments } from "../core/util/Defaults";
-import { readOnly } from "../core/util/Interface";
+import { Volume } from "../component/channel/Volume.js";
+import { Param } from "../core/context/Param.js";
+import {
+	OutputNode,
+	ToneAudioNode,
+	ToneAudioNodeOptions,
+} from "../core/context/ToneAudioNode.js";
+import { Decibels, Frequency, NormalRange, Time } from "../core/type/Units.js";
+import { optionsFromArguments } from "../core/util/Defaults.js";
+import { readOnly } from "../core/util/Interface.js";
 
 export interface InstrumentOptions extends ToneAudioNodeOptions {
 	volume: Decibels;
@@ -12,8 +16,9 @@ export interface InstrumentOptions extends ToneAudioNodeOptions {
 /**
  * Base-class for all instruments
  */
-export abstract class Instrument<Options extends InstrumentOptions> extends ToneAudioNode<Options> {
-
+export abstract class Instrument<
+	Options extends InstrumentOptions,
+> extends ToneAudioNode<Options> {
 	/**
 	 * The output and volume triming node
 	 */
@@ -47,9 +52,11 @@ export abstract class Instrument<Options extends InstrumentOptions> extends Tone
 
 	constructor(options?: Partial<InstrumentOptions>);
 	constructor() {
-
 		super(optionsFromArguments(Instrument.getDefaults(), arguments));
-		const options = optionsFromArguments(Instrument.getDefaults(), arguments);
+		const options = optionsFromArguments(
+			Instrument.getDefaults(),
+			arguments
+		);
 
 		this._volume = this.output = new Volume({
 			context: this.context,
@@ -109,7 +116,7 @@ export abstract class Instrument<Options extends InstrumentOptions> extends Tone
 	 * @param  timePosition What position the time argument appears in
 	 */
 	protected _syncMethod(method: string, timePosition: number): void {
-		const originalMethod = this["_original_" + method] = this[method];
+		const originalMethod = (this["_original_" + method] = this[method]);
 		this[method] = (...args: any[]) => {
 			const time = args[timePosition];
 			const id = this.context.transport.schedule((t) => {
@@ -124,7 +131,7 @@ export abstract class Instrument<Options extends InstrumentOptions> extends Tone
 	 * Unsync the instrument from the Transport
 	 */
 	unsync(): this {
-		this._scheduledEvents.forEach(id => this.context.transport.clear(id));
+		this._scheduledEvents.forEach((id) => this.context.transport.clear(id));
 		this._scheduledEvents = [];
 		if (this._synced) {
 			this._synced = false;
@@ -150,7 +157,12 @@ export abstract class Instrument<Options extends InstrumentOptions> extends Tone
 	 * // trigger "C4" for the duration of an 8th note
 	 * synth.triggerAttackRelease("C4", "8n");
 	 */
-	triggerAttackRelease(note: Frequency, duration: Time, time?: Time, velocity?: NormalRange): this {
+	triggerAttackRelease(
+		note: Frequency,
+		duration: Time,
+		time?: Time,
+		velocity?: NormalRange
+	): this {
 		const computedTime = this.toSeconds(time);
 		const computedDuration = this.toSeconds(duration);
 		this.triggerAttack(note, computedTime, velocity);
@@ -164,7 +176,11 @@ export abstract class Instrument<Options extends InstrumentOptions> extends Tone
 	 * @param time the time to trigger the note
 	 * @param velocity the velocity to trigger the note (between 0-1)
 	 */
-	abstract triggerAttack(note: Frequency, time?: Time, velocity?: NormalRange): this;
+	abstract triggerAttack(
+		note: Frequency,
+		time?: Time,
+		velocity?: NormalRange
+	): this;
 	private _original_triggerAttack = this.triggerAttack;
 
 	/**
@@ -175,9 +191,10 @@ export abstract class Instrument<Options extends InstrumentOptions> extends Tone
 	private _original_triggerRelease = this.triggerRelease;
 
 	/**
-	 * The release which is scheduled to the timeline. 
+	 * The release which is scheduled to the timeline.
 	 */
-	protected _syncedRelease = (time: number) => this._original_triggerRelease(time);
+	protected _syncedRelease = (time: number) =>
+		this._original_triggerRelease(time);
 
 	/**
 	 * clean up

package/Tone/instrument/MembraneSynth.test.ts

@@ -1,34 +1,40 @@
 import { expect } from "chai";
-import { BasicTests } from "test/helper/Basic";
-import { CompareToFile } from "test/helper/CompareToFile";
-import { InstrumentTest } from "test/helper/InstrumentTests";
-import { MembraneSynth } from "./MembraneSynth";
+import { BasicTests } from "../../test/helper/Basic.js";
+import { CompareToFile } from "../../test/helper/CompareToFile.js";
+import { InstrumentTest } from "../../test/helper/InstrumentTests.js";
+import { MembraneSynth } from "./MembraneSynth.js";
 
 describe("MembraneSynth", () => {
-
 	BasicTests(MembraneSynth);
 	InstrumentTest(MembraneSynth, "C2");
 
 	it("matches a file", () => {
-		return CompareToFile(() => {
-			const synth = new MembraneSynth().toDestination();
-			synth.triggerAttackRelease("F#2", 0.1, 0.05);
-		}, "membraneSynth.wav", 0.5);
+		return CompareToFile(
+			() => {
+				const synth = new MembraneSynth().toDestination();
+				synth.triggerAttackRelease("F#2", 0.1, 0.05);
+			},
+			"membraneSynth.wav",
+			0.5
+		);
 	});
 
 	it("matches another file", () => {
-		return CompareToFile(() => {
-			const synth = new MembraneSynth({
-				envelope: {
-					sustain: 0,
-				},
-			}).toDestination();
-			synth.triggerAttackRelease("C2", 0.1);
-		}, "membraneSynth2.wav", 0.5);
+		return CompareToFile(
+			() => {
+				const synth = new MembraneSynth({
+					envelope: {
+						sustain: 0,
+					},
+				}).toDestination();
+				synth.triggerAttackRelease("C2", 0.1);
+			},
+			"membraneSynth2.wav",
+			0.5
+		);
 	});
 
 	context("API", () => {
-
 		it("can get and set oscillator attributes", () => {
 			const drumSynth = new MembraneSynth();
 			drumSynth.oscillator.type = "triangle";

package/Tone/instrument/MembraneSynth.ts

@@ -1,10 +1,10 @@
-import { FrequencyClass } from "../core/type/Frequency";
-import { Frequency, Positive, Time } from "../core/type/Units";
-import { deepMerge, optionsFromArguments } from "../core/util/Defaults";
-import { readOnly, RecursivePartial } from "../core/util/Interface";
-import { Monophonic } from "./Monophonic";
-import { Synth, SynthOptions } from "./Synth";
-import { range, timeRange } from "../core/util/Decorator";
+import { FrequencyClass } from "../core/type/Frequency.js";
+import { Frequency, Positive, Time } from "../core/type/Units.js";
+import { deepMerge, optionsFromArguments } from "../core/util/Defaults.js";
+import { readOnly, RecursivePartial } from "../core/util/Interface.js";
+import { Monophonic } from "./Monophonic.js";
+import { Synth, SynthOptions } from "./Synth.js";
+import { range, timeRange } from "../core/util/Decorator.js";
 
 export interface MembraneSynthOptions extends SynthOptions {
 	pitchDecay: Time;
@@ -25,7 +25,6 @@ export interface MembraneSynthOptions extends SynthOptions {
  * @category Instrument
  */
 export class MembraneSynth extends Synth<MembraneSynthOptions> {
-
 	readonly name: string = "MembraneSynth";
 
 	/**
@@ -52,11 +51,13 @@ export class MembraneSynth extends Synth<MembraneSynthOptions> {
 	/**
 	 * @param options the options available for the synth see defaults
 	 */
-	constructor(options?: RecursivePartial<MembraneSynthOptions>)
+	constructor(options?: RecursivePartial<MembraneSynthOptions>);
 	constructor() {
-
 		super(optionsFromArguments(MembraneSynth.getDefaults(), arguments));
-		const options = optionsFromArguments(MembraneSynth.getDefaults(), arguments);
+		const options = optionsFromArguments(
+			MembraneSynth.getDefaults(),
+			arguments
+		);
 
 		this.pitchDecay = options.pitchDecay;
 		this.octaves = options.octaves;
@@ -82,10 +83,15 @@ export class MembraneSynth extends Synth<MembraneSynthOptions> {
 
 	setNote(note: Frequency | FrequencyClass, time?: Time): this {
 		const seconds = this.toSeconds(time);
-		const hertz = this.toFrequency(note instanceof FrequencyClass ? note.toFrequency() : note);
+		const hertz = this.toFrequency(
+			note instanceof FrequencyClass ? note.toFrequency() : note
+		);
 		const maxNote = hertz * this.octaves;
 		this.oscillator.frequency.setValueAtTime(maxNote, seconds);
-		this.oscillator.frequency.exponentialRampToValueAtTime(hertz, seconds + this.toSeconds(this.pitchDecay));
+		this.oscillator.frequency.exponentialRampToValueAtTime(
+			hertz,
+			seconds + this.toSeconds(this.pitchDecay)
+		);
 		return this;
 	}
 

package/Tone/instrument/MetalSynth.test.ts

@@ -1,26 +1,28 @@
 import { expect } from "chai";
-import { BasicTests } from "test/helper/Basic";
-import { CompareToFile } from "test/helper/CompareToFile";
-import { InstrumentTest } from "test/helper/InstrumentTests";
-import { MonophonicTest } from "test/helper/MonophonicTests";
-import { MetalSynth } from "./MetalSynth";
+import { BasicTests } from "../../test/helper/Basic.js";
+import { CompareToFile } from "../../test/helper/CompareToFile.js";
+import { InstrumentTest } from "../../test/helper/InstrumentTests.js";
+import { MonophonicTest } from "../../test/helper/MonophonicTests.js";
+import { MetalSynth } from "./MetalSynth.js";
 
 describe("MetalSynth", () => {
-
 	BasicTests(MetalSynth);
 
 	InstrumentTest(MetalSynth, "C2");
 	MonophonicTest(MetalSynth, "C4");
 
 	it("matches a file", () => {
-		return CompareToFile(() => {
-			const synth = new MetalSynth().toDestination();
-			synth.triggerAttackRelease(200, 0.1, 0.05);
-		}, "metalSynth.wav", 2);
+		return CompareToFile(
+			() => {
+				const synth = new MetalSynth().toDestination();
+				synth.triggerAttackRelease(200, 0.1, 0.05);
+			},
+			"metalSynth.wav",
+			2
+		);
 	});
 
 	context("API", () => {
-
 		it("can be constructed with octave and harmonicity values", () => {
 			const cymbal = new MetalSynth({
 				harmonicity: 3.1,
@@ -61,6 +63,5 @@ describe("MetalSynth", () => {
 			expect(cymbal.resonance).to.be.closeTo(2222, 1);
 			cymbal.dispose();
 		});
-
 	});
 });

package/Tone/instrument/MetalSynth.ts

@@ -1,28 +1,28 @@
-import { Envelope, EnvelopeOptions } from "../component/envelope/Envelope";
-import { Filter } from "../component/filter/Filter";
-import { Gain } from "../core/context/Gain";
+import { Envelope, EnvelopeOptions } from "../component/envelope/Envelope.js";
+import { Filter } from "../component/filter/Filter.js";
+import { Gain } from "../core/context/Gain.js";
 import {
 	ToneAudioNode,
 	ToneAudioNodeOptions,
-} from "../core/context/ToneAudioNode";
+} from "../core/context/ToneAudioNode.js";
 import {
 	Frequency,
 	NormalRange,
 	Positive,
 	Seconds,
 	Time,
-} from "../core/type/Units";
+} from "../core/type/Units.js";
 import {
 	deepMerge,
 	omitFromObject,
 	optionsFromArguments,
-} from "../core/util/Defaults";
-import { noOp, RecursivePartial } from "../core/util/Interface";
-import { Multiply } from "../signal/Multiply";
-import { Scale } from "../signal/Scale";
-import { Signal } from "../signal/Signal";
-import { FMOscillator } from "../source/oscillator/FMOscillator";
-import { Monophonic, MonophonicOptions } from "./Monophonic";
+} from "../core/util/Defaults.js";
+import { noOp, RecursivePartial } from "../core/util/Interface.js";
+import { Multiply } from "../signal/Multiply.js";
+import { Scale } from "../signal/Scale.js";
+import { Signal } from "../signal/Signal.js";
+import { FMOscillator } from "../source/oscillator/FMOscillator.js";
+import { Monophonic, MonophonicOptions } from "./Monophonic.js";
 
 export interface MetalSynthOptions extends MonophonicOptions {
 	harmonicity: Positive;

package/Tone/instrument/ModulationSynth.ts

@@ -1,17 +1,20 @@
-import { Signal } from "../signal/Signal";
-import { Multiply } from "../signal/Multiply";
-import { Gain } from "../core/context/Gain";
-import { NormalRange, Positive, Seconds, Time } from "../core/type/Units";
-import { Envelope, EnvelopeOptions } from "../component/envelope/Envelope";
-import { ToneAudioNode, ToneAudioNodeOptions } from "../core/context/ToneAudioNode";
-import { Monophonic } from "./Monophonic";
-import { OmniOscillator } from "../source/oscillator/OmniOscillator";
-import { OmniOscillatorSynthOptions } from "../source/oscillator/OscillatorInterface";
-import { Source } from "../source/Source";
-import { Synth, SynthOptions } from "./Synth";
-import { AmplitudeEnvelope } from "../component/envelope/AmplitudeEnvelope";
-import { readOnly, RecursivePartial } from "../core/util/Interface";
-import { omitFromObject, optionsFromArguments } from "../core/util/Defaults";
+import { Signal } from "../signal/Signal.js";
+import { Multiply } from "../signal/Multiply.js";
+import { Gain } from "../core/context/Gain.js";
+import { NormalRange, Positive, Seconds, Time } from "../core/type/Units.js";
+import { Envelope, EnvelopeOptions } from "../component/envelope/Envelope.js";
+import {
+	ToneAudioNode,
+	ToneAudioNodeOptions,
+} from "../core/context/ToneAudioNode.js";
+import { Monophonic } from "./Monophonic.js";
+import { OmniOscillator } from "../source/oscillator/OmniOscillator.js";
+import { OmniOscillatorSynthOptions } from "../source/oscillator/OscillatorInterface.js";
+import { Source } from "../source/Source.js";
+import { Synth, SynthOptions } from "./Synth.js";
+import { AmplitudeEnvelope } from "../component/envelope/AmplitudeEnvelope.js";
+import { readOnly, RecursivePartial } from "../core/util/Interface.js";
+import { omitFromObject, optionsFromArguments } from "../core/util/Defaults.js";
 
 export interface ModulationSynthOptions extends SynthOptions {
 	harmonicity: Positive;
@@ -21,8 +24,9 @@ export interface ModulationSynthOptions extends SynthOptions {
 /**
  * Base class for both AM and FM synths
  */
-export abstract class ModulationSynth<Options extends ModulationSynthOptions> extends Monophonic<Options> {
-
+export abstract class ModulationSynth<
+	Options extends ModulationSynthOptions,
+> extends Monophonic<Options> {
 	readonly name: string = "ModulationSynth";
 
 	/**
@@ -85,7 +89,10 @@ export abstract class ModulationSynth<Options extends ModulationSynthOptions> ex
 	constructor(options?: RecursivePartial<ModulationSynthOptions>);
 	constructor() {
 		super(optionsFromArguments(ModulationSynth.getDefaults(), arguments));
-		const options = optionsFromArguments(ModulationSynth.getDefaults(), arguments);
+		const options = optionsFromArguments(
+			ModulationSynth.getDefaults(),
+			arguments
+		);
 
 		this._carrier = new Synth({
 			context: this.context,
@@ -113,7 +120,7 @@ export abstract class ModulationSynth<Options extends ModulationSynthOptions> ex
 		this.detune = new Signal({
 			context: this.context,
 			value: options.detune,
-			units: "cents"
+			units: "cents",
 		});
 		this.harmonicity = new Multiply({
 			context: this.context,
@@ -125,7 +132,15 @@ export abstract class ModulationSynth<Options extends ModulationSynthOptions> ex
 			gain: 0,
 		});
 
-		readOnly(this, ["frequency", "harmonicity", "oscillator", "envelope", "modulation", "modulationEnvelope", "detune"]);
+		readOnly(this, [
+			"frequency",
+			"harmonicity",
+			"oscillator",
+			"envelope",
+			"modulation",
+			"modulationEnvelope",
+			"detune",
+		]);
 	}
 
 	static getDefaults(): ModulationSynthOptions {
@@ -135,10 +150,10 @@ export abstract class ModulationSynth<Options extends ModulationSynthOptions> ex
 				omitFromObject(OmniOscillator.getDefaults(), [
 					...Object.keys(Source.getDefaults()),
 					"frequency",
-					"detune"
+					"detune",
 				]),
 				{
-					type: "sine"
+					type: "sine",
 				}
 			) as OmniOscillatorSynthOptions,
 			envelope: Object.assign(
@@ -150,17 +165,17 @@ export abstract class ModulationSynth<Options extends ModulationSynthOptions> ex
 					attack: 0.01,
 					decay: 0.01,
 					sustain: 1,
-					release: 0.5
+					release: 0.5,
 				}
 			),
 			modulation: Object.assign(
 				omitFromObject(OmniOscillator.getDefaults(), [
 					...Object.keys(Source.getDefaults()),
 					"frequency",
-					"detune"
+					"detune",
 				]),
 				{
-					type: "square"
+					type: "square",
 				}
 			) as OmniOscillatorSynthOptions,
 			modulationEnvelope: Object.assign(
@@ -172,9 +187,9 @@ export abstract class ModulationSynth<Options extends ModulationSynthOptions> ex
 					attack: 0.5,
 					decay: 0.0,
 					sustain: 1,
-					release: 0.5
+					release: 0.5,
 				}
-			)
+			),
 		});
 	}
 

package/Tone/instrument/MonoSynth.test.ts

@@ -1,24 +1,26 @@
-import { BasicTests } from "test/helper/Basic";
-import { MonoSynth } from "./MonoSynth";
-import { InstrumentTest } from "test/helper/InstrumentTests";
-import { CompareToFile } from "test/helper/CompareToFile";
+import { BasicTests } from "../../test/helper/Basic.js";
+import { MonoSynth } from "./MonoSynth.js";
+import { InstrumentTest } from "../../test/helper/InstrumentTests.js";
+import { CompareToFile } from "../../test/helper/CompareToFile.js";
 import { expect } from "chai";
-import { Offline } from "test/helper/Offline";
+import { Offline } from "../../test/helper/Offline.js";
 
 describe("MonoSynth", () => {
-
 	BasicTests(MonoSynth);
 	InstrumentTest(MonoSynth, "C4");
 
 	it("matches a file", () => {
-		return CompareToFile(() => {
-			const synth = new MonoSynth().toDestination();
-			synth.triggerAttackRelease("C4", 0.1, 0.05);
-		}, "monoSynth.wav", 0.01);
+		return CompareToFile(
+			() => {
+				const synth = new MonoSynth().toDestination();
+				synth.triggerAttackRelease("C4", 0.1, 0.05);
+			},
+			"monoSynth.wav",
+			0.01
+		);
 	});
 
 	context("API", () => {
-
 		it("can get and set oscillator attributes", () => {
 			const monoSynth = new MonoSynth();
 			monoSynth.oscillator.type = "triangle";
@@ -50,8 +52,8 @@ describe("MonoSynth", () => {
 		it("can be constructed with an options object", () => {
 			const monoSynth = new MonoSynth({
 				envelope: {
-					sustain: 0.3
-				}
+					sustain: 0.3,
+				},
 			});
 			expect(monoSynth.envelope.sustain).to.equal(0.3);
 			monoSynth.dispose();
@@ -61,8 +63,8 @@ describe("MonoSynth", () => {
 			const monoSynth = new MonoSynth();
 			monoSynth.set({
 				envelope: {
-					decay: 0.24
-				}
+					decay: 0.24,
+				},
 			});
 			expect(monoSynth.get().envelope.decay).to.equal(0.24);
 			monoSynth.dispose();
@@ -75,14 +77,12 @@ describe("MonoSynth", () => {
 						attack: 0.1,
 						decay: 0.1,
 						sustain: 0,
-					}
+					},
 				}).toDestination();
 				synth.triggerAttack("C4", 0);
 			}, 0.5).then((buffer) => {
 				expect(buffer.getTimeOfLastSound()).to.be.closeTo(0.2, 0.01);
 			});
 		});
-
 	});
 });
-