tone 14.8.27

package/build/esm/source/Noise.d.ts

@@ -0,0 +1,96 @@
+import { Positive, Time } from "../core/type/Units";
+import { Source, SourceOptions } from "../source/Source";
+export declare type NoiseType = "white" | "brown" | "pink";
+export interface NoiseOptions extends SourceOptions {
+    type: NoiseType;
+    playbackRate: Positive;
+    fadeIn: Time;
+    fadeOut: Time;
+}
+/**
+ * Noise is a noise generator. It uses looped noise buffers to save on performance.
+ * Noise supports the noise types: "pink", "white", and "brown". Read more about
+ * colors of noise on [Wikipedia](https://en.wikipedia.org/wiki/Colors_of_noise).
+ *
+ * @example
+ * // initialize the noise and start
+ * const noise = new Tone.Noise("pink").start();
+ * // make an autofilter to shape the noise
+ * const autoFilter = new Tone.AutoFilter({
+ * 	frequency: "8n",
+ * 	baseFrequency: 200,
+ * 	octaves: 8
+ * }).toDestination().start();
+ * // connect the noise
+ * noise.connect(autoFilter);
+ * // start the autofilter LFO
+ * autoFilter.start();
+ * @category Source
+ */
+export declare class Noise extends Source<NoiseOptions> {
+    readonly name: string;
+    /**
+     * Private reference to the source
+     */
+    private _source;
+    /**
+     * private reference to the type
+     */
+    private _type;
+    /**
+     * The playback rate of the noise. Affects
+     * the "frequency" of the noise.
+     */
+    private _playbackRate;
+    /**
+     * The fadeIn time of the amplitude envelope.
+     */
+    protected _fadeIn: Time;
+    /**
+     * The fadeOut time of the amplitude envelope.
+     */
+    protected _fadeOut: Time;
+    /**
+     * @param type the noise type (white|pink|brown)
+     */
+    constructor(type?: NoiseType);
+    constructor(options?: Partial<NoiseOptions>);
+    static getDefaults(): NoiseOptions;
+    /**
+     * The type of the noise. Can be "white", "brown", or "pink".
+     * @example
+     * const noise = new Tone.Noise().toDestination().start();
+     * noise.type = "brown";
+     */
+    get type(): NoiseType;
+    set type(type: NoiseType);
+    /**
+     * The playback rate of the noise. Affects
+     * the "frequency" of the noise.
+     */
+    get playbackRate(): Positive;
+    set playbackRate(rate: Positive);
+    /**
+     * internal start method
+     */
+    protected _start(time?: Time): void;
+    /**
+     * internal stop method
+     */
+    protected _stop(time?: Time): void;
+    /**
+     * The fadeIn time of the amplitude envelope.
+     */
+    get fadeIn(): Time;
+    set fadeIn(time: Time);
+    /**
+     * The fadeOut time of the amplitude envelope.
+     */
+    get fadeOut(): Time;
+    set fadeOut(time: Time);
+    protected _restart(time?: Time): void;
+    /**
+     * Clean up.
+     */
+    dispose(): this;
+}

package/build/esm/source/Noise.js

