tone 15.5.19 → 15.5.21

package/Tone/core/Global.test.ts

@@ -0,0 +1,19 @@
+import { expect } from "chai";
+
+import { Context } from "./context/Context.js";
+import { getContext, setContext } from "./Global.js";
+
+describe("Global", () => {
+	it("can setContext with disposeOld = true", () => {
+		const origContext = getContext();
+		const toneContext = new Context();
+
+		setContext(toneContext);
+		expect(getContext()).to.equal(toneContext);
+
+		setContext(origContext, true);
+
+		expect(getContext()).to.equal(origContext);
+		expect(toneContext.disposed).to.be.true;
+	});
+});

package/Tone/core/Global.ts

@@ -1,39 +1,18 @@
 import { version } from "../version.js";
-import {
-	AnyAudioContext,
-	hasAudioContext,
-	theWindow,
-} from "./context/AudioContext.js";
+import { AnyAudioContext, theWindow } from "./context/AudioContext.js";
 import { BaseContext } from "./context/BaseContext.js";
 import { Context } from "./context/Context.js";
-import { DummyContext } from "./context/DummyContext.js";
+import {
+	getContext,
+	setContext as _setContext,
+} from "./context/GlobalContext.js";
 import { OfflineContext } from "./context/OfflineContext.js";
 import {
 	isAudioContext,
 	isOfflineAudioContext,
 } from "./util/AdvancedTypeCheck.js";
 
-/**
- * This dummy context is used to avoid throwing immediate errors when importing in Node.js
- */
-const dummyContext = new DummyContext();
-
-/**
- * The global audio context which is getable and assignable through
- * getContext and setContext
- */
-let globalContext: BaseContext = dummyContext;
-
-/**
- * Returns the default system-wide {@link Context}
- * @category Core
- */
-export function getContext(): BaseContext {
-	if (globalContext === dummyContext && hasAudioContext) {
-		setContext(new Context());
-	}
-	return globalContext;
-}
+export { getContext };
 
 /**
  * Set the default audio context
@@ -46,15 +25,15 @@ export function setContext(
 	disposeOld = false
 ): void {
 	if (disposeOld) {
-		globalContext.dispose();
+		getContext().dispose();
 	}
 
 	if (isAudioContext(context)) {
-		globalContext = new Context(context);
+		_setContext(new Context(context));
 	} else if (isOfflineAudioContext(context)) {
-		globalContext = new OfflineContext(context);
+		_setContext(new OfflineContext(context));
 	} else {
-		globalContext = context;
+		_setContext(context);
 	}
 }
 
@@ -72,7 +51,7 @@ export function setContext(
  * @category Core
  */
 export function start(): Promise<void> {
-	return globalContext.resume();
+	return getContext().resume();
 }
 
 /**

package/Tone/core/context/Context.test.ts

@@ -221,6 +221,16 @@ describe("Context", () => {
 			}, 0.05);
 		});
 
+		it("can efficiently add and remove 10k timeouts", () => {
+			const ids: number[] = [];
+			for (let i = 0; i < 10_000; i++) {
+				ids.push(ctx.setTimeout(() => {}, i * 0.001));
+			}
+			for (const id of ids) {
+				ctx.clearTimeout(id);
+			}
+		}).timeout(100);
+
 		it("is robust against altering the timeline within the callback fn", (done) => {
 			let invokeCount = 0;
 			function checkDone(id: number) {

package/Tone/core/context/Context.ts

@@ -64,6 +64,11 @@ export class Context extends BaseContext {
 	 */
 	private _timeouts: Timeline<ContextTimeoutEvent> = new Timeline();
 
+	/**
+	 * A Map from timeout ID to event for O(1) lookup in clearTimeout.
+	 */
+	private _timeoutMap = new Map<number, ContextTimeoutEvent>();
+
 	/**
 	 * The timeout id counter
 	 */
