tone
Version:
A Web Audio framework for making interactive music in the browser.
195 lines • 6.33 kB
JavaScript
import { __awaiter } from "tslib";
import { optionsFromArguments } from "../../core/util/Defaults";
import { noOp, readOnly } from "../../core/util/Interface";
import { Signal } from "../../signal/Signal";
import { Source } from "../Source";
import { Oscillator } from "./Oscillator";
import { generateWaveform } from "./OscillatorInterface";
import { assertRange } from "../../core/util/Debug";
/**
* FatOscillator is an array of oscillators with detune spread between the oscillators
* @example
* const fatOsc = new Tone.FatOscillator("Ab3", "sawtooth", 40).toDestination().start();
* @category Source
*/
export class FatOscillator extends Source {
constructor() {
super(optionsFromArguments(FatOscillator.getDefaults(), arguments, ["frequency", "type", "spread"]));
this.name = "FatOscillator";
/**
* The array of oscillators
*/
this._oscillators = [];
const options = optionsFromArguments(FatOscillator.getDefaults(), arguments, ["frequency", "type", "spread"]);
this.frequency = new Signal({
context: this.context,
units: "frequency",
value: options.frequency,
});
this.detune = new Signal({
context: this.context,
units: "cents",
value: options.detune,
});
this._spread = options.spread;
this._type = options.type;
this._phase = options.phase;
this._partials = options.partials;
this._partialCount = options.partialCount;
// set the count initially
this.count = options.count;
readOnly(this, ["frequency", "detune"]);
}
static getDefaults() {
return Object.assign(Oscillator.getDefaults(), {
count: 3,
spread: 20,
type: "sawtooth",
});
}
/**
* start the oscillator
*/
_start(time) {
time = this.toSeconds(time);
this._forEach(osc => osc.start(time));
}
/**
* stop the oscillator
*/
_stop(time) {
time = this.toSeconds(time);
this._forEach(osc => osc.stop(time));
}
_restart(time) {
this._forEach(osc => osc.restart(time));
}
/**
* Iterate over all of the oscillators
*/
_forEach(iterator) {
for (let i = 0; i < this._oscillators.length; i++) {
iterator(this._oscillators[i], i);
}
}
/**
* The type of the oscillator
*/
get type() {
return this._type;
}
set type(type) {
this._type = type;
this._forEach(osc => osc.type = type);
}
/**
* The detune spread between the oscillators. If "count" is
* set to 3 oscillators and the "spread" is set to 40,
* the three oscillators would be detuned like this: [-20, 0, 20]
* for a total detune spread of 40 cents.
* @example
* const fatOsc = new Tone.FatOscillator().toDestination().start();
* fatOsc.spread = 70;
*/
get spread() {
return this._spread;
}
set spread(spread) {
this._spread = spread;
if (this._oscillators.length > 1) {
const start = -spread / 2;
const step = spread / (this._oscillators.length - 1);
this._forEach((osc, i) => osc.detune.value = start + step * i);
}
}
/**
* The number of detuned oscillators. Must be an integer greater than 1.
* @example
* const fatOsc = new Tone.FatOscillator("C#3", "sawtooth").toDestination().start();
* // use 4 sawtooth oscillators
* fatOsc.count = 4;
*/
get count() {
return this._oscillators.length;
}
set count(count) {
assertRange(count, 1);
if (this._oscillators.length !== count) {
// dispose the previous oscillators
this._forEach(osc => osc.dispose());
this._oscillators = [];
for (let i = 0; i < count; i++) {
const osc = new Oscillator({
context: this.context,
volume: -6 - count * 1.1,
type: this._type,
phase: this._phase + (i / count) * 360,
partialCount: this._partialCount,
onstop: i === 0 ? () => this.onstop(this) : noOp,
});
if (this.type === "custom") {
osc.partials = this._partials;
}
this.frequency.connect(osc.frequency);
this.detune.connect(osc.detune);
osc.detune.overridden = false;
osc.connect(this.output);
this._oscillators[i] = osc;
}
// set the spread
this.spread = this._spread;
if (this.state === "started") {
this._forEach(osc => osc.start());
}
}
}
get phase() {
return this._phase;
}
set phase(phase) {
this._phase = phase;
this._forEach((osc, i) => osc.phase = this._phase + (i / this.count) * 360);
}
get baseType() {
return this._oscillators[0].baseType;
}
set baseType(baseType) {
this._forEach(osc => osc.baseType = baseType);
this._type = this._oscillators[0].type;
}
get partials() {
return this._oscillators[0].partials;
}
set partials(partials) {
this._partials = partials;
this._partialCount = this._partials.length;
if (partials.length) {
this._type = "custom";
this._forEach(osc => osc.partials = partials);
}
}
get partialCount() {
return this._oscillators[0].partialCount;
}
set partialCount(partialCount) {
this._partialCount = partialCount;
this._forEach(osc => osc.partialCount = partialCount);
this._type = this._oscillators[0].type;
}
asArray(length = 1024) {
return __awaiter(this, void 0, void 0, function* () {
return generateWaveform(this, length);
});
}
/**
* Clean up.
*/
dispose() {
super.dispose();
this.frequency.dispose();
this.detune.dispose();
this._forEach(osc => osc.dispose());
return this;
}
}
//# sourceMappingURL=FatOscillator.js.map