tone 14.8.27

package/build/esm/source/oscillator/FatOscillator.js

@@ -0,0 +1,195 @@
+import { __awaiter } from "tslib";
+import { optionsFromArguments } from "../../core/util/Defaults";
+import { noOp, readOnly } from "../../core/util/Interface";
+import { Signal } from "../../signal/Signal";
+import { Source } from "../Source";
+import { Oscillator } from "./Oscillator";
+import { generateWaveform } from "./OscillatorInterface";
+import { assertRange } from "../../core/util/Debug";
+/**
+ * FatOscillator is an array of oscillators with detune spread between the oscillators
+ * @example
+ * const fatOsc = new Tone.FatOscillator("Ab3", "sawtooth", 40).toDestination().start();
+ * @category Source
+ */
+export class FatOscillator extends Source {
+    constructor() {
+        super(optionsFromArguments(FatOscillator.getDefaults(), arguments, ["frequency", "type", "spread"]));
+        this.name = "FatOscillator";
+        /**
+         * The array of oscillators
+         */
+        this._oscillators = [];
+        const options = optionsFromArguments(FatOscillator.getDefaults(), arguments, ["frequency", "type", "spread"]);
+        this.frequency = new Signal({
+            context: this.context,
+            units: "frequency",
+            value: options.frequency,
+        });
+        this.detune = new Signal({
+            context: this.context,
+            units: "cents",
+            value: options.detune,
+        });
+        this._spread = options.spread;
+        this._type = options.type;
+        this._phase = options.phase;
+        this._partials = options.partials;
+        this._partialCount = options.partialCount;
+        // set the count initially
+        this.count = options.count;
+        readOnly(this, ["frequency", "detune"]);
+    }
+    static getDefaults() {
+        return Object.assign(Oscillator.getDefaults(), {
+            count: 3,
+            spread: 20,
+            type: "sawtooth",
+        });
+    }
+    /**
+     * start the oscillator
+     */
+    _start(time) {
+        time = this.toSeconds(time);
+        this._forEach(osc => osc.start(time));
+    }
+    /**
+     * stop the oscillator
+     */
+    _stop(time) {
+        time = this.toSeconds(time);
+        this._forEach(osc => osc.stop(time));
+    }
+    _restart(time) {
+        this._forEach(osc => osc.restart(time));
+    }
+    /**
+     * Iterate over all of the oscillators
+     */
+    _forEach(iterator) {
+        for (let i = 0; i < this._oscillators.length; i++) {
+            iterator(this._oscillators[i], i);
+        }
+    }
+    /**
+     * The type of the oscillator
+     */
+    get type() {
+        return this._type;
+    }
+    set type(type) {
+        this._type = type;
+        this._forEach(osc => osc.type = type);
+    }
+    /**
+     * The detune spread between the oscillators. If "count" is
+     * set to 3 oscillators and the "spread" is set to 40,
+     * the three oscillators would be detuned like this: [-20, 0, 20]
+     * for a total detune spread of 40 cents.
+     * @example
+     * const fatOsc = new Tone.FatOscillator().toDestination().start();
+     * fatOsc.spread = 70;
+     */
+    get spread() {
+        return this._spread;
+    }
+    set spread(spread) {
+        this._spread = spread;
+        if (this._oscillators.length > 1) {
+            const start = -spread / 2;
+            const step = spread / (this._oscillators.length - 1);
+            this._forEach((osc, i) => osc.detune.value = start + step * i);
+        }
+    }
+    /**
+     * The number of detuned oscillators. Must be an integer greater than 1.
+     * @example
+     * const fatOsc = new Tone.FatOscillator("C#3", "sawtooth").toDestination().start();
+     * // use 4 sawtooth oscillators
+     * fatOsc.count = 4;
+     */
+    get count() {
+        return this._oscillators.length;
+    }
+    set count(count) {
+        assertRange(count, 1);
+        if (this._oscillators.length !== count) {
+            // dispose the previous oscillators
+            this._forEach(osc => osc.dispose());
+            this._oscillators = [];
+            for (let i = 0; i < count; i++) {
+                const osc = new Oscillator({
+                    context: this.context,
+                    volume: -6 - count * 1.1,
+                    type: this._type,
+                    phase: this._phase + (i / count) * 360,
+                    partialCount: this._partialCount,
+                    onstop: i === 0 ? () => this.onstop(this) : noOp,
+                });
+                if (this.type === "custom") {
+                    osc.partials = this._partials;
+                }
+                this.frequency.connect(osc.frequency);
+                this.detune.connect(osc.detune);
+                osc.detune.overridden = false;
+                osc.connect(this.output);
+                this._oscillators[i] = osc;
+            }
+            // set the spread
+            this.spread = this._spread;
+            if (this.state === "started") {
+                this._forEach(osc => osc.start());
+            }
+        }
+    }
+    get phase() {
+        return this._phase;
+    }
+    set phase(phase) {
+        this._phase = phase;
+        this._forEach((osc, i) => osc.phase = this._phase + (i / this.count) * 360);
+    }
+    get baseType() {
+        return this._oscillators[0].baseType;
+    }
+    set baseType(baseType) {
+        this._forEach(osc => osc.baseType = baseType);
+        this._type = this._oscillators[0].type;
+    }
+    get partials() {
+        return this._oscillators[0].partials;
+    }
+    set partials(partials) {
+        this._partials = partials;
+        this._partialCount = this._partials.length;
+        if (partials.length) {
+            this._type = "custom";
+            this._forEach(osc => osc.partials = partials);
+        }
+    }
+    get partialCount() {
+        return this._oscillators[0].partialCount;
+    }
+    set partialCount(partialCount) {
+        this._partialCount = partialCount;
+        this._forEach(osc => osc.partialCount = partialCount);
+        this._type = this._oscillators[0].type;
+    }
+    asArray(length = 1024) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return generateWaveform(this, length);
+        });
+    }
+    /**
+     * Clean up.
+     */
+    dispose() {
+        super.dispose();
+        this.frequency.dispose();
+        this.detune.dispose();
+        this._forEach(osc => osc.dispose());
+        return this;
+    }
+}
+//# sourceMappingURL=FatOscillator.js.map

