tone 14.8.27

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

@@ -0,0 +1,126 @@
+import { ToneAudioBuffer } from "../core/context/ToneAudioBuffer";
+import { Frequency, MidiNote, NormalRange, Note, Time } from "../core/type/Units";
+import { Instrument, InstrumentOptions } from "../instrument/Instrument";
+import { ToneBufferSourceCurve } from "../source/buffer/ToneBufferSource";
+interface SamplesMap {
+    [note: string]: ToneAudioBuffer | AudioBuffer | string;
+    [midi: number]: ToneAudioBuffer | AudioBuffer | string;
+}
+export interface SamplerOptions extends InstrumentOptions {
+    attack: Time;
+    release: Time;
+    onload: () => void;
+    onerror: (error: Error) => void;
+    baseUrl: string;
+    curve: ToneBufferSourceCurve;
+    urls: SamplesMap;
+}
+/**
+ * Pass in an object which maps the note's pitch or midi value to the url,
+ * then you can trigger the attack and release of that note like other instruments.
+ * By automatically repitching the samples, it is possible to play pitches which
+ * were not explicitly included which can save loading time.
+ *
+ * For sample or buffer playback where repitching is not necessary,
+ * use [[Player]].
+ * @example
+ * const sampler = new Tone.Sampler({
+ * 	urls: {
+ * 		A1: "A1.mp3",
+ * 		A2: "A2.mp3",
+ * 	},
+ * 	baseUrl: "https://tonejs.github.io/audio/casio/",
+ * 	onload: () => {
+ * 		sampler.triggerAttackRelease(["C1", "E1", "G1", "B1"], 0.5);
+ * 	}
+ * }).toDestination();
+ * @category Instrument
+ */
+export declare class Sampler extends Instrument<SamplerOptions> {
+    readonly name: string;
+    /**
+     * The stored and loaded buffers
+     */
+    private _buffers;
+    /**
+     * The object of all currently playing BufferSources
+     */
+    private _activeSources;
+    /**
+     * The envelope applied to the beginning of the sample.
+     * @min 0
+     * @max 1
+     */
+    attack: Time;
+    /**
+     * The envelope applied to the end of the envelope.
+     * @min 0
+     * @max 1
+     */
+    release: Time;
+    /**
+     * The shape of the attack/release curve.
+     * Either "linear" or "exponential"
+     */
+    curve: ToneBufferSourceCurve;
+    /**
+     * @param samples An object of samples mapping either Midi Note Numbers or
+     * 			Scientific Pitch Notation to the url of that sample.
+     * @param onload The callback to invoke when all of the samples are loaded.
+     * @param baseUrl The root URL of all of the samples, which is prepended to all the URLs.
+     */
+    constructor(samples?: SamplesMap, onload?: () => void, baseUrl?: string);
+    /**
+     * @param samples An object of samples mapping either Midi Note Numbers or
+     * 			Scientific Pitch Notation to the url of that sample.
+     * @param options The remaining options associated with the sampler
+     */
+    constructor(samples?: SamplesMap, options?: Partial<Omit<SamplerOptions, "urls">>);
+    constructor(options?: Partial<SamplerOptions>);
+    static getDefaults(): SamplerOptions;
+    /**
+     * Returns the difference in steps between the given midi note at the closets sample.
+     */
+    private _findClosest;
+    /**
+     * @param  notes	The note to play, or an array of notes.
+     * @param  time     When to play the note
+     * @param  velocity The velocity to play the sample back.
+     */
+    triggerAttack(notes: Frequency | Frequency[], time?: Time, velocity?: NormalRange): this;
+    /**
+     * @param  notes	The note to release, or an array of notes.
+     * @param  time     	When to release the note.
+     */
+    triggerRelease(notes: Frequency | Frequency[], time?: Time): this;
+    /**
+     * Release all currently active notes.
+     * @param  time     	When to release the notes.
+     */
+    releaseAll(time?: Time): this;
+    sync(): this;
+    /**
+     * Invoke the attack phase, then after the duration, invoke the release.
+     * @param  notes	The note to play and release, or an array of notes.
+     * @param  duration The time the note should be held
+     * @param  time     When to start the attack
+     * @param  velocity The velocity of the attack
+     */
+    triggerAttackRelease(notes: Frequency[] | Frequency, duration: Time | Time[], time?: Time, velocity?: NormalRange): this;
+    /**
+     * Add a note to the sampler.
+     * @param  note      The buffer's pitch.
+     * @param  url  Either the url of the buffer, or a buffer which will be added with the given name.
+     * @param  callback  The callback to invoke when the url is loaded.
+     */
+    add(note: Note | MidiNote, url: string | ToneAudioBuffer | AudioBuffer, callback?: () => void): this;
+    /**
+     * If the buffers are loaded or not
+     */
+    get loaded(): boolean;
+    /**
+     * Clean up
+     */
+    dispose(): this;
+}
+export {};

