tone 14.8.27

package/build/esm/component/channel/Solo.js

@@ -0,0 +1,121 @@
+import { Gain } from "../../core/context/Gain";
+import { ToneAudioNode } from "../../core/context/ToneAudioNode";
+import { optionsFromArguments } from "../../core/util/Defaults";
+/**
+ * Solo lets you isolate a specific audio stream. When an instance is set to `solo=true`,
+ * it will mute all other instances of Solo.
+ * @example
+ * const soloA = new Tone.Solo().toDestination();
+ * const oscA = new Tone.Oscillator("C4", "sawtooth").connect(soloA);
+ * const soloB = new Tone.Solo().toDestination();
+ * const oscB = new Tone.Oscillator("E4", "square").connect(soloB);
+ * soloA.solo = true;
+ * // no audio will pass through soloB
+ * @category Component
+ */
+export class Solo extends ToneAudioNode {
+    constructor() {
+        super(optionsFromArguments(Solo.getDefaults(), arguments, ["solo"]));
+        this.name = "Solo";
+        const options = optionsFromArguments(Solo.getDefaults(), arguments, ["solo"]);
+        this.input = this.output = new Gain({
+            context: this.context,
+        });
+        if (!Solo._allSolos.has(this.context)) {
+            Solo._allSolos.set(this.context, new Set());
+        }
+        Solo._allSolos.get(this.context).add(this);
+        // set initially
+        this.solo = options.solo;
+    }
+    static getDefaults() {
+        return Object.assign(ToneAudioNode.getDefaults(), {
+            solo: false,
+        });
+    }
+    /**
+     * Isolates this instance and mutes all other instances of Solo.
+     * Only one instance can be soloed at a time. A soloed
+     * instance will report `solo=false` when another instance is soloed.
+     */
+    get solo() {
+        return this._isSoloed();
+    }
+    set solo(solo) {
+        if (solo) {
+            this._addSolo();
+        }
+        else {
+            this._removeSolo();
+        }
+        Solo._allSolos.get(this.context).forEach(instance => instance._updateSolo());
+    }
+    /**
+     * If the current instance is muted, i.e. another instance is soloed
+     */
+    get muted() {
+        return this.input.gain.value === 0;
+    }
+    /**
+     * Add this to the soloed array
+     */
+    _addSolo() {
+        if (!Solo._soloed.has(this.context)) {
+            Solo._soloed.set(this.context, new Set());
+        }
+        Solo._soloed.get(this.context).add(this);
+    }
+    /**
+     * Remove this from the soloed array
+     */
+    _removeSolo() {
+        if (Solo._soloed.has(this.context)) {
+            Solo._soloed.get(this.context).delete(this);
+        }
+    }
+    /**
+     * Is this on the soloed array
+     */
+    _isSoloed() {
+        return Solo._soloed.has(this.context) && Solo._soloed.get(this.context).has(this);
+    }
+    /**
+     * Returns true if no one is soloed
+     */
+    _noSolos() {
+        // either does not have any soloed added
+        return !Solo._soloed.has(this.context) ||
+            // or has a solo set but doesn't include any items
+            (Solo._soloed.has(this.context) && Solo._soloed.get(this.context).size === 0);
+    }
+    /**
+     * Solo the current instance and unsolo all other instances.
+     */
+    _updateSolo() {
+        if (this._isSoloed()) {
+            this.input.gain.value = 1;
+        }
+        else if (this._noSolos()) {
+            // no one is soloed
+            this.input.gain.value = 1;
+        }
+        else {
+            this.input.gain.value = 0;
+        }
+    }
+    dispose() {
+        super.dispose();
+        Solo._allSolos.get(this.context).delete(this);
+        this._removeSolo();
+        return this;
+    }
+}
+/**
+ * Hold all of the solo'ed tracks belonging to a specific context
+ */
+Solo._allSolos = new Map();
+/**
+ * Hold the currently solo'ed instance(s)
+ */
+Solo._soloed = new Map();
+//# sourceMappingURL=Solo.js.map