@@ -0,0 +1,225 @@
+import { ToneAudioBuffer } from "../core/context/ToneAudioBuffer";
+import { optionsFromArguments } from "../core/util/Defaults";
+import { assert } from "../core/util/Debug";
+import { Source } from "../source/Source";
+import { ToneBufferSource } from "./buffer/ToneBufferSource";
+/**
+ * Noise is a noise generator. It uses looped noise buffers to save on performance.
+ * Noise supports the noise types: "pink", "white", and "brown". Read more about
+ * colors of noise on [Wikipedia](https://en.wikipedia.org/wiki/Colors_of_noise).
+ *
+ * @example
+ * // initialize the noise and start
+ * const noise = new Tone.Noise("pink").start();
+ * // make an autofilter to shape the noise
+ * const autoFilter = new Tone.AutoFilter({
+ * 	frequency: "8n",
+ * 	baseFrequency: 200,
+ * 	octaves: 8
+ * }).toDestination().start();
+ * // connect the noise
+ * noise.connect(autoFilter);
+ * // start the autofilter LFO
+ * autoFilter.start();
+ * @category Source
+ */
+export class Noise extends Source {
+    constructor() {
+        super(optionsFromArguments(Noise.getDefaults(), arguments, ["type"]));
+        this.name = "Noise";
+        /**
+         * Private reference to the source
+         */
+        this._source = null;
+        const options = optionsFromArguments(Noise.getDefaults(), arguments, ["type"]);
+        this._playbackRate = options.playbackRate;
+        this.type = options.type;
+        this._fadeIn = options.fadeIn;
+        this._fadeOut = options.fadeOut;
+    }
+    static getDefaults() {
+        return Object.assign(Source.getDefaults(), {
+            fadeIn: 0,
+            fadeOut: 0,
+            playbackRate: 1,
+            type: "white",
+        });
+    }
+    /**
+     * The type of the noise. Can be "white", "brown", or "pink".
+     * @example
+     * const noise = new Tone.Noise().toDestination().start();
+     * noise.type = "brown";
+     */
+    get type() {
+        return this._type;
+    }
+    set type(type) {
+        assert(type in _noiseBuffers, "Noise: invalid type: " + type);
+        if (this._type !== type) {
+            this._type = type;
+            // if it's playing, stop and restart it
+            if (this.state === "started") {
+                const now = this.now();
+                this._stop(now);
+                this._start(now);
+            }
+        }
+    }
+    /**
+     * The playback rate of the noise. Affects
+     * the "frequency" of the noise.
+     */
+    get playbackRate() {
+        return this._playbackRate;
+    }
+    set playbackRate(rate) {
+        this._playbackRate = rate;
+        if (this._source) {
+            this._source.playbackRate.value = rate;
+        }
+    }
+    /**
+     * internal start method
+     */
+    _start(time) {
+        const buffer = _noiseBuffers[this._type];
+        this._source = new ToneBufferSource({
+            url: buffer,
+            context: this.context,
+            fadeIn: this._fadeIn,
+            fadeOut: this._fadeOut,
+            loop: true,
+            onended: () => this.onstop(this),
+            playbackRate: this._playbackRate,
+        }).connect(this.output);
+        this._source.start(this.toSeconds(time), Math.random() * (buffer.duration - 0.001));
+    }
+    /**
+     * internal stop method
+     */
+    _stop(time) {
+        if (this._source) {
+            this._source.stop(this.toSeconds(time));
+            this._source = null;
+        }
+    }
+    /**
+     * The fadeIn time of the amplitude envelope.
+     */
+    get fadeIn() {
+        return this._fadeIn;
+    }
+    set fadeIn(time) {
+        this._fadeIn = time;
+        if (this._source) {
+            this._source.fadeIn = this._fadeIn;
+        }
+    }
+    /**
+     * The fadeOut time of the amplitude envelope.
+     */
+    get fadeOut() {
+        return this._fadeOut;
+    }
+    set fadeOut(time) {
+        this._fadeOut = time;
+        if (this._source) {
+            this._source.fadeOut = this._fadeOut;
+        }
+    }
+    _restart(time) {
+        // TODO could be optimized by cancelling the buffer source 'stop'
+        this._stop(time);
+        this._start(time);
+    }
+    /**
+     * Clean up.
+     */
+    dispose() {
+        super.dispose();
+        if (this._source) {
+            this._source.disconnect();
+        }
+        return this;
+    }
+}
+//--------------------
+// THE NOISE BUFFERS
+//--------------------
+// Noise buffer stats
+const BUFFER_LENGTH = 44100 * 5;
+const NUM_CHANNELS = 2;
+/**
+ * Cache the noise buffers
+ */
+const _noiseCache = {
+    brown: null,
+    pink: null,
+    white: null,
+};
+/**
+ * The noise arrays. Generated on initialization.
+ * borrowed heavily from https://github.com/zacharydenton/noise.js
+ * (c) 2013 Zach Denton (MIT)
+ */
+const _noiseBuffers = {
+    get brown() {
+        if (!_noiseCache.brown) {
+            const buffer = [];
+            for (let channelNum = 0; channelNum < NUM_CHANNELS; channelNum++) {
+                const channel = new Float32Array(BUFFER_LENGTH);
+                buffer[channelNum] = channel;
+                let lastOut = 0.0;
+                for (let i = 0; i < BUFFER_LENGTH; i++) {
+                    const white = Math.random() * 2 - 1;
+                    channel[i] = (lastOut + (0.02 * white)) / 1.02;
+                    lastOut = channel[i];
+                    channel[i] *= 3.5; // (roughly) compensate for gain
+                }
+            }
+            _noiseCache.brown = new ToneAudioBuffer().fromArray(buffer);
+        }
+        return _noiseCache.brown;
+    },
+    get pink() {
+        if (!_noiseCache.pink) {
+            const buffer = [];
+            for (let channelNum = 0; channelNum < NUM_CHANNELS; channelNum++) {
+                const channel = new Float32Array(BUFFER_LENGTH);
+                buffer[channelNum] = channel;
+                let b0, b1, b2, b3, b4, b5, b6;
+                b0 = b1 = b2 = b3 = b4 = b5 = b6 = 0.0;
+                for (let i = 0; i < BUFFER_LENGTH; i++) {
+                    const white = Math.random() * 2 - 1;
+                    b0 = 0.99886 * b0 + white * 0.0555179;
+                    b1 = 0.99332 * b1 + white * 0.0750759;
+                    b2 = 0.96900 * b2 + white * 0.1538520;
+                    b3 = 0.86650 * b3 + white * 0.3104856;
+                    b4 = 0.55000 * b4 + white * 0.5329522;
+                    b5 = -0.7616 * b5 - white * 0.0168980;
+                    channel[i] = b0 + b1 + b2 + b3 + b4 + b5 + b6 + white * 0.5362;
+                    channel[i] *= 0.11; // (roughly) compensate for gain
+                    b6 = white * 0.115926;
+                }
+            }
+            _noiseCache.pink = new ToneAudioBuffer().fromArray(buffer);
+        }
+        return _noiseCache.pink;
+    },
+    get white() {
+        if (!_noiseCache.white) {
+            const buffer = [];
+            for (let channelNum = 0; channelNum < NUM_CHANNELS; channelNum++) {
+                const channel = new Float32Array(BUFFER_LENGTH);
+                buffer[channelNum] = channel;
+                for (let i = 0; i < BUFFER_LENGTH; i++) {
+                    channel[i] = Math.random() * 2 - 1;
+                }
+            }
+            _noiseCache.white = new ToneAudioBuffer().fromArray(buffer);
+        }
+        return _noiseCache.white;
+    },
+};
+//# sourceMappingURL=Noise.js.map

