mirror of
https://github.com/Tonejs/Tone.js
synced 2024-12-26 19:43:12 +00:00
66 lines
2.4 KiB
TypeScript
66 lines
2.4 KiB
TypeScript
import { Positive } from "../core/type/Units";
|
|
import { optionsFromArguments } from "../core/util/Defaults";
|
|
import { RecursivePartial } from "../core/util/Interface";
|
|
import { Multiply } from "../signal/Multiply";
|
|
import { ModulationSynth, ModulationSynthOptions } from "./ModulationSynth";
|
|
|
|
export interface FMSynthOptions extends ModulationSynthOptions {
|
|
modulationIndex: Positive;
|
|
}
|
|
|
|
/**
|
|
* FMSynth is composed of two Tone.Synths where one Tone.Synth modulates
|
|
* the frequency of a second Tone.Synth. A lot of spectral content
|
|
* can be explored using the modulationIndex parameter. Read more about
|
|
* frequency modulation synthesis on Sound On Sound: [Part 1](https://web.archive.org/web/20160403123704/http://www.soundonsound.com/sos/apr00/articles/synthsecrets.htm), [Part 2](https://web.archive.org/web/20160403115835/http://www.soundonsound.com/sos/may00/articles/synth.htm).
|
|
*
|
|
* @example
|
|
* import { FMSynth } from "tone";
|
|
* const fmSynth = new FMSynth().toDestination();
|
|
* fmSynth.triggerAttackRelease("C5", "4n");
|
|
*
|
|
* @category Instrument
|
|
*/
|
|
|
|
export class FMSynth extends ModulationSynth<FMSynthOptions> {
|
|
readonly name: string = "FMSynth";
|
|
|
|
/**
|
|
* The modulation index which essentially the depth or amount of the modulation. It is the
|
|
* ratio of the frequency of the modulating signal (mf) to the amplitude of the
|
|
* modulating signal (ma) -- as in ma/mf.
|
|
*/
|
|
readonly modulationIndex: Multiply;
|
|
|
|
constructor(options?: RecursivePartial<FMSynthOptions>);
|
|
constructor() {
|
|
super(optionsFromArguments(FMSynth.getDefaults(), arguments));
|
|
const options = optionsFromArguments(FMSynth.getDefaults(), arguments);
|
|
|
|
this.modulationIndex = new Multiply({
|
|
context: this.context,
|
|
value: options.modulationIndex,
|
|
});
|
|
|
|
// control the two voices frequency
|
|
this.frequency.connect(this._carrier.frequency);
|
|
this.frequency.chain(this.harmonicity, this._modulator.frequency);
|
|
this.frequency.chain(this.modulationIndex, this._modulationNode);
|
|
this.detune.fan(this._carrier.detune, this._modulator.detune);
|
|
this._modulator.connect(this._modulationNode.gain);
|
|
this._modulationNode.connect(this._carrier.frequency);
|
|
this._carrier.connect(this.output);
|
|
}
|
|
|
|
static getDefaults(): FMSynthOptions {
|
|
return Object.assign(ModulationSynth.getDefaults(), {
|
|
modulationIndex: 10,
|
|
});
|
|
}
|
|
|
|
dispose(): this {
|
|
super.dispose();
|
|
this.modulationIndex.dispose();
|
|
return this;
|
|
}
|
|
}
|