package/build/esm/component/channel/Solo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Solo.js","sourceRoot":"","sources":["../../../../Tone/component/channel/Solo.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAwB,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAMhE;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,IAAK,SAAQ,aAA0B;IAYnD;QAEC,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAZ7D,SAAI,GAAW,MAAM,CAAC;QAa9B,MAAM,OAAO,GAAG,oBAAoB,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QAE9E,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,IAAI,CAAC;YACnC,OAAO,EAAE,IAAI,CAAC,OAAO;SACrB,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACtC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;SAC5C;QACA,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAE1D,gBAAgB;QAChB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC1B,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE;YACjD,IAAI,EAAE,KAAK;SACX,CAAC,CAAC;IACJ,CAAC;IAYD;;;;OAIG;IACH,IAAI,IAAI;QACP,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;IACzB,CAAC;IACD,IAAI,IAAI,CAAC,IAAI;QACZ,IAAI,IAAI,EAAE;YACT,IAAI,CAAC,QAAQ,EAAE,CAAC;SAChB;aAAM;YACN,IAAI,CAAC,WAAW,EAAE,CAAC;SACnB;QACA,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACR,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACK,QAAQ;QACf,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACpC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;SAC1C;QACA,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACK,WAAW;QAClB,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YAClC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;SAC3D;IACF,CAAC;IAED;;OAEG;IACK,SAAS;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAK,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAClG,CAAC;IAED;;OAEG;IACK,QAAQ;QACf,wCAAwC;QACxC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC;YACrC,kDAAkD;YAClD,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,IAAK,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAe,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED;;OAEG;IACK,WAAW;QAClB,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE;YACrB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;SAC1B;aAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE;YAC3B,mBAAmB;YACnB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;SAC1B;aAAM;YACN,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;SAC1B;IACF,CAAC;IAED,OAAO;QACN,KAAK,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;;AAzFD;;GAEG;AACY,cAAS,GAAgC,IAAI,GAAG,EAAE,CAAC;AAElE;;GAEG;AACY,YAAO,GAAgC,IAAI,GAAG,EAAE,CAAC"}

package/build/esm/component/channel/Split.d.ts

@@ -0,0 +1,29 @@
+import { ToneAudioNode, ToneAudioNodeOptions } from "../../core/context/ToneAudioNode";
+interface SplitOptions extends ToneAudioNodeOptions {
+    channels: number;
+}
+/**
+ * Split splits an incoming signal into the number of given channels.
+ *
+ * @example
+ * const split = new Tone.Split();
+ * // stereoSignal.connect(split);
+ * @category Component
+ */
+export declare class Split extends ToneAudioNode<SplitOptions> {
+    readonly name: string;
+    /**
+     * The splitting node
+     */
+    private _splitter;
+    readonly input: ChannelSplitterNode;
+    readonly output: ChannelSplitterNode;
+    /**
+     * @param channels The number of channels to merge.
+     */
+    constructor(channels?: number);
+    constructor(options?: Partial<SplitOptions>);
+    static getDefaults(): SplitOptions;
+    dispose(): this;
+}
+export {};

package/build/esm/component/channel/Split.js

@@ -0,0 +1,30 @@
+import { ToneAudioNode } from "../../core/context/ToneAudioNode";
+import { optionsFromArguments } from "../../core/util/Defaults";
+/**
+ * Split splits an incoming signal into the number of given channels.
+ *
+ * @example
+ * const split = new Tone.Split();
+ * // stereoSignal.connect(split);
+ * @category Component
+ */
+export class Split extends ToneAudioNode {
+    constructor() {
+        super(optionsFromArguments(Split.getDefaults(), arguments, ["channels"]));
+        this.name = "Split";
+        const options = optionsFromArguments(Split.getDefaults(), arguments, ["channels"]);
+        this._splitter = this.input = this.output = this.context.createChannelSplitter(options.channels);
+        this._internalChannels = [this._splitter];
+    }
+    static getDefaults() {
+        return Object.assign(ToneAudioNode.getDefaults(), {
+            channels: 2,
+        });
+    }
+    dispose() {
+        super.dispose();
+        this._splitter.disconnect();
+        return this;
+    }
+}
+//# sourceMappingURL=Split.js.map

