tone 14.8.27

package/build/esm/instrument/Instrument.js

@@ -0,0 +1,127 @@
+import { Volume } from "../component/channel/Volume";
+import { ToneAudioNode } from "../core/context/ToneAudioNode";
+import { optionsFromArguments } from "../core/util/Defaults";
+import { readOnly } from "../core/util/Interface";
+/**
+ * Base-class for all instruments
+ */
+export class Instrument extends ToneAudioNode {
+    constructor() {
+        super(optionsFromArguments(Instrument.getDefaults(), arguments));
+        /**
+         * Keep track of all events scheduled to the transport
+         * when the instrument is 'synced'
+         */
+        this._scheduledEvents = [];
+        /**
+         * If the instrument is currently synced
+         */
+        this._synced = false;
+        this._original_triggerAttack = this.triggerAttack;
+        this._original_triggerRelease = this.triggerRelease;
+        const options = optionsFromArguments(Instrument.getDefaults(), arguments);
+        this._volume = this.output = new Volume({
+            context: this.context,
+            volume: options.volume,
+        });
+        this.volume = this._volume.volume;
+        readOnly(this, "volume");
+    }
+    static getDefaults() {
+        return Object.assign(ToneAudioNode.getDefaults(), {
+            volume: 0,
+        });
+    }
+    /**
+     * Sync the instrument to the Transport. All subsequent calls of
+     * [[triggerAttack]] and [[triggerRelease]] will be scheduled along the transport.
+     * @example
+     * const fmSynth = new Tone.FMSynth().toDestination();
+     * fmSynth.volume.value = -6;
+     * fmSynth.sync();
+     * // schedule 3 notes when the transport first starts
+     * fmSynth.triggerAttackRelease("C4", "8n", 0);
+     * fmSynth.triggerAttackRelease("E4", "8n", "8n");
+     * fmSynth.triggerAttackRelease("G4", "8n", "4n");
+     * // start the transport to hear the notes
+     * Tone.Transport.start();
+     */
+    sync() {
+        if (this._syncState()) {
+            this._syncMethod("triggerAttack", 1);
+            this._syncMethod("triggerRelease", 0);
+        }
+        return this;
+    }
+    /**
+     * set _sync
+     */
+    _syncState() {
+        let changed = false;
+        if (!this._synced) {
+            this._synced = true;
+            changed = true;
+        }
+        return changed;
+    }
+    /**
+     * Wrap the given method so that it can be synchronized
+     * @param method Which method to wrap and sync
+     * @param  timePosition What position the time argument appears in
+     */
+    _syncMethod(method, timePosition) {
+        const originalMethod = this["_original_" + method] = this[method];
+        this[method] = (...args) => {
+            const time = args[timePosition];
+            const id = this.context.transport.schedule((t) => {
+                args[timePosition] = t;
+                originalMethod.apply(this, args);
+            }, time);
+            this._scheduledEvents.push(id);
+        };
+    }
+    /**
+     * Unsync the instrument from the Transport
+     */
+    unsync() {
+        this._scheduledEvents.forEach(id => this.context.transport.clear(id));
+        this._scheduledEvents = [];
+        if (this._synced) {
+            this._synced = false;
+            this.triggerAttack = this._original_triggerAttack;
+            this.triggerRelease = this._original_triggerRelease;
+        }
+        return this;
+    }
+    /**
+     * Trigger the attack and then the release after the duration.
+     * @param  note     The note to trigger.
+     * @param  duration How long the note should be held for before
+     *                         triggering the release. This value must be greater than 0.
+     * @param time  When the note should be triggered.
+     * @param  velocity The velocity the note should be triggered at.
+     * @example
+     * const synth = new Tone.Synth().toDestination();
+     * // trigger "C4" for the duration of an 8th note
+     * synth.triggerAttackRelease("C4", "8n");
+     */
+    triggerAttackRelease(note, duration, time, velocity) {
+        const computedTime = this.toSeconds(time);
+        const computedDuration = this.toSeconds(duration);
+        this.triggerAttack(note, computedTime, velocity);
+        this.triggerRelease(computedTime + computedDuration);
+        return this;
+    }
+    /**
+     * clean up
+     * @returns {Instrument} this
+     */
+    dispose() {
+        super.dispose();
+        this._volume.dispose();
+        this.unsync();
+        this._scheduledEvents = [];
+        return this;
+    }
+}
+//# sourceMappingURL=Instrument.js.map