package/build/esm/source/Noise.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Noise.js","sourceRoot":"","sources":["../../../Tone/source/Noise.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAElE,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAiB,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAW7D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,KAAM,SAAQ,MAAoB;IAmC9C;QACC,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAlC9D,SAAI,GAAW,OAAO,CAAC;QAEhC;;WAEG;QACK,YAAO,GAA4B,IAAI,CAAC;QA8B/C,MAAM,OAAO,GAAG,oBAAoB,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAE/E,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;QAC1C,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IACjC,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE;YAC1C,MAAM,EAAE,CAAC;YACT,OAAO,EAAE,CAAC;YACV,YAAY,EAAE,CAAC;YACf,IAAI,EAAE,OAAoB;SAC1B,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,IAAI,IAAI;QACP,OAAO,IAAI,CAAC,KAAK,CAAC;IACnB,CAAC;IACD,IAAI,IAAI,CAAC,IAAe;QACvB,MAAM,CAAC,IAAI,IAAI,aAAa,EAAE,uBAAuB,GAAG,IAAI,CAAC,CAAC;QAC9D,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE;YACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAClB,uCAAuC;YACvC,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;gBAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBACvB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAChB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;aACjB;SACD;IACF,CAAC;IAED;;;OAGG;IACH,IAAI,YAAY;QACf,OAAO,IAAI,CAAC,aAAa,CAAC;IAC3B,CAAC;IACD,IAAI,YAAY,CAAC,IAAc;QAC9B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,KAAK,GAAG,IAAI,CAAC;SACvC;IACF,CAAC;IAED;;OAEG;IACO,MAAM,CAAC,IAAW;QAC3B,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,IAAI,gBAAgB,CAAC;YACnC,GAAG,EAAE,MAAM;YACX,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YAChC,YAAY,EAAE,IAAI,CAAC,aAAa;SAChC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,IAAW;QAC1B,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;YACxC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;SACpB;IACF,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;IACD,IAAI,MAAM,CAAC,IAAI;QACd,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;SACnC;IACF,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IACD,IAAI,OAAO,CAAC,IAAI;QACf,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC;SACrC;IACF,CAAC;IAES,QAAQ,CAAC,IAAW;QAC7B,iEAAiE;QACjE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,OAAO;QACN,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;SAC1B;QACD,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AAED,sBAAsB;AACtB,oBAAoB;AACpB,sBAAsB;AAEtB,qBAAqB;AACrB,MAAM,aAAa,GAAG,KAAK,GAAG,CAAC,CAAC;AAChC,MAAM,YAAY,GAAG,CAAC,CAAC;AASvB;;GAEG;AACH,MAAM,WAAW,GAAe;IAC/B,KAAK,EAAE,IAAI;IACX,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,IAAI;CACX,CAAC;AAEF;;;;GAIG;AACH,MAAM,aAAa,GAAG;IACrB,IAAI,KAAK;QACR,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE;YACvB,MAAM,MAAM,GAAmB,EAAE,CAAC;YAClC,KAAK,IAAI,UAAU,GAAG,CAAC,EAAE,UAAU,GAAG,YAAY,EAAE,UAAU,EAAE,EAAE;gBACjE,MAAM,OAAO,GAAG,IAAI,YAAY,CAAC,aAAa,CAAC,CAAC;gBAChD,MAAM,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;gBAC7B,IAAI,OAAO,GAAG,GAAG,CAAC;gBAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,CAAC,EAAE,EAAE;oBACvC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;oBACpC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,GAAG,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;oBAC/C,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;oBACrB,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,gCAAgC;iBACnD;aACD;YACD,WAAW,CAAC,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;SAC5D;QACD,OAAO,WAAW,CAAC,KAAK,CAAC;IAC1B,CAAC;IAED,IAAI,IAAI;QACP,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE;YACtB,MAAM,MAAM,GAAmB,EAAE,CAAC;YAClC,KAAK,IAAI,UAAU,GAAG,CAAC,EAAE,UAAU,GAAG,YAAY,EAAE,UAAU,EAAE,EAAE;gBACjE,MAAM,OAAO,GAAG,IAAI,YAAY,CAAC,aAAa,CAAC,CAAC;gBAChD,MAAM,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;gBAC7B,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;gBAC/B,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC;gBACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,CAAC,EAAE,EAAE;oBACvC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;oBACpC,EAAE,GAAG,OAAO,GAAG,EAAE,GAAG,KAAK,GAAG,SAAS,CAAC;oBACtC,EAAE,GAAG,OAAO,GAAG,EAAE,GAAG,KAAK,GAAG,SAAS,CAAC;oBACtC,EAAE,GAAG,OAAO,GAAG,EAAE,GAAG,KAAK,GAAG,SAAS,CAAC;oBACtC,EAAE,GAAG,OAAO,GAAG,EAAE,GAAG,KAAK,GAAG,SAAS,CAAC;oBACtC,EAAE,GAAG,OAAO,GAAG,EAAE,GAAG,KAAK,GAAG,SAAS,CAAC;oBACtC,EAAE,GAAG,CAAC,MAAM,GAAG,EAAE,GAAG,KAAK,GAAG,SAAS,CAAC;oBACtC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,KAAK,GAAG,MAAM,CAAC;oBAC/D,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,gCAAgC;oBACpD,EAAE,GAAG,KAAK,GAAG,QAAQ,CAAC;iBACtB;aACD;YACD,WAAW,CAAC,IAAI,GAAG,IAAI,eAAe,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;SAC3D;QACD,OAAO,WAAW,CAAC,IAAI,CAAC;IACzB,CAAC;IAED,IAAI,KAAK;QACR,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE;YACvB,MAAM,MAAM,GAAmB,EAAE,CAAC;YAClC,KAAK,IAAI,UAAU,GAAG,CAAC,EAAE,UAAU,GAAG,YAAY,EAAE,UAAU,EAAE,EAAE;gBACjE,MAAM,OAAO,GAAG,IAAI,YAAY,CAAC,aAAa,CAAC,CAAC;gBAChD,MAAM,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;gBAC7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,CAAC,EAAE,EAAE;oBACvC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;iBACnC;aACD;YACD,WAAW,CAAC,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;SAC5D;QACD,OAAO,WAAW,CAAC,KAAK,CAAC;IAC1B,CAAC;CACD,CAAC"}