package/build/esm/component/channel/Split.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Split.js","sourceRoot":"","sources":["../../../../Tone/component/channel/Split.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAwB,MAAM,kCAAkC,CAAC;AACvF,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAMhE;;;;;;;GAOG;AACH,MAAM,OAAO,KAAM,SAAQ,aAA2B;IAgBrD;QACC,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAhBlE,SAAI,GAAW,OAAO,CAAC;QAiB/B,MAAM,OAAO,GAAG,oBAAoB,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;QAEnF,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACjG,IAAI,CAAC,iBAAiB,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC3C,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE;YACjD,QAAQ,EAAE,CAAC;SACX,CAAC,CAAC;IACJ,CAAC;IAED,OAAO;QACN,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACb,CAAC;CACD"}

package/build/esm/component/channel/Volume.d.ts

@@ -0,0 +1,60 @@
+import { Gain } from "../../core/context/Gain";
+import { Param } from "../../core/context/Param";
+import { ToneAudioNode, ToneAudioNodeOptions } from "../../core/context/ToneAudioNode";
+import { Decibels } from "../../core/type/Units";
+interface VolumeOptions extends ToneAudioNodeOptions {
+    volume: Decibels;
+    mute: boolean;
+}
+/**
+ * Volume is a simple volume node, useful for creating a volume fader.
+ *
+ * @example
+ * const vol = new Tone.Volume(-12).toDestination();
+ * const osc = new Tone.Oscillator().connect(vol).start();
+ * @category Component
+ */
+export declare class Volume extends ToneAudioNode<VolumeOptions> {
+    readonly name: string;
+    /**
+     * the output node
+     */
+    output: Gain<"decibels">;
+    /**
+     * Input and output are the same
+     */
+    input: Gain<"decibels">;
+    /**
+     * The unmuted volume
+     */
+    private _unmutedVolume;
+    /**
+     * The volume control in decibels.
+     * @example
+     * const vol = new Tone.Volume().toDestination();
+     * const osc = new Tone.Oscillator().connect(vol).start();
+     * vol.volume.value = -20;
+     */
+    volume: Param<"decibels">;
+    /**
+     * @param volume the initial volume in decibels
+     */
+    constructor(volume?: Decibels);
+    constructor(options?: Partial<VolumeOptions>);
+    static getDefaults(): VolumeOptions;
+    /**
+     * Mute the output.
+     * @example
+     * const vol = new Tone.Volume(-12).toDestination();
+     * const osc = new Tone.Oscillator().connect(vol).start();
+     * // mute the output
+     * vol.mute = true;
+     */
+    get mute(): boolean;
+    set mute(mute: boolean);
+    /**
+     * clean up
+     */
+    dispose(): this;
+}
+export {};

package/build/esm/component/channel/Volume.js

@@ -0,0 +1,66 @@
+import { Gain } from "../../core/context/Gain";
+import { ToneAudioNode } from "../../core/context/ToneAudioNode";
+import { optionsFromArguments } from "../../core/util/Defaults";
+import { readOnly } from "../../core/util/Interface";
+/**
+ * Volume is a simple volume node, useful for creating a volume fader.
+ *
+ * @example
+ * const vol = new Tone.Volume(-12).toDestination();
+ * const osc = new Tone.Oscillator().connect(vol).start();
+ * @category Component
+ */
+export class Volume extends ToneAudioNode {
+    constructor() {
+        super(optionsFromArguments(Volume.getDefaults(), arguments, ["volume"]));
+        this.name = "Volume";
+        const options = optionsFromArguments(Volume.getDefaults(), arguments, ["volume"]);
+        this.input = this.output = new Gain({
+            context: this.context,
+            gain: options.volume,
+            units: "decibels",
+        });
+        this.volume = this.output.gain;
+        readOnly(this, "volume");
+        this._unmutedVolume = options.volume;
+        // set the mute initially
+        this.mute = options.mute;
+    }
+    static getDefaults() {
+        return Object.assign(ToneAudioNode.getDefaults(), {
+            mute: false,
+            volume: 0,
+        });
+    }
+    /**
+     * Mute the output.
+     * @example
+     * const vol = new Tone.Volume(-12).toDestination();
+     * const osc = new Tone.Oscillator().connect(vol).start();
+     * // mute the output
+     * vol.mute = true;
+     */
+    get mute() {
+        return this.volume.value === -Infinity;
+    }
+    set mute(mute) {
+        if (!this.mute && mute) {
+            this._unmutedVolume = this.volume.value;
+            // maybe it should ramp here?
+            this.volume.value = -Infinity;
+        }
+        else if (this.mute && !mute) {
+            this.volume.value = this._unmutedVolume;
+        }
+    }
+    /**
+     * clean up
+     */
+    dispose() {
+        super.dispose();
+        this.input.dispose();
+        this.volume.dispose();
+        return this;
+    }
+}
+//# sourceMappingURL=Volume.js.map