package/build/esm/instrument/Instrument.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Instrument.js","sourceRoot":"","sources":["../../../Tone/instrument/Instrument.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAErD,OAAO,EAAc,aAAa,EAAwB,MAAM,+BAA+B,CAAC;AAEhG,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAMlD;;GAEG;AACH,MAAM,OAAgB,UAA8C,SAAQ,aAAsB;IAkCjG;QAEC,KAAK,CAAC,oBAAoB,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;QAdlE;;;WAGG;QACK,qBAAgB,GAAa,EAAE,CAAC;QAExC;;WAEG;QACK,YAAO,GAAG,KAAK,CAAC;QAkHhB,4BAAuB,GAAG,IAAI,CAAC,aAAa,CAAC;QAO7C,6BAAwB,GAAG,IAAI,CAAC,cAAc,CAAC;QAnHtD,MAAM,OAAO,GAAG,oBAAoB,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,SAAS,CAAC,CAAC;QAE1E,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC;YACvC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,OAAO,CAAC,MAAM;SACtB,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QAClC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE;YACjD,MAAM,EAAE,CAAC;SACT,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI;QACH,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE;YACtB,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;YACrC,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;SACtC;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACO,UAAU;QACnB,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YAClB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACpB,OAAO,GAAG,IAAI,CAAC;SACf;QACD,OAAO,OAAO,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACO,WAAW,CAAC,MAAc,EAAE,YAAoB;QACzD,MAAM,cAAc,GAAG,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;QAClE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE;YACjC,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;YAChC,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE;gBAChD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;gBACvB,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAClC,CAAC,EAAE,IAAI,CAAC,CAAC;YACT,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAChC,CAAC,CAAC;IACH,CAAC;IAED;;OAEG;IACH,MAAM;QACL,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAC3B,IAAI,IAAI,CAAC,OAAO,EAAE;YACjB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;YACrB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,uBAAuB,CAAC;YAClD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,wBAAwB,CAAC;SACpD;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;OAWG;IACH,oBAAoB,CAAC,IAAe,EAAE,QAAc,EAAE,IAAW,EAAE,QAAsB;QACxF,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC1C,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;QACjD,IAAI,CAAC,cAAc,CAAC,YAAY,GAAG,gBAAgB,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC;IACb,CAAC;IAkBD;;;OAGG;IACH,OAAO;QACN,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACvB,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC;IACb,CAAC;CACD"}

package/build/esm/instrument/MembraneSynth.d.ts

@@ -0,0 +1,47 @@
+import { FrequencyClass } from "../core/type/Frequency";
+import { Frequency, Positive, Time } from "../core/type/Units";
+import { RecursivePartial } from "../core/util/Interface";
+import { Synth, SynthOptions } from "./Synth";
+export interface MembraneSynthOptions extends SynthOptions {
+    pitchDecay: Time;
+    octaves: Positive;
+}
+/**
+ * MembraneSynth makes kick and tom sounds using a single oscillator
+ * with an amplitude envelope and frequency ramp. A Tone.OmniOscillator
+ * is routed through a Tone.AmplitudeEnvelope to the output. The drum
+ * quality of the sound comes from the frequency envelope applied
+ * during MembraneSynth.triggerAttack(note). The frequency envelope
+ * starts at <code>note * .octaves</code> and ramps to <code>note</code>
+ * over the duration of <code>.pitchDecay</code>.
+ * @example
+ * const synth = new Tone.MembraneSynth().toDestination();
+ * synth.triggerAttackRelease("C2", "8n");
+ * @category Instrument
+ */
+export declare class MembraneSynth extends Synth<MembraneSynthOptions> {
+    readonly name: string;
+    /**
+     * The number of octaves the pitch envelope ramps.
+     * @min 0.5
+     * @max 8
+     */
+    octaves: Positive;
+    /**
+     * The amount of time the frequency envelope takes.
+     * @min 0
+     * @max 0.5
+     */
+    pitchDecay: Time;
+    /**
+     * Portamento is ignored in this synth. use pitch decay instead.
+     */
+    readonly portamento = 0;
+    /**
+     * @param options the options available for the synth see defaults
+     */
+    constructor(options?: RecursivePartial<MembraneSynthOptions>);
+    static getDefaults(): MembraneSynthOptions;
+    setNote(note: Frequency | FrequencyClass, time?: Time): this;
+    dispose(): this;
+}

