mirror of
https://github.com/Tonejs/Tone.js
synced 2024-12-28 04:23:15 +00:00
aaf880c925
* WIP moving tests to web-test-runner * updating thresholds * Adding file extensions * Testing integrations * linting * fixing dep * moving back to root dir * prettier all of the files * updating eslint rules to use with prettier * remove import package * moving tsignore around * removing unneeded ignores * all tests run on puppeteer, no need for testing guards * linting * import type syntax * cleaning up * Update package.json
104 lines
2.5 KiB
TypeScript
104 lines
2.5 KiB
TypeScript
import { optionsFromArguments } from "../core/util/Defaults.js";
|
|
import { WaveShaper } from "../signal/WaveShaper.js";
|
|
import { Effect, EffectOptions } from "./Effect.js";
|
|
|
|
export interface DistortionOptions extends EffectOptions {
|
|
distortion: number;
|
|
oversample: OverSampleType;
|
|
}
|
|
|
|
/**
|
|
* A simple distortion effect using Tone.WaveShaper.
|
|
* Algorithm from [this stackoverflow answer](http://stackoverflow.com/a/22313408).
|
|
* Read more about distortion on [Wikipedia] (https://en.wikipedia.org/wiki/Distortion_(music)).
|
|
* @example
|
|
* const dist = new Tone.Distortion(0.8).toDestination();
|
|
* const fm = new Tone.FMSynth().connect(dist);
|
|
* fm.triggerAttackRelease("A1", "8n");
|
|
* @category Effect
|
|
*/
|
|
export class Distortion extends Effect<DistortionOptions> {
|
|
readonly name: string = "Distortion";
|
|
|
|
/**
|
|
* The waveshaper which does the distortion
|
|
*/
|
|
private _shaper: WaveShaper;
|
|
|
|
/**
|
|
* Stores the distortion value
|
|
*/
|
|
private _distortion: number;
|
|
|
|
/**
|
|
* @param distortion The amount of distortion (nominal range of 0-1)
|
|
*/
|
|
constructor(distortion?: number);
|
|
constructor(options?: Partial<DistortionOptions>);
|
|
constructor() {
|
|
super(
|
|
optionsFromArguments(Distortion.getDefaults(), arguments, [
|
|
"distortion",
|
|
])
|
|
);
|
|
const options = optionsFromArguments(
|
|
Distortion.getDefaults(),
|
|
arguments,
|
|
["distortion"]
|
|
);
|
|
|
|
this._shaper = new WaveShaper({
|
|
context: this.context,
|
|
length: 4096,
|
|
});
|
|
|
|
this._distortion = options.distortion;
|
|
|
|
this.connectEffect(this._shaper);
|
|
this.distortion = options.distortion;
|
|
this.oversample = options.oversample;
|
|
}
|
|
|
|
static getDefaults(): DistortionOptions {
|
|
return Object.assign(Effect.getDefaults(), {
|
|
distortion: 0.4,
|
|
oversample: "none" as OverSampleType,
|
|
});
|
|
}
|
|
|
|
/**
|
|
* The amount of distortion. Nominal range is between 0 and 1.
|
|
*/
|
|
get distortion(): number {
|
|
return this._distortion;
|
|
}
|
|
set distortion(amount) {
|
|
this._distortion = amount;
|
|
const k = amount * 100;
|
|
const deg = Math.PI / 180;
|
|
this._shaper.setMap((x) => {
|
|
if (Math.abs(x) < 0.001) {
|
|
// should output 0 when input is 0
|
|
return 0;
|
|
} else {
|
|
return ((3 + k) * x * 20 * deg) / (Math.PI + k * Math.abs(x));
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* The oversampling of the effect. Can either be "none", "2x" or "4x".
|
|
*/
|
|
get oversample(): OverSampleType {
|
|
return this._shaper.oversample;
|
|
}
|
|
set oversample(oversampling) {
|
|
this._shaper.oversample = oversampling;
|
|
}
|
|
|
|
dispose(): this {
|
|
super.dispose();
|
|
this._shaper.dispose();
|
|
return this;
|
|
}
|
|
}
|