package/build/esm/source/OneShotSource.d.ts

@@ -0,0 +1,102 @@
+import { Gain } from "../core/context/Gain";
+import { ToneAudioNode, ToneAudioNodeOptions } from "../core/context/ToneAudioNode";
+import { GainFactor, Seconds, Time } from "../core/type/Units";
+import { BasicPlaybackState } from "../core/util/StateTimeline";
+export declare type OneShotSourceCurve = "linear" | "exponential";
+declare type onEndedCallback = (source: OneShotSource<any>) => void;
+export interface OneShotSourceOptions extends ToneAudioNodeOptions {
+    onended: onEndedCallback;
+    fadeIn: Time;
+    fadeOut: Time;
+    curve: OneShotSourceCurve;
+}
+/**
+ * Base class for fire-and-forget nodes
+ */
+export declare abstract class OneShotSource<Options extends ToneAudioNodeOptions> extends ToneAudioNode<Options> {
+    /**
+     * The callback to invoke after the
+     * source is done playing.
+     */
+    onended: onEndedCallback;
+    /**
+     * Sources do not have input nodes
+     */
+    input: undefined;
+    /**
+     * The start time
+     */
+    protected _startTime: number;
+    /**
+     * The stop time
+     */
+    protected _stopTime: number;
+    /**
+     * The id of the timeout
+     */
+    private _timeout;
+    /**
+     * The public output node
+     */
+    output: Gain;
+    /**
+     * The output gain node.
+     */
+    protected _gainNode: Gain<"gain">;
+    /**
+     * The fadeIn time of the amplitude envelope.
+     */
+    protected _fadeIn: Time;
+    /**
+     * The fadeOut time of the amplitude envelope.
+     */
+    protected _fadeOut: Time;
+    /**
+     * The curve applied to the fades, either "linear" or "exponential"
+     */
+    protected _curve: OneShotSourceCurve;
+    constructor(options: OneShotSourceOptions);
+    static getDefaults(): OneShotSourceOptions;
+    /**
+     * Stop the source node
+     */
+    protected abstract _stopSource(time: Seconds): void;
+    /**
+     * Start the source node at the given time
+     * @param  time When to start the node
+     */
+    protected abstract start(time?: Time): this;
+    /**
+     * Start the source at the given time
+     * @param  time When to start the source
+     */
+    protected _startGain(time: Seconds, gain?: GainFactor): this;
+    /**
+     * Stop the source node at the given time.
+     * @param time When to stop the source
+     */
+    stop(time?: Time): this;
+    /**
+     * Stop the source at the given time
+     * @param  time When to stop the source
+     */
+    protected _stopGain(time: Seconds): this;
+    /**
+     * Invoke the onended callback
+     */
+    protected _onended(): void;
+    /**
+     * Get the playback state at the given time
+     */
+    getStateAtTime: (time: Time) => BasicPlaybackState;
+    /**
+     * Get the playback state at the current time
+     */
+    get state(): BasicPlaybackState;
+    /**
+     * Cancel a scheduled stop event
+     */
+    cancelStop(): this;
+    dispose(): this;
+}
+export {};