package/build/esm/instrument/MembraneSynth.js

@@ -0,0 +1,69 @@
+import { __decorate } from "tslib";
+import { FrequencyClass } from "../core/type/Frequency";
+import { deepMerge, optionsFromArguments } from "../core/util/Defaults";
+import { readOnly } from "../core/util/Interface";
+import { Monophonic } from "./Monophonic";
+import { Synth } from "./Synth";
+import { range, timeRange } from "../core/util/Decorator";
+/**
+ * MembraneSynth makes kick and tom sounds using a single oscillator
+ * with an amplitude envelope and frequency ramp. A Tone.OmniOscillator
+ * is routed through a Tone.AmplitudeEnvelope to the output. The drum
+ * quality of the sound comes from the frequency envelope applied
+ * during MembraneSynth.triggerAttack(note). The frequency envelope
+ * starts at <code>note * .octaves</code> and ramps to <code>note</code>
+ * over the duration of <code>.pitchDecay</code>.
+ * @example
+ * const synth = new Tone.MembraneSynth().toDestination();
+ * synth.triggerAttackRelease("C2", "8n");
+ * @category Instrument
+ */
+export class MembraneSynth extends Synth {
+    constructor() {
+        super(optionsFromArguments(MembraneSynth.getDefaults(), arguments));
+        this.name = "MembraneSynth";
+        /**
+         * Portamento is ignored in this synth. use pitch decay instead.
+         */
+        this.portamento = 0;
+        const options = optionsFromArguments(MembraneSynth.getDefaults(), arguments);
+        this.pitchDecay = options.pitchDecay;
+        this.octaves = options.octaves;
+        readOnly(this, ["oscillator", "envelope"]);
+    }
+    static getDefaults() {
+        return deepMerge(Monophonic.getDefaults(), Synth.getDefaults(), {
+            envelope: {
+                attack: 0.001,
+                attackCurve: "exponential",
+                decay: 0.4,
+                release: 1.4,
+                sustain: 0.01,
+            },
+            octaves: 10,
+            oscillator: {
+                type: "sine",
+            },
+            pitchDecay: 0.05,
+        });
+    }
+    setNote(note, time) {
+        const seconds = this.toSeconds(time);
+        const hertz = this.toFrequency(note instanceof FrequencyClass ? note.toFrequency() : note);
+        const maxNote = hertz * this.octaves;
+        this.oscillator.frequency.setValueAtTime(maxNote, seconds);
+        this.oscillator.frequency.exponentialRampToValueAtTime(hertz, seconds + this.toSeconds(this.pitchDecay));
+        return this;
+    }
+    dispose() {
+        super.dispose();
+        return this;
+    }
+}
+__decorate([
+    range(0)
+], MembraneSynth.prototype, "octaves", void 0);
+__decorate([
+    timeRange(0)
+], MembraneSynth.prototype, "pitchDecay", void 0);
+//# sourceMappingURL=MembraneSynth.js.map