package/build/esm/component/channel/Volume.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Volume.js","sourceRoot":"","sources":["../../../../Tone/component/channel/Volume.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAE/C,OAAO,EAAE,aAAa,EAAwB,MAAM,kCAAkC,CAAC;AAEvF,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAOrD;;;;;;;GAOG;AACH,MAAM,OAAO,MAAO,SAAQ,aAA4B;IAiCvD;QAEC,KAAK,CAAC,oBAAoB,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QAjCjE,SAAI,GAAW,QAAQ,CAAC;QAkChC,MAAM,OAAO,GAAG,oBAAoB,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;QAElF,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,IAAI,CAAC;YACnC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,OAAO,CAAC,MAAM;YACpB,KAAK,EAAE,UAAU;SACjB,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;QAC/B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACzB,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;QAErC,yBAAyB;QACzB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC1B,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE;YACjD,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,CAAC;SACT,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,IAAI;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,KAAK,CAAC,QAAQ,CAAC;IACxC,CAAC;IACD,IAAI,IAAI,CAAC,IAAa;QACrB,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE;YACvB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YACxC,6BAA6B;YAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,QAAQ,CAAC;SAC9B;aAAM,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE;YAC9B,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC;SACxC;IACF,CAAC;IAED;;OAEG;IACH,OAAO;QACN,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACb,CAAC;CACD"}

package/build/esm/component/dynamics/Compressor.d.ts

@@ -0,0 +1,73 @@
+import { Param } from "../../core/context/Param";
+import { ToneAudioNode, ToneAudioNodeOptions } from "../../core/context/ToneAudioNode";
+import { Decibels, Positive, Time } from "../../core/type/Units";
+export interface CompressorOptions extends ToneAudioNodeOptions {
+    attack: Time;
+    knee: Decibels;
+    ratio: Positive;
+    release: Time;
+    threshold: Decibels;
+}
+/**
+ * Compressor is a thin wrapper around the Web Audio
+ * [DynamicsCompressorNode](http://webaudio.github.io/web-audio-api/#the-dynamicscompressornode-interface).
+ * Compression reduces the volume of loud sounds or amplifies quiet sounds
+ * by narrowing or "compressing" an audio signal's dynamic range.
+ * Read more on [Wikipedia](https://en.wikipedia.org/wiki/Dynamic_range_compression).
+ * @example
+ * const comp = new Tone.Compressor(-30, 3);
+ * @category Component
+ */
+export declare class Compressor extends ToneAudioNode<CompressorOptions> {
+    readonly name: string;
+    /**
+     * the compressor node
+     */
+    private _compressor;
+    readonly input: DynamicsCompressorNode;
+    readonly output: DynamicsCompressorNode;
+    /**
+     * The decibel value above which the compression will start taking effect.
+     * @min -100
+     * @max 0
+     */
+    readonly threshold: Param<"decibels">;
+    /**
+     * The amount of time (in seconds) to reduce the gain by 10dB.
+     * @min 0
+     * @max 1
+     */
+    readonly attack: Param<"time">;
+    /**
+     * The amount of time (in seconds) to increase the gain by 10dB.
+     * @min 0
+     * @max 1
+     */
+    readonly release: Param<"time">;
+    /**
+     * A decibel value representing the range above the threshold where the
+     * curve smoothly transitions to the "ratio" portion.
+     * @min 0
+     * @max 40
+     */
+    readonly knee: Param<"decibels">;
+    /**
+     * The amount of dB change in input for a 1 dB change in output.
+     * @min 1
+     * @max 20
+     */
+    readonly ratio: Param<"positive">;
+    /**
+     * @param threshold The value above which the compression starts to be applied.
+     * @param ratio The gain reduction ratio.
+     */
+    constructor(threshold?: Decibels, ratio?: Positive);
+    constructor(options?: Partial<CompressorOptions>);
+    static getDefaults(): CompressorOptions;
+    /**
+     * A read-only decibel value for metering purposes, representing the current amount of gain
+     * reduction that the compressor is applying to the signal. If fed no signal the value will be 0 (no gain reduction).
+     */
+    get reduction(): Decibels;
+    dispose(): this;
+}