package/build/esm/source/OneShotSource.js

@@ -0,0 +1,183 @@
+import { Gain } from "../core/context/Gain";
+import { ToneAudioNode, } from "../core/context/ToneAudioNode";
+import { noOp } from "../core/util/Interface";
+import { assert } from "../core/util/Debug";
+/**
+ * Base class for fire-and-forget nodes
+ */
+export class OneShotSource extends ToneAudioNode {
+    constructor(options) {
+        super(options);
+        /**
+         * The callback to invoke after the
+         * source is done playing.
+         */
+        this.onended = noOp;
+        /**
+         * The start time
+         */
+        this._startTime = -1;
+        /**
+         * The stop time
+         */
+        this._stopTime = -1;
+        /**
+         * The id of the timeout
+         */
+        this._timeout = -1;
+        /**
+         * The public output node
+         */
+        this.output = new Gain({
+            context: this.context,
+            gain: 0,
+        });
+        /**
+         * The output gain node.
+         */
+        this._gainNode = this.output;
+        /**
+         * Get the playback state at the given time
+         */
+        this.getStateAtTime = function (time) {
+            const computedTime = this.toSeconds(time);
+            if (this._startTime !== -1 &&
+                computedTime >= this._startTime &&
+                (this._stopTime === -1 || computedTime <= this._stopTime)) {
+                return "started";
+            }
+            else {
+                return "stopped";
+            }
+        };
+        this._fadeIn = options.fadeIn;
+        this._fadeOut = options.fadeOut;
+        this._curve = options.curve;
+        this.onended = options.onended;
+    }
+    static getDefaults() {
+        return Object.assign(ToneAudioNode.getDefaults(), {
+            curve: "linear",
+            fadeIn: 0,
+            fadeOut: 0,
+            onended: noOp,
+        });
+    }
+    /**
+     * Start the source at the given time
+     * @param  time When to start the source
+     */
+    _startGain(time, gain = 1) {
+        assert(this._startTime === -1, "Source cannot be started more than once");
+        // apply a fade in envelope
+        const fadeInTime = this.toSeconds(this._fadeIn);
+        // record the start time
+        this._startTime = time + fadeInTime;
+        this._startTime = Math.max(this._startTime, this.context.currentTime);
+        // schedule the envelope
+        if (fadeInTime > 0) {
+            this._gainNode.gain.setValueAtTime(0, time);
+            if (this._curve === "linear") {
+                this._gainNode.gain.linearRampToValueAtTime(gain, time + fadeInTime);
+            }
+            else {
+                this._gainNode.gain.exponentialApproachValueAtTime(gain, time, fadeInTime);
+            }
+        }
+        else {
+            this._gainNode.gain.setValueAtTime(gain, time);
+        }
+        return this;
+    }
+    /**
+     * Stop the source node at the given time.
+     * @param time When to stop the source
+     */
+    stop(time) {
+        this.log("stop", time);
+        this._stopGain(this.toSeconds(time));
+        return this;
+    }
+    /**
+     * Stop the source at the given time
+     * @param  time When to stop the source
+     */
+    _stopGain(time) {
+        assert(this._startTime !== -1, "'start' must be called before 'stop'");
+        // cancel the previous stop
+        this.cancelStop();
+        // the fadeOut time
+        const fadeOutTime = this.toSeconds(this._fadeOut);
+        // schedule the stop callback
+        this._stopTime = this.toSeconds(time) + fadeOutTime;
+        this._stopTime = Math.max(this._stopTime, this.context.currentTime);
+        if (fadeOutTime > 0) {
+            // start the fade out curve at the given time
+            if (this._curve === "linear") {
+                this._gainNode.gain.linearRampTo(0, fadeOutTime, time);
+            }
+            else {
+                this._gainNode.gain.targetRampTo(0, fadeOutTime, time);
+            }
+        }
+        else {
+            // stop any ongoing ramps, and set the value to 0
+            this._gainNode.gain.cancelAndHoldAtTime(time);
+            this._gainNode.gain.setValueAtTime(0, time);
+        }
+        this.context.clearTimeout(this._timeout);
+        this._timeout = this.context.setTimeout(() => {
+            // allow additional time for the exponential curve to fully decay
+            const additionalTail = this._curve === "exponential" ? fadeOutTime * 2 : 0;
+            this._stopSource(this.now() + additionalTail);
+            this._onended();
+        }, this._stopTime - this.context.currentTime);
+        return this;
+    }
+    /**
+     * Invoke the onended callback
+     */
+    _onended() {
+        if (this.onended !== noOp) {
+            this.onended(this);
+            // overwrite onended to make sure it only is called once
+            this.onended = noOp;
+            // dispose when it's ended to free up for garbage collection only in the online context
+            if (!this.context.isOffline) {
+                const disposeCallback = () => this.dispose();
+                // @ts-ignore
+                if (typeof window.requestIdleCallback !== "undefined") {
+                    // @ts-ignore
+                    window.requestIdleCallback(disposeCallback);
+                }
+                else {
+                    setTimeout(disposeCallback, 1000);
+                }
+            }
+        }
+    }
+    /**
+     * Get the playback state at the current time
+     */
+    get state() {
+        return this.getStateAtTime(this.now());
+    }
+    /**
+     * Cancel a scheduled stop event
+     */
+    cancelStop() {
+        this.log("cancelStop");
+        assert(this._startTime !== -1, "Source is not started");
+        // cancel the stop envelope
+        this._gainNode.gain.cancelScheduledValues(this._startTime + this.sampleTime);
+        this.context.clearTimeout(this._timeout);
+        this._stopTime = -1;
+        return this;
+    }
+    dispose() {
+        super.dispose();
+        this._gainNode.disconnect();
+        return this;
+    }
+}
+//# sourceMappingURL=OneShotSource.js.map

