tone 14.8.32 → 14.8.36

package/Tone/source/buffer/Player.test.ts

@@ -8,7 +8,6 @@ import { getContext } from "Tone/core/Global";
 import { Player } from "./Player";
 
 describe("Player", () => {
-
 	const buffer = new ToneAudioBuffer();
 
 	beforeEach(() => {
@@ -20,15 +19,18 @@ describe("Player", () => {
 	SourceTests(Player, buffer);
 
 	it("matches a file", () => {
-		return CompareToFile(() => {
-			const player = new Player(buffer).toDestination();
-			player.start(0.1).stop(0.2);
-			player.playbackRate = 2;
-		}, "player.wav", 0.005);
+		return CompareToFile(
+			() => {
+				const player = new Player(buffer).toDestination();
+				player.start(0.1).stop(0.2);
+				player.playbackRate = 2;
+			},
+			"player.wav",
+			0.005
+		);
 	});
 
 	context("Constructor", () => {
-
 		it("can be constructed with a Tone.Buffer", () => {
 			const player = new Player(buffer);
 			expect(player.buffer.get()).to.equal(buffer.get());
@@ -60,7 +62,6 @@ describe("Player", () => {
 	});
 
 	context("onstop", () => {
-
 		it("invokes the onstop method when the player is explicitly stopped", () => {
 			let wasInvoked = false;
 			return Offline(() => {
@@ -105,7 +106,6 @@ describe("Player", () => {
 	});
 
 	context("Loading", () => {
-
 		it("loads a url which was passed in", (done) => {
 			const player = new Player("./audio/sine.wav", () => {
 				expect(player.loaded).to.be.true;
@@ -131,12 +131,12 @@ describe("Player", () => {
 
 		it("invokes onerror if no url", (done) => {
 			const source = new Player({
-				url: "./nosuchfile.wav", 
+				url: "./nosuchfile.wav",
 				onerror(e) {
 					expect(e).to.be.instanceOf(Error);
 					source.dispose();
 					done();
-				}
+				},
 			});
 		});
 
@@ -152,11 +152,9 @@ describe("Player", () => {
 				url: "./audio/sine.wav",
 			});
 		});
-
 	});
 
 	context("Reverse", () => {
-
 		it("can get/set reverse", () => {
 			const player = new Player();
 			player.reverse = true;
@@ -166,7 +164,9 @@ describe("Player", () => {
 
 		it("can be played in reverse", () => {
 			const shorterBuffer = buffer.slice(0, buffer.duration / 2);
-			const audioBuffer = (shorterBuffer.get() as AudioBuffer).getChannelData(0);
+			const audioBuffer = (
+				shorterBuffer.get() as AudioBuffer
+			).getChannelData(0);
 			const lastSample = audioBuffer[audioBuffer.length - 1];
 			expect(lastSample).to.not.equal(0);
 			return Offline(() => {
@@ -180,11 +180,9 @@ describe("Player", () => {
 				expect(firstSample).to.equal(lastSample);
 			});
 		});
-
 	});
 
 	context("Looping", () => {
-
 		beforeEach(() => {
 			return buffer.load("./audio/short_sine.wav");
 		});
@@ -243,7 +241,7 @@ describe("Player", () => {
 				player.toDestination();
 				player.start(0);
 				player.loop = true;
-			}, buffer.duration * 1.5).then(buff => {
+			}, buffer.duration * 1.5).then((buff) => {
 				expect(buff.getRmsAtTime(0)).to.be.above(0);
 				expect(buff.getRmsAtTime(buffer.duration * 0.5)).to.be.above(0);
 				expect(buff.getRmsAtTime(buffer.duration)).to.be.above(0);
@@ -252,7 +250,8 @@ describe("Player", () => {
 		});
 
 		it("offset is the loopStart when set to loop", () => {
-			const testSample = buffer.toArray(0)[Math.floor(0.1 * getContext().sampleRate)];
+			const testSample =
+				buffer.toArray(0)[Math.floor(0.1 * getContext().sampleRate)];
 			return Offline(() => {
 				const player = new Player(buffer);
 				player.loopStart = 0.1;
@@ -271,10 +270,10 @@ describe("Player", () => {
 				player.loop = true;
 				player.toDestination();
 				player.start(0, 0, playDur);
-			}, buffer.duration * 2).then(buff => {
+			}, buffer.duration * 2).then((buff) => {
 				for (let time = 0; time < buffer.duration * 2; time += 0.1) {
 					const val = buff.getRmsAtTime(time);
-					if (time < (playDur - 0.01)) {
+					if (time < playDur - 0.01) {
 						expect(val).to.be.greaterThan(0);
 					} else if (time > playDur) {
 						expect(val).to.equal(0);
@@ -286,9 +285,11 @@ describe("Player", () => {
 		it("correctly compensates if the offset is greater than the loopEnd", () => {
 			return Offline(() => {
 				// make a ramp between 0-1
-				const ramp = new Float32Array(Math.floor(getContext().sampleRate * 0.3));
+				const ramp = new Float32Array(
+					Math.floor(getContext().sampleRate * 0.3)
+				);
 				for (let i = 0; i < ramp.length; i++) {
-					ramp[i] = (i / (ramp.length)) * 0.3;
+					ramp[i] = (i / ramp.length) * 0.3;
 				}
 				const buff = ToneAudioBuffer.fromArray(ramp);
 				const player = new Player(buff).toDestination();
@@ -306,7 +307,6 @@ describe("Player", () => {
 				});
 			});
 		});
-
 	});
 
 	context("PlaybackRate", () => {
@@ -344,7 +344,6 @@ describe("Player", () => {
 	});
 
 	context("Get/Set", () => {
-
 		it("can be set with an options object", () => {
 			const player = new Player();
 			expect(player.loop).to.be.false;
@@ -399,13 +398,12 @@ describe("Player", () => {
 			expect(player.playbackRate).to.equal(0.5);
 			player.dispose();
 		});
-
 	});
 
 	context("Start Scheduling", () => {
-
 		it("can be start with an offset", () => {
-			const testSample = buffer.toArray(0)[Math.floor(0.1 * getContext().sampleRate)];
+			const testSample =
+				buffer.toArray(0)[Math.floor(0.1 * getContext().sampleRate)];
 			return Offline(() => {
 				const player = new Player(buffer.get());
 				player.toDestination();
@@ -418,9 +416,11 @@ describe("Player", () => {
 		it("is stopped and restarted when start is called twice", () => {
 			return Offline(() => {
 				// make a ramp between 0-1
-				const ramp = new Float32Array(Math.floor(getContext().sampleRate * 0.3));
+				const ramp = new Float32Array(
+					Math.floor(getContext().sampleRate * 0.3)
+				);
 				for (let i = 0; i < ramp.length; i++) {
-					ramp[i] = (i / (ramp.length - 1));
+					ramp[i] = i / (ramp.length - 1);
 				}
 				const buff = new ToneAudioBuffer().fromArray(ramp);
 				const player = new Player(buff).toDestination();
@@ -442,9 +442,11 @@ describe("Player", () => {
 
 		it("can seek to a position at the given time", () => {
 			return Offline(() => {
-				const ramp = new Float32Array(Math.floor(getContext().sampleRate * 0.3));
+				const ramp = new Float32Array(
+					Math.floor(getContext().sampleRate * 0.3)
+				);
 				for (let i = 0; i < ramp.length; i++) {
-					ramp[i] = (i / (ramp.length)) * 0.3;
+					ramp[i] = (i / ramp.length) * 0.3;
 				}
 				const buff = new ToneAudioBuffer().fromArray(ramp);
 				const player = new Player(buff).toDestination();
@@ -466,7 +468,7 @@ describe("Player", () => {
 				const player = new Player(buffer);
 				player.toDestination();
 				player.start(0).stop(0.1);
-				return time => {
+				return (time) => {
 					whenBetween(time, 0.1, Infinity, () => {
 						expect(player.state).to.equal("stopped");
 					});
@@ -475,9 +477,13 @@ describe("Player", () => {
 					});
 				};
 			}, 0.3).then((buff) => {
-				buff.forEachBetween((sample) => {
-					expect(sample).to.equal(0);
-				}, 0.11, 0.15);
+				buff.forEachBetween(
+					(sample) => {
+						expect(sample).to.equal(0);
+					},
+					0.11,
+					0.15
+				);
 			});
 		});
 
@@ -495,7 +501,10 @@ describe("Player", () => {
 			return Offline(() => {
 				const player = new Player(buffer);
 				player.toDestination();
-				player.start(0, 0, 0.05).start(0.1, 0, 0.05).start(0.2, 0, 0.05);
+				player
+					.start(0, 0, 0.05)
+					.start(0.1, 0, 0.05)
+					.start(0.2, 0, 0.05);
 				player.stop(0.1);
 			}, 0.3).then((buff) => {
 				expect(buff.getTimeOfLastSound()).to.be.closeTo(0.1, 0.02);
@@ -518,7 +527,7 @@ describe("Player", () => {
 				const player = new Player(buffer);
 				player.toDestination();
 				player.start(0, 0, 0.1);
-				return time => {
+				return (time) => {
 					whenBetween(time, 0.1, Infinity, () => {
 						expect(player.state).to.equal("stopped");
 					});
@@ -549,17 +558,42 @@ describe("Player", () => {
 
 		it("plays synced to the Transport", () => {
 			return Offline(({ transport }) => {
-				const player = new Player(buffer).sync().start(0).toDestination();
+				const player = new Player(buffer)
+					.sync()
+					.start(0)
+					.toDestination();
 				transport.start(0);
 			}, 0.05).then((buff) => {
 				expect(buff.isSilent()).to.be.false;
 			});
 		});
 
+		it("does not play twice when the offset is very small", () => {
+			// addresses #999 and #944
+			return CompareToFile(
+				() => {
+					const player = new Player(buffer).toDestination();
+					player.sync().start(0);
+					getContext().transport.bpm.value = 125;
+					getContext().transport.setLoopPoints(0, "1:0:0");
+					getContext().transport.loop = true;
+					getContext().transport.start(0);
+				},
+				"playerSyncLoop.wav",
+				0.01
+			);
+		});
+
 		it("offsets correctly when started by the Transport", () => {
-			const testSample = buffer.toArray(0)[Math.floor(0.13125 * getContext().sampleRate)];
+			const testSample =
+				buffer.toArray(0)[
+					Math.floor(0.13125 * getContext().sampleRate)
+				];
 			return Offline(({ transport }) => {
-				const player = new Player(buffer).sync().start(0, 0.1).toDestination();
+				const player = new Player(buffer)
+					.sync()
+					.start(0, 0.1)
+					.toDestination();
 				transport.start(0, 0.03125);
 			}, 0.05).then((buff) => {
 				expect(buff.toArray()[0][0]).to.equal(testSample);
@@ -569,9 +603,11 @@ describe("Player", () => {
 		it("starts at the correct position when Transport is offset and playbackRate is not 1", () => {
 			return Offline(({ transport }) => {
 				// make a ramp between 0-1
-				const ramp = new Float32Array(Math.floor(getContext().sampleRate * 0.3));
+				const ramp = new Float32Array(
+					Math.floor(getContext().sampleRate * 0.3)
+				);
 				for (let i = 0; i < ramp.length; i++) {
-					ramp[i] = (i / (ramp.length));
+					ramp[i] = i / ramp.length;
 				}
 				const buff = ToneAudioBuffer.fromArray(ramp);
 				const player = new Player(buff).toDestination();
@@ -586,9 +622,11 @@ describe("Player", () => {
 
 		it("starts with an offset when synced and started after Transport is running", () => {
 			return Offline(({ transport }) => {
-				const ramp = new Float32Array(Math.floor(getContext().sampleRate * 0.3));
+				const ramp = new Float32Array(
+					Math.floor(getContext().sampleRate * 0.3)
+				);
 				for (let i = 0; i < ramp.length; i++) {
-					ramp[i] = (i / (ramp.length)) * 0.3;
+					ramp[i] = (i / ramp.length) * 0.3;
 				}
 				const buff = new ToneAudioBuffer().fromArray(ramp);
 				const player = new Player(buff).toDestination();
@@ -606,9 +644,11 @@ describe("Player", () => {
 
 		it("can pass in an offset when synced and started after Transport is running", () => {
 			return Offline(({ transport }) => {
-				const ramp = new Float32Array(Math.floor(getContext().sampleRate * 0.3));
+				const ramp = new Float32Array(
+					Math.floor(getContext().sampleRate * 0.3)
+				);
 				for (let i = 0; i < ramp.length; i++) {
-					ramp[i] = (i / (ramp.length)) * 0.3;
+					ramp[i] = (i / ramp.length) * 0.3;
 				}
 				const buff = new ToneAudioBuffer().fromArray(ramp);
 				const player = new Player(buff).toDestination();
@@ -630,12 +670,18 @@ describe("Player", () => {
 		it("fades in and out correctly", () => {
 			let duration = 0.5;
 			return Offline(() => {
-				const onesArray = new Float32Array(getContext().sampleRate * duration);
+				const onesArray = new Float32Array(
+					getContext().sampleRate * duration
+				);
 				onesArray.forEach((sample, index) => {
 					onesArray[index] = 1;
 				});
 				const onesBuffer = ToneAudioBuffer.fromArray(onesArray);
-				const player = new Player({ url: onesBuffer, fadeOut: 0.1, fadeIn: 0.1 }).toDestination();
+				const player = new Player({
+					url: onesBuffer,
+					fadeOut: 0.1,
+					fadeIn: 0.1,
+				}).toDestination();
 				player.start(0);
 			}, 0.6).then((buff) => {
 				expect(buff.getRmsAtTime(0)).to.be.closeTo(0, 0.1);
@@ -643,7 +689,10 @@ describe("Player", () => {
 				expect(buff.getRmsAtTime(0.1)).to.be.closeTo(1, 0.1);
 				duration -= 0.1;
 				expect(buff.getRmsAtTime(duration)).to.be.closeTo(1, 0.1);
-				expect(buff.getRmsAtTime(duration + 0.05)).to.be.closeTo(0.5, 0.1);
+				expect(buff.getRmsAtTime(duration + 0.05)).to.be.closeTo(
+					0.5,
+					0.1
+				);
 				expect(buff.getRmsAtTime(duration + 0.1)).to.be.closeTo(0, 0.1);
 			});
 		});

package/Tone/source/buffer/Player.ts

@@ -31,7 +31,6 @@ export interface PlayerOptions extends SourceOptions {
  * @category Source
  */
 export class Player extends Source<PlayerOptions> {
-
 	readonly name: string = "Player";
 
 	/**
@@ -86,12 +85,22 @@ export class Player extends Source<PlayerOptions> {
 	 * @param url Either the AudioBuffer or the url from which to load the AudioBuffer
 	 * @param onload The function to invoke when the buffer is loaded.
 	 */
-	constructor(url?: string | AudioBuffer | ToneAudioBuffer, onload?: () => void);
+	constructor(
+		url?: string | AudioBuffer | ToneAudioBuffer,
+		onload?: () => void
+	);
 	constructor(options?: Partial<PlayerOptions>);
 	constructor() {
-
-		super(optionsFromArguments(Player.getDefaults(), arguments, ["url", "onload"]));
-		const options = optionsFromArguments(Player.getDefaults(), arguments, ["url", "onload"]);
+		super(
+			optionsFromArguments(Player.getDefaults(), arguments, [
+				"url",
+				"onload",
+			])
+		);
+		const options = optionsFromArguments(Player.getDefaults(), arguments, [
+			"url",
+			"onload",
+		]);
 
 		this._buffer = new ToneAudioBuffer({
 			onload: this._onload.bind(this, options.onload),
@@ -157,8 +166,11 @@ export class Player extends Source<PlayerOptions> {
 
 		// delete the source from the active sources
 		this._activeSources.delete(source);
-		if (this._activeSources.size === 0 && !this._synced &&
-			this._state.getValueAtTime(this.now()) === "started") {
+		if (
+			this._activeSources.size === 0 &&
+			!this._synced &&
+			this._state.getValueAtTime(this.now()) === "started"
+		) {
 			// remove the 'implicitEnd' event and replace with an explicit end
 			this._state.cancel(this.now());
 			this._state.setStateAtTime("stopped", this.now());
@@ -196,7 +208,10 @@ export class Player extends Source<PlayerOptions> {
 
 		// compute the duration which is either the passed in duration of the buffer.duration - offset
 		const origDuration = duration;
-		duration = defaultArg(duration, Math.max(this._buffer.duration - computedOffset, 0));
+		duration = defaultArg(
+			duration,
+			Math.max(this._buffer.duration - computedOffset, 0)
+		);
 		let computedDuration = this.toSeconds(duration);
 
 		// scale it by the playback rate
@@ -223,9 +238,13 @@ export class Player extends Source<PlayerOptions> {
 			// cancel the previous stop
 			this._state.cancel(startTime + computedDuration);
 			// if it's not looping, set the state change at the end of the sample
-			this._state.setStateAtTime("stopped", startTime + computedDuration, {
-				implicitEnd: true,
-			});
+			this._state.setStateAtTime(
+				"stopped",
+				startTime + computedDuration,
+				{
+					implicitEnd: true,
+				}
+			);
 		}
 
 		// add it to the array of active sources
@@ -236,7 +255,11 @@ export class Player extends Source<PlayerOptions> {
 			source.start(startTime, computedOffset);
 		} else {
 			// subtract the fade out time
-			source.start(startTime, computedOffset, computedDuration - this.toSeconds(this.fadeOut));
+			source.start(
+				startTime,
+				computedOffset,
+				computedDuration - this.toSeconds(this.fadeOut)
+			);
 		}
 	}
 
@@ -245,14 +268,14 @@ export class Player extends Source<PlayerOptions> {
 	 */
 	protected _stop(time?: Time): void {
 		const computedTime = this.toSeconds(time);
-		this._activeSources.forEach(source => source.stop(computedTime));
+		this._activeSources.forEach((source) => source.stop(computedTime));
 	}
 
 	/**
 	 * Stop and then restart the player from the beginning (or offset)
 	 * @param  time When the player should start.
 	 * @param  offset The offset from the beginning of the sample to start at.
-	 * @param  duration How long the sample should play. If no duration is given, 
+	 * @param  duration How long the sample should play. If no duration is given,
 	 * 					it will default to the full length of the sample (minus any offset)
 	 */
 	restart(time?: Seconds, offset?: Time, duration?: Time): this {
@@ -318,7 +341,7 @@ export class Player extends Source<PlayerOptions> {
 			assertRange(this.toSeconds(loopStart), 0, this.buffer.duration);
 		}
 		// get the current source
-		this._activeSources.forEach(source => {
+		this._activeSources.forEach((source) => {
 			source.loopStart = loopStart;
 		});
 	}
@@ -335,7 +358,7 @@ export class Player extends Source<PlayerOptions> {
 			assertRange(this.toSeconds(loopEnd), 0, this.buffer.duration);
 		}
 		// get the current source
-		this._activeSources.forEach(source => {
+		this._activeSources.forEach((source) => {
 			source.loopEnd = loopEnd;
 		});
 	}
@@ -367,7 +390,7 @@ export class Player extends Source<PlayerOptions> {
 		}
 		this._loop = loop;
 		// set the loop of all of the sources
-		this._activeSources.forEach(source => {
+		this._activeSources.forEach((source) => {
 			source.loop = loop;
 		});
 		if (loop) {
@@ -399,17 +422,18 @@ export class Player extends Source<PlayerOptions> {
 		const stopEvent = this._state.getNextState("stopped", now);
 		if (stopEvent && stopEvent.implicitEnd) {
 			this._state.cancel(stopEvent.time);
-			this._activeSources.forEach(source => source.cancelStop());
+			this._activeSources.forEach((source) => source.cancelStop());
 		}
 
 		// set all the sources
-		this._activeSources.forEach(source => {
+		this._activeSources.forEach((source) => {
 			source.playbackRate.setValueAtTime(rate, now);
 		});
 	}
 
 	/**
-	 * If the buffer should be reversed
+	 * If the buffer should be reversed. Note that this sets the underlying [[ToneAudioBuffer.reverse]], so
+	 * if multiple players are pointing at the same ToneAudioBuffer, they will all be reversed.
 	 * @example
 	 * const player = new Tone.Player("https://tonejs.github.io/audio/berklee/chime_1.mp3").toDestination();
 	 * player.autostart = true;
@@ -432,7 +456,7 @@ export class Player extends Source<PlayerOptions> {
 	dispose(): this {
 		super.dispose();
 		// disconnect all of the players
-		this._activeSources.forEach(source => source.dispose());
+		this._activeSources.forEach((source) => source.dispose());
 		this._activeSources.clear();
 		this._buffer.dispose();
 		return this;

package/Tone/version.ts

@@ -1 +1 @@
-export const version: string = "14.8.32";
+export const version: string = "14.8.36";