Merge branch 'main' into Listener_tests

Author: davepagurek

lib/p5.sound.js

@@ -16,16 +16,16 @@
     "chai": "3.4.1",
     "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-prettier": "^3.1.3",
-    "grunt": "~0.4.5",
-    "grunt-cli": "^0.1.13",
+    "grunt": "~1.5.3",
+    "grunt-cli": "^1.4.3",
     "grunt-contrib-connect": "^1.0.2",
     "grunt-decomment": "^0.2.4",
     "grunt-eslint": "^20.0.0",
     "grunt-githooks": "^0.6.0",
     "grunt-mocha": "^1.0.4",
     "grunt-open": "^0.2.3",
     "grunt-webpack": "^3.1.3",
-    "mocha": "2.3.4",
+    "mocha": "10.1.0",
     "prettier": "2.0.5",
     "raw-loader": "^3.0.0",
     "tslint-config-prettier": "^1.18.0",

package-lock.json

@@ -129,6 +129,12 @@ p5.Distortion = Distortion;
 import Gain from './gain';
 p5.Gain = Gain;
 
+import Envelope from './envelope';
+p5.Envelope = Envelope;
+
+import Env from './deprecations/Env';
+p5.Env = Env;
+
 import AudioVoice from './audioVoice';
 p5.AudioVoice = AudioVoice;
 

package.json

