Tone.js/Tone/effect/Convolver.js

95 lines
2.3 KiB
JavaScript
Raw Normal View History

2014-10-23 15:42:41 +00:00
define(["Tone/core/Tone", "Tone/core/Buffer", "Tone/effect/Effect"], function(Tone){
2014-10-23 15:42:41 +00:00
"use strict";
/**
2014-10-23 15:42:41 +00:00
* @class Convolver wrapper for reverb and emulation.
* NB: currently, this class only supports 1 buffer member.
* Future iterations will include a this.buffers collection for multi buffer mode.
*
* @constructor
* @extends {Tone.Effect}
* @param {string|Object|AudioBuffer=} url
2014-12-02 06:42:08 +00:00
* @param {function=} callback function
*/
Tone.Convolver = function(url){
Tone.Effect.apply(this, arguments);
2014-10-23 15:42:41 +00:00
/**
* convolver node
* @type {ConvolverNode}
* @private
*/
this._convolver = this.context.createConvolver();
2014-10-23 15:42:41 +00:00
/**
* the convolution buffer
* @type {Tone.Buffer}
2014-10-23 15:42:41 +00:00
* @private
*/
this._buffer = new Tone.Buffer(url, this.setBuffer.bind(this));
2014-10-23 15:42:41 +00:00
this.connectEffect(this._convolver);
};
2014-10-23 15:42:41 +00:00
Tone.extend(Tone.Convolver, Tone.Effect);
2014-10-23 15:42:41 +00:00
/**
* the default parameters
2014-10-23 15:42:41 +00:00
* @static
* @const
2014-10-23 15:42:41 +00:00
* @type {Object}
*/
Tone.Convolver.defaults = {};
2014-10-23 15:42:41 +00:00
/**
* Load the impulse response url as an audio buffer.
* Decodes the audio asynchronously and invokes
* the callback once the audio buffer loads.
* @param {string} url the url of the buffer to load.
* filetype support depends on the
* browser.
* @param {function(Tone.Convolver)=} callback
*/
Tone.Convolver.prototype.load = function(url, callback){
var self = this;
this._buffer.load(url, function(buff){
self.setBuffer(buff);
if (callback){
callback(this);
}
});
2014-10-23 15:42:41 +00:00
};
/**
2014-10-23 15:42:41 +00:00
* set the buffer
* @param {AudioBuffer} buffer the impulse response
*/
Tone.Convolver.prototype.setBuffer = function(buffer){
this._buffer.set(buffer);
this._convolver.buffer = this._buffer.get();
2014-10-23 15:42:41 +00:00
};
/**
* set multiple parameters at once with an object
* @param {Object} params the parameters as an object
*/
Tone.Convolver.prototype.set = function(params){
if (!this.isUndef(params.buffer)) this.setBuffer(params.buffer);
Tone.Effect.prototype.set.call(this, params);
};
/**
* dispose and disconnect
*/
Tone.Convolver.prototype.dispose = function(){
Tone.Effect.prototype.dispose.call(this);
this._convolver.disconnect();
this._convolver = null;
this._buffer.dispose();
2014-10-23 15:42:41 +00:00
this._buffer = null;
};
return Tone.Convolver;
});