mirror of
https://github.com/Tonejs/Tone.js
synced 2024-12-26 19:43:12 +00:00
102 lines
2.8 KiB
TypeScript
102 lines
2.8 KiB
TypeScript
import { FrequencyClass } from "../core/type/Frequency.js";
|
|
import { Frequency, Positive, Time } from "../core/type/Units.js";
|
|
import { deepMerge, optionsFromArguments } from "../core/util/Defaults.js";
|
|
import { readOnly, RecursivePartial } from "../core/util/Interface.js";
|
|
import { Monophonic } from "./Monophonic.js";
|
|
import { Synth, SynthOptions } from "./Synth.js";
|
|
import { range, timeRange } from "../core/util/Decorator.js";
|
|
|
|
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 class MembraneSynth extends Synth<MembraneSynthOptions> {
|
|
readonly name: string = "MembraneSynth";
|
|
|
|
/**
|
|
* The number of octaves the pitch envelope ramps.
|
|
* @min 0.5
|
|
* @max 8
|
|
*/
|
|
@range(0)
|
|
octaves: Positive;
|
|
|
|
/**
|
|
* The amount of time the frequency envelope takes.
|
|
* @min 0
|
|
* @max 0.5
|
|
*/
|
|
@timeRange(0)
|
|
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>);
|
|
constructor() {
|
|
const options = optionsFromArguments(
|
|
MembraneSynth.getDefaults(),
|
|
arguments
|
|
);
|
|
super(options);
|
|
|
|
this.pitchDecay = options.pitchDecay;
|
|
this.octaves = options.octaves;
|
|
readOnly(this, ["oscillator", "envelope"]);
|
|
}
|
|
|
|
static getDefaults(): MembraneSynthOptions {
|
|
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: Frequency | FrequencyClass, time?: Time): this {
|
|
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(): this {
|
|
super.dispose();
|
|
return this;
|
|
}
|
|
}
|