package/build/esm/source/oscillator/FatOscillator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FatOscillator.js","sourceRoot":"","sources":["../../../../Tone/source/oscillator/FatOscillator.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAEN,gBAAgB,EAChB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAIpD;;;;;GAKG;AACH,MAAM,OAAO,aAAc,SAAQ,MAA4B;IA4C9D;QAEC,KAAK,CAAC,oBAAoB,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;QA5C7F,SAAI,GAAW,eAAe,CAAC;QAKxC;;WAEG;QACK,iBAAY,GAAiB,EAAE,CAAC;QAqCvC,MAAM,OAAO,GAAG,oBAAoB,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;QAE9G,IAAI,CAAC,SAAS,GAAG,IAAI,MAAM,CAAC;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,WAAW;YAClB,KAAK,EAAE,OAAO,CAAC,SAAS;SACxB,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC;YACxB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,OAAO;YACd,KAAK,EAAE,OAAO,CAAC,MAAM;SACrB,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;QAC1B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC;QAClC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;QAE1C,0BAA0B;QAC1B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAE3B,QAAQ,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE;YAC9C,KAAK,EAAE,CAAC;YACR,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,UAAU;SAChB,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACO,MAAM,CAAC,IAAU;QAC1B,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACvC,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,IAAU;QACzB,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACtC,CAAC;IAES,QAAQ,CAAC,IAAa;QAC/B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACzC,CAAC;IAED;;OAEG;IACK,QAAQ,CAAC,QAAkD;QAClE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAClD,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;SAClC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACP,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IACD,IAAI,IAAI,CAAC,IAAwB;QAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;;OAQG;IACH,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IACD,IAAI,MAAM,CAAC,MAAa;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE;YACjC,MAAM,KAAK,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;YAC1B,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACrD,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,GAAG,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC;SAC/D;IACF,CAAC;IAED;;;;;;OAMG;IACH,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC;IACjC,CAAC;IACD,IAAI,KAAK,CAAC,KAAa;QACtB,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACtB,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,KAAK,KAAK,EAAE;YACvC,mCAAmC;YACnC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YACpC,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;YACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE;gBAC/B,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC;oBAC1B,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,MAAM,EAAE,CAAC,CAAC,GAAG,KAAK,GAAG,GAAG;oBACxB,IAAI,EAAE,IAAI,CAAC,KAAgC;oBAC3C,KAAK,EAAE,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,GAAG;oBACtC,YAAY,EAAE,IAAI,CAAC,aAAa;oBAChC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;iBAChD,CAAC,CAAC;gBACH,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE;oBAC3B,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;iBAC9B;gBACD,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;gBACtC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAChC,GAAG,CAAC,MAAM,CAAC,UAAU,GAAG,KAAK,CAAC;gBAC9B,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACzB,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;aAC3B;YACD,iBAAiB;YACjB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;YAC3B,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;gBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;aAClC;SACD;IACF,CAAC;IAED,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;IACD,IAAI,KAAK,CAAC,KAAc;QACvB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC;IAC7E,CAAC;IAED,IAAI,QAAQ;QACX,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IACtC,CAAC;IACD,IAAI,QAAQ,CAAC,QAAwB;QACpC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC;QAC9C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACxC,CAAC;IAED,IAAI,QAAQ;QACX,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IACtC,CAAC;IACD,IAAI,QAAQ,CAAC,QAAkB;QAC9B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;QAC3C,IAAI,QAAQ,CAAC,MAAM,EAAE;YACpB,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;YACtB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC;SAC9C;IACF,CAAC;IAED,IAAI,YAAY;QACf,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;IAC1C,CAAC;IACD,IAAI,YAAY,CAAC,YAAoB;QACpC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,YAAY,GAAG,YAAY,CAAC,CAAC;QACtD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACxC,CAAC;IAEK,OAAO,CAAC,MAAM,GAAG,IAAI;;YAC1B,OAAO,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACvC,CAAC;KAAA;IAED;;OAEG;IACH,OAAO;QACN,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACtB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC;IACb,CAAC;CACD"}