package/build/esm/instrument/MembraneSynth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MembraneSynth.js","sourceRoot":"","sources":["../../../Tone/instrument/MembraneSynth.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,OAAO,EAAE,SAAS,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAoB,MAAM,wBAAwB,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAgB,MAAM,SAAS,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAO1D;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,aAAc,SAAQ,KAA2B;IA6B7D;QAEC,KAAK,CAAC,oBAAoB,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;QA7B5D,SAAI,GAAW,eAAe,CAAC;QAkBxC;;WAEG;QACM,eAAU,GAAG,CAAC,CAAC;QASvB,MAAM,OAAO,GAAG,oBAAoB,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE,SAAS,CAAC,CAAC;QAE7E,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,QAAQ,CAAC,IAAI,EAAE,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,SAAS,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,KAAK,CAAC,WAAW,EAAE,EAAE;YAC/D,QAAQ,EAAE;gBACT,MAAM,EAAE,KAAK;gBACb,WAAW,EAAE,aAAa;gBAC1B,KAAK,EAAE,GAAG;gBACV,OAAO,EAAE,GAAG;gBACZ,OAAO,EAAE,IAAI;aACb;YACD,OAAO,EAAE,EAAE;YACX,UAAU,EAAE;gBACX,IAAI,EAAE,MAAM;aACZ;YACD,UAAU,EAAE,IAAI;SAChB,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,IAAgC,EAAE,IAAW;QACpD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,YAAY,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAC3F,MAAM,OAAO,GAAG,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC;QACrC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC3D,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,4BAA4B,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QACzG,OAAO,IAAI,CAAC;IACb,CAAC;IAED,OAAO;QACN,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AA3DA;IADC,KAAK,CAAC,CAAC,CAAC;8CACS;AAQlB;IADC,SAAS,CAAC,CAAC,CAAC;iDACI"}

package/build/esm/instrument/MetalSynth.d.ts

@@ -0,0 +1,109 @@
+import { Envelope, EnvelopeOptions } from "../component/envelope/Envelope";
+import { ToneAudioNodeOptions } from "../core/context/ToneAudioNode";
+import { Frequency, NormalRange, Positive, Seconds, Time } from "../core/type/Units";
+import { RecursivePartial } from "../core/util/Interface";
+import { Signal } from "../signal/Signal";
+import { Monophonic, MonophonicOptions } from "./Monophonic";
+export interface MetalSynthOptions extends MonophonicOptions {
+    harmonicity: Positive;
+    modulationIndex: Positive;
+    octaves: number;
+    resonance: Frequency;
+    envelope: Omit<EnvelopeOptions, keyof ToneAudioNodeOptions>;
+}
+/**
+ * A highly inharmonic and spectrally complex source with a highpass filter
+ * and amplitude envelope which is good for making metallophone sounds.
+ * Based on CymbalSynth by [@polyrhythmatic](https://github.com/polyrhythmatic).
+ * Inspiration from [Sound on Sound](https://shorturl.at/rSZ12).
+ * @category Instrument
+ */
+export declare class MetalSynth extends Monophonic<MetalSynthOptions> {
+    readonly name: string;
+    /**
+     * The frequency of the cymbal
+     */
+    readonly frequency: Signal<"frequency">;
+    /**
+     * The detune applied to the oscillators
+     */
+    readonly detune: Signal<"cents">;
+    /**
+     * The array of FMOscillators
+     */
+    private _oscillators;
+    /**
+     * The frequency multipliers
+     */
+    private _freqMultipliers;
+    /**
+     * The gain node for the envelope.
+     */
+    private _amplitude;
+    /**
+     * Highpass the output
+     */
+    private _highpass;
+    /**
+     * The number of octaves the highpass
+     * filter frequency ramps
+     */
+    private _octaves;
+    /**
+     * Scale the body envelope for the highpass filter
+     */
+    private _filterFreqScaler;
+    /**
+     * The envelope which is connected both to the
+     * amplitude and a highpass filter's cutoff frequency.
+     * The lower-limit of the filter is controlled by the [[resonance]]
+     */
+    readonly envelope: Envelope;
+    constructor(options?: RecursivePartial<MetalSynthOptions>);
+    static getDefaults(): MetalSynthOptions;
+    /**
+     * Trigger the attack.
+     * @param time When the attack should be triggered.
+     * @param velocity The velocity that the envelope should be triggered at.
+     */
+    protected _triggerEnvelopeAttack(time: Seconds, velocity?: NormalRange): this;
+    /**
+     * Trigger the release of the envelope.
+     * @param time When the release should be triggered.
+     */
+    protected _triggerEnvelopeRelease(time: Seconds): this;
+    getLevelAtTime(time: Time): NormalRange;
+    /**
+     * The modulationIndex of the oscillators which make up the source.
+     * see [[FMOscillator.modulationIndex]]
+     * @min 1
+     * @max 100
+     */
+    get modulationIndex(): number;
+    set modulationIndex(val: number);
+    /**
+     * The harmonicity of the oscillators which make up the source.
+     * see Tone.FMOscillator.harmonicity
+     * @min 0.1
+     * @max 10
+     */
+    get harmonicity(): number;
+    set harmonicity(val: number);
+    /**
+     * The lower level of the highpass filter which is attached to the envelope.
+     * This value should be between [0, 7000]
+     * @min 0
+     * @max 7000
+     */
+    get resonance(): Frequency;
+    set resonance(val: Frequency);
+    /**
+     * The number of octaves above the "resonance" frequency
+     * that the filter ramps during the attack/decay envelope
+     * @min 0
+     * @max 8
+     */
+    get octaves(): number;
+    set octaves(val: number);
+    dispose(): this;
+}

