It is not only a good practice to give users control over starting
@@ -102,7 +102,7 @@ p5.prototype.getAudioContext = function () {
* }
*
*/
-p5.prototype.userStartAudio = function (elements, callback) {
+export function userStartAudio(elements, callback) {
var elt = elements;
if (elements instanceof p5.Element) {
elt = elements.elt;
@@ -112,6 +112,6 @@ p5.prototype.userStartAudio = function (elements, callback) {
});
}
return StartAudioContext(audiocontext, elt, callback);
-};
+}
export default audiocontext;
diff --git a/src/audioin.js b/src/audioin.js
index 10ab52a4..78b402d0 100644
--- a/src/audioin.js
+++ b/src/audioin.js
@@ -31,7 +31,7 @@ p5sound.inputSources = [];
*
* function setup(){
* let cnv = createCanvas(100, 100);
- * cnv.mousePressed(userStartAudio);
+ * cnv.mousePressed(useraudiocontextStartAudio);
* textAlign(CENTER);
* mic = new p5.AudioIn();
* mic.start();
@@ -48,348 +48,351 @@ p5sound.inputSources = [];
* }
*
*/
-p5.AudioIn = function (errorCallback) {
- // set up audio input
- /**
- * @property {GainNode} input
- */
- this.input = p5sound.audiocontext.createGain();
- /**
- * @property {GainNode} output
- */
- this.output = p5sound.audiocontext.createGain();
+class AudioIn {
+ constructor(errorCallback) {
+ // set up audio input
+ /**
+ * @property {GainNode} input
+ */
+ this.input = p5sound.audiocontext.createGain();
+ /**
+ * @property {GainNode} output
+ */
+ this.output = p5sound.audiocontext.createGain();
- /**
- * @property {MediaStream|null} stream
- */
- this.stream = null;
- /**
- * @property {MediaStreamAudioSourceNode|null} mediaStream
- */
- this.mediaStream = null;
- /**
- * @property {Number|null} currentSource
- */
- this.currentSource = null;
+ /**
+ * @property {MediaStream|null} stream
+ */
+ this.stream = null;
+ /**
+ * @property {MediaStreamAudioSourceNode|null} mediaStream
+ */
+ this.mediaStream = null;
+ /**
+ * @property {Number|null} currentSource
+ */
+ this.currentSource = null;
- /**
- * Client must allow browser to access their microphone / audioin source.
- * Default: false. Will become true when the client enables access.
- *
- * @property {Boolean} enabled
- */
- this.enabled = false;
+ /**
+ * Client must allow browser to access their microphone / audioin source.
+ * Default: false. Will become true when the client enables access.
+ *
+ * @property {Boolean} enabled
+ */
+ this.enabled = false;
+
+ /**
+ * Input amplitude, connect to it by default but not to master out
+ *
+ * @property {p5.Amplitude} amplitude
+ */
+ this.amplitude = new Amplitude();
+ this.output.connect(this.amplitude.input);
+ if (
+ !window.MediaStreamTrack ||
+ !window.navigator.mediaDevices ||
+ !window.navigator.mediaDevices.getUserMedia
+ ) {
+ errorCallback
+ ? errorCallback()
+ : window.alert(
+ 'This browser does not support MediaStreamTrack and mediaDevices'
+ );
+ }
+
+ // add to soundArray so we can dispose on close
+ p5sound.soundArray.push(this);
+ }
/**
- * Input amplitude, connect to it by default but not to master out
+ * Start processing audio input. This enables the use of other
+ * AudioIn methods like getLevel(). Note that by default, AudioIn
+ * is not connected to p5.sound's output. So you won't hear
+ * anything unless you use the connect() method.
*
- * @property {p5.Amplitude} amplitude
+ * Certain browsers limit access to the user's microphone. For example,
+ * Chrome only allows access from localhost and over https. For this reason,
+ * you may want to include an errorCallback—a function that is called in case
+ * the browser won't provide mic access.
+ *
+ * @method start
+ * @for p5.AudioIn
+ * @param {Function} [successCallback] Name of a function to call on
+ * success.
+ * @param {Function} [errorCallback] Name of a function to call if
+ * there was an error. For example,
+ * some browsers do not support
+ * getUserMedia.
*/
- this.amplitude = new Amplitude();
- this.output.connect(this.amplitude.input);
-
- if (
- !window.MediaStreamTrack ||
- !window.navigator.mediaDevices ||
- !window.navigator.mediaDevices.getUserMedia
- ) {
- errorCallback
- ? errorCallback()
- : window.alert(
- 'This browser does not support MediaStreamTrack and mediaDevices'
- );
- }
+ start(successCallback, errorCallback) {
+ var self = this;
- // add to soundArray so we can dispose on close
- p5sound.soundArray.push(this);
-};
-
-/**
- * Start processing audio input. This enables the use of other
- * AudioIn methods like getLevel(). Note that by default, AudioIn
- * is not connected to p5.sound's output. So you won't hear
- * anything unless you use the connect() method.
- *
- * Certain browsers limit access to the user's microphone. For example,
- * Chrome only allows access from localhost and over https. For this reason,
- * you may want to include an errorCallback—a function that is called in case
- * the browser won't provide mic access.
- *
- * @method start
- * @for p5.AudioIn
- * @param {Function} [successCallback] Name of a function to call on
- * success.
- * @param {Function} [errorCallback] Name of a function to call if
- * there was an error. For example,
- * some browsers do not support
- * getUserMedia.
- */
-p5.AudioIn.prototype.start = function (successCallback, errorCallback) {
- var self = this;
+ if (this.stream) {
+ this.stop();
+ }
- if (this.stream) {
- this.stop();
- }
+ // set the audio source
+ var audioSource = p5sound.inputSources[self.currentSource];
+ var constraints = {
+ audio: {
+ sampleRate: p5sound.audiocontext.sampleRate,
+ echoCancellation: false,
+ },
+ };
- // set the audio source
- var audioSource = p5sound.inputSources[self.currentSource];
- var constraints = {
- audio: {
- sampleRate: p5sound.audiocontext.sampleRate,
- echoCancellation: false,
- },
- };
+ // if developers determine which source to use
+ if (p5sound.inputSources[this.currentSource]) {
+ constraints.audio.deviceId = audioSource.deviceId;
+ }
- // if developers determine which source to use
- if (p5sound.inputSources[this.currentSource]) {
- constraints.audio.deviceId = audioSource.deviceId;
+ window.navigator.mediaDevices
+ .getUserMedia(constraints)
+ .then(function (stream) {
+ self.stream = stream;
+ self.enabled = true;
+ // Wrap a MediaStreamSourceNode around the live input
+ self.mediaStream = p5sound.audiocontext.createMediaStreamSource(stream);
+ self.mediaStream.connect(self.output);
+ // only send to the Amplitude reader, so we can see it but not hear it.
+ self.amplitude.setInput(self.output);
+ if (successCallback) successCallback();
+ })
+ .catch(function (err) {
+ if (errorCallback) errorCallback(err);
+ else console.error(err);
+ });
}
- window.navigator.mediaDevices
- .getUserMedia(constraints)
- .then(function (stream) {
- self.stream = stream;
- self.enabled = true;
- // Wrap a MediaStreamSourceNode around the live input
- self.mediaStream = p5sound.audiocontext.createMediaStreamSource(stream);
- self.mediaStream.connect(self.output);
- // only send to the Amplitude reader, so we can see it but not hear it.
- self.amplitude.setInput(self.output);
- if (successCallback) successCallback();
- })
- .catch(function (err) {
- if (errorCallback) errorCallback(err);
- else console.error(err);
- });
-};
-
-/**
- * Turn the AudioIn off. If the AudioIn is stopped, it cannot getLevel().
- * If re-starting, the user may be prompted for permission access.
- *
- * @method stop
- * @for p5.AudioIn
- */
-p5.AudioIn.prototype.stop = function () {
- if (this.stream) {
- this.stream.getTracks().forEach(function (track) {
- track.stop();
- });
+ /**
+ * Turn the AudioIn off. If the AudioIn is stopped, it cannot getLevel().
+ * If re-starting, the user may be prompted for permission access.
+ *
+ * @method stop
+ * @for p5.AudioIn
+ */
+ stop() {
+ if (this.stream) {
+ this.stream.getTracks().forEach(function (track) {
+ track.stop();
+ });
- this.mediaStream.disconnect();
+ this.mediaStream.disconnect();
- delete this.mediaStream;
- delete this.stream;
+ delete this.mediaStream;
+ delete this.stream;
+ }
}
-};
-/**
- * Connect to an audio unit. If no parameter is provided, will
- * connect to the master output (i.e. your speakers).
- *
- * @method connect
- * @for p5.AudioIn
- * @param {Object} [unit] An object that accepts audio input,
- * such as an FFT
- */
-p5.AudioIn.prototype.connect = function (unit) {
- if (unit) {
- if (unit.hasOwnProperty('input')) {
- this.output.connect(unit.input);
- } else if (unit.hasOwnProperty('analyser')) {
- this.output.connect(unit.analyser);
+ /**
+ * Connect to an audio unit. If no parameter is provided, will
+ * connect to the master output (i.e. your speakers).
+ *
+ * @method connect
+ * @for p5.AudioIn
+ * @param {Object} [unit] An object that accepts audio input,
+ * such as an FFT
+ */
+ connect(unit) {
+ if (unit) {
+ if (unit.hasOwnProperty('input')) {
+ this.output.connect(unit.input);
+ } else if (unit.hasOwnProperty('analyser')) {
+ this.output.connect(unit.analyser);
+ } else {
+ this.output.connect(unit);
+ }
} else {
- this.output.connect(unit);
+ this.output.connect(p5sound.input);
}
- } else {
- this.output.connect(p5sound.input);
}
-};
-/**
- * Disconnect the AudioIn from all audio units. For example, if
- * connect() had been called, disconnect() will stop sending
- * signal to your speakers.
- *
- * @method disconnect
- * @for p5.AudioIn
- */
-p5.AudioIn.prototype.disconnect = function () {
- if (this.output) {
- this.output.disconnect();
- // stay connected to amplitude even if not outputting to p5
- this.output.connect(this.amplitude.input);
+ /**
+ * Disconnect the AudioIn from all audio units. For example, if
+ * connect() had been called, disconnect() will stop sending
+ * signal to your speakers.
+ *
+ * @method disconnect
+ * @for p5.AudioIn
+ */
+ disconnect() {
+ if (this.output) {
+ this.output.disconnect();
+ // stay connected to amplitude even if not outputting to p5
+ this.output.connect(this.amplitude.input);
+ }
}
-};
-/**
- * Read the Amplitude (volume level) of an AudioIn. The AudioIn
- * class contains its own instance of the Amplitude class to help
- * make it easy to get a microphone's volume level. Accepts an
- * optional smoothing value (0.0 < 1.0). NOTE: AudioIn must
- * .start() before using .getLevel().
- *
- * @method getLevel
- * @for p5.AudioIn
- * @param {Number} [smoothing] Smoothing is 0.0 by default.
- * Smooths values based on previous values.
- * @return {Number} Volume level (between 0.0 and 1.0)
- */
-p5.AudioIn.prototype.getLevel = function (smoothing) {
- if (smoothing) {
- this.amplitude.smoothing = smoothing;
+ /**
+ * Read the Amplitude (volume level) of an AudioIn. The AudioIn
+ * class contains its own instance of the Amplitude class to help
+ * make it easy to get a microphone's volume level. Accepts an
+ * optional smoothing value (0.0 < 1.0). NOTE: AudioIn must
+ * .start() before using .getLevel().
+ *
+ * @method getLevel
+ * @for p5.AudioIn
+ * @param {Number} [smoothing] Smoothing is 0.0 by default.
+ * Smooths values based on previous values.
+ * @return {Number} Volume level (between 0.0 and 1.0)
+ */
+ getLevel(smoothing) {
+ if (smoothing) {
+ this.amplitude.smoothing = smoothing;
+ }
+ return this.amplitude.getLevel();
}
- return this.amplitude.getLevel();
-};
-/**
- * Set amplitude (volume) of a mic input between 0 and 1.0.
- *
- * @method amp
- * @for p5.AudioIn
- * @param {Number} vol between 0 and 1.0
- * @param {Number} [time] ramp time (optional)
- */
-p5.AudioIn.prototype.amp = function (vol, t) {
- if (t) {
- var rampTime = t || 0;
- var currentVol = this.output.gain.value;
- this.output.gain.cancelScheduledValues(p5sound.audiocontext.currentTime);
- this.output.gain.setValueAtTime(
- currentVol,
- p5sound.audiocontext.currentTime
- );
- this.output.gain.linearRampToValueAtTime(
- vol,
- rampTime + p5sound.audiocontext.currentTime
- );
- } else {
- this.output.gain.cancelScheduledValues(p5sound.audiocontext.currentTime);
- this.output.gain.setValueAtTime(vol, p5sound.audiocontext.currentTime);
+ /**
+ * Set amplitude (volume) of a mic input between 0 and 1.0.
+ *
+ * @method amp
+ * @for p5.AudioIn
+ * @param {Number} vol between 0 and 1.0
+ * @param {Number} [time] ramp time (optional)
+ */
+ amp(vol, t) {
+ if (t) {
+ var rampTime = t || 0;
+ var currentVol = this.output.gain.value;
+ this.output.gain.cancelScheduledValues(p5sound.audiocontext.currentTime);
+ this.output.gain.setValueAtTime(
+ currentVol,
+ p5sound.audiocontext.currentTime
+ );
+ this.output.gain.linearRampToValueAtTime(
+ vol,
+ rampTime + p5sound.audiocontext.currentTime
+ );
+ } else {
+ this.output.gain.cancelScheduledValues(p5sound.audiocontext.currentTime);
+ this.output.gain.setValueAtTime(vol, p5sound.audiocontext.currentTime);
+ }
}
-};
-/**
- * Returns a list of available input sources. This is a wrapper
- * for
- * MediaDevices.enumerateDevices() - Web APIs | MDN
- * and it returns a Promise.
- * @method getSources
- * @for p5.AudioIn
- * @param {Function} [successCallback] This callback function handles the sources when they
- * have been enumerated. The callback function
- * receives the deviceList array as its only argument
- * @param {Function} [errorCallback] This optional callback receives the error
- * message as its argument.
- * @returns {Promise} Returns a Promise that can be used in place of the callbacks, similar
- * to the enumerateDevices() method
- * @example
- *
- * let audioIn;
- *
- * function setup(){
- * text('getting sources...', 0, 20);
- * audioIn = new p5.AudioIn();
- * audioIn.getSources(gotSources);
- * }
- *
- * function gotSources(deviceList) {
- * if (deviceList.length > 0) {
- * //set the source to the first item in the deviceList array
- * audioIn.setSource(0);
- * let currentSource = deviceList[audioIn.currentSource];
- * text('set source to: ' + currentSource.deviceId, 5, 20, width);
- * }
- * }
- *
+ * let audioIn;
+ *
+ * function setup(){
+ * text('getting sources...', 0, 20);
+ * audioIn = new p5.AudioIn();
+ * audioIn.getSources(gotSources);
+ * }
+ *
+ * function gotSources(deviceList) {
+ * if (deviceList.length > 0) {
+ * //set the source to the first item in the deviceList array
+ * audioIn.setSource(0);
+ * let currentSource = deviceList[audioIn.currentSource];
+ * text('set source to: ' + currentSource.deviceId, 5, 20, width);
+ * }
+ * }
+ *
- * let audioIn;
- *
- * function setup(){
- * text('getting sources...', 0, 20);
- * audioIn = new p5.AudioIn();
- * audioIn.getSources(gotSources);
- * }
- *
- * function gotSources(deviceList) {
- * if (deviceList.length > 0) {
- * //set the source to the first item in the deviceList array
- * audioIn.setSource(0);
- * let currentSource = deviceList[audioIn.currentSource];
- * text('set source to: ' + currentSource.deviceId, 5, 20, width);
- * }
- * }
- *
+ * let audioIn;
+ *
+ * function setup(){
+ * text('getting sources...', 0, 20);
+ * audioIn = new p5.AudioIn();
+ * audioIn.getSources(gotSources);
+ * }
+ *
+ * function gotSources(deviceList) {
+ * if (deviceList.length > 0) {
+ * //set the source to the first item in the deviceList array
+ * audioIn.setSource(0);
+ * let currentSource = deviceList[audioIn.currentSource];
+ * text('set source to: ' + currentSource.deviceId, 5, 20, width);
+ * }
+ * }
+ *
- * let monoSynth;
- *
- * function setup() {
- * let cnv = createCanvas(100, 100);
- * cnv.mousePressed(playSynth);
- * background(220);
- * textAlign(CENTER);
- * text('tap to play', width/2, height/2);
- *
- * monoSynth = new p5.MonoSynth();
- * }
- *
- * function playSynth() {
- * userStartAudio();
- *
- * let note = random(['Fb4', 'G4']);
- * // note velocity (volume, from 0 to 1)
- * let velocity = random();
- * // time from now (in seconds)
- * let time = 0;
- * // note duration (in seconds)
- * let dur = 1/6;
- *
- * monoSynth.play(note, velocity, time, dur);
- * }
- *
- * let monoSynth;
- *
- * function setup() {
- * let cnv = createCanvas(100, 100);
- * cnv.mousePressed(triggerAttack);
- * background(220);
- * text('tap here for attack, let go to release', 5, 20, width - 20);
- * monoSynth = new p5.MonoSynth();
- * }
- *
- * function triggerAttack() {
- * userStartAudio();
- *
- * monoSynth.triggerAttack("E3");
- * }
- *
- * function mouseReleased() {
- * monoSynth.triggerRelease();
- * }
- *
+ * let monoSynth;
+ *
+ * function setup() {
+ * let cnv = createCanvas(100, 100);
+ * cnv.mousePressed(playSynth);
+ * background(220);
+ * textAlign(CENTER);
+ * text('tap to play', width/2, height/2);
+ *
+ * monoSynth = new p5.MonoSynth();
+ * }
+ *
+ * function playSynth() {
+ * userStartAudio();
+ *
+ * let note = random(['Fb4', 'G4']);
+ * // note velocity (volume, from 0 to 1)
+ * let velocity = random();
+ * // time from now (in seconds)
+ * let time = 0;
+ * // note duration (in seconds)
+ * let dur = 1/6;
+ *
+ * monoSynth.play(note, velocity, time, dur);
+ * }
+ *
- * let monoSynth;
- *
- * function setup() {
- * let cnv = createCanvas(100, 100);
- * cnv.mousePressed(triggerAttack);
- * background(220);
- * text('tap here for attack, let go to release', 5, 20, width - 20);
- * monoSynth = new p5.MonoSynth();
- * }
- *
- * function triggerAttack() {
- * userStartAudio();
- *
- * monoSynth.triggerAttack("E3");
- * }
- *
- * function mouseReleased() {
- * monoSynth.triggerRelease();
- * }
- *
+ * let monoSynth;
+ *
+ * function setup() {
+ * let cnv = createCanvas(100, 100);
+ * cnv.mousePressed(triggerAttack);
+ * background(220);
+ * text('tap here for attack, let go to release', 5, 20, width - 20);
+ * monoSynth = new p5.MonoSynth();
+ * }
+ *
+ * function triggerAttack() {
+ * userStartAudio();
+ *
+ * monoSynth.triggerAttack("E3");
+ * }
+ *
+ * function mouseReleased() {
+ * monoSynth.triggerRelease();
+ * }
+ * 
setRange),
- * then decayLevel would increase proportionally, to become 0.5.
- * @param {Number} [releaseTime] Time in seconds from now (defaults to 0)
- */
-p5.MonoSynth.prototype.setADSR = function (attack, decay, sustain, release) {
- this.env.setADSR(attack, decay, sustain, release);
-};
+ /**
+ * Trigger the release of the Envelope. This is similar to releasing
+ * the key on a piano and letting the sound fade according to the
+ * release level and release time.
+ *
+ * @param {Number} secondsFromNow time to trigger the release
+ * @method triggerRelease
+ * @for p5.MonoSynth
+ * @example
+ *
+ * let monoSynth;
+ *
+ * function setup() {
+ * let cnv = createCanvas(100, 100);
+ * cnv.mousePressed(triggerAttack);
+ * background(220);
+ * text('tap here for attack, let go to release', 5, 20, width - 20);
+ * monoSynth = new p5.MonoSynth();
+ * }
+ *
+ * function triggerAttack() {
+ * userStartAudio();
+ *
+ * monoSynth.triggerAttack("E3");
+ * }
+ *
+ * function mouseReleased() {
+ * monoSynth.triggerRelease();
+ * }
+ * setRange),
+ * then decayLevel would increase proportionally, to become 0.5.
+ * @param {Number} [releaseTime] Time in seconds from now (defaults to 0)
+ */
+ setADSR(attack, decay, sustain, release) {
+ this.env.setADSR(attack, decay, sustain, release);
+ }
-/**
- * MonoSynth amp
- * @method amp
- * @for p5.MonoSynth
- * @param {Number} vol desired volume
- * @param {Number} [rampTime] Time to reach new volume
- * @return {Number} new volume value
- */
-p5.MonoSynth.prototype.amp = function (vol, rampTime) {
- var t = rampTime || 0;
- if (typeof vol !== 'undefined') {
- this.oscillator.amp(vol, t);
+ /**
+ * MonoSynth amp
+ * @method amp
+ * @for p5.MonoSynth
+ * @param {Number} vol desired volume
+ * @param {Number} [rampTime] Time to reach new volume
+ * @return {Number} new volume value
+ */
+ amp(vol, rampTime) {
+ var t = rampTime || 0;
+ if (typeof vol !== 'undefined') {
+ this.oscillator.amp(vol, t);
+ }
+ return this.oscillator.amp().value;
}
- return this.oscillator.amp().value;
-};
-/**
- * Connect to a p5.sound / Web Audio object.
- *
- * @method connect
- * @for p5.MonoSynth
- * @param {Object} unit A p5.sound or Web Audio object
- */
+ /**
+ * Connect to a p5.sound / Web Audio object.
+ *
+ * @method connect
+ * @for p5.MonoSynth
+ * @param {Object} unit A p5.sound or Web Audio object
+ */
-p5.MonoSynth.prototype.connect = function (unit) {
- var u = unit || p5sound.input;
- this.output.connect(u.input ? u.input : u);
-};
+ connect(unit) {
+ var u = unit || p5sound.input;
+ this.output.connect(u.input ? u.input : u);
+ }
-/**
- * Disconnect all outputs
- *
- * @method disconnect
- * @for p5.MonoSynth
- */
-p5.MonoSynth.prototype.disconnect = function () {
- if (this.output) {
- this.output.disconnect();
+ /**
+ * Disconnect all outputs
+ *
+ * @method disconnect
+ * @for p5.MonoSynth
+ */
+ disconnect() {
+ if (this.output) {
+ this.output.disconnect();
+ }
}
-};
-/**
- * Get rid of the MonoSynth and free up its resources / memory.
- *
- * @method dispose
- * @for p5.MonoSynth
- */
-p5.MonoSynth.prototype.dispose = function () {
- AudioVoice.prototype.dispose.apply(this);
+ /**
+ * Get rid of the MonoSynth and free up its resources / memory.
+ *
+ * @method dispose
+ * @for p5.MonoSynth
+ */
+ dispose() {
+ super.dispose();
- if (this.env) {
- this.env.dispose();
+ if (this.env) {
+ this.env.dispose();
+ }
+ if (this.oscillator) {
+ this.oscillator.dispose();
+ }
}
- if (this.oscillator) {
- this.oscillator.dispose();
- }
-};
+}
+
+export default MonoSynth;
diff --git a/src/oscillator.js b/src/oscillator.js
index 577390cb..490f2a67 100644
--- a/src/oscillator.js
+++ b/src/oscillator.js
@@ -626,4 +626,5 @@ p5.SqrOsc = function (freq) {
p5.SqrOsc.prototype = Object.create(p5.Oscillator.prototype);
-export const Oscillator = p5.Oscillator;
+const Oscillator = p5.Oscillator;
+export default Oscillator;