package/build/esm/instrument/Sampler.js

@@ -0,0 +1,259 @@
+import { __decorate } from "tslib";
+import { ToneAudioBuffers } from "../core/context/ToneAudioBuffers";
+import { ftomf, intervalToFrequencyRatio } from "../core/type/Conversions";
+import { FrequencyClass } from "../core/type/Frequency";
+import { optionsFromArguments } from "../core/util/Defaults";
+import { noOp } from "../core/util/Interface";
+import { isArray, isNote, isNumber } from "../core/util/TypeCheck";
+import { Instrument } from "../instrument/Instrument";
+import { ToneBufferSource } from "../source/buffer/ToneBufferSource";
+import { timeRange } from "../core/util/Decorator";
+import { assert } from "../core/util/Debug";
+/**
+ * Pass in an object which maps the note's pitch or midi value to the url,
+ * then you can trigger the attack and release of that note like other instruments.
+ * By automatically repitching the samples, it is possible to play pitches which
+ * were not explicitly included which can save loading time.
+ *
+ * For sample or buffer playback where repitching is not necessary,
+ * use [[Player]].
+ * @example
+ * const sampler = new Tone.Sampler({
+ * 	urls: {
+ * 		A1: "A1.mp3",
+ * 		A2: "A2.mp3",
+ * 	},
+ * 	baseUrl: "https://tonejs.github.io/audio/casio/",
+ * 	onload: () => {
+ * 		sampler.triggerAttackRelease(["C1", "E1", "G1", "B1"], 0.5);
+ * 	}
+ * }).toDestination();
+ * @category Instrument
+ */
+export class Sampler extends Instrument {
+    constructor() {
+        super(optionsFromArguments(Sampler.getDefaults(), arguments, ["urls", "onload", "baseUrl"], "urls"));
+        this.name = "Sampler";
+        /**
+         * The object of all currently playing BufferSources
+         */
+        this._activeSources = new Map();
+        const options = optionsFromArguments(Sampler.getDefaults(), arguments, ["urls", "onload", "baseUrl"], "urls");
+        const urlMap = {};
+        Object.keys(options.urls).forEach((note) => {
+            const noteNumber = parseInt(note, 10);
+            assert(isNote(note)
+                || (isNumber(noteNumber) && isFinite(noteNumber)), `url key is neither a note or midi pitch: ${note}`);
+            if (isNote(note)) {
+                // convert the note name to MIDI
+                const mid = new FrequencyClass(this.context, note).toMidi();
+                urlMap[mid] = options.urls[note];
+            }
+            else if (isNumber(noteNumber) && isFinite(noteNumber)) {
+                // otherwise if it's numbers assume it's midi
+                urlMap[noteNumber] = options.urls[noteNumber];
+            }
+        });
+        this._buffers = new ToneAudioBuffers({
+            urls: urlMap,
+            onload: options.onload,
+            baseUrl: options.baseUrl,
+            onerror: options.onerror,
+        });
+        this.attack = options.attack;
+        this.release = options.release;
+        this.curve = options.curve;
+        // invoke the callback if it's already loaded
+        if (this._buffers.loaded) {
+            // invoke onload deferred
+            Promise.resolve().then(options.onload);
+        }
+    }
+    static getDefaults() {
+        return Object.assign(Instrument.getDefaults(), {
+            attack: 0,
+            baseUrl: "",
+            curve: "exponential",
+            onload: noOp,
+            onerror: noOp,
+            release: 0.1,
+            urls: {},
+        });
+    }
+    /**
+     * Returns the difference in steps between the given midi note at the closets sample.
+     */
+    _findClosest(midi) {
+        // searches within 8 octaves of the given midi note
+        const MAX_INTERVAL = 96;
+        let interval = 0;
+        while (interval < MAX_INTERVAL) {
+            // check above and below
+            if (this._buffers.has(midi + interval)) {
+                return -interval;
+            }
+            else if (this._buffers.has(midi - interval)) {
+                return interval;
+            }
+            interval++;
+        }
+        throw new Error(`No available buffers for note: ${midi}`);
+    }
+    /**
+     * @param  notes	The note to play, or an array of notes.
+     * @param  time     When to play the note
+     * @param  velocity The velocity to play the sample back.
+     */
+    triggerAttack(notes, time, velocity = 1) {
+        this.log("triggerAttack", notes, time, velocity);
+        if (!Array.isArray(notes)) {
+            notes = [notes];
+        }
+        notes.forEach(note => {
+            const midiFloat = ftomf(new FrequencyClass(this.context, note).toFrequency());
+            const midi = Math.round(midiFloat);
+            const remainder = midiFloat - midi;
+            // find the closest note pitch
+            const difference = this._findClosest(midi);
+            const closestNote = midi - difference;
+            const buffer = this._buffers.get(closestNote);
+            const playbackRate = intervalToFrequencyRatio(difference + remainder);
+            // play that note
+            const source = new ToneBufferSource({
+                url: buffer,
+                context: this.context,
+                curve: this.curve,
+                fadeIn: this.attack,
+                fadeOut: this.release,
+                playbackRate,
+            }).connect(this.output);
+            source.start(time, 0, buffer.duration / playbackRate, velocity);
+            // add it to the active sources
+            if (!isArray(this._activeSources.get(midi))) {
+                this._activeSources.set(midi, []);
+            }
+            this._activeSources.get(midi).push(source);
+            // remove it when it's done
+            source.onended = () => {
+                if (this._activeSources && this._activeSources.has(midi)) {
+                    const sources = this._activeSources.get(midi);
+                    const index = sources.indexOf(source);
+                    if (index !== -1) {
+                        sources.splice(index, 1);
+                    }
+                }
+            };
+        });
+        return this;
+    }
+    /**
+     * @param  notes	The note to release, or an array of notes.
+     * @param  time     	When to release the note.
+     */
+    triggerRelease(notes, time) {
+        this.log("triggerRelease", notes, time);
+        if (!Array.isArray(notes)) {
+            notes = [notes];
+        }
+        notes.forEach(note => {
+            const midi = new FrequencyClass(this.context, note).toMidi();
+            // find the note
+            if (this._activeSources.has(midi) && this._activeSources.get(midi).length) {
+                const sources = this._activeSources.get(midi);
+                time = this.toSeconds(time);
+                sources.forEach(source => {
+                    source.stop(time);
+                });
+                this._activeSources.set(midi, []);
+            }
+        });
+        return this;
+    }
+    /**
+     * Release all currently active notes.
+     * @param  time     	When to release the notes.
+     */
+    releaseAll(time) {
+        const computedTime = this.toSeconds(time);
+        this._activeSources.forEach(sources => {
+            while (sources.length) {
+                const source = sources.shift();
+                source.stop(computedTime);
+            }
+        });
+        return this;
+    }
+    sync() {
+        if (this._syncState()) {
+            this._syncMethod("triggerAttack", 1);
+            this._syncMethod("triggerRelease", 1);
+        }
+        return this;
+    }
+    /**
+     * Invoke the attack phase, then after the duration, invoke the release.
+     * @param  notes	The note to play and release, or an array of notes.
+     * @param  duration The time the note should be held
+     * @param  time     When to start the attack
+     * @param  velocity The velocity of the attack
+     */
+    triggerAttackRelease(notes, duration, time, velocity = 1) {
+        const computedTime = this.toSeconds(time);
+        this.triggerAttack(notes, computedTime, velocity);
+        if (isArray(duration)) {
+            assert(isArray(notes), "notes must be an array when duration is array");
+            notes.forEach((note, index) => {
+                const d = duration[Math.min(index, duration.length - 1)];
+                this.triggerRelease(note, computedTime + this.toSeconds(d));
+            });
+        }
+        else {
+            this.triggerRelease(notes, computedTime + this.toSeconds(duration));
+        }
+        return this;
+    }
+    /**
+     * Add a note to the sampler.
+     * @param  note      The buffer's pitch.
+     * @param  url  Either the url of the buffer, or a buffer which will be added with the given name.
+     * @param  callback  The callback to invoke when the url is loaded.
+     */
+    add(note, url, callback) {
+        assert(isNote(note) || isFinite(note), `note must be a pitch or midi: ${note}`);
+        if (isNote(note)) {
+            // convert the note name to MIDI
+            const mid = new FrequencyClass(this.context, note).toMidi();
+            this._buffers.add(mid, url, callback);
+        }
+        else {
+            // otherwise if it's numbers assume it's midi
+            this._buffers.add(note, url, callback);
+        }
+        return this;
+    }
+    /**
+     * If the buffers are loaded or not
+     */
+    get loaded() {
+        return this._buffers.loaded;
+    }
+    /**
+     * Clean up
+     */
+    dispose() {
+        super.dispose();
+        this._buffers.dispose();
+        this._activeSources.forEach(sources => {
+            sources.forEach(source => source.dispose());
+        });
+        this._activeSources.clear();
+        return this;
+    }
+}
+__decorate([
+    timeRange(0)
+], Sampler.prototype, "attack", void 0);
+__decorate([
+    timeRange(0)
+], Sampler.prototype, "release", void 0);
+//# sourceMappingURL=Sampler.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Sampler.js","sourceRoot":"","sources":["../../../Tone/instrument/Sampler.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,KAAK,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAExD,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,EAAE,UAAU,EAAqB,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAyB,MAAM,mCAAmC,CAAC;AAC5F,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAiB5C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,OAAQ,SAAQ,UAA0B;IAkDtD;QAEC,KAAK,CAAC,oBAAoB,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;QAlD7F,SAAI,GAAW,SAAS,CAAC;QAOlC;;WAEG;QACK,mBAAc,GAAsC,IAAI,GAAG,EAAE,CAAC;QAyCrE,MAAM,OAAO,GAAG,oBAAoB,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,CAAC;QAE9G,MAAM,MAAM,GAAG,EAAE,CAAC;QAClB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC1C,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACtC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;mBACf,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,CAAC,EAAE,4CAA4C,IAAI,EAAE,CAAC,CAAC;YACxG,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE;gBACjB,gCAAgC;gBAChC,MAAM,GAAG,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;gBAC5D,MAAM,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;aACjC;iBAAM,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC,EAAE;gBACxD,6CAA6C;gBAC7C,MAAM,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aAC9C;QACF,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAgB,CAAC;YACpC,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,OAAO,EAAE,OAAO,CAAC,OAAO;SACxB,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAE3B,6CAA6C;QAC7C,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YACzB,yBAAyB;YACzB,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SACvC;IACF,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE;YAC9C,MAAM,EAAE,CAAC;YACT,OAAO,EAAE,EAAE;YACX,KAAK,EAAE,aAA8B;YACrC,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,GAAG;YACZ,IAAI,EAAE,EAAE;SACR,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,YAAY,CAAC,IAAc;QAClC,mDAAmD;QACnD,MAAM,YAAY,GAAG,EAAE,CAAC;QACxB,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,OAAO,QAAQ,GAAG,YAAY,EAAE;YAC/B,wBAAwB;YACxB,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,QAAQ,CAAC,EAAE;gBACvC,OAAO,CAAC,QAAQ,CAAC;aACjB;iBAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,QAAQ,CAAC,EAAE;gBAC9C,OAAO,QAAQ,CAAC;aAChB;YACD,QAAQ,EAAE,CAAC;SACX;QACD,MAAM,IAAI,KAAK,CAAC,kCAAkC,IAAI,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,KAA8B,EAAE,IAAW,EAAE,WAAwB,CAAC;QACnF,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QACjD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAC1B,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC;SAChB;QACD,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACpB,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAC9E,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAa,CAAC;YAC/C,MAAM,SAAS,GAAG,SAAS,GAAG,IAAI,CAAC;YACnC,8BAA8B;YAC9B,MAAM,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YAC3C,MAAM,WAAW,GAAG,IAAI,GAAG,UAAU,CAAC;YACtC,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC9C,MAAM,YAAY,GAAG,wBAAwB,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;YACtE,iBAAiB;YACjB,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC;gBACnC,GAAG,EAAE,MAAM;gBACX,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,YAAY;aACZ,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACxB,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,QAAQ,GAAG,YAAY,EAAE,QAAQ,CAAC,CAAC;YAChE,+BAA+B;YAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE;gBAC5C,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aAClC;YACA,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAwB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEnE,2BAA2B;YAC3B,MAAM,CAAC,OAAO,GAAG,GAAG,EAAE;gBACrB,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;oBACzD,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAuB,CAAC;oBACpE,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;oBACtC,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE;wBACjB,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;qBACzB;iBACD;YACF,CAAC,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,KAA8B,EAAE,IAAW;QACzD,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAC1B,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC;SAChB;QACD,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACpB,MAAM,IAAI,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;YAC7D,gBAAgB;YAChB,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,IAAK,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAwB,CAAC,MAAM,EAAE;gBAClG,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAuB,CAAC;gBACpE,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;gBAC5B,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;oBACxB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACnB,CAAC,CAAC,CAAC;gBACH,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;aAClC;QACF,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,IAAW;QACrB,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACrC,OAAO,OAAO,CAAC,MAAM,EAAE;gBACtB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,EAAsB,CAAC;gBACnD,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;aAC1B;QACF,CAAC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACb,CAAC;IAED,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;;;;;;OAMG;IACH,oBAAoB,CACnB,KAA8B,EAC9B,QAAuB,EACvB,IAAW,EACX,WAAwB,CAAC;QAEzB,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,CAAC,CAAC;QAClD,IAAI,OAAO,CAAC,QAAQ,CAAC,EAAE;YACtB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,+CAA+C,CAAC,CAAC;YACvE,KAAqB,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;gBAC9C,MAAM,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;gBACzD,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7D,CAAC,CAAC,CAAC;SACH;aAAM;YACN,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;SACpE;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,IAAqB,EAAE,GAA2C,EAAE,QAAqB;QAC5F,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE,iCAAiC,IAAI,EAAE,CAAC,CAAC;QAChF,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE;YACjB,gCAAgC;YAChC,MAAM,GAAG,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;YAC5D,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;SACtC;aAAM;YACN,6CAA6C;YAC7C,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC;SACvC;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,OAAO;QACN,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;QACxB,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACrC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AAnQA;IADC,SAAS,CAAC,CAAC,CAAC;uCACA;AAQb;IADC,SAAS,CAAC,CAAC,CAAC;wCACC"}

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