package/build/esm/source/OneShotSource.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OneShotSource.js","sourceRoot":"","sources":["../../../Tone/source/OneShotSource.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC5C,OAAO,EACN,aAAa,GAEb,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAc5C;;GAEG;AACH,MAAM,OAAgB,aAEpB,SAAQ,aAAsB;IAuD/B,YAAY,OAA6B;QACxC,KAAK,CAAC,OAAO,CAAC,CAAC;QAvDhB;;;WAGG;QACH,YAAO,GAAoB,IAAI,CAAC;QAOhC;;WAEG;QACO,eAAU,GAAG,CAAC,CAAC,CAAC;QAE1B;;WAEG;QACO,cAAS,GAAG,CAAC,CAAC,CAAC;QAEzB;;WAEG;QACK,aAAQ,GAAG,CAAC,CAAC,CAAC;QAEtB;;WAEG;QACH,WAAM,GAAS,IAAI,IAAI,CAAC;YACvB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,CAAC;SACP,CAAC,CAAC;QAEH;;WAEG;QACO,cAAS,GAAG,IAAI,CAAC,MAAM,CAAC;QAwJlC;;WAEG;QACH,mBAAc,GAAG,UAAS,IAAU;YACnC,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YAC1C,IACC,IAAI,CAAC,UAAU,KAAK,CAAC,CAAC;gBACtB,YAAY,IAAI,IAAI,CAAC,UAAU;gBAC/B,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,CAAC,IAAI,YAAY,IAAI,IAAI,CAAC,SAAS,CAAC,EACxD;gBACD,OAAO,SAAS,CAAC;aACjB;iBAAM;gBACN,OAAO,SAAS,CAAC;aACjB;QACF,CAAC,CAAC;QAlJD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE;YACjD,KAAK,EAAE,QAA8B;YACrC,MAAM,EAAE,CAAC;YACT,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,IAAI;SACb,CAAC,CAAC;IACJ,CAAC;IAYD;;;OAGG;IACO,UAAU,CAAC,IAAa,EAAE,OAAmB,CAAC;QACvD,MAAM,CACL,IAAI,CAAC,UAAU,KAAK,CAAC,CAAC,EACtB,yCAAyC,CACzC,CAAC;QACF,2BAA2B;QAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAEhD,wBAAwB;QACxB,IAAI,CAAC,UAAU,GAAG,IAAI,GAAG,UAAU,CAAC;QACpC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAEtE,wBAAwB;QACxB,IAAI,UAAU,GAAG,CAAC,EAAE;YACnB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YAC5C,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE;gBAC7B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,uBAAuB,CAC1C,IAAI,EACJ,IAAI,GAAG,UAAU,CACjB,CAAC;aACF;iBAAM;gBACN,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,8BAA8B,CACjD,IAAI,EACJ,IAAI,EACJ,UAAU,CACV,CAAC;aACF;SACD;aAAM;YACN,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;SAC/C;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,IAAW;QACf,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACvB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACO,SAAS,CAAC,IAAa;QAChC,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,CAAC,EAAE,sCAAsC,CAAC,CAAC;QACvE,2BAA2B;QAC3B,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,mBAAmB;QACnB,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAElD,6BAA6B;QAC7B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC;QACpD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACpE,IAAI,WAAW,GAAG,CAAC,EAAE;YACpB,6CAA6C;YAC7C,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE;gBAC7B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;aACvD;iBAAM;gBACN,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;aACvD;SACD;aAAM;YACN,iDAAiD;YACjD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;YAC9C,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;SAC5C;QACD,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,EAAE;YAC5C,iEAAiE;YACjE,MAAM,cAAc,GACnB,IAAI,CAAC,MAAM,KAAK,aAAa,CAAC,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACrD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,cAAc,CAAC,CAAC;YAC9C,IAAI,CAAC,QAAQ,EAAE,CAAC;QACjB,CAAC,EAAE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACO,QAAQ;QACjB,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,EAAE;YAC1B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACnB,wDAAwD;YACxD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACpB,uFAAuF;YACvF,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;gBAC5B,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC7C,aAAa;gBACb,IAAI,OAAO,MAAM,CAAC,mBAAmB,KAAK,WAAW,EAAE;oBACtD,aAAa;oBACb,MAAM,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;iBAC5C;qBAAM;oBACN,UAAU,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;iBAClC;aACD;SACD;IACF,CAAC;IAkBD;;OAEG;IACH,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,UAAU;QACT,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACvB,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,CAAC,EAAE,uBAAuB,CAAC,CAAC;QACxD,2BAA2B;QAC3B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,qBAAqB,CACxC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CACjC,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzC,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;QACpB,OAAO,IAAI,CAAC;IACb,CAAC;IAED,OAAO;QACN,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACb,CAAC;CACD"}