Browse files

Update dsp documentation for single-sample

  • Loading branch information...
1 parent f88ba41 commit 51d2f18ef5366f4c3a5f03cc5e1a4d551545c3dc @oampo committed Apr 27, 2012
View
2 src/dsp/Amplitude.js
@@ -38,7 +38,7 @@ var Amplitude = function(audiolet, attack, release) {
extend(Amplitude, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
Amplitude.prototype.generate = function() {
var input = this.inputs[0];
View
2 src/dsp/BadValueDetector.js
@@ -41,7 +41,7 @@ BadValueDetector.prototype.callback = function(value, channel) {
};
/**
- * Process a block of samples
+ * Process samples
*/
BadValueDetector.prototype.generate = function() {
var input = this.inputs[0];
View
2 src/dsp/BiquadFilter.js
@@ -57,7 +57,7 @@ BiquadFilter.prototype.calculateCoefficients = function(frequency) {
};
/**
- * Process a block of samples
+ * Process samples
*/
BiquadFilter.prototype.generate = function() {
var input = this.inputs[0];
View
2 src/dsp/BitCrusher.js
@@ -31,7 +31,7 @@ var BitCrusher = function(audiolet, bits) {
extend(BitCrusher, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
BitCrusher.prototype.generate = function() {
var input = this.inputs[0];
View
2 src/dsp/BufferPlayer.js
@@ -56,7 +56,7 @@ var BufferPlayer = function(audiolet, buffer, playbackRate, startPosition,
extend(BufferPlayer, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
BufferPlayer.prototype.generate = function() {
var output = this.outputs[0];
View
2 src/dsp/CombFilter.js
@@ -39,7 +39,7 @@ var CombFilter = function(audiolet, maximumDelayTime, delayTime, decayTime) {
extend(CombFilter, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
CombFilter.prototype.generate = function() {
var input = this.inputs[0];
View
2 src/dsp/CrossFade.js
@@ -34,7 +34,7 @@ var CrossFade = function(audiolet, position) {
extend(CrossFade, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
CrossFade.prototype.generate = function() {
var inputA = this.inputs[0];
View
2 src/dsp/DCFilter.js
@@ -39,7 +39,7 @@ var DCFilter = function(audiolet, coefficient) {
extend(DCFilter, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
DCFilter.prototype.generate = function() {
var coefficient = this.coefficient.getValue();
View
2 src/dsp/DampedCombFilter.js
@@ -46,7 +46,7 @@ var DampedCombFilter = function(audiolet, maximumDelayTime, delayTime,
extend(DampedCombFilter, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
DampedCombFilter.prototype.generate = function() {
var input = this.inputs[0];
View
2 src/dsp/Delay.js
@@ -36,7 +36,7 @@ var Delay = function(audiolet, maximumDelayTime, delayTime) {
extend(Delay, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
Delay.prototype.generate = function() {
var input = this.inputs[0];
View
2 src/dsp/DiscontinuityDetector.js
@@ -46,7 +46,7 @@ DiscontinuityDetector.prototype.callback = function(size, channel) {
};
/**
- * Process a block of samples
+ * Process samples
*/
DiscontinuityDetector.prototype.generate = function() {
var input = this.inputs[0];
View
7 src/dsp/Envelope.js
@@ -49,12 +49,9 @@ var Envelope = function(audiolet, gate, levels, times, releaseStage,
extend(Envelope, AudioletNode);
/**
- * Process a block of samples
- *
- * @param {AudioletBuffer[]} inputBuffers Samples received from the inputs.
- * @param {AudioletBuffer[]} outputBuffers Samples to be sent to the outputs.
+ * Process samples
*/
-Envelope.prototype.generate = function(inputBuffers, outputBuffers) {
+Envelope.prototype.generate = function() {
var gate = this.gate.getValue();
var stageChanged = false;
View
2 src/dsp/FFT.js
@@ -36,7 +36,7 @@ var FFT = function(audiolet, bufferSize) {
extend(FFT, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
FFT.prototype.generate = function() {
var input = this.inputs[0];
View
2 src/dsp/FeedbackDelay.js
@@ -45,7 +45,7 @@ var FeedbackDelay = function(audiolet, maximumDelayTime, delayTime, feedback,
extend(FeedbackDelay, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
FeedbackDelay.prototype.generate = function() {
var input = this.inputs[0];
View
2 src/dsp/IFFT.js
@@ -40,7 +40,7 @@ var IFFT = function(audiolet, bufferSize) {
extend(IFFT, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
IFFT.prototype.generate = function() {
var input = this.inputs[0];
View
2 src/dsp/Lag.js
@@ -36,7 +36,7 @@ var Lag = function(audiolet, value, lagTime) {
extend(Lag, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
Lag.prototype.generate = function() {
var input = this.inputs[0];
View
2 src/dsp/Limiter.js
@@ -43,7 +43,7 @@ var Limiter = function(audiolet, threshold, attack, release) {
extend(Limiter, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
Limiter.prototype.generate = function() {
var input = this.inputs[0];
View
2 src/dsp/LinearCrossFade.js
@@ -33,7 +33,7 @@ var LinearCrossFade = function(audiolet, position) {
extend(LinearCrossFade, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
LinearCrossFade.prototype.generate = function() {
var inputA = this.inputs[0];
View
2 src/dsp/Pan.js
@@ -36,7 +36,7 @@ var Pan = function(audiolet, pan) {
extend(Pan, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
Pan.prototype.generate = function() {
var input = this.inputs[0];
View
7 src/dsp/Pulse.js
@@ -34,12 +34,9 @@ var Pulse = function(audiolet, frequency, pulseWidth) {
extend(Pulse, AudioletNode);
/**
- * Process a block of samples
- *
- * @param {AudioletBuffer[]} inputBuffers Samples received from the inputs.
- * @param {AudioletBuffer[]} outputBuffers Samples to be sent to the outputs.
+ * Process samples
*/
-Pulse.prototype.generate = function(inputBuffers, outputBuffers) {
+Pulse.prototype.generate = function() {
var pulseWidth = this.pulseWidth.getValue();
this.outputs[0].samples[0] = (this.phase < pulseWidth) ? 1 : -1;
View
2 src/dsp/Reverb.js
@@ -88,7 +88,7 @@ var Reverb = function(audiolet, mix, roomSize, damping) {
extend(Reverb, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
Reverb.prototype.generate = function() {
var mix = this.mix.getValue();
View
2 src/dsp/SoftClip.js
@@ -25,7 +25,7 @@ var SoftClip = function(audiolet) {
extend(SoftClip, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
SoftClip.prototype.generate = function() {
var input = this.inputs[0];
View
11 src/dsp/TriggerControl.js
@@ -3,8 +3,8 @@
*/
/**
- * Simple trigger which allows you to set a single sample to be 1 at the start
- * of a processing block
+ * Simple trigger which allows you to set a single sample to be 1 and then
+ * resets itself.
*
* **Outputs**
*
@@ -26,12 +26,9 @@ var TriggerControl = function(audiolet, trigger) {
extend(TriggerControl, AudioletNode);
/**
- * Process a block of samples
- *
- * @param {AudioletBuffer[]} inputBuffers Samples received from the inputs.
- * @param {AudioletBuffer[]} outputBuffers Samples to be sent to the outputs.
+ * Process samples
*/
-TriggerControl.prototype.generate = function(inputBuffers, outputBuffers) {
+TriggerControl.prototype.generate = function() {
if (this.trigger.getValue() > 0) {
this.outputs[0].samples[0] = 1;
this.trigger.setValue(0);
View
2 src/dsp/UpMixer.js
@@ -25,7 +25,7 @@ var UpMixer = function(audiolet, outputChannels) {
extend(UpMixer, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
UpMixer.prototype.generate = function() {
var input = this.inputs[0];
View
2 src/dsp/WhiteNoise.js
@@ -19,7 +19,7 @@ var WhiteNoise = function(audiolet) {
extend(WhiteNoise, AudioletNode);
/**
- * Process a block of samples
+ * Process samples
*/
WhiteNoise.prototype.generate = function() {
this.outputs[0].samples[0] = Math.random() * 2 - 1;

0 comments on commit 51d2f18

Please sign in to comment.