@@ -0,0 +1,65 @@
+import { AmplitudeEnvelope } from "../component/envelope/AmplitudeEnvelope";
+import { EnvelopeOptions } from "../component/envelope/Envelope";
+import { ToneAudioNodeOptions } from "../core/context/ToneAudioNode";
+import { NormalRange, Seconds, Time } from "../core/type/Units";
+import { RecursivePartial } from "../core/util/Interface";
+import { Signal } from "../signal/Signal";
+import { OmniOscillator } from "../source/oscillator/OmniOscillator";
+import { OmniOscillatorSynthOptions } from "../source/oscillator/OscillatorInterface";
+import { Monophonic, MonophonicOptions } from "./Monophonic";
+export interface SynthOptions extends MonophonicOptions {
+    oscillator: OmniOscillatorSynthOptions;
+    envelope: Omit<EnvelopeOptions, keyof ToneAudioNodeOptions>;
+}
+/**
+ * Synth is composed simply of a [[OmniOscillator]] routed through an [[AmplitudeEnvelope]].
+ * ```
+ * +----------------+   +-------------------+
+ * | OmniOscillator +>--> AmplitudeEnvelope +>--> Output
+ * +----------------+   +-------------------+
+ * ```
+ * @example
+ * const synth = new Tone.Synth().toDestination();
+ * synth.triggerAttackRelease("C4", "8n");
+ * @category Instrument
+ */
+export declare class Synth<Options extends SynthOptions = SynthOptions> extends Monophonic<Options> {
+    readonly name: string;
+    /**
+     * The oscillator.
+     */
+    readonly oscillator: OmniOscillator<any>;
+    /**
+     * The frequency signal
+     */
+    readonly frequency: Signal<"frequency">;
+    /**
+     * The detune signal
+     */
+    readonly detune: Signal<"cents">;
+    /**
+     * The envelope
+     */
+    readonly envelope: AmplitudeEnvelope;
+    /**
+     * @param options the options available for the synth.
+     */
+    constructor(options?: RecursivePartial<SynthOptions>);
+    static getDefaults(): SynthOptions;
+    /**
+     * start the attack portion of the envelope
+     * @param time the time the attack should start
+     * @param velocity the velocity of the note (0-1)
+     */
+    protected _triggerEnvelopeAttack(time: Seconds, velocity: number): void;
+    /**
+     * start the release portion of the envelope
+     * @param time the time the release should start
+     */
+    protected _triggerEnvelopeRelease(time: Seconds): void;
+    getLevelAtTime(time: Time): NormalRange;
+    /**
+     * clean up
+     */
+    dispose(): this;
+}