package/build/esm/component/dynamics/Compressor.js

@@ -0,0 +1,99 @@
+import { Param } from "../../core/context/Param";
+import { ToneAudioNode } from "../../core/context/ToneAudioNode";
+import { optionsFromArguments } from "../../core/util/Defaults";
+import { readOnly } from "../../core/util/Interface";
+/**
+ * Compressor is a thin wrapper around the Web Audio
+ * [DynamicsCompressorNode](http://webaudio.github.io/web-audio-api/#the-dynamicscompressornode-interface).
+ * Compression reduces the volume of loud sounds or amplifies quiet sounds
+ * by narrowing or "compressing" an audio signal's dynamic range.
+ * Read more on [Wikipedia](https://en.wikipedia.org/wiki/Dynamic_range_compression).
+ * @example
+ * const comp = new Tone.Compressor(-30, 3);
+ * @category Component
+ */
+export class Compressor extends ToneAudioNode {
+    constructor() {
+        super(optionsFromArguments(Compressor.getDefaults(), arguments, ["threshold", "ratio"]));
+        this.name = "Compressor";
+        /**
+         * the compressor node
+         */
+        this._compressor = this.context.createDynamicsCompressor();
+        this.input = this._compressor;
+        this.output = this._compressor;
+        const options = optionsFromArguments(Compressor.getDefaults(), arguments, ["threshold", "ratio"]);
+        this.threshold = new Param({
+            minValue: this._compressor.threshold.minValue,
+            maxValue: this._compressor.threshold.maxValue,
+            context: this.context,
+            convert: false,
+            param: this._compressor.threshold,
+            units: "decibels",
+            value: options.threshold,
+        });
+        this.attack = new Param({
+            minValue: this._compressor.attack.minValue,
+            maxValue: this._compressor.attack.maxValue,
+            context: this.context,
+            param: this._compressor.attack,
+            units: "time",
+            value: options.attack,
+        });
+        this.release = new Param({
+            minValue: this._compressor.release.minValue,
+            maxValue: this._compressor.release.maxValue,
+            context: this.context,
+            param: this._compressor.release,
+            units: "time",
+            value: options.release,
+        });
+        this.knee = new Param({
+            minValue: this._compressor.knee.minValue,
+            maxValue: this._compressor.knee.maxValue,
+            context: this.context,
+            convert: false,
+            param: this._compressor.knee,
+            units: "decibels",
+            value: options.knee,
+        });
+        this.ratio = new Param({
+            minValue: this._compressor.ratio.minValue,
+            maxValue: this._compressor.ratio.maxValue,
+            context: this.context,
+            convert: false,
+            param: this._compressor.ratio,
+            units: "positive",
+            value: options.ratio,
+        });
+        // set the defaults
+        readOnly(this, ["knee", "release", "attack", "ratio", "threshold"]);
+    }
+    static getDefaults() {
+        return Object.assign(ToneAudioNode.getDefaults(), {
+            attack: 0.003,
+            knee: 30,
+            ratio: 12,
+            release: 0.25,
+            threshold: -24,
+        });
+    }
+    /**
+     * A read-only decibel value for metering purposes, representing the current amount of gain
+     * reduction that the compressor is applying to the signal. If fed no signal the value will be 0 (no gain reduction).
+     */
+    get reduction() {
+        return this._compressor.reduction;
+    }
+    dispose() {
+        super.dispose();
+        this._compressor.disconnect();
+        this.attack.dispose();
+        this.release.dispose();
+        this.threshold.dispose();
+        this.ratio.dispose();
+        this.knee.dispose();
+        return this;
+    }
+}
+//# sourceMappingURL=Compressor.js.map

