tone 14.8.45 → 14.8.47

package/README.md

@@ -12,22 +12,24 @@ Tone.js is a Web Audio framework for creating interactive music in the browser.
 
 # Installation
 
-To install the latest stable version.
+There are two ways to incorporate Tone.js into a proejct. First, it can be installed locally into a project using `npm`:
 
 ```bash
-npm install tone
+npm install tone      // Install the latest stable version
+npm install tone@next // Or, alternatively, use the 'next' version
 ```
 
-Or to install the 'next' version
+Add Tone.js to a project using the JavaScript `import` syntax:
 
-```bash
-npm install tone@next
+```js
+import * as Tone from 'tone';
 ```
 
-To import Tone.js:
+Tone.js is also hosted at unpkg.com. It can be added directly within an HTML document, as long as it precedes any project scripts. [See the example here](https://github.com/Tonejs/Tone.js/blob/master/examples/simpleHtml.html) for more details.
 
-```js
-import * as Tone from 'tone'
+```html
+<script src="http://unpkg.com/tone"></script>
+<script src="myScript.js"></script>
 ```
 
 # Hello Tone

package/Tone/component/analysis/DCMeter.ts

@@ -4,7 +4,7 @@ import { MeterBase, MeterBaseOptions } from "./MeterBase";
 export type DCMeterOptions = MeterBaseOptions;
 
 /**
- * DCMeter gets the raw value of the input signal at the current time.
+ * DCMeter gets the raw value of the input signal at the current time. See also {@link Meter}.
  *
  * @example
  * const meter = new Tone.DCMeter();

package/Tone/component/analysis/Meter.ts

@@ -14,6 +14,9 @@ export interface MeterOptions extends MeterBaseOptions {
 /**
  * Meter gets the [RMS](https://en.wikipedia.org/wiki/Root_mean_square)
  * of an input signal. It can also get the raw value of the input signal.
+ * Setting `normalRange` to `true` will covert the output to a range of
+ * 0-1. See an example using a graphical display 
+ * [here](https://tonejs.github.io/examples/meter). See also {@link DCMeter}.
  *
  * @example
  * const meter = new Tone.Meter();

package/Tone/core/clock/Transport.ts

@@ -1,6 +1,8 @@
 import { TimeClass } from "../../core/type/Time";
 import { PlaybackState } from "../../core/util/StateTimeline";
 import { TimelineValue } from "../../core/util/TimelineValue";
+import { ToneAudioNode } from "../../core/context/ToneAudioNode";
+import { Pow } from "../../signal/Pow";
 import { Signal } from "../../signal/Signal";
 import {
 	onContextClose,
@@ -58,7 +60,7 @@ type TransportEventNames =
 interface SyncedSignalEvent {
 	signal: Signal;
 	initial: number;
-	ratio: Gain;
+	nodes: ToneAudioNode<any>[];
 }
 
 type TransportCallback = (time: Seconds) => void;
@@ -707,25 +709,45 @@ export class Transport
 	 * 			Otherwise it will be computed based on their current values.
 	 */
 	syncSignal(signal: Signal<any>, ratio?: number): this {
+		const now = this.now();
+		let source : TickParam<"bpm"> | ToneAudioNode<any> = this.bpm;
+		let sourceValue = 1 / (60 / source.getValueAtTime(now) / this.PPQ);
+		let nodes : ToneAudioNode<any>[] = [];
+		// If the signal is in the time domain, sync it to the reciprocal of
+		// the tempo instead of the tempo.
+		if (signal.units === "time") {
+			// The input to Pow should be in the range [1 / 4096, 1], where
+			// where 4096 is half of the buffer size of Pow's waveshaper.
+			// Pick a scaling factor based on the initial tempo that ensures
+			// that the initial input is in this range, while leaving room for
+			// tempo changes.
+			const scaleFactor = 1 / 64 / sourceValue;
+			const scaleBefore = new Gain(scaleFactor);
+			const reciprocal = new Pow(-1);
+			const scaleAfter = new Gain(scaleFactor);
+			// @ts-ignore
+			source.chain(scaleBefore, reciprocal, scaleAfter);
+			source = scaleAfter;
+			sourceValue = 1 / sourceValue;
+			nodes = [scaleBefore, reciprocal, scaleAfter];
+		}
 		if (!ratio) {
 			// get the sync ratio
-			const now = this.now();
 			if (signal.getValueAtTime(now) !== 0) {
-				const bpm = this.bpm.getValueAtTime(now);
-				const computedFreq = 1 / (60 / bpm / this.PPQ);
-				ratio = signal.getValueAtTime(now) / computedFreq;
+				ratio = signal.getValueAtTime(now) / sourceValue;
 			} else {
 				ratio = 0;
 			}
 		}
 		const ratioSignal = new Gain(ratio);
 		// @ts-ignore
-		this.bpm.connect(ratioSignal);
+		source.connect(ratioSignal);
 		// @ts-ignore
 		ratioSignal.connect(signal._param);
+		nodes.push(ratioSignal);
 		this._syncedSignals.push({
 			initial: signal.value,
-			ratio: ratioSignal,
+			nodes: nodes,
 			signal,
 		});
 		signal.value = 0;
@@ -740,7 +762,7 @@ export class Transport
 		for (let i = this._syncedSignals.length - 1; i >= 0; i--) {
 			const syncedSignal = this._syncedSignals[i];
 			if (syncedSignal.signal === signal) {
-				syncedSignal.ratio.dispose();
+				syncedSignal.nodes.forEach((node) => node.dispose());
 				syncedSignal.signal.value = syncedSignal.initial;
 				this._syncedSignals.splice(i, 1);
 			}

package/Tone/signal/Signal.test.ts

@@ -480,6 +480,15 @@ describe("Signal", () => {
 			}, 10);
 		});
 
+		it("keeps the ratio of a time signal when the bpm changes", () => {
+			return ConstantOutput(({ transport }) => {
+				transport.bpm.value = 120;
+				const sig = new Signal("4n", "time").toDestination();
+				transport.syncSignal(sig);
+				transport.bpm.value = 240;
+			}, 0.25);
+		});
+
 		it("outputs 0 when the signal is 0", () => {
 			return ConstantOutput(({ transport }) => {
 				transport.bpm.value = 120;

package/Tone/version.ts

@@ -1 +1 @@
-export const version: string = "14.8.45";
+export const version: string = "14.8.47";