@@ -23,6 +23,8 @@ class AudioVoice {
 
   amp(vol, rampTime) {}
 
+  setADSR(attack, decay, sustain, release) {}
+
   /**
    * Connect to p5 objects or Web Audio Nodes
    * @method  connect

src/app.js

@@ -235,7 +235,7 @@ class Compressor extends Effect {
    * @return {Number} Value of the amount of gain reduction that is applied to the signal
    */
   reduction() {
-    return this.compressor.reduction.value;
+    return this.compressor.reduction;
   }
 
   dispose() {

src/audioVoice.js

@@ -114,7 +114,7 @@ class Delay extends Effect {
    *
    *  @method  process
    *  @for p5.Delay
-   *  @param  {Object} Signal  An object that outputs audio
+   *  @param  {Object} src An object that outputs audio
    *  @param  {Number} [delayTime] Time (in seconds) of the delay/echo.
    *                               Some browsers limit delayTime to
    *                               1 second.

src/compressor.js

@@ -0,0 +1,13 @@
+import Envelope from '../envelope';
+
+class Env extends Envelope {
+  constructor(t1, l1, t2, l2, t3, l3) {
+    console.warn(
+      'WARNING: p5.Env is now deprecated and may be removed in future versions. ' +
+        'Please use the new p5.Envelope instead.'
+    );
+    super(t1, l1, t2, l2, t3, l3);
+  }
+}
+
+export default Env;

src/delay.js

@@ -30,10 +30,72 @@ function makeDistortionCurve(amount) {
  * @class p5.Distortion
  * @extends p5.Effect
  * @constructor
- * @param {Number} [amount=0.25] Unbounded distortion amount.
- *                                Normal values range from 0-1.
- * @param {String} [oversample='none'] 'none', '2x', or '4x'.
+ * @param {Number} [amount] Unbounded distortion amount.
+ *                                Normal values range from 0-1 (defaults to 0.25)
+ * @param {String} [oversample] 'none', '2x' (default), or '4x'.
+ *  @example
+ *  <div><code>
+ *  let osc, distortion, fft;
  *
+ *  function setup() {
+ *    let cnv = createCanvas(100, 100);
+ *    fft = new p5.FFT(0, 256);
+ *
+ *    osc = new p5.TriOsc();
+ *    osc.amp(0.3);
+ *    osc.freq(375);
+ *
+ *    distortion = new p5.Distortion();
+ *    distortion.process(osc);
+ *    cnv.mousePressed(oscStart);
+ *  }
+ *
+ *  function draw() {
+ *    background(220);
+ *    // set the amount based on mouseX
+ *    let amount = constrain(map(mouseX, 0, width, 0, 1), 0, 1);
+ *
+ *    // multiply the amount to smooth the value
+ *    distortion.set(amount * amount);
+ *
+ *    noStroke();
+ *    fill(0);
+ *    text('tap to play', 10, 20);
+ *    text('amount: ' + amount, 10, 40);
+ *
+ *    // draw the waveform
+ *    var samples = fft.waveform();
+ *    drawOscilloscope(samples);
+ *  }
+ *
+ *  //function based on distortion example
+ *  function drawOscilloscope(samples) {
+ *    var yTranslateScope = 20;
+ *    var scopeWidth = width;
+ *    var scopeHeight = height;
+ *
+ *    stroke(0);
+ *    strokeWeight(1);
+ *    noFill();
+ *
+ *    beginShape();
+ *    for (var sampleIndex in samples) {
+ *      var x = map(sampleIndex, 0, samples.length, 0, scopeWidth);
+ *      var y = map(samples[sampleIndex], -1, 1, -scopeHeight / 4, scopeHeight / 4);
+ *      vertex(x, y + scopeHeight / 2 + yTranslateScope);
+ *    }
+ *    endShape();
+ *  }
+ *
+ *  function oscStart() {
+ *    osc.start();
+ *  }
+ *
+ *  function mouseReleased() {
+ *    osc.stop();
+ *  }
+ *
+ *  </code></div>
  */
 class Distortion extends Effect {
   constructor(amount, oversample) {
@@ -61,8 +123,7 @@ class Distortion extends Effect {
      *  @property {AudioNode} WaveShaperNode
      */
     this.waveShaperNode = this.ac.createWaveShaper();
-
-    this.amount = curveAmount;
+    this.amount = amount;
     this.waveShaperNode.curve = makeDistortionCurve(curveAmount);
     this.waveShaperNode.oversample = oversample;
 
@@ -76,9 +137,10 @@ class Distortion extends Effect {
    *
    * @method process
    * @for p5.Distortion
-   * @param {Number} [amount=0.25] Unbounded distortion amount.
+   * @param {Object} src An object that outputs audio
+   * @param {Number} [amount] Unbounded distortion amount.
    *                                Normal values range from 0-1.
-   * @param {String} [oversample='none'] 'none', '2x', or '4x'.
+   * @param {String} [oversample] 'none', '2x', or '4x'.
    */
   process(src, amount, oversample) {
     src.connect(this.input);
@@ -90,14 +152,15 @@ class Distortion extends Effect {
    *
    * @method set
    * @for p5.Distortion
-   * @param {Number} [amount=0.25] Unbounded distortion amount.
+   * @param {Number} [amount] Unbounded distortion amount.
    *                                Normal values range from 0-1.
-   * @param {String} [oversample='none'] 'none', '2x', or '4x'.
+   * @param {String} [oversample] 'none', '2x', or '4x'.
    */
   set(amount, oversample) {
-    if (amount) {
+    if (typeof amount === 'number') {
       var curveAmount = p5.prototype.map(amount, 0.0, 1.0, 0, 2000);
-      this.amount = curveAmount;
+      //this.amount = curveAmount;
+      this.amount = amount;
       this.waveShaperNode.curve = makeDistortionCurve(curveAmount);
     }
     if (oversample) {

src/deprecations/Env.js

@@ -11,7 +11,9 @@ import CrossFade from 'Tone/component/CrossFade.js';
  * <a href="/reference/#/p5.Compressor">p5.Compressor</a>,
  * <a href="/reference/#/p5.Delay">p5.Delay</a>,
  * <a href="/reference/#/p5.Filter">p5.Filter</a>,
- * <a href="/reference/#/p5.Reverb">p5.Reverb</a>.
+ * <a href="/reference/#/p5.Reverb">p5.Reverb</a>,
+ * <a href="/reference/#/p5.EQ">p5.EQ</a>,
+ * <a href="/reference/#/p5.Panner3D">p5.Panner3D</a>.
  *
  * @class  p5.Effect
  * @constructor