package/build/esm/component/dynamics/Compressor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Compressor.js","sourceRoot":"","sources":["../../../../Tone/component/dynamics/Compressor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,aAAa,EAAwB,MAAM,kCAAkC,CAAC;AAEvF,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAUrD;;;;;;;;;GASG;AACH,MAAM,OAAO,UAAW,SAAQ,aAAgC;IAqD/D;QAEC,KAAK,CAAC,oBAAoB,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QArDjF,SAAI,GAAW,YAAY,CAAC;QAErC;;WAEG;QACK,gBAAW,GAA2B,IAAI,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAC;QAC7E,UAAK,GAAG,IAAI,CAAC,WAAW,CAAC;QACzB,WAAM,GAAG,IAAI,CAAC,WAAW,CAAC;QA+ClC,MAAM,OAAO,GAAG,oBAAoB,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;QAElG,IAAI,CAAC,SAAS,GAAG,IAAI,KAAK,CAAC;YAC1B,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ;YAC7C,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ;YAC7C,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,SAAS;YACjC,KAAK,EAAE,UAAU;YACjB,KAAK,EAAE,OAAO,CAAC,SAAS;SACxB,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,IAAI,KAAK,CAAC;YACvB,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ;YAC1C,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ;YAC1C,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM;YAC9B,KAAK,EAAE,MAAM;YACb,KAAK,EAAE,OAAO,CAAC,MAAM;SACrB,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,IAAI,KAAK,CAAC;YACxB,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ;YAC3C,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ;YAC3C,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO;YAC/B,KAAK,EAAE,MAAM;YACb,KAAK,EAAE,OAAO,CAAC,OAAO;SACtB,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,CAAC;YACrB,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ;YACxC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ;YACxC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;YAC5B,KAAK,EAAE,UAAU;YACjB,KAAK,EAAE,OAAO,CAAC,IAAI;SACnB,CAAC,CAAC;QAEH,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC;YACtB,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ;YACzC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,QAAQ;YACzC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK;YAC7B,KAAK,EAAE,UAAU;YACjB,KAAK,EAAE,OAAO,CAAC,KAAK;SACpB,CAAC,CAAC;QAEH,mBAAmB;QACnB,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE;YACjD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,EAAE;YACR,KAAK,EAAE,EAAE;YACT,OAAO,EAAE,IAAI;YACb,SAAS,EAAE,CAAC,EAAE;SACd,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;IACnC,CAAC;IAED,OAAO;QACN,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACvB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC;IACb,CAAC;CACD"}

package/build/esm/component/dynamics/Gate.d.ts

@@ -0,0 +1,53 @@
+import { ToneAudioNode, ToneAudioNodeOptions } from "../../core/context/ToneAudioNode";
+import { Decibels, Time } from "../../core/type/Units";
+export interface GateOptions extends ToneAudioNodeOptions {
+    threshold: Decibels;
+    smoothing: Time;
+}
+/**
+ * Gate only passes a signal through when the incoming
+ * signal exceeds a specified threshold. It uses [[Follower]] to follow the ampltiude
+ * of the incoming signal and compares it to the [[threshold]] value using [[GreaterThan]].
+ *
+ * @example
+ * const gate = new Tone.Gate(-30, 0.2).toDestination();
+ * const mic = new Tone.UserMedia().connect(gate);
+ * // the gate will only pass through the incoming
+ * // signal when it's louder than -30db
+ * @category Component
+ */
+export declare class Gate extends ToneAudioNode<GateOptions> {
+    readonly name: string;
+    readonly input: ToneAudioNode;
+    readonly output: ToneAudioNode;
+    /**
+     * Follow the incoming signal
+     */
+    private _follower;
+    /**
+     * Test if it's greater than the threshold
+     */
+    private _gt;
+    /**
+     * Gate the incoming signal when it does not exceed the threshold
+     */
+    private _gate;
+    /**
+     * @param threshold The threshold above which the gate will open.
+     * @param smoothing The follower's smoothing time
+     */
+    constructor(threshold?: Decibels, smoothing?: Time);
+    constructor(options?: Partial<GateOptions>);
+    static getDefaults(): GateOptions;
+    /**
+     * The threshold of the gate in decibels
+     */
+    get threshold(): Decibels;
+    set threshold(thresh: Decibels);
+    /**
+     * The attack/decay speed of the gate. See [[Follower.smoothing]]
+     */
+    get smoothing(): Time;
+    set smoothing(smoothingTime: Time);
+    dispose(): this;
+}