@@ -554,6 +559,7 @@ export class Context extends BaseContext {
 		super.dispose();
 		this._ticker.dispose();
 		this._timeouts.dispose();
+		this._timeoutMap.clear();
 		Object.keys(this._constants).map((val) =>
 			this._constants[val].disconnect()
 		);
@@ -565,6 +571,26 @@ export class Context extends BaseContext {
 	// TIMEOUTS
 	//---------------------------
 
+	/**
+	 * Add a timeout event to the timeline and map.
+	 */
+	private _addTimeoutEvent(event: ContextTimeoutEvent): void {
+		this._timeouts.add(event);
+		this._timeoutMap.set(event.id, event);
+	}
+
+	/**
+	 * Remove a timeout event from the timeline and map.
+	 */
+	private _removeTimeoutEvent(event: ContextTimeoutEvent): void {
+		this._timeouts.remove(event);
+		// Skips the map deletion in setInterval case where the same id
+		// is reused for the next event.
+		if (this._timeoutMap.get(event.id) === event) {
+			this._timeoutMap.delete(event.id);
+		}
+	}
+
 	/**
 	 * The private loop which keeps track of the context scheduled timeouts
 	 * Is invoked from the clock source
@@ -575,7 +601,7 @@ export class Context extends BaseContext {
 			try {
 				event.callback();
 			} finally {
-				this._timeouts.remove(event);
+				this._removeTimeoutEvent(event);
 			}
 		});
 	}
@@ -592,7 +618,7 @@ export class Context extends BaseContext {
 	setTimeout(fn: (...args: any[]) => void, timeout: Seconds): number {
 		this._timeoutIds++;
 		const now = this.now();
-		this._timeouts.add({
+		this._addTimeoutEvent({
 			callback: fn,
 			id: this._timeoutIds,
 			time: now + timeout,
@@ -605,11 +631,10 @@ export class Context extends BaseContext {
 	 * @param id The ID returned from {@link setTimeout}.
 	 */
 	clearTimeout(id: number): this {
-		this._timeouts.forEach((event) => {
-			if (event.id === id) {
-				this._timeouts.remove(event);
-			}
-		});
+		const event = this._timeoutMap.get(id);
+		if (event) {
+			this._removeTimeoutEvent(event);
+		}
 		return this;
 	}
 
@@ -631,7 +656,7 @@ export class Context extends BaseContext {
 		const id = ++this._timeoutIds;
 		const intervalFn = () => {
 			const now = this.now();
-			this._timeouts.add({
+			this._addTimeoutEvent({
 				callback: () => {
 					// invoke the callback
 					fn();

package/Tone/core/context/GlobalContext.ts

@@ -0,0 +1,34 @@
+import { hasAudioContext } from "./AudioContext.js";
+import { BaseContext } from "./BaseContext.js";
+import { Context } from "./Context.js";
+import { DummyContext } from "./DummyContext.js";
+
+/**
+ * This dummy context is used to avoid throwing immediate errors when importing in Node.js
+ */
+export const dummyContext: BaseContext = new DummyContext();
+
+/**
+ * The global audio context which is getable and assignable through
+ * getContext and setContext
+ */
+let globalContext: BaseContext = dummyContext;
+
+/**
+ * Returns the default system-wide {@link Context}.
+ * Auto-initializes a real Context in browser environments.
+ */
+export function getContext(): BaseContext {
+	if (globalContext === dummyContext && hasAudioContext) {
+		globalContext = new Context();
+	}
+	return globalContext;
+}
+
+/**
+ * Set the global context directly. Unlike the richer `setContext` in Global.ts,
+ * this only accepts a {@link BaseContext} — no native AudioContext wrapping.
+ */
+export function setContext(context: BaseContext): void {
+	globalContext = context;
+}

package/Tone/core/context/OfflineContext.ts

@@ -1,8 +1,8 @@
 import { createOfflineAudioContext } from "../context/AudioContext.js";
 import { Context } from "../context/Context.js";
-import { getContext, setContext } from "../Global.js";
 import { Seconds } from "../type/Units.js";
 import { isOfflineAudioContext } from "../util/AdvancedTypeCheck.js";
+import { getContext, setContext } from "./GlobalContext.js";
 import { ToneAudioBuffer } from "./ToneAudioBuffer.js";
 
 /**

package/Tone/core/context/ToneAudioBuffer.ts

@@ -1,10 +1,10 @@
-import { getContext } from "../Global.js";
 import { Tone } from "../Tone.js";
 import { Samples, Seconds } from "../type/Units.js";
 import { assert } from "../util/Debug.js";
 import { optionsFromArguments } from "../util/Defaults.js";
 import { noOp } from "../util/Interface.js";
 import { isArray, isNumber, isString } from "../util/TypeCheck.js";
+import { getContext } from "./GlobalContext.js";
 
 interface ToneAudioBufferOptions {
 	url?: string | AudioBuffer | ToneAudioBuffer;

package/Tone/core/util/Timeline.test.ts

@@ -93,6 +93,10 @@ describe("Timeline", () => {
 			sched.remove({ time: 4 });
 		});
 		expect(sched.length).to.equal(1);
+		sched.add({ time: 1 });
+		sched.add({ time: 3 });
+		sched.remove({ time: 2 });
+		expect(sched.length).to.equal(3);
 		sched.dispose();
 	});
 

package/Tone/core/util/Timeline.ts

@@ -115,7 +115,7 @@ export class Timeline<GenericEvent extends TimelineEvent> extends Tone {
 	 * @returns {Timeline} this
 	 */
 	remove(event: GenericEvent): this {
-		const index = this._timeline.indexOf(event);
+		const index = this._indexOf(event);
 		if (index !== -1) {
 			this._timeline.splice(index, 1);
 		}
@@ -240,7 +240,7 @@ export class Timeline<GenericEvent extends TimelineEvent> extends Tone {
 	 * @return The event right before the given event
 	 */
 	previousEvent(event: GenericEvent): GenericEvent | null {
-		const index = this._timeline.indexOf(event);
+		const index = this._indexOf(event);
 		if (index > 0) {
 			return this._timeline[index - 1];
 		} else {
@@ -248,6 +248,34 @@ export class Timeline<GenericEvent extends TimelineEvent> extends Tone {
 		}
 	}
 
+	/**
+	 * Return the index of the given event in the timeline. -1 if it is not found.
+	 */
+	private _indexOf(event: GenericEvent): number {
+		// Use _search since internally implemented with binary search.
+		const index = this._search(event.time);
+		if (index === -1) {
+			return -1;
+		}
+		// There may be multiple events with the same time, so find the exact event
+		// Search forward and backward for events with the same time
+		for (let i = index; i < this._timeline.length; i++) {
+			if (this._timeline[i] === event) {
+				return i;
+			} else if (this._timeline[i].time !== event.time) {
+				break;
+			}
+		}
+		for (let j = index - 1; j >= 0; j--) {
+			if (this._timeline[j] === event) {
+				return j;
+			} else if (this._timeline[j].time !== event.time) {
+				break;
+			}
+		}
+		return -1;
+	}
+
 	/**
 	 * Does a binary search on the timeline array and returns the
 	 * nearest event index whose time is after or equal to the given time.

package/Tone/version.ts

@@ -1 +1 @@
-export const version: string = "15.5.19";
+export const version: string = "15.5.21";