package/build/esm/source/oscillator/LFO.d.ts

@@ -0,0 +1,167 @@
+import { Param } from "../../core/context/Param";
+import { InputNode, OutputNode, ToneAudioNode } from "../../core/context/ToneAudioNode";
+import { Degrees, Frequency, NormalRange, Time, UnitName } from "../../core/type/Units";
+import { BasicPlaybackState } from "../../core/util/StateTimeline";
+import { Signal } from "../../signal/Signal";
+import { ToneOscillatorType } from "./Oscillator";
+import { ToneOscillatorOptions } from "./OscillatorInterface";
+export declare type LFOOptions = {
+    min: number;
+    max: number;
+    amplitude: NormalRange;
+    units: UnitName;
+} & ToneOscillatorOptions;
+/**
+ * LFO stands for low frequency oscillator. LFO produces an output signal
+ * which can be attached to an AudioParam or Tone.Signal
+ * in order to modulate that parameter with an oscillator. The LFO can
+ * also be synced to the transport to start/stop and change when the tempo changes.
+ * @example
+ * return Tone.Offline(() => {
+ * 	const lfo = new Tone.LFO("4n", 400, 4000).start().toDestination();
+ * }, 0.5, 1);
+ * @category Source
+ */
+export declare class LFO extends ToneAudioNode<LFOOptions> {
+    readonly name: string;
+    /**
+     * The oscillator.
+     */
+    private _oscillator;
+    /**
+     * The gain of the output
+     */
+    private _amplitudeGain;
+    /**
+     * The amplitude of the LFO, which controls the output range between
+     * the min and max output. For example if the min is -10 and the max
+     * is 10, setting the amplitude to 0.5 would make the LFO modulate
+     * between -5 and 5.
+     */
+    readonly amplitude: Param<"normalRange">;
+    /**
+     * The signal which is output when the LFO is stopped
+     */
+    private _stoppedSignal;
+    /**
+     * Just outputs zeros. This is used so that scaled signal is not
+     * optimized to silence.
+     */
+    private _zeros;
+    /**
+     * The value that the LFO outputs when it's stopped
+     */
+    private _stoppedValue;
+    /**
+     * Convert the oscillators audio range to an output between 0-1 so it can be scaled
+     */
+    private _a2g;
+    /**
+     * Scales the final output to the min and max value
+     */
+    private _scaler;
+    /**
+     * The output of the LFO
+     */
+    readonly output: OutputNode;
+    /**
+     * There is no input node
+     */
+    readonly input: undefined;
+    /**
+     * A private placeholder for the units
+     */
+    private _units;
+    /**
+     * If the input value is converted using the [[units]]
+     */
+    convert: boolean;
+    /**
+     * The frequency value of the LFO
+     */
+    readonly frequency: Signal<"frequency">;
+    /**
+     * @param frequency The frequency of the oscillation.
+     * Typically, LFOs will be in the frequency range of 0.1 to 10 hertz.
+     * @param min The minimum output value of the LFO.
+     * @param max The maximum value of the LFO.
+     */
+    constructor(frequency?: Frequency, min?: number, max?: number);
+    constructor(options?: Partial<LFOOptions>);
+    static getDefaults(): LFOOptions;
+    /**
+     * Start the LFO.
+     * @param time The time the LFO will start
+     */
+    start(time?: Time): this;
+    /**
+     * Stop the LFO.
+     * @param  time The time the LFO will stop
+     */
+    stop(time?: Time): this;
+    /**
+     * Sync the start/stop/pause to the transport
+     * and the frequency to the bpm of the transport
+     * @example
+     * const lfo = new Tone.LFO("8n");
+     * lfo.sync().start(0);
+     * // the rate of the LFO will always be an eighth note, even as the tempo changes
+     */
+    sync(): this;
+    /**
+     * unsync the LFO from transport control
+     */
+    unsync(): this;
+    /**
+     * After the oscillator waveform is updated, reset the `_stoppedSignal` value to match the updated waveform
+     */
+    private _setStoppedValue;
+    /**
+     * The minimum output of the LFO.
+     */
+    get min(): number;
+    set min(min: number);
+    /**
+     * The maximum output of the LFO.
+     */
+    get max(): number;
+    set max(max: number);
+    /**
+     * The type of the oscillator: See [[Oscillator.type]]
+     */
+    get type(): ToneOscillatorType;
+    set type(type: ToneOscillatorType);
+    /**
+     * The oscillator's partials array: See [[Oscillator.partials]]
+     */
+    get partials(): number[];
+    set partials(partials: number[]);
+    /**
+     * The phase of the LFO.
+     */
+    get phase(): Degrees;
+    set phase(phase: Degrees);
+    /**
+     * The output units of the LFO.
+     */
+    get units(): UnitName;
+    set units(val: UnitName);
+    /**
+     * Returns the playback state of the source, either "started" or "stopped".
+     */
+    get state(): BasicPlaybackState;
+    /**
+     * @param node the destination to connect to
+     * @param outputNum the optional output number
+     * @param inputNum the input number
+     */
+    connect(node: InputNode, outputNum?: number, inputNum?: number): this;
+    /**
+     * Private methods borrowed from Param
+     */
+    private _fromType;
+    private _toType;
+    private _is;
+    private _clampValue;
+    dispose(): this;
+}