package/build/esm/component/dynamics/Gate.js

@@ -0,0 +1,72 @@
+import { ToneAudioNode } from "../../core/context/ToneAudioNode";
+import { GreaterThan } from "../../signal/GreaterThan";
+import { Gain } from "../../core/context/Gain";
+import { Follower } from "../analysis/Follower";
+import { optionsFromArguments } from "../../core/util/Defaults";
+import { dbToGain, gainToDb } from "../../core/type/Conversions";
+/**
+ * Gate only passes a signal through when the incoming
+ * signal exceeds a specified threshold. It uses [[Follower]] to follow the ampltiude
+ * of the incoming signal and compares it to the [[threshold]] value using [[GreaterThan]].
+ *
+ * @example
+ * const gate = new Tone.Gate(-30, 0.2).toDestination();
+ * const mic = new Tone.UserMedia().connect(gate);
+ * // the gate will only pass through the incoming
+ * // signal when it's louder than -30db
+ * @category Component
+ */
+export class Gate extends ToneAudioNode {
+    constructor() {
+        super(Object.assign(optionsFromArguments(Gate.getDefaults(), arguments, ["threshold", "smoothing"])));
+        this.name = "Gate";
+        const options = optionsFromArguments(Gate.getDefaults(), arguments, ["threshold", "smoothing"]);
+        this._follower = new Follower({
+            context: this.context,
+            smoothing: options.smoothing,
+        });
+        this._gt = new GreaterThan({
+            context: this.context,
+            value: dbToGain(options.threshold),
+        });
+        this.input = new Gain({ context: this.context });
+        this._gate = this.output = new Gain({ context: this.context });
+        // connections
+        this.input.connect(this._gate);
+        // the control signal
+        this.input.chain(this._follower, this._gt, this._gate.gain);
+    }
+    static getDefaults() {
+        return Object.assign(ToneAudioNode.getDefaults(), {
+            smoothing: 0.1,
+            threshold: -40
+        });
+    }
+    /**
+     * The threshold of the gate in decibels
+     */
+    get threshold() {
+        return gainToDb(this._gt.value);
+    }
+    set threshold(thresh) {
+        this._gt.value = dbToGain(thresh);
+    }
+    /**
+     * The attack/decay speed of the gate. See [[Follower.smoothing]]
+     */
+    get smoothing() {
+        return this._follower.smoothing;
+    }
+    set smoothing(smoothingTime) {
+        this._follower.smoothing = smoothingTime;
+    }
+    dispose() {
+        super.dispose();
+        this.input.dispose();
+        this._follower.dispose();
+        this._gt.dispose();
+        this._gate.dispose();
+        return this;
+    }
+}
+//# sourceMappingURL=Gate.js.map

package/build/esm/component/dynamics/Gate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Gate.js","sourceRoot":"","sources":["../../../../Tone/component/dynamics/Gate.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAwB,MAAM,kCAAkC,CAAC;AAEvF,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAOjE;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,IAAK,SAAQ,aAA0B;IA4BnD;QACC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;QA3B9F,SAAI,GAAW,MAAM,CAAC;QA4B9B,MAAM,OAAO,GAAG,oBAAoB,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;QAEhG,IAAI,CAAC,SAAS,GAAG,IAAI,QAAQ,CAAC;YAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS,EAAE,OAAO,CAAC,SAAS;SAC5B,CAAC,CAAC;QACH,IAAI,CAAC,GAAG,GAAG,IAAI,WAAW,CAAC;YAC1B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC;SAClC,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAE/D,cAAc;QACd,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC/B,qBAAqB;QACrB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE;YACjD,SAAS,EAAE,GAAG;YACd,SAAS,EAAE,CAAC,EAAE;SACd,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACZ,OAAO,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,SAAS,CAAC,MAAM;QACnB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC;IACjC,CAAC;IACD,IAAI,SAAS,CAAC,aAAa;QAC1B,IAAI,CAAC,SAAS,CAAC,SAAS,GAAG,aAAa,CAAC;IAC1C,CAAC;IAED,OAAO;QACN,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACnB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC;IACb,CAAC;CACD"}