tone 14.8.30 → 14.8.34

package/Tone/instrument/NoiseSynth.ts

@@ -4,7 +4,10 @@ import { omitFromObject, optionsFromArguments } from "../core/util/Defaults";
 import { RecursivePartial } from "../core/util/Interface";
 import { Noise, NoiseOptions } from "../source/Noise";
 import { Instrument, InstrumentOptions } from "./Instrument";
-import { ToneAudioNode, ToneAudioNodeOptions } from "../core/context/ToneAudioNode";
+import {
+	ToneAudioNode,
+	ToneAudioNodeOptions,
+} from "../core/context/ToneAudioNode";
 import { Envelope, EnvelopeOptions } from "../component/envelope/Envelope";
 import { Source } from "../source/Source";
 
@@ -14,7 +17,7 @@ export interface NoiseSynthOptions extends InstrumentOptions {
 }
 
 /**
- * Tone.NoiseSynth is composed of [[Noise]] through an [[AmplitudeEnvelope]]. 
+ * Tone.NoiseSynth is composed of [[Noise]] through an [[AmplitudeEnvelope]].
  * ```
  * +-------+   +-------------------+
  * | Noise +>--> AmplitudeEnvelope +>--> Output
@@ -26,7 +29,6 @@ export interface NoiseSynthOptions extends InstrumentOptions {
  * @category Instrument
  */
 export class NoiseSynth extends Instrument<NoiseSynthOptions> {
-
 	readonly name = "NoiseSynth";
 
 	/**
@@ -39,17 +41,30 @@ export class NoiseSynth extends Instrument<NoiseSynthOptions> {
 	 */
 	readonly envelope: AmplitudeEnvelope;
 
-	constructor(options?: RecursivePartial<NoiseSynthOptions>)
+	constructor(options?: RecursivePartial<NoiseSynthOptions>);
 	constructor() {
 		super(optionsFromArguments(NoiseSynth.getDefaults(), arguments));
-		const options = optionsFromArguments(NoiseSynth.getDefaults(), arguments);
-		this.noise = new Noise(Object.assign({
-			context: this.context,
-		}, options.noise));
+		const options = optionsFromArguments(
+			NoiseSynth.getDefaults(),
+			arguments
+		);
+		this.noise = new Noise(
+			Object.assign(
+				{
+					context: this.context,
+				},
+				options.noise
+			)
+		);
 
-		this.envelope = new AmplitudeEnvelope(Object.assign({
-			context: this.context,
-		}, options.envelope));
+		this.envelope = new AmplitudeEnvelope(
+			Object.assign(
+				{
+					context: this.context,
+				},
+				options.envelope
+			)
+		);
 
 		// connect the noise to the output
 		this.noise.chain(this.envelope, this.output);
@@ -58,17 +73,23 @@ export class NoiseSynth extends Instrument<NoiseSynthOptions> {
 	static getDefaults(): NoiseSynthOptions {
 		return Object.assign(Instrument.getDefaults(), {
 			envelope: Object.assign(
-				omitFromObject(Envelope.getDefaults(), Object.keys(ToneAudioNode.getDefaults())),
+				omitFromObject(
+					Envelope.getDefaults(),
+					Object.keys(ToneAudioNode.getDefaults())
+				),
 				{
 					decay: 0.1,
 					sustain: 0.0,
-				},
+				}
 			),
 			noise: Object.assign(
-				omitFromObject(Noise.getDefaults(), Object.keys(Source.getDefaults())),
+				omitFromObject(
+					Noise.getDefaults(),
+					Object.keys(Source.getDefaults())
+				),
 				{
 					type: "white",
-				},
+				}
 			),
 		});
 	}
@@ -87,7 +108,11 @@ export class NoiseSynth extends Instrument<NoiseSynthOptions> {
 		// start the noise
 		this.noise.start(time);
 		if (this.envelope.sustain === 0) {
-			this.noise.stop(time + this.toSeconds(this.envelope.attack) + this.toSeconds(this.envelope.decay));
+			this.noise.stop(
+				time +
+					this.toSeconds(this.envelope.attack) +
+					this.toSeconds(this.envelope.decay)
+			);
 		}
 		return this;
 	}
@@ -110,7 +135,21 @@ export class NoiseSynth extends Instrument<NoiseSynthOptions> {
 		return this;
 	}
 
-	triggerAttackRelease(duration: Time, time?: Time, velocity: NormalRange = 1): this {
+	/**
+	 * Trigger the attack and then the release after the duration.
+	 * @param duration The amount of time to hold the note for
+	 * @param time The time the note should start
+	 * @param velocity The volume of the note (0-1)
+	 * @example
+	 * const noiseSynth = new Tone.NoiseSynth().toDestination();
+	 * // hold the note for 0.5 seconds
+	 * noiseSynth.triggerAttackRelease(0.5);
+	 */
+	triggerAttackRelease(
+		duration: Time,
+		time?: Time,
+		velocity: NormalRange = 1
+	): this {
 		time = this.toSeconds(time);
 		duration = this.toSeconds(duration);
 		this.triggerAttack(time, velocity);

package/Tone/instrument/PolySynth.test.ts

@@ -135,23 +135,6 @@ describe("PolySynth", () => {
 			});
 		});
 
-		it("can be synced to the transport", () => {
-			return Offline(({ transport }) => {
-				const polySynth = new PolySynth(Synth, {
-					envelope: {
-						release: 0.1,
-					},
-				}).sync();
-				polySynth.toDestination();
-				polySynth.triggerAttackRelease("C4", 0.1, 0.1);
-				polySynth.triggerAttackRelease("E4", 0.1, 0.3);
-				transport.start(0.1);
-			}, 0.8).then((buffer) => {
-				expect(buffer.getTimeOfFirstSound()).to.be.closeTo(0.2, 0.01);
-				expect(buffer.getTimeOfLastSound()).to.be.closeTo(0.6, 0.01);
-			});
-		});
-
 		it("disposes voices when they are no longer used", () => {
 			return Offline(() => {
 				const polySynth = new PolySynth(Synth, {
@@ -266,6 +249,86 @@ describe("PolySynth", () => {
 
 	});
 
+	context("Transport sync", () => {
+		it("can be synced to the transport", () => {
+			return Offline(({ transport }) => {
+				const polySynth = new PolySynth(Synth, {
+					envelope: {
+						release: 0.1,
+					},
+				}).sync();
+				polySynth.toDestination();
+				polySynth.triggerAttackRelease("C4", 0.1, 0.1);
+				polySynth.triggerAttackRelease("E4", 0.1, 0.3);
+				transport.start(0.1);
+			}, 0.8).then((buffer) => {
+				expect(buffer.getTimeOfFirstSound()).to.be.closeTo(0.2, 0.01);
+				expect(buffer.getTimeOfLastSound()).to.be.closeTo(0.6, 0.01);
+			});
+		});
+
+		it("is silent until the transport is started", () => {
+			return Offline(({ transport }) => {
+				const synth = new PolySynth(Synth).sync().toDestination();
+				synth.triggerAttackRelease("C4", 0.5);
+				transport.start(0.5);
+			}, 1).then((buffer) => {
+				expect(buffer.getTimeOfFirstSound()).is.closeTo(0.5, 0.1);
+			});
+		});
+
+		it("stops when the transport is stopped", () => {
+			return Offline(({ transport }) => {
+				const synth = new PolySynth(Synth, {
+					envelope: {
+						release: 0
+					}
+				}).sync().toDestination();
+				synth.triggerAttackRelease("C4", 0.5);
+				transport.start(0.5).stop(1);
+			}, 1.5).then((buffer) => {
+				expect(buffer.getTimeOfLastSound()).is.closeTo(1, 0.1);
+			});
+		});
+
+		it("goes silent at the loop boundary", () => {
+			return Offline(({ transport }) => {
+				const synth = new PolySynth(Synth, {
+					envelope: {
+						release: 0
+					}
+				}).sync().toDestination();
+				synth.triggerAttackRelease("C4", 0.8, 0.5);
+				transport.loopEnd = 1;
+				transport.loop = true;
+				transport.start();
+			}, 2).then((buffer) => {
+				expect(buffer.getRmsAtTime(0)).to.be.closeTo(0, 0.05);
+				expect(buffer.getRmsAtTime(0.6)).to.be.closeTo(0.2, 0.05);
+				expect(buffer.getRmsAtTime(1.1)).to.be.closeTo(0, 0.05);
+				expect(buffer.getRmsAtTime(1.6)).to.be.closeTo(0.2, 0.05);
+			});
+		});
+
+		it("can unsync", () => {
+			return Offline(({ transport }) => {
+				const synth = new PolySynth(Synth, {
+					envelope: {
+						sustain: 1,
+						release: 0
+					}
+				}).sync().toDestination().unsync();
+				synth.triggerAttackRelease("C4", 1, 0.5);
+				transport.start().stop(1);
+			}, 2).then((buffer) => {
+				expect(buffer.getRmsAtTime(0)).to.be.closeTo(0, 0.05);
+				expect(buffer.getRmsAtTime(0.6)).to.be.closeTo(0.6, 0.05);
+				expect(buffer.getRmsAtTime(1.4)).to.be.closeTo(0.6, 0.05);
+				expect(buffer.getRmsAtTime(1.6)).to.be.closeTo(0, 0.05);
+			});
+		});
+	});
+
 	context("API", () => {
 
 		it("can be constructed with an options object", () => {
@@ -282,7 +345,7 @@ describe("PolySynth", () => {
 			expect(() => {
 				// @ts-ignore
 				new PolySynth(PluckSynth);
-			}).throws(Error)
+			}).throws(Error);
 		});
 
 		it("can pass in the volume", () => {

package/Tone/instrument/PolySynth.ts

@@ -341,10 +341,20 @@ export class PolySynth<Voice extends Monophonic<any> = Synth> extends Instrument
 		if (this._syncState()) {
 			this._syncMethod("triggerAttack", 1);
 			this._syncMethod("triggerRelease", 1);
+
+			// make sure that the sound doesn't play after its been stopped
+			this.context.transport.on("stop", this._syncedRelease);
+			this.context.transport.on("pause", this._syncedRelease);
+			this.context.transport.on("loopEnd", this._syncedRelease);
 		}
 		return this;
 	}
 
+	/**
+	 * The release which is scheduled to the timeline. 
+	 */
+	 protected _syncedRelease = (time: number) => this.releaseAll(time);
+
 	/**
 	 * Set a member/attribute of the voices
 	 * @example
@@ -382,7 +392,7 @@ export class PolySynth<Voice extends Monophonic<any> = Synth> extends Instrument
 		});
 		return this;
 	}
-
+	
 	dispose(): this {
 		super.dispose();
 		this._dummyVoice.dispose();

package/Tone/instrument/Sampler.test.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/camelcase */
 import { expect } from "chai";
 import { BasicTests } from "test/helper/Basic";
 import { CompareToFile } from "test/helper/CompareToFile";

package/Tone/instrument/Sampler.ts

@@ -138,7 +138,7 @@ export class Sampler extends Instrument<SamplerOptions> {
 		return Object.assign(Instrument.getDefaults(), {
 			attack: 0,
 			baseUrl: "",
-			curve: "exponential" as "exponential",
+			curve: "exponential" as const,
 			onload: noOp,
 			onerror: noOp,
 			release: 0.1,

package/Tone/instrument/Synth.test.ts

@@ -106,6 +106,69 @@ describe("Synth", () => {
 		});
 	});
 
+	context("Transport sync", () => {
+		it("is silent until the transport is started", () => {
+			return Offline(({ transport }) => {
+				const synth = new Synth().sync().toDestination();
+				synth.triggerAttackRelease("C4", 0.5);
+				transport.start(0.5);
+			}, 1).then((buffer) => {
+				expect(buffer.getTimeOfFirstSound()).is.closeTo(0.5, 0.1);
+			});
+		});
+
+		it("stops when the transport is stopped", () => {
+			return Offline(({ transport }) => {
+				const synth = new Synth({
+					envelope: {
+						release: 0
+					}
+				}).sync().toDestination();
+				synth.triggerAttackRelease("C4", 0.5);
+				transport.start(0.5).stop(1);
+			}, 1.5).then((buffer) => {
+				expect(buffer.getTimeOfLastSound()).is.closeTo(1, 0.1);
+			});
+		});
+
+		it("goes silent at the loop boundary", () => {
+			return Offline(({ transport }) => {
+				const synth = new Synth({
+					envelope: {
+						release: 0
+					}
+				}).sync().toDestination();
+				synth.triggerAttackRelease("C4", 0.8, 0.5);
+				transport.loopEnd = 1;
+				transport.loop = true;
+				transport.start();
+			}, 2).then((buffer) => {
+				expect(buffer.getRmsAtTime(0)).to.be.closeTo(0, 0.05);
+				expect(buffer.getRmsAtTime(0.6)).to.be.closeTo(0.2, 0.05);
+				expect(buffer.getRmsAtTime(1.1)).to.be.closeTo(0, 0.05);
+				expect(buffer.getRmsAtTime(1.6)).to.be.closeTo(0.2, 0.05);
+			});
+		});
+
+		it("can unsync", () => {
+			return Offline(({ transport }) => {
+				const synth = new Synth({
+					envelope: {
+						sustain: 1,
+						release: 0
+					}
+				}).sync().toDestination().unsync();
+				synth.triggerAttackRelease("C4", 1, 0.5);
+				transport.start().stop(1);
+			}, 2).then((buffer) => {
+				expect(buffer.getRmsAtTime(0)).to.be.closeTo(0, 0.05);
+				expect(buffer.getRmsAtTime(0.6)).to.be.closeTo(0.6, 0.05);
+				expect(buffer.getRmsAtTime(1.4)).to.be.closeTo(0.6, 0.05);
+				expect(buffer.getRmsAtTime(1.6)).to.be.closeTo(0, 0.05);
+			});
+		});
+	});
+
 	context("Portamento", () => {
 		it("can play notes with a portamento", () => {
 			return Offline(() => {

package/Tone/source/Source.ts

@@ -2,11 +2,19 @@ import { Volume } from "../component/channel/Volume";
 import "../core/context/Destination";
 import "../core/clock/Transport";
 import { Param } from "../core/context/Param";
-import { OutputNode, ToneAudioNode, ToneAudioNodeOptions } from "../core/context/ToneAudioNode";
+import {
+	OutputNode,
+	ToneAudioNode,
+	ToneAudioNodeOptions,
+} from "../core/context/ToneAudioNode";
 import { Decibels, Seconds, Time } from "../core/type/Units";
 import { defaultArg } from "../core/util/Defaults";
 import { noOp, readOnly } from "../core/util/Interface";
-import { BasicPlaybackState, StateTimeline, StateTimelineEvent } from "../core/util/StateTimeline";
+import {
+	BasicPlaybackState,
+	StateTimeline,
+	StateTimelineEvent,
+} from "../core/util/StateTimeline";
 import { isDefined, isUndef } from "../core/util/TypeCheck";
 import { assert, assertContextRunning } from "../core/util/Debug";
 import { GT } from "../core/util/Math";
@@ -20,9 +28,9 @@ export interface SourceOptions extends ToneAudioNodeOptions {
 }
 
 /**
- * Base class for sources. 
+ * Base class for sources.
  * start/stop of this.context.transport.
- * 
+ *
  * ```
  * // Multiple state change events can be chained together,
  * // but must be set in the correct order and with ascending times
@@ -36,8 +44,9 @@ export interface SourceOptions extends ToneAudioNodeOptions {
  * state.start("+0.3").stop("+0.2");
  * ```
  */
-export abstract class Source<Options extends SourceOptions> extends ToneAudioNode<Options> {
-
+export abstract class Source<
+	Options extends SourceOptions
+> extends ToneAudioNode<Options> {
 	/**
 	 * The output volume node
 	 */
@@ -129,7 +138,9 @@ export abstract class Source<Options extends SourceOptions> extends ToneAudioNod
 	get state(): BasicPlaybackState {
 		if (this._synced) {
 			if (this.context.transport.state === "started") {
-				return this._state.getValueAtTime(this.context.transport.seconds) as BasicPlaybackState;
+				return this._state.getValueAtTime(
+					this.context.transport.seconds
+				) as BasicPlaybackState;
 			} else {
 				return "stopped";
 			}
@@ -155,7 +166,11 @@ export abstract class Source<Options extends SourceOptions> extends ToneAudioNod
 	// overwrite these functions
 	protected abstract _start(time: Time, offset?: Time, duration?: Time): void;
 	protected abstract _stop(time: Time): void;
-	protected abstract _restart(time: Seconds, offset?: Time, duration?: Time): void;
+	protected abstract _restart(
+		time: Seconds,
+		offset?: Time,
+		duration?: Time
+	): void;
 
 	/**
 	 * Ensure that the scheduled time is not before the current time.
@@ -178,12 +193,24 @@ export abstract class Source<Options extends SourceOptions> extends ToneAudioNod
 	 * source.start("+0.5"); // starts the source 0.5 seconds from now
 	 */
 	start(time?: Time, offset?: Time, duration?: Time): this {
-		let computedTime = isUndef(time) && this._synced ? this.context.transport.seconds : this.toSeconds(time);
+		let computedTime =
+			isUndef(time) && this._synced
+				? this.context.transport.seconds
+				: this.toSeconds(time);
 		computedTime = this._clampToCurrentTime(computedTime);
 		// if it's started, stop it and restart it
-		if (!this._synced && this._state.getValueAtTime(computedTime) === "started") {
+		if (
+			!this._synced &&
+			this._state.getValueAtTime(computedTime) === "started"
+		) {
 			// time should be strictly greater than the previous start time
-			assert(GT(computedTime, (this._state.get(computedTime) as StateTimelineEvent).time), "Start time must be strictly greater than previous start time");
+			assert(
+				GT(
+					computedTime,
+					(this._state.get(computedTime) as StateTimelineEvent).time
+				),
+				"Start time must be strictly greater than previous start time"
+			);
 			this._state.cancel(computedTime);
 			this._state.setStateAtTime("started", computedTime);
 			this.log("restart", computedTime);
@@ -196,18 +223,26 @@ export abstract class Source<Options extends SourceOptions> extends ToneAudioNod
 				const event = this._state.get(computedTime);
 				if (event) {
 					event.offset = this.toSeconds(defaultArg(offset, 0));
-					event.duration = duration ? this.toSeconds(duration) : undefined;
+					event.duration = duration
+						? this.toSeconds(duration)
+						: undefined;
 				}
-				const sched = this.context.transport.schedule(t => {
+				const sched = this.context.transport.schedule((t) => {
 					this._start(t, offset, duration);
 				}, computedTime);
 				this._scheduled.push(sched);
 
 				// if the transport is already started
 				// and the time is greater than where the transport is
-				if (this.context.transport.state === "started" && 
-					this.context.transport.getSecondsAtTime(this.immediate()) > computedTime) {
-					this._syncedStart(this.now(), this.context.transport.seconds);
+				if (
+					this.context.transport.state === "started" &&
+					this.context.transport.getSecondsAtTime(this.immediate()) >
+						computedTime
+				) {
+					this._syncedStart(
+						this.now(),
+						this.context.transport.seconds
+					);
 				}
 			} else {
 				assertContextRunning(this.context);
@@ -227,14 +262,23 @@ export abstract class Source<Options extends SourceOptions> extends ToneAudioNod
 	 * source.stop("+0.5"); // stops the source 0.5 seconds from now
 	 */
 	stop(time?: Time): this {
-		let computedTime = isUndef(time) && this._synced ? this.context.transport.seconds : this.toSeconds(time);
+		let computedTime =
+			isUndef(time) && this._synced
+				? this.context.transport.seconds
+				: this.toSeconds(time);
 		computedTime = this._clampToCurrentTime(computedTime);
-		if (this._state.getValueAtTime(computedTime) === "started" || isDefined(this._state.getNextState("started", computedTime))) {
+		if (
+			this._state.getValueAtTime(computedTime) === "started" ||
+			isDefined(this._state.getNextState("started", computedTime))
+		) {
 			this.log("stop", computedTime);
 			if (!this._synced) {
 				this._stop(computedTime);
 			} else {
-				const sched = this.context.transport.schedule(this._stop.bind(this), computedTime);
+				const sched = this.context.transport.schedule(
+					this._stop.bind(this),
+					computedTime
+				);
 				this._scheduled.push(sched);
 			}
 			this._state.cancel(computedTime);
@@ -274,23 +318,36 @@ export abstract class Source<Options extends SourceOptions> extends ToneAudioNod
 		if (!this._synced) {
 			this._synced = true;
 			this._syncedStart = (time, offset) => {
-				if (offset > 0) {
+				if (GT(offset, 0)) {
 					// get the playback state at that time
 					const stateEvent = this._state.get(offset);
 					// listen for start events which may occur in the middle of the sync'ed time
-					if (stateEvent && stateEvent.state === "started" && stateEvent.time !== offset) {
+					if (
+						stateEvent &&
+						stateEvent.state === "started" &&
+						stateEvent.time !== offset
+					) {
 						// get the offset
-						const startOffset = offset - this.toSeconds(stateEvent.time);
+						const startOffset =
+							offset - this.toSeconds(stateEvent.time);
 						let duration: number | undefined;
 						if (stateEvent.duration) {
-							duration = this.toSeconds(stateEvent.duration) - startOffset;
+							duration =
+								this.toSeconds(stateEvent.duration) -
+								startOffset;
 						}
-						this._start(time, this.toSeconds(stateEvent.offset) + startOffset, duration);
+						this._start(
+							time,
+							this.toSeconds(stateEvent.offset) + startOffset,
+							duration
+						);
 					}
 				}
 			};
-			this._syncedStop = time => {
-				const seconds = this.context.transport.getSecondsAtTime(Math.max(time - this.sampleTime, 0));
+			this._syncedStop = (time) => {
+				const seconds = this.context.transport.getSecondsAtTime(
+					Math.max(time - this.sampleTime, 0)
+				);
 				if (this._state.getValueAtTime(seconds) === "started") {
 					this._stop(time);
 				}
@@ -317,7 +374,7 @@ export abstract class Source<Options extends SourceOptions> extends ToneAudioNod
 		}
 		this._synced = false;
 		// clear all of the scheduled ids
-		this._scheduled.forEach(id => this.context.transport.clear(id));
+		this._scheduled.forEach((id) => this.context.transport.clear(id));
 		this._scheduled = [];
 		this._state.cancel(0);
 		// stop it also