package/build/esm/instrument/MetalSynth.js

@@ -0,0 +1,198 @@
+import { Envelope } from "../component/envelope/Envelope";
+import { Filter } from "../component/filter/Filter";
+import { Gain } from "../core/context/Gain";
+import { ToneAudioNode } from "../core/context/ToneAudioNode";
+import { deepMerge, omitFromObject, optionsFromArguments } from "../core/util/Defaults";
+import { noOp } from "../core/util/Interface";
+import { Multiply } from "../signal/Multiply";
+import { Scale } from "../signal/Scale";
+import { Signal } from "../signal/Signal";
+import { FMOscillator } from "../source/oscillator/FMOscillator";
+import { Monophonic } from "./Monophonic";
+/**
+ * Inharmonic ratio of frequencies based on the Roland TR-808
+ * Taken from https://ccrma.stanford.edu/papers/tr-808-cymbal-physically-informed-circuit-bendable-digital-model
+ */
+const inharmRatios = [1.0, 1.483, 1.932, 2.546, 2.630, 3.897];
+/**
+ * A highly inharmonic and spectrally complex source with a highpass filter
+ * and amplitude envelope which is good for making metallophone sounds.
+ * Based on CymbalSynth by [@polyrhythmatic](https://github.com/polyrhythmatic).
+ * Inspiration from [Sound on Sound](https://shorturl.at/rSZ12).
+ * @category Instrument
+ */
+export class MetalSynth extends Monophonic {
+    constructor() {
+        super(optionsFromArguments(MetalSynth.getDefaults(), arguments));
+        this.name = "MetalSynth";
+        /**
+         * The array of FMOscillators
+         */
+        this._oscillators = [];
+        /**
+         * The frequency multipliers
+         */
+        this._freqMultipliers = [];
+        const options = optionsFromArguments(MetalSynth.getDefaults(), arguments);
+        this.detune = new Signal({
+            context: this.context,
+            units: "cents",
+            value: options.detune,
+        });
+        this.frequency = new Signal({
+            context: this.context,
+            units: "frequency",
+        });
+        this._amplitude = new Gain({
+            context: this.context,
+            gain: 0,
+        }).connect(this.output);
+        this._highpass = new Filter({
+            // Q: -3.0102999566398125,
+            Q: 0,
+            context: this.context,
+            type: "highpass",
+        }).connect(this._amplitude);
+        for (let i = 0; i < inharmRatios.length; i++) {
+            const osc = new FMOscillator({
+                context: this.context,
+                harmonicity: options.harmonicity,
+                modulationIndex: options.modulationIndex,
+                modulationType: "square",
+                onstop: i === 0 ? () => this.onsilence(this) : noOp,
+                type: "square",
+            });
+            osc.connect(this._highpass);
+            this._oscillators[i] = osc;
+            const mult = new Multiply({
+                context: this.context,
+                value: inharmRatios[i],
+            });
+            this._freqMultipliers[i] = mult;
+            this.frequency.chain(mult, osc.frequency);
+            this.detune.connect(osc.detune);
+        }
+        this._filterFreqScaler = new Scale({
+            context: this.context,
+            max: 7000,
+            min: this.toFrequency(options.resonance),
+        });
+        this.envelope = new Envelope({
+            attack: options.envelope.attack,
+            attackCurve: "linear",
+            context: this.context,
+            decay: options.envelope.decay,
+            release: options.envelope.release,
+            sustain: 0,
+        });
+        this.envelope.chain(this._filterFreqScaler, this._highpass.frequency);
+        this.envelope.connect(this._amplitude.gain);
+        // set the octaves
+        this._octaves = options.octaves;
+        this.octaves = options.octaves;
+    }
+    static getDefaults() {
+        return deepMerge(Monophonic.getDefaults(), {
+            envelope: Object.assign(omitFromObject(Envelope.getDefaults(), Object.keys(ToneAudioNode.getDefaults())), {
+                attack: 0.001,
+                decay: 1.4,
+                release: 0.2,
+            }),
+            harmonicity: 5.1,
+            modulationIndex: 32,
+            octaves: 1.5,
+            resonance: 4000,
+        });
+    }
+    /**
+     * Trigger the attack.
+     * @param time When the attack should be triggered.
+     * @param velocity The velocity that the envelope should be triggered at.
+     */
+    _triggerEnvelopeAttack(time, velocity = 1) {
+        this.envelope.triggerAttack(time, velocity);
+        this._oscillators.forEach(osc => osc.start(time));
+        if (this.envelope.sustain === 0) {
+            this._oscillators.forEach(osc => {
+                osc.stop(time + this.toSeconds(this.envelope.attack) + this.toSeconds(this.envelope.decay));
+            });
+        }
+        return this;
+    }
+    /**
+     * Trigger the release of the envelope.
+     * @param time When the release should be triggered.
+     */
+    _triggerEnvelopeRelease(time) {
+        this.envelope.triggerRelease(time);
+        this._oscillators.forEach(osc => osc.stop(time + this.toSeconds(this.envelope.release)));
+        return this;
+    }
+    getLevelAtTime(time) {
+        time = this.toSeconds(time);
+        return this.envelope.getValueAtTime(time);
+    }
+    /**
+     * The modulationIndex of the oscillators which make up the source.
+     * see [[FMOscillator.modulationIndex]]
+     * @min 1
+     * @max 100
+     */
+    get modulationIndex() {
+        return this._oscillators[0].modulationIndex.value;
+    }
+    set modulationIndex(val) {
+        this._oscillators.forEach(osc => (osc.modulationIndex.value = val));
+    }
+    /**
+     * The harmonicity of the oscillators which make up the source.
+     * see Tone.FMOscillator.harmonicity
+     * @min 0.1
+     * @max 10
+     */
+    get harmonicity() {
+        return this._oscillators[0].harmonicity.value;
+    }
+    set harmonicity(val) {
+        this._oscillators.forEach(osc => (osc.harmonicity.value = val));
+    }
+    /**
+     * The lower level of the highpass filter which is attached to the envelope.
+     * This value should be between [0, 7000]
+     * @min 0
+     * @max 7000
+     */
+    get resonance() {
+        return this._filterFreqScaler.min;
+    }
+    set resonance(val) {
+        this._filterFreqScaler.min = this.toFrequency(val);
+        this.octaves = this._octaves;
+    }
+    /**
+     * The number of octaves above the "resonance" frequency
+     * that the filter ramps during the attack/decay envelope
+     * @min 0
+     * @max 8
+     */
+    get octaves() {
+        return this._octaves;
+    }
+    set octaves(val) {
+        this._octaves = val;
+        this._filterFreqScaler.max = this._filterFreqScaler.min * Math.pow(2, val);
+    }
+    dispose() {
+        super.dispose();
+        this._oscillators.forEach(osc => osc.dispose());
+        this._freqMultipliers.forEach(freqMult => freqMult.dispose());
+        this.frequency.dispose();
+        this.detune.dispose();
+        this._filterFreqScaler.dispose();
+        this._amplitude.dispose();
+        this.envelope.dispose();
+        this._highpass.dispose();
+        return this;
+    }
+}
+//# sourceMappingURL=MetalSynth.js.map