package/build/esm/instrument/Synth.js

@@ -0,0 +1,91 @@
+import { AmplitudeEnvelope } from "../component/envelope/AmplitudeEnvelope";
+import { Envelope } from "../component/envelope/Envelope";
+import { ToneAudioNode } from "../core/context/ToneAudioNode";
+import { omitFromObject, optionsFromArguments } from "../core/util/Defaults";
+import { readOnly } from "../core/util/Interface";
+import { OmniOscillator } from "../source/oscillator/OmniOscillator";
+import { Source } from "../source/Source";
+import { Monophonic } from "./Monophonic";
+/**
+ * Synth is composed simply of a [[OmniOscillator]] routed through an [[AmplitudeEnvelope]].
+ * ```
+ * +----------------+   +-------------------+
+ * | OmniOscillator +>--> AmplitudeEnvelope +>--> Output
+ * +----------------+   +-------------------+
+ * ```
+ * @example
+ * const synth = new Tone.Synth().toDestination();
+ * synth.triggerAttackRelease("C4", "8n");
+ * @category Instrument
+ */
+export class Synth extends Monophonic {
+    constructor() {
+        super(optionsFromArguments(Synth.getDefaults(), arguments));
+        this.name = "Synth";
+        const options = optionsFromArguments(Synth.getDefaults(), arguments);
+        this.oscillator = new OmniOscillator(Object.assign({
+            context: this.context,
+            detune: options.detune,
+            onstop: () => this.onsilence(this),
+        }, options.oscillator));
+        this.frequency = this.oscillator.frequency;
+        this.detune = this.oscillator.detune;
+        this.envelope = new AmplitudeEnvelope(Object.assign({
+            context: this.context,
+        }, options.envelope));
+        // connect the oscillators to the output
+        this.oscillator.chain(this.envelope, this.output);
+        readOnly(this, ["oscillator", "frequency", "detune", "envelope"]);
+    }
+    static getDefaults() {
+        return Object.assign(Monophonic.getDefaults(), {
+            envelope: Object.assign(omitFromObject(Envelope.getDefaults(), Object.keys(ToneAudioNode.getDefaults())), {
+                attack: 0.005,
+                decay: 0.1,
+                release: 1,
+                sustain: 0.3,
+            }),
+            oscillator: Object.assign(omitFromObject(OmniOscillator.getDefaults(), [...Object.keys(Source.getDefaults()), "frequency", "detune"]), {
+                type: "triangle",
+            }),
+        });
+    }
+    /**
+     * start the attack portion of the envelope
+     * @param time the time the attack should start
+     * @param velocity the velocity of the note (0-1)
+     */
+    _triggerEnvelopeAttack(time, velocity) {
+        // the envelopes
+        this.envelope.triggerAttack(time, velocity);
+        this.oscillator.start(time);
+        // if there is no release portion, stop the oscillator
+        if (this.envelope.sustain === 0) {
+            const computedAttack = this.toSeconds(this.envelope.attack);
+            const computedDecay = this.toSeconds(this.envelope.decay);
+            this.oscillator.stop(time + computedAttack + computedDecay);
+        }
+    }
+    /**
+     * start the release portion of the envelope
+     * @param time the time the release should start
+     */
+    _triggerEnvelopeRelease(time) {
+        this.envelope.triggerRelease(time);
+        this.oscillator.stop(time + this.toSeconds(this.envelope.release));
+    }
+    getLevelAtTime(time) {
+        time = this.toSeconds(time);
+        return this.envelope.getValueAtTime(time);
+    }
+    /**
+     * clean up
+     */
+    dispose() {
+        super.dispose();
+        this.oscillator.dispose();
+        this.envelope.dispose();
+        return this;
+    }
+}
+//# sourceMappingURL=Synth.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Synth.js","sourceRoot":"","sources":["../../../Tone/instrument/Synth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,EAAE,QAAQ,EAAmB,MAAM,gCAAgC,CAAC;AAC3E,OAAO,EAAE,aAAa,EAAwB,MAAM,+BAA+B,CAAC;AAEpF,OAAO,EAAE,cAAc,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAC7E,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAGlD,OAAO,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AAErE,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAqB,MAAM,cAAc,CAAC;AAO7D;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,KAAmD,SAAQ,UAAmB;IA4B1F;QACC,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;QA3BpD,SAAI,GAAW,OAAO,CAAC;QA4B/B,MAAM,OAAO,GAAG,oBAAoB,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,SAAS,CAAC,CAAC;QAErE,IAAI,CAAC,UAAU,GAAG,IAAI,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC;YAClD,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAClC,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;QAExB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;QAC3C,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAErC,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC;YACnD,OAAO,EAAE,IAAI,CAAC,OAAO;SACrB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEtB,wCAAwC;QACxC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAClD,QAAQ,CAAC,IAAI,EAAE,CAAC,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;IACnE,CAAC;IAED,MAAM,CAAC,WAAW;QACjB,OAAO,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE;YAC9C,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,CAAC;gBACV,OAAO,EAAE,GAAG;aACZ,CACD;YACD,UAAU,EAAE,MAAM,CAAC,MAAM,CACxB,cAAc,CAAC,cAAc,CAAC,WAAW,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,EAC3G;gBACC,IAAI,EAAE,UAAU;aAChB,CACwB;SAC1B,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACO,sBAAsB,CAAC,IAAa,EAAE,QAAgB;QAC/D,gBAAgB;QAChB,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC5C,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC5B,sDAAsD;QACtD,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,KAAK,CAAC,EAAE;YAChC,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC5D,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC1D,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,GAAG,cAAc,GAAG,aAAa,CAAC,CAAC;SAC5D;IACF,CAAC;IAED;;;OAGG;IACO,uBAAuB,CAAC,IAAa;QAC9C,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;IACpE,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;;OAEG;IACH,OAAO;QACN,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;QAC1B,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACb,CAAC;CACD"}

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

