tone
Version:
A Web Audio framework for making interactive music in the browser.
68 lines • 2.17 kB
JavaScript
import { Filter } from "../component/filter/Filter.js";
import { optionsFromArguments } from "../core/util/Defaults.js";
import { LFOEffect } from "./LFOEffect.js";
/**
* AutoFilter is a Tone.Filter with a Tone.LFO connected to the filter cutoff frequency.
* Setting the LFO rate and depth allows for control over the filter modulation rate
* and depth.
*
* @example
* // create an autofilter and start it's LFO
* const autoFilter = new Tone.AutoFilter("4n").toDestination().start();
* // route an oscillator through the filter and start it
* const oscillator = new Tone.Oscillator().connect(autoFilter).start();
* @category Effect
*/
export class AutoFilter extends LFOEffect {
constructor() {
const options = optionsFromArguments(AutoFilter.getDefaults(), arguments, ["frequency", "baseFrequency", "octaves"]);
super(options);
this.name = "AutoFilter";
this.filter = new Filter(Object.assign(options.filter, {
context: this.context,
}));
// connections
this.connectEffect(this.filter);
this._lfo.connect(this.filter.frequency);
this.octaves = options.octaves;
this.baseFrequency = options.baseFrequency;
}
static getDefaults() {
return Object.assign(LFOEffect.getDefaults(), {
baseFrequency: 200,
octaves: 2.6,
filter: {
type: "lowpass",
rolloff: -12,
Q: 1,
},
});
}
/**
* The minimum value of the filter's cutoff frequency.
*/
get baseFrequency() {
return this._lfo.min;
}
set baseFrequency(freq) {
this._lfo.min = this.toFrequency(freq);
// and set the max
this.octaves = this._octaves;
}
/**
* The maximum value of the filter's cutoff frequency.
*/
get octaves() {
return this._octaves;
}
set octaves(oct) {
this._octaves = oct;
this._lfo.max = this._lfo.min * Math.pow(2, oct);
}
dispose() {
super.dispose();
this.filter.dispose();
return this;
}
}
//# sourceMappingURL=AutoFilter.js.map