package/build/esm/instrument/MetalSynth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MetalSynth.js","sourceRoot":"","sources":["../../../Tone/instrument/MetalSynth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAmB,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAwB,MAAM,+BAA+B,CAAC;AAEpF,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AACxF,OAAO,EAAE,IAAI,EAAoB,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AACjE,OAAO,EAAE,UAAU,EAAqB,MAAM,cAAc,CAAC;AAU7D;;;GAGG;AACH,MAAM,YAAY,GAAa,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAExE;;;;;;GAMG;AACH,MAAM,OAAO,UAAW,SAAQ,UAA6B;IAqD5D;QACC,KAAK,CAAC,oBAAoB,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;QApDzD,SAAI,GAAW,YAAY,CAAC;QAYrC;;WAEG;QACK,iBAAY,GAAmB,EAAE,CAAC;QAE1C;;WAEG;QACK,qBAAgB,GAAe,EAAE,CAAC;QAiCzC,MAAM,OAAO,GAAG,oBAAoB,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,SAAS,CAAC,CAAC;QAE1E,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,SAAS,GAAG,IAAI,MAAM,CAAC;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,WAAW;SAClB,CAAC,CAAC;QAEH,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,CAAC;YAC1B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,CAAC;SACP,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAExB,IAAI,CAAC,SAAS,GAAG,IAAI,MAAM,CAAC;YAC3B,0BAA0B;YAC1B,CAAC,EAAE,CAAC;YACJ,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,UAAU;SAChB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAE5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC7C,MAAM,GAAG,GAAG,IAAI,YAAY,CAAC;gBAC5B,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,eAAe,EAAE,OAAO,CAAC,eAAe;gBACxC,cAAc,EAAE,QAAQ;gBACxB,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;gBACnD,IAAI,EAAE,QAAQ;aACd,CAAC,CAAC;YACH,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC5B,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;YAE3B,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC;gBACzB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;aACtB,CAAC,CAAC;YACH,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;YAChC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;YAC1C,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;SAChC;QAED,IAAI,CAAC,iBAAiB,GAAG,IAAI,KAAK,CAAC;YAClC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,GAAG,EAAE,IAAI;YACT,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC;SACxC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC;YAC5B,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,MAAM;YAC/B,WAAW,EAAE,QAAQ;YACrB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,KAAK;YAC7B,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO;YACjC,OAAO,EAAE,CAAC;SACV,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACtE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC5C,kBAAkB;QAClB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;QAChC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,SAAS,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE;YAC1C,QAAQ,EAAE,MAAM,CAAC,MAAM,CACtB,cAAc,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,EAChF;gBACC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,GAAG;gBACV,OAAO,EAAE,GAAG;aACZ,CACD;YACD,WAAW,EAAE,GAAG;YAChB,eAAe,EAAE,EAAE;YACnB,OAAO,EAAE,GAAG;YACZ,SAAS,EAAE,IAAI;SACf,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACO,sBAAsB,CAAC,IAAa,EAAE,WAAwB,CAAC;QACxE,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC5C,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;QAClD,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,KAAK,CAAC,EAAE;YAChC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;gBAC/B,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;YAC7F,CAAC,CAAC,CAAC;SACH;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACO,uBAAuB,CAAC,IAAa;QAC9C,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACzF,OAAO,IAAI,CAAC;IACb,CAAC;IAED,cAAc,CAAC,IAAU;QACxB,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,IAAI,eAAe;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC;IACnD,CAAC;IACD,IAAI,eAAe,CAAC,GAAG;QACtB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACH,IAAI,WAAW;QACd,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC;IAC/C,CAAC;IACD,IAAI,WAAW,CAAC,GAAG;QAClB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACH,IAAI,SAAS;QACZ,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC;IACnC,CAAC;IACD,IAAI,SAAS,CAAC,GAAG;QAChB,IAAI,CAAC,iBAAiB,CAAC,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC;IAC9B,CAAC;IAED;;;;;OAKG;IACH,IAAI,OAAO;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IACD,IAAI,OAAO,CAAC,GAAG;QACd,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;QACpB,IAAI,CAAC,iBAAiB,CAAC,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC5E,CAAC;IAED,OAAO;QACN,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QAChD,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9D,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACtB,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAC;QACjC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;QAC1B,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;QACxB,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC;IACb,CAAC;CACD"}

