mirror of
https://github.com/Tonejs/Tone.js
synced 2024-11-16 16:48:00 +00:00
70 lines
No EOL
1.6 KiB
JavaScript
70 lines
No EOL
1.6 KiB
JavaScript
define(["Tone/core/Tone", "Tone/component/Compressor"], function(Tone){
|
|
|
|
"use strict";
|
|
|
|
/**
|
|
* @class Tone.Limiter will limit the loudness of an incoming signal.
|
|
* It is composed of a Tone.Compressor with a fast attack
|
|
* and release. Limiters are commonly used to safeguard against
|
|
* signal clipping. Unlike a compressor, limiters do not provide
|
|
* smooth gain reduction and almost completely prevent
|
|
* additional gain above the threshold.
|
|
*
|
|
* @extends {Tone}
|
|
* @constructor
|
|
* @param {number} threshold The theshold above which the limiting is applied.
|
|
* @example
|
|
* var limiter = new Tone.Limiter(-6);
|
|
*/
|
|
Tone.Limiter = function(){
|
|
|
|
var options = this.optionsObject(arguments, ["threshold"], Tone.Limiter.defaults);
|
|
|
|
/**
|
|
* the compressor
|
|
* @private
|
|
* @type {Tone.Compressor}
|
|
*/
|
|
this._compressor = this.input = this.output = new Tone.Compressor({
|
|
"attack" : 0.001,
|
|
"decay" : 0.001,
|
|
"threshold" : options.threshold
|
|
});
|
|
|
|
/**
|
|
* The threshold of of the limiter
|
|
* @type {Decibel}
|
|
* @signal
|
|
*/
|
|
this.threshold = this._compressor.threshold;
|
|
|
|
this._readOnly("threshold");
|
|
};
|
|
|
|
Tone.extend(Tone.Limiter);
|
|
|
|
/**
|
|
* The default value
|
|
* @type {Object}
|
|
* @const
|
|
* @static
|
|
*/
|
|
Tone.Limiter.defaults = {
|
|
"threshold" : -12
|
|
};
|
|
|
|
/**
|
|
* Clean up.
|
|
* @returns {Tone.Limiter} this
|
|
*/
|
|
Tone.Limiter.prototype.dispose = function(){
|
|
Tone.prototype.dispose.call(this);
|
|
this._compressor.dispose();
|
|
this._compressor = null;
|
|
this._writable("threshold");
|
|
this.threshold = null;
|
|
return this;
|
|
};
|
|
|
|
return Tone.Limiter;
|
|
}); |