package/build/esm/source/oscillator/LFO.js

@@ -0,0 +1,233 @@
+import { Gain } from "../../core/context/Gain";
+import { Param } from "../../core/context/Param";
+import { ToneAudioNode } from "../../core/context/ToneAudioNode";
+import { optionsFromArguments } from "../../core/util/Defaults";
+import { readOnly } from "../../core/util/Interface";
+import { AudioToGain } from "../../signal/AudioToGain";
+import { Scale } from "../../signal/Scale";
+import { connectSignal, Signal } from "../../signal/Signal";
+import { Zero } from "../../signal/Zero";
+import { Oscillator } from "./Oscillator";
+/**
+ * LFO stands for low frequency oscillator. LFO produces an output signal
+ * which can be attached to an AudioParam or Tone.Signal
+ * in order to modulate that parameter with an oscillator. The LFO can
+ * also be synced to the transport to start/stop and change when the tempo changes.
+ * @example
+ * return Tone.Offline(() => {
+ * 	const lfo = new Tone.LFO("4n", 400, 4000).start().toDestination();
+ * }, 0.5, 1);
+ * @category Source
+ */
+export class LFO extends ToneAudioNode {
+    constructor() {
+        super(optionsFromArguments(LFO.getDefaults(), arguments, ["frequency", "min", "max"]));
+        this.name = "LFO";
+        /**
+         * The value that the LFO outputs when it's stopped
+         */
+        this._stoppedValue = 0;
+        /**
+         * A private placeholder for the units
+         */
+        this._units = "number";
+        /**
+         * If the input value is converted using the [[units]]
+         */
+        this.convert = true;
+        /**
+         * Private methods borrowed from Param
+         */
+        // @ts-ignore
+        this._fromType = Param.prototype._fromType;
+        // @ts-ignore
+        this._toType = Param.prototype._toType;
+        // @ts-ignore
+        this._is = Param.prototype._is;
+        // @ts-ignore
+        this._clampValue = Param.prototype._clampValue;
+        const options = optionsFromArguments(LFO.getDefaults(), arguments, ["frequency", "min", "max"]);
+        this._oscillator = new Oscillator(options);
+        this.frequency = this._oscillator.frequency;
+        this._amplitudeGain = new Gain({
+            context: this.context,
+            gain: options.amplitude,
+            units: "normalRange",
+        });
+        this.amplitude = this._amplitudeGain.gain;
+        this._stoppedSignal = new Signal({
+            context: this.context,
+            units: "audioRange",
+            value: 0,
+        });
+        this._zeros = new Zero({ context: this.context });
+        this._a2g = new AudioToGain({ context: this.context });
+        this._scaler = this.output = new Scale({
+            context: this.context,
+            max: options.max,
+            min: options.min,
+        });
+        this.units = options.units;
+        this.min = options.min;
+        this.max = options.max;
+        // connect it up
+        this._oscillator.chain(this._amplitudeGain, this._a2g, this._scaler);
+        this._zeros.connect(this._a2g);
+        this._stoppedSignal.connect(this._a2g);
+        readOnly(this, ["amplitude", "frequency"]);
+        this.phase = options.phase;
+    }
+    static getDefaults() {
+        return Object.assign(Oscillator.getDefaults(), {
+            amplitude: 1,
+            frequency: "4n",
+            max: 1,
+            min: 0,
+            type: "sine",
+            units: "number",
+        });
+    }
+    /**
+     * Start the LFO.
+     * @param time The time the LFO will start
+     */
+    start(time) {
+        time = this.toSeconds(time);
+        this._stoppedSignal.setValueAtTime(0, time);
+        this._oscillator.start(time);
+        return this;
+    }
+    /**
+     * Stop the LFO.
+     * @param  time The time the LFO will stop
+     */
+    stop(time) {
+        time = this.toSeconds(time);
+        this._stoppedSignal.setValueAtTime(this._stoppedValue, time);
+        this._oscillator.stop(time);
+        return this;
+    }
+    /**
+     * Sync the start/stop/pause to the transport
+     * and the frequency to the bpm of the transport
+     * @example
+     * const lfo = new Tone.LFO("8n");
+     * lfo.sync().start(0);
+     * // the rate of the LFO will always be an eighth note, even as the tempo changes
+     */
+    sync() {
+        this._oscillator.sync();
+        this._oscillator.syncFrequency();
+        return this;
+    }
+    /**
+     * unsync the LFO from transport control
+     */
+    unsync() {
+        this._oscillator.unsync();
+        this._oscillator.unsyncFrequency();
+        return this;
+    }
+    /**
+     * After the oscillator waveform is updated, reset the `_stoppedSignal` value to match the updated waveform
+     */
+    _setStoppedValue() {
+        this._stoppedValue = this._oscillator.getInitialValue();
+        this._stoppedSignal.value = this._stoppedValue;
+    }
+    /**
+     * The minimum output of the LFO.
+     */
+    get min() {
+        return this._toType(this._scaler.min);
+    }
+    set min(min) {
+        min = this._fromType(min);
+        this._scaler.min = min;
+    }
+    /**
+     * The maximum output of the LFO.
+     */
+    get max() {
+        return this._toType(this._scaler.max);
+    }
+    set max(max) {
+        max = this._fromType(max);
+        this._scaler.max = max;
+    }
+    /**
+     * The type of the oscillator: See [[Oscillator.type]]
+     */
+    get type() {
+        return this._oscillator.type;
+    }
+    set type(type) {
+        this._oscillator.type = type;
+        this._setStoppedValue();
+    }
+    /**
+     * The oscillator's partials array: See [[Oscillator.partials]]
+     */
+    get partials() {
+        return this._oscillator.partials;
+    }
+    set partials(partials) {
+        this._oscillator.partials = partials;
+        this._setStoppedValue();
+    }
+    /**
+     * The phase of the LFO.
+     */
+    get phase() {
+        return this._oscillator.phase;
+    }
+    set phase(phase) {
+        this._oscillator.phase = phase;
+        this._setStoppedValue();
+    }
+    /**
+     * The output units of the LFO.
+     */
+    get units() {
+        return this._units;
+    }
+    set units(val) {
+        const currentMin = this.min;
+        const currentMax = this.max;
+        // convert the min and the max
+        this._units = val;
+        this.min = currentMin;
+        this.max = currentMax;
+    }
+    /**
+     * Returns the playback state of the source, either "started" or "stopped".
+     */
+    get state() {
+        return this._oscillator.state;
+    }
+    /**
+     * @param node the destination to connect to
+     * @param outputNum the optional output number
+     * @param inputNum the input number
+     */
+    connect(node, outputNum, inputNum) {
+        if (node instanceof Param || node instanceof Signal) {
+            this.convert = node.convert;
+            this.units = node.units;
+        }
+        connectSignal(this, node, outputNum, inputNum);
+        return this;
+    }
+    dispose() {
+        super.dispose();
+        this._oscillator.dispose();
+        this._stoppedSignal.dispose();
+        this._zeros.dispose();
+        this._scaler.dispose();
+        this._a2g.dispose();
+        this._amplitudeGain.dispose();
+        this.amplitude.dispose();
+        return this;
+    }
+}
+//# sourceMappingURL=LFO.js.map