@@ -0,0 +1,11 @@
+export * from "./AMSynth";
+export * from "./DuoSynth";
+export * from "./FMSynth";
+export * from "./MetalSynth";
+export * from "./MembraneSynth";
+export * from "./MonoSynth";
+export * from "./NoiseSynth";
+export * from "./PluckSynth";
+export * from "./PolySynth";
+export * from "./Sampler";
+export * from "./Synth";

package/build/esm/instrument/index.js

@@ -0,0 +1,12 @@
+export * from "./AMSynth";
+export * from "./DuoSynth";
+export * from "./FMSynth";
+export * from "./MetalSynth";
+export * from "./MembraneSynth";
+export * from "./MonoSynth";
+export * from "./NoiseSynth";
+export * from "./PluckSynth";
+export * from "./PolySynth";
+export * from "./Sampler";
+export * from "./Synth";
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../Tone/instrument/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC"}

package/build/esm/signal/Abs.d.ts

@@ -0,0 +1,34 @@
+import { ToneAudioNodeOptions } from "../core/context/ToneAudioNode";
+import { SignalOperator } from "./SignalOperator";
+import { WaveShaper } from "./WaveShaper";
+/**
+ * Return the absolute value of an incoming signal.
+ *
+ * @example
+ * return Tone.Offline(() => {
+ * 	const abs = new Tone.Abs().toDestination();
+ * 	const signal = new Tone.Signal(1);
+ * 	signal.rampTo(-1, 0.5);
+ * 	signal.connect(abs);
+ * }, 0.5, 1);
+ * @category Signal
+ */
+export declare class Abs extends SignalOperator<ToneAudioNodeOptions> {
+    readonly name: string;
+    /**
+     * The node which converts the audio ranges
+     */
+    private _abs;
+    /**
+     * The AudioRange input [-1, 1]
+     */
+    input: WaveShaper;
+    /**
+     * The output range [0, 1]
+     */
+    output: WaveShaper;
+    /**
+     * clean up
+     */
+    dispose(): this;
+}