package/build/esm/instrument/ModulationSynth.d.ts

@@ -0,0 +1,81 @@
+import { Signal } from "../signal/Signal";
+import { Multiply } from "../signal/Multiply";
+import { Gain } from "../core/context/Gain";
+import { NormalRange, Positive, Seconds, Time } from "../core/type/Units";
+import { EnvelopeOptions } from "../component/envelope/Envelope";
+import { ToneAudioNodeOptions } from "../core/context/ToneAudioNode";
+import { Monophonic } from "./Monophonic";
+import { OmniOscillator } from "../source/oscillator/OmniOscillator";
+import { OmniOscillatorSynthOptions } from "../source/oscillator/OscillatorInterface";
+import { Synth, SynthOptions } from "./Synth";
+import { AmplitudeEnvelope } from "../component/envelope/AmplitudeEnvelope";
+import { RecursivePartial } from "../core/util/Interface";
+export interface ModulationSynthOptions extends SynthOptions {
+    harmonicity: Positive;
+    modulationEnvelope: Omit<EnvelopeOptions, keyof ToneAudioNodeOptions>;
+    modulation: OmniOscillatorSynthOptions;
+}
+/**
+ * Base class for both AM and FM synths
+ */
+export declare abstract class ModulationSynth<Options extends ModulationSynthOptions> extends Monophonic<Options> {
+    readonly name: string;
+    /**
+     * The carrier voice.
+     */
+    protected _carrier: Synth;
+    /**
+     * The modulator voice.
+     */
+    protected _modulator: Synth;
+    /**
+     * The carrier's oscillator
+     */
+    readonly oscillator: OmniOscillator<any>;
+    /**
+     * The carrier's envelope
+     */
+    readonly envelope: AmplitudeEnvelope;
+    /**
+     * The modulator's oscillator which is applied to the amplitude of the oscillator
+     */
+    readonly modulation: OmniOscillator<any>;
+    /**
+     * The modulator's envelope
+     */
+    readonly modulationEnvelope: AmplitudeEnvelope;
+    /**
+     * The frequency control
+     */
+    readonly frequency: Signal<"frequency">;
+    /**
+     * The detune in cents
+     */
+    readonly detune: Signal<"cents">;
+    /**
+     * Harmonicity is the ratio between the two voices. A harmonicity of
+     * 1 is no change. Harmonicity = 2 means a change of an octave.
+     * @example
+     * const amSynth = new Tone.AMSynth().toDestination();
+     * // pitch the modulator an octave below oscillator
+     * amSynth.harmonicity.value = 0.5;
+     * amSynth.triggerAttackRelease("C5", "4n");
+     */
+    readonly harmonicity: Multiply;
+    /**
+     * The node where the modulation happens
+     */
+    protected _modulationNode: Gain;
+    constructor(options?: RecursivePartial<ModulationSynthOptions>);
+    static getDefaults(): ModulationSynthOptions;
+    /**
+     * Trigger the attack portion of the note
+     */
+    protected _triggerEnvelopeAttack(time: Seconds, velocity: number): void;
+    /**
+     * Trigger the release portion of the note
+     */
+    protected _triggerEnvelopeRelease(time: Seconds): this;
+    getLevelAtTime(time: Time): NormalRange;
+    dispose(): this;
+}