package/build/esm/source/oscillator/LFO.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LFO.js","sourceRoot":"","sources":["../../../../Tone/source/oscillator/LFO.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAyB,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAExF,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAErD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,UAAU,EAAsB,MAAM,cAAc,CAAC;AAU9D;;;;;;;;;;GAUG;AACH,MAAM,OAAO,GAAI,SAAQ,aAAyB;IAiFjD;QAEC,KAAK,CAAC,oBAAoB,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QAjF/E,SAAI,GAAW,KAAK,CAAC;QA+B9B;;WAEG;QACK,kBAAa,GAAG,CAAC,CAAC;QAsB1B;;WAEG;QACK,WAAM,GAAa,QAAQ,CAAC;QAEpC;;WAEG;QACH,YAAO,GAAG,IAAI,CAAC;QAkNf;;WAEG;QACH,aAAa;QACL,cAAS,GAAG,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC;QAC9C,aAAa;QACL,YAAO,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC;QAC1C,aAAa;QACL,QAAG,GAAG,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC;QAClC,aAAa;QACL,gBAAW,GAAG,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC;QA1MjD,MAAM,OAAO,GAAG,oBAAoB,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QAEhG,IAAI,CAAC,WAAW,GAAG,IAAI,UAAU,CAAC,OAA2C,CAAC,CAAC;QAE/E,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;QAE5C,IAAI,CAAC,cAAc,GAAG,IAAI,IAAI,CAAC;YAC9B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,OAAO,CAAC,SAAS;YACvB,KAAK,EAAE,aAAa;SACpB,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC;QAC1C,IAAI,CAAC,cAAc,GAAG,IAAI,MAAM,CAAC;YAChC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,YAAY;YACnB,KAAK,EAAE,CAAC;SACR,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,IAAI,WAAW,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QACvD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,KAAK,CAAC;YACtC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,GAAG,EAAE,OAAO,CAAC,GAAG;SAChB,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;QAEvB,gBAAgB;QAChB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACrE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,QAAQ,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;IAC5B,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE;YAC9C,SAAS,EAAE,CAAC;YACZ,SAAS,EAAE,IAAI;YACf,GAAG,EAAE,CAAC;YACN,GAAG,EAAE,CAAC;YACN,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,QAAoB;SAC3B,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAW;QAChB,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,IAAW;QACf,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;OAOG;IACH,IAAI;QACH,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QACxB,IAAI,CAAC,WAAW,CAAC,aAAa,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,MAAM;QACL,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAC1B,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC;QACnC,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACK,gBAAgB;QACvB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC;QACxD,IAAI,CAAC,cAAc,CAAC,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,IAAI,GAAG;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACvC,CAAC;IACD,IAAI,GAAG,CAAC,GAAG;QACV,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAI,GAAG;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACvC,CAAC;IACD,IAAI,GAAG,CAAC,GAAG;QACV,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACP,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC9B,CAAC;IACD,IAAI,IAAI,CAAC,IAAI;QACZ,IAAI,CAAC,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC;QAC7B,IAAI,CAAC,gBAAgB,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACX,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC;IAClC,CAAC;IACD,IAAI,QAAQ,CAAC,QAAQ;QACpB,IAAI,CAAC,WAAW,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACrC,IAAI,CAAC,gBAAgB,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;IAC/B,CAAC;IACD,IAAI,KAAK,CAAC,KAAK;QACd,IAAI,CAAC,WAAW,CAAC,KAAK,GAAG,KAAK,CAAC;QAC/B,IAAI,CAAC,gBAAgB,EAAE,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,MAAM,CAAC;IACpB,CAAC;IACD,IAAI,KAAK,CAAC,GAAG;QACZ,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC;QAC5B,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC;QAC5B,8BAA8B;QAC9B,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;QAClB,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC;QACtB,IAAI,CAAC,GAAG,GAAG,UAAU,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,IAAe,EAAE,SAAkB,EAAE,QAAiB;QAC7D,IAAI,IAAI,YAAY,KAAK,IAAI,IAAI,YAAY,MAAM,EAAE;YACpD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;SACxB;QACD,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACb,CAAC;IAcD,OAAO;QACN,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;QAC3B,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACvB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACpB,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;QAC9B,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACb,CAAC;CACD"}