package/build/esm/signal/Abs.js

@@ -0,0 +1,51 @@
+import { SignalOperator } from "./SignalOperator";
+import { WaveShaper } from "./WaveShaper";
+/**
+ * Return the absolute value of an incoming signal.
+ *
+ * @example
+ * return Tone.Offline(() => {
+ * 	const abs = new Tone.Abs().toDestination();
+ * 	const signal = new Tone.Signal(1);
+ * 	signal.rampTo(-1, 0.5);
+ * 	signal.connect(abs);
+ * }, 0.5, 1);
+ * @category Signal
+ */
+export class Abs extends SignalOperator {
+    constructor() {
+        super(...arguments);
+        this.name = "Abs";
+        /**
+         * The node which converts the audio ranges
+         */
+        this._abs = new WaveShaper({
+            context: this.context,
+            mapping: val => {
+                if (Math.abs(val) < 0.001) {
+                    return 0;
+                }
+                else {
+                    return Math.abs(val);
+                }
+            },
+        });
+        /**
+         * The AudioRange input [-1, 1]
+         */
+        this.input = this._abs;
+        /**
+         * The output range [0, 1]
+         */
+        this.output = this._abs;
+    }
+    /**
+     * clean up
+     */
+    dispose() {
+        super.dispose();
+        this._abs.dispose();
+        return this;
+    }
+}
+//# sourceMappingURL=Abs.js.map