31 |
32 |
33 | Processing Intuition times JavaScript power
34 |
37 |
38 |
39 |
50 |
51 |
56 |
57 |
58 |
59 | 60 |
Empty Example
20 |Returns the Audio Context for this sketch. Useful for users 12 | * who would like to dig deeper into the Web Audio API 14 | * . and the reference for it at 16 | * MDN Web Docs
17 | * 18 | *Browsers require users to start the audio context 19 | * with a user gesture, such as touchStarted in the example below.
20 | * 21 | * @for p5sound 22 | * @method getAudioContext 23 | * @return {Object} audioContext for this sketch 24 | * @example 25 | * function draw() { 26 | * background(255); 27 | * textAlign(CENTER); 28 | * 29 | * if (getAudioContext().state == 'running') { 30 | * text('audioContext is running', width/2, height/2); 31 | * } else if (getAudioContext().state == 'suspended') { 32 | * text('audio is suspended', width/2, height/2); 33 | * } else if (getAudioContext().state == 'closed') { 34 | * text('audioContext is closed', width/2, height/2); 35 | * } 36 | * 37 | * text('tap or mouse press to change behavior', width/2, height/2 + 20); 38 | * 39 | * function mousePressed() { 40 | * if (getAudioContext().state == 'suspended') { 41 | * getAudioContext().resume(); 42 | * } else if (getAudioContext().state == 'running') { 43 | * getAudioContext().suspend(); 44 | * } 45 | * 46 | */ 47 | export function getAudioContext() { 48 | return audioContext; 49 | } 50 | 51 | export default audioContext; -------------------------------------------------------------------------------- /test/manual-test-examples/addons/p5.sound/waveform_with_playhead/sketch.js: -------------------------------------------------------------------------------- 1 | // /** 2 | // * DEMO 3 | // * - find the peaks in an audio file to draw the entire waveform with SoundFile.getPeaks(); 4 | // * - draw cursor on a timeline with SoundFile.currentTime() and SoundFile.duration(); 5 | // */ 6 | 7 | // // ==================== 8 | 9 | // var soundFile; 10 | 11 | // var p, peakCount; 12 | 13 | // function preload() { 14 | // soundFormats('ogg', 'mp3'); 15 | // soundFile = loadSound('../_files/lucky_dragons'); 16 | // } 17 | 18 | // function setup() { 19 | // createCanvas(800, 400); 20 | // soundFile.loop(); 21 | // background(0); 22 | // p = createP('peaks to draw: ' + peakCount); 23 | // createP('Press any key to play/pause.'); 24 | // } 25 | 26 | // function draw() { 27 | // background(255); 28 | 29 | // peakCount = map(this.mouseY, height, 0, 5, 2000); 30 | // if (peakCount < 8) { 31 | // peakCount = 8; 32 | // } 33 | 34 | // var waveform = soundFile.getPeaks(peakCount); 35 | // fill(0); 36 | // stroke(0); 37 | // strokeWeight(2); 38 | // beginShape(); 39 | // for (var i = 0; i < waveform.length; i++) { 40 | // vertex( 41 | // map(i, 0, waveform.length, 0, width), 42 | // map(waveform[i], -1, 1, height, 0) 43 | // ); 44 | // } 45 | // endShape(); 46 | 47 | // // update display text: 48 | // p.html('MouseY = Visible Amplitude Peaks: ' + peakCount.toFixed(3)); 49 | 50 | // drawCursor(); 51 | // } 52 | 53 | // function drawCursor() { 54 | // noStroke(); 55 | // fill(0, 255, 0); 56 | // rect( 57 | // map(soundFile.currentTime(), 0, soundFile.duration(), 0, width), 58 | // 0, 59 | // 5, 60 | // height 61 | // ); 62 | // } 63 | 64 | // // Keyboard Controls 65 | // function keyTyped() { 66 | // if (soundFile.isPlaying()) { 67 | // soundFile.pause(); 68 | // } else { 69 | // soundFile.play(); 70 | // } 71 | // } 72 | -------------------------------------------------------------------------------- /test/manual-test-examples/addons/p5.sound/waveform_peaks_with_playhead/sketch.js: -------------------------------------------------------------------------------- 1 | // /** 2 | // * DEMO 3 | // * - find the peaks in an audio file to draw the entire waveform with SoundFile.getPeaks(); 4 | // * - draw cursor on a timeline with SoundFile.currentTime() and SoundFile.duration(); 5 | // */ 6 | 7 | // // ==================== 8 | 9 | // var soundFile; 10 | 11 | // var p, peakCount; 12 | 13 | // function preload() { 14 | // soundFormats('ogg', 'mp3'); 15 | // soundFile = loadSound('../_files/lucky_dragons'); 16 | // } 17 | 18 | // function setup() { 19 | // createCanvas(800, 400); 20 | // noFill(); 21 | 22 | // soundFile.loop(); 23 | // background(0); 24 | // p = createP('peaks to draw: ' + peakCount); 25 | // createP('Press any key to play/pause.'); 26 | // } 27 | 28 | // function draw() { 29 | // background(255); 30 | 31 | // peakCount = map(this.mouseY, height, 0, 5, 2000); 32 | // if (peakCount < 8) { 33 | // peakCount = 8; 34 | // } 35 | // var waveform = soundFile.getPeaks(peakCount); 36 | // fill(0); 37 | // stroke(0); 38 | // strokeWeight(2); 39 | // beginShape(); 40 | // for (var i = 0; i < waveform.length; i++) { 41 | // vertex( 42 | // map(i, 0, waveform.length, 0, width), 43 | // map(waveform[i], -1, 1, height, 0) 44 | // ); 45 | // } 46 | // endShape(); 47 | 48 | // // update display text: 49 | // p.html('MouseY = Visible Amplitude Peaks: ' + peakCount.toFixed(3)); 50 | 51 | // drawCursor(); 52 | // } 53 | 54 | // function drawCursor() { 55 | // noStroke(); 56 | // fill(0, 255, 0); 57 | // rect( 58 | // map(soundFile.currentTime(), 0, soundFile.duration(), 0, width), 59 | // 0, 60 | // 5, 61 | // height 62 | // ); 63 | // } 64 | 65 | // // Keyboard Controls 66 | // function keyTyped() { 67 | // if (soundFile.isPlaying()) { 68 | // soundFile.pause(); 69 | // } else { 70 | // soundFile.play(); 71 | // } 72 | // } 73 | -------------------------------------------------------------------------------- /test/manual-test-examples/addons/p5.sound/Reverb_convolve/sketch.js: -------------------------------------------------------------------------------- 1 | // /** 2 | // * Example: Convolution Reverb 3 | // * 4 | // * The p5.Convolver can recreate the sound of actual spaces using convolution. 5 | // * 6 | // * Toggle between five different buffer sources 7 | // * 8 | // * Convolution samples Creative Commons BY recordinghopkins, via freesound.org 9 | // * https://www.freesound.org/people/recordinghopkins/ 10 | // */ 11 | 12 | // var sound, cVerb; 13 | // var currentIR = 0; 14 | // var p; 15 | 16 | // function preload() { 17 | // // we have included both MP3 and OGG versions of all the impulses/sounds 18 | // soundFormats('ogg', 'mp3'); 19 | 20 | // // create a p5.Convolver 21 | // cVerb = createConvolver('../_files/bx-spring'); 22 | 23 | // // add Impulse Responses to cVerb.impulses array, in addition to bx-spring 24 | // cVerb.addImpulse('../_files/small-plate'); 25 | // cVerb.addImpulse('../_files/drum'); 26 | // cVerb.addImpulse('../_files/concrete-tunnel'); 27 | 28 | // // load a sound that will be processed by the p5.ConvultionReverb 29 | // sound = loadSound('../_files/Damscray_DancingTiger'); 30 | // } 31 | 32 | // function setup() { 33 | // // disconnect from main output... 34 | // sound.disconnect(); 35 | // // ... and process with cVerb so that we only hear the reverb 36 | // cVerb.process(sound); 37 | 38 | // createP('Click to play a sound and change the impulse'); 39 | // p = createP(''); 40 | // } 41 | 42 | // function mousePressed() { 43 | // // cycle through the array of cVerb.impulses 44 | // currentIR++; 45 | // if (currentIR >= cVerb.impulses.length) { 46 | // currentIR = 0; 47 | // } 48 | // cVerb.toggleImpulse(currentIR); 49 | 50 | // // play the sound through the impulse 51 | // sound.play(); 52 | 53 | // // display the current Impulse Response name (the filepath) 54 | // p.html('Convolution Impulse Response: ' + cVerb.impulses[currentIR].name); 55 | // } 56 | -------------------------------------------------------------------------------- /test/manual-test-examples/addons/p5.sound/soundfile_playMode/sketch.js: -------------------------------------------------------------------------------- 1 | // /** 2 | // * Toggle play mode between 'restart' and 'sustain'. 3 | // * Sustain is the default playmode for SoundFiles 4 | // * Music from Damscray, "Dancing Tiger", Creative Commons BY-NC-SA 5 | // */ 6 | 7 | // var playMode = 'sustain'; 8 | // var sample1, sample2, button; 9 | 10 | // function preload() { 11 | // sample1 = loadSound([ 12 | // '../_files/Damscray_01.ogg', 13 | // '../_files/Damscray_01.mp3' 14 | // ]); 15 | // sample2 = loadSound([ 16 | // '../_files/Damscray_02.ogg', 17 | // '../_files/Damscray_02.mp3' 18 | // ]); 19 | // } 20 | 21 | // function setup() { 22 | // createCanvas(0, 0); 23 | 24 | // createP( 25 | // 'Press "a" and "s" on your keyboard to play two different samples.
31 |
32 |
33 | Processing Intuition times JavaScript power
34 |60 |
p5.sound extends p5 with Web Audio functionality including audio input, 4 | * playback, analysis and synthesis. 5 | *
6 | *p5.sound is on GitHub. 42 | * Download the latest version 43 | * here.
44 | * 45 | * @module p5.sound 46 | * @submodule p5.sound 47 | * @for p5.sound 48 | * @main 49 | */ 50 | 51 | /** 52 | * p5.sound 53 | * https://p5js.org/reference/#/libraries/p5.sound 54 | * 55 | * From the Processing Foundation and contributors 56 | * https://github.com/processing/p5.js-sound/graphs/contributors 57 | * 58 | * MIT License (MIT) 59 | * https://github.com/processing/p5.js-sound/blob/master/LICENSE 60 | * 61 | * Some of the many audio libraries & resources that inspire p5.sound: 62 | * - TONE.js (c) Yotam Mann. Licensed under The MIT License (MIT). https://github.com/TONEnoTONE/Tone.js 63 | * - buzz.js (c) Jay Salvat. Licensed under The MIT License (MIT). http://buzz.jaysalvat.com/ 64 | * - Boris Smus Web Audio API book, 2013. Licensed under the Apache License http://www.apache.org/licenses/LICENSE-2.0 65 | * - wavesurfer.js https://github.com/katspaugh/wavesurfer.js 66 | * - Web Audio Components by Jordan Santell https://github.com/web-audio-components 67 | * - Wilm Thoben's Sound library for Processing https://github.com/processing/processing/tree/master/java/libraries/sound 68 | * 69 | * Web Audio API: http://w3.org/TR/webaudio/ 70 | */ 71 | -------------------------------------------------------------------------------- /test/node/test-docs-preprocessor.js: -------------------------------------------------------------------------------- 1 | import { expect } from 'chai'; 2 | import preprocessor from '../../docs/preprocessor'; 3 | 4 | suite('docs preprocessor', function() { 5 | suite('mergeOverloadedMethods()', function() { 6 | const merge = preprocessor.mergeOverloadedMethods; 7 | 8 | const ensureMergeDoesNothing = function(data) { 9 | const dataCopy = JSON.parse(JSON.stringify(data)); 10 | merge(dataCopy); 11 | expect(dataCopy).to.eql(data); 12 | }; 13 | 14 | test('should merge methods with the same name', function() { 15 | const data = { 16 | classes: { 17 | Bar: {}, 18 | Baz: {} 19 | }, 20 | classitems: [ 21 | { 22 | file: 'foo.js', 23 | line: 1, 24 | description: 'Does foo.', 25 | itemtype: 'method', 26 | name: 'foo', 27 | class: 'Bar', 28 | params: [{ name: 'bar', type: 'String' }] 29 | }, 30 | { 31 | file: 'foo.js', 32 | line: 5, 33 | itemtype: 'method', 34 | name: 'foo', 35 | class: 'Bar', 36 | params: [{ name: 'baz', type: 'Number' }] 37 | } 38 | ], 39 | consts: {} 40 | }; 41 | 42 | merge(data); 43 | 44 | expect(data).to.eql({ 45 | classes: { 46 | Bar: {}, 47 | Baz: {} 48 | }, 49 | classitems: [ 50 | { 51 | file: 'foo.js', 52 | line: 1, 53 | description: 'Does foo.', 54 | itemtype: 'method', 55 | name: 'foo', 56 | class: 'Bar', 57 | overloads: [ 58 | { 59 | line: 1, 60 | params: [{ name: 'bar', type: 'String' }] 61 | }, 62 | { 63 | line: 5, 64 | params: [{ name: 'baz', type: 'Number' }] 65 | } 66 | ] 67 | } 68 | ], 69 | consts: {} 70 | }); 71 | }); 72 | 73 | test('should not merge methods from different classes', function() { 74 | ensureMergeDoesNothing({ 75 | classes: { 76 | Bar: {}, 77 | Baz: {} 78 | }, 79 | classitems: [ 80 | { itemtype: 'method', class: 'Bar', name: 'foo' }, 81 | { itemtype: 'method', class: 'Baz', name: 'foo' } 82 | ], 83 | consts: {} 84 | }); 85 | }); 86 | 87 | test('should not merge properties', function() { 88 | ensureMergeDoesNothing({ 89 | classes: { 90 | Bar: {}, 91 | Baz: {} 92 | }, 93 | classitems: [ 94 | { itemtype: 'property', class: 'Bar', name: 'foo' }, 95 | { itemtype: 'property', class: 'Baz', name: 'foo' } 96 | ], 97 | consts: {} 98 | }); 99 | }); 100 | }); 101 | 102 | suite('renderDescriptionsAsMarkdown', function() { 103 | const render = preprocessor.renderDescriptionsAsMarkdown; 104 | 105 | test('should work', function() { 106 | const data = { 107 | modules: {}, 108 | classes: { 109 | Bar: {}, 110 | Baz: {} 111 | }, 112 | classitems: [ 113 | { 114 | description: 'hi `there`', 115 | params: [{ description: 'what is *up*' }] 116 | } 117 | ], 118 | consts: {} 119 | }; 120 | 121 | render(data); 122 | 123 | expect(data).to.eql({ 124 | modules: {}, 125 | classes: { 126 | Bar: {}, 127 | Baz: {} 128 | }, 129 | classitems: [ 130 | { 131 | description: 'hi there
what is up
\n' }] 133 | } 134 | ], 135 | consts: {} 136 | }); 137 | }); 138 | }); 139 | }); 140 | -------------------------------------------------------------------------------- /test/js/p5_helpers.js: -------------------------------------------------------------------------------- 1 | /* eslint no-unused-vars: 0 */ 2 | 3 | function promisedSketch(sketch_fn) { 4 | var myInstance; 5 | var promise = new Promise(function(resolve, reject) { 6 | myInstance = new p5sound(function(sketch) { 7 | return sketch_fn(sketch, resolve, reject); 8 | }); 9 | }); 10 | 11 | promise.catch(function() {}).then(function() { 12 | myInstance.remove(); 13 | }); 14 | return promise; 15 | } 16 | 17 | function testSketchWithPromise(name, sketch_fn) { 18 | var test_fn = function() { 19 | return promisedSketch(sketch_fn); 20 | }; 21 | test_fn.toString = function() { 22 | return sketch_fn.toString(); 23 | }; 24 | return test(name, test_fn); 25 | } 26 | 27 | function testWithDownload(name, fn, asyncFn = false) { 28 | var test_fn = function(done) { 29 | // description of this is also on 30 | // https://github.com/processing/p5sound.js/pull/4418/ 31 | 32 | let blobContainer = {}; 33 | 34 | // create a backup of createObjectURL 35 | let couBackup = window.URL.createObjectURL; 36 | 37 | // file-saver uses createObjectURL as an intermediate step. If we 38 | // modify the definition a just a little bit we can capture whenever 39 | // it is called and also peek in the data that was passed to it 40 | window.URL.createObjectURL = blob => { 41 | blobContainer.blob = blob; 42 | return couBackup(blob); 43 | }; 44 | 45 | let error; 46 | if (asyncFn) { 47 | fn(blobContainer) 48 | .then(() => { 49 | window.URL.createObjectURL = couBackup; 50 | }) 51 | .catch(err => { 52 | error = err; 53 | }) 54 | .finally(() => { 55 | // restore createObjectURL to the original one 56 | window.URL.createObjectURL = couBackup; 57 | error ? done(error) : done(); 58 | }); 59 | } else { 60 | try { 61 | fn(blobContainer); 62 | } catch (err) { 63 | error = err; 64 | } 65 | // restore createObjectURL to the original one 66 | window.URL.createObjectURL = couBackup; 67 | error ? done(error) : done(); 68 | } 69 | }; 70 | 71 | return test(name, test_fn); 72 | } 73 | 74 | // Tests should run only for the unminified script 75 | function testUnMinified(name, test_fn) { 76 | return !window.IS_TESTING_MINIFIED_VERSION ? test(name, test_fn) : null; 77 | } 78 | 79 | function parallelSketches(sketch_fns) { 80 | var setupPromises = []; 81 | var resultPromises = []; 82 | var endCallbacks = []; 83 | for (let i = 0; i < sketch_fns.length; i++) { 84 | setupPromises[i] = new Promise(function(resolve) { 85 | resultPromises[i] = promisedSketch(function(sketch, _resolve, _reject) { 86 | sketch_fns[i](sketch, _resolve, _reject); 87 | var old_setup = sketch.setup; 88 | sketch.setup = function() { 89 | if (old_setup) { 90 | old_setup(); 91 | } 92 | resolve(); 93 | }; 94 | endCallbacks[i] = sketch.finish; 95 | }); 96 | }); 97 | } 98 | 99 | function end() { 100 | for (var callback of endCallbacks) { 101 | if (callback) { 102 | callback(); 103 | } 104 | } 105 | } 106 | 107 | return { 108 | end: end, 109 | setup: Promise.all(setupPromises), 110 | result: Promise.all(resultPromises) 111 | }; 112 | } 113 | 114 | var P5_SCRIPT_URL = '../../lib/p5sound.js'; 115 | var P5_SCRIPT_TAG = ''; 116 | 117 | function createP5Iframe(html) { 118 | html = html || P5_SCRIPT_TAG; 119 | 120 | var elt = document.createElement('iframe'); 121 | 122 | document.body.appendChild(elt); 123 | elt.style.visibility = 'hidden'; 124 | 125 | elt.contentDocument.open(); 126 | elt.contentDocument.write(html); 127 | elt.contentDocument.close(); 128 | 129 | return { 130 | elt: elt, 131 | teardown: function() { 132 | elt.parentNode.removeChild(elt); 133 | } 134 | }; 135 | } 136 | -------------------------------------------------------------------------------- /tasks/build/browserify.js: -------------------------------------------------------------------------------- 1 | // This file holds the "browersify" task which compiles the individual src/ code into p5sound.js and p5.sound.min.js. 2 | 3 | 'use strict'; 4 | 5 | import { resolve } from 'path'; 6 | import browserify from 'browserify'; 7 | import derequire from 'derequire'; 8 | 9 | const bannerTemplate = 10 | '/*! p5.sound.js v<%= pkg.version %> <%= grunt.template.today("mmmm dd, yyyy") %> */'; 11 | 12 | module.exports = function(grunt) { 13 | const srcFilePath = require.resolve('../../src/app.js'); 14 | 15 | grunt.registerTask( 16 | 'browserify', 17 | 'Compile the p5.sound.js source with Browserify', 18 | function(param) { 19 | const isMin = param === 'min'; 20 | const isTest = param === 'test'; 21 | const isDev = param === 'dev'; 22 | 23 | const filename = isMin 24 | ? 'p5.sound.pre-min.js' 25 | : isTest ? 'p5.sound-test.js' : 'p5.sound.js'; 26 | 27 | // This file will not exist until it has been built 28 | const libFilePath = resolve('lib/' + filename); 29 | 30 | // Reading and writing files is asynchronous 31 | const done = this.async(); 32 | 33 | // Render the banner for the top of the file 34 | const banner = grunt.template.process(bannerTemplate); 35 | 36 | let globalVars = {}; 37 | if (isDev) { 38 | globalVars['P5_DEV_BUILD'] = () => true; 39 | } 40 | // Invoke Browserify programatically to bundle the code 41 | let browserified = browserify(srcFilePath, { 42 | standalone: 'p5sound', 43 | insertGlobalVars: globalVars 44 | }); 45 | 46 | if (isMin) { 47 | // These paths should be the exact same as what are used in the import 48 | // statements in the source. They are not relative to this file. It's 49 | // just how browserify works apparently. 50 | browserified = browserified 51 | .exclude('../../docs/reference/data.json') 52 | .exclude('../../../docs/parameterData.json') 53 | .exclude('../../translations') 54 | .exclude('./browser_errors'); 55 | } 56 | 57 | if (!isDev) { 58 | browserified = browserified.exclude('../../translations/dev'); 59 | } 60 | 61 | const babelifyOpts = { 62 | global: true 63 | }; 64 | 65 | if (isTest) { 66 | babelifyOpts.envName = 'test'; 67 | } 68 | 69 | const bundle = browserified 70 | .transform('brfs-babel') 71 | .transform('babelify', babelifyOpts) 72 | .bundle(); 73 | 74 | // Start the generated output with the banner comment, 75 | let code = banner + '\n'; 76 | 77 | // Then read the bundle into memory so we can run it through derequire 78 | bundle 79 | .on('data', function(data) { 80 | code += data; 81 | }) 82 | .on('end', function() { 83 | code = code.replace( 84 | "'VERSION_CONST_WILL_BE_REPLACED_BY_BROWSERIFY_BUILD_PROCESS'", 85 | grunt.template.process("'<%= pkg.version %>'") 86 | ); 87 | 88 | // "code" is complete: create the distributable UMD build by running 89 | // the bundle through derequire 90 | // (Derequire changes the bundle's internal "require" function to 91 | // something that will not interfere with this module being used 92 | // within a separate browserify bundle.) 93 | code = derequire(code); 94 | 95 | // and prettify the code 96 | if (!isMin) { 97 | const prettyFast = require('pretty-fast'); 98 | code = prettyFast(code, { 99 | url: '(anonymous)', 100 | indent: ' ' 101 | }).code; 102 | } 103 | 104 | // finally, write it to disk 105 | grunt.file.write(libFilePath, code); 106 | 107 | // Print a success message 108 | grunt.log.writeln( 109 | '>>'.green + ' Bundle ' + ('lib/' + filename).cyan + ' created.' 110 | ); 111 | 112 | // Complete the task 113 | done(); 114 | }); 115 | } 116 | ); 117 | }; 118 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "p5sound", 3 | "repository": "processing/p5.sound.js", 4 | "scripts": { 5 | "build": "grunt build", 6 | "dev": "grunt yui browserify:dev connect:yui watch:quick", 7 | "docs": "grunt yui", 8 | "docs:dev": "grunt yui:dev", 9 | "test-grunt": "grunt", 10 | "test": "mocha --ui tdd ./test/unit/sound/*.js", 11 | "lint": "grunt lint", 12 | "lint:source": "grunt lint:source", 13 | "lint:samples": "grunt lint:samples", 14 | "lint:fix": "grunt lint-fix", 15 | "release": "grunt release-p5sound", 16 | "prepublishOnly": "grunt prerelease" 17 | }, 18 | "lint-staged": { 19 | "ignore": [ 20 | "test/js/**/*.js" 21 | ], 22 | "Gruntfile.js": "eslint", 23 | "docs/preprocessor.js": "eslint", 24 | "utils/**/*.js": "eslint", 25 | "tasks/**/*.js": "eslint", 26 | "test/**/*.js": "eslint", 27 | "src/**/*.js": [ 28 | "eslint", 29 | "node --require @babel/register ./utils/sample-linter.js" 30 | ] 31 | }, 32 | "version": "0.0.6-alpha", 33 | "devDependencies": { 34 | "@babel/core": "^7.7.7", 35 | "@babel/preset-env": "^7.10.2", 36 | "@babel/register": "^7.7.7", 37 | "all-contributors-cli": "^6.19.0", 38 | "babel-plugin-i18next-extract": "^0.5.0", 39 | "babel-plugin-istanbul": "^5.2.0", 40 | "babel-plugin-preval": "^3.0.1", 41 | "babelify": "^10.0.0", 42 | "brfs-babel": "^2.0.0", 43 | "browserify": "^16.5.0", 44 | "chai": "^3.5.0", 45 | "connect-modrewrite": "^0.10.1", 46 | "core-js": "^3.6.5", 47 | "derequire": "^2.0.0", 48 | "es6-promise": "^4.2.8", 49 | "eslint": "^8.23.1", 50 | "fetch-jsonp": "^1.1.3", 51 | "file-saver": "^1.3.8", 52 | "gifenc": "^1.0.3", 53 | "grunt": "^1.6.1", 54 | "grunt-cli": "^1.4.3", 55 | "grunt-contrib-clean": "^2.0.1", 56 | "grunt-contrib-compress": "^2.0.0", 57 | "grunt-contrib-connect": "^3.0.0", 58 | "grunt-contrib-copy": "^1.0.0", 59 | "grunt-contrib-uglify": "^5.2.2", 60 | "grunt-contrib-watch": "^1.1.0", 61 | "grunt-contrib-yuidoc": "1.0.0", 62 | "grunt-eslint": "^24.0.0", 63 | "grunt-minjson": "^0.4.0", 64 | "grunt-mocha-test": "^0.13.3", 65 | "grunt-newer": "^1.3.0", 66 | "grunt-simple-nyc": "^3.0.1", 67 | "html-entities": "^1.3.1", 68 | "husky": "^4.2.3", 69 | "libtess": "^1.2.2", 70 | "lint-staged": "^4.3.0", 71 | "marked": "^4.0.10", 72 | "mocha": "^10.2.0", 73 | "np": "^7.6.2", 74 | "open": "^7.0.3", 75 | "opentype.js": "^0.9.0", 76 | "pretty-fast": "^0.2.7", 77 | "promise-map-series": "^0.2.3", 78 | "puppeteer": "^18.2.1", 79 | "raw-loader": "^4.0.2", 80 | "regenerator-runtime": "^0.13.3", 81 | "simple-git": "^3.16.1", 82 | "whatwg-fetch": "^2.0.4" 83 | }, 84 | "license": "LGPL-2.1", 85 | "main": "./lib/p5.sound.min.js", 86 | "files": [ 87 | "license.txt", 88 | "lib/p5.sound.min.js", 89 | "lib/p5.sound.js", 90 | "translations/**" 91 | ], 92 | "description": "[](https://www.npmjs.com/package/p5)", 93 | "bugs": { 94 | "url": "https://github.com/processing/p5.sound.js/issues" 95 | }, 96 | "homepage": "https://github.com/processing/p5.sound.js#readme", 97 | "directories": { 98 | "doc": "docs", 99 | "test": "test" 100 | }, 101 | "babel": { 102 | "presets": [ 103 | [ 104 | "@babel/preset-env", 105 | { 106 | "useBuiltIns": "usage", 107 | "corejs": 3 108 | } 109 | ] 110 | ], 111 | "env": { 112 | "test": { 113 | "plugins": [ 114 | [ 115 | "istanbul", 116 | { 117 | "include": [ 118 | "src/**/*.js" 119 | ] 120 | } 121 | ] 122 | ] 123 | } 124 | } 125 | }, 126 | "browserslist": [ 127 | "last 2 versions", 128 | "not dead" 129 | ], 130 | "author": "", 131 | "husky": { 132 | "hooks": { 133 | "pre-commit": "lint-staged" 134 | } 135 | }, 136 | "dependencies": { 137 | "tone": "^0.12.80" 138 | } 139 | } 140 | -------------------------------------------------------------------------------- /tasks/build/combineModules.js: -------------------------------------------------------------------------------- 1 | // This file contains the "combineModules" task called during the build process. 2 | 3 | 'use strict'; 4 | 5 | const fs = require('fs'); 6 | const path = require('path'); 7 | const browserify = require('browserify'); 8 | const derequire = require('derequire'); 9 | 10 | module.exports = function(grunt) { 11 | const tempFilePath = path.resolve('./src/customApp.js'); 12 | grunt.registerTask( 13 | 'combineModules', 14 | 'Compile and combine certain modules with Browserify', 15 | function(args) { 16 | // Reading and writing files is asynchronous 17 | const done = this.async(); 18 | 19 | // Modules is an array of p5sound modules to be bundled. 20 | const modules = ['core']; 21 | for (const arg of arguments) { 22 | if (arg !== 'min') { 23 | modules.push(arg); 24 | } 25 | } 26 | const modulesList = modules.join(', '); 27 | 28 | // Render the banner for the top of the file. Includes the Module name. 29 | const bannerTemplate = `/*! Custom p5sound.js v<%= pkg.version %> <%= grunt.template.today("mmmm dd, yyyy") %> 30 | Contains the following modules : ${modulesList}*/`; 31 | const banner = grunt.template.process(bannerTemplate); 32 | 33 | // Make a list of sources from app.js which match our criteria 34 | const dump = fs.readFileSync('./src/app.js', 'utf8').split('\n'); 35 | const sources = []; 36 | const regexp = new RegExp('./(' + modules.join('/|') + ')', 'g'); 37 | dump.forEach(source => { 38 | let match; 39 | while ((match = regexp.exec(source)) !== null) { 40 | sources.push(match.input); 41 | } 42 | }); 43 | sources.push('module.exports = p5sound;'); 44 | 45 | // Create a temp file with this data and feed it to browserify 46 | fs.writeFileSync(tempFilePath, sources.join('\n'), 'utf8'); 47 | 48 | // Check whether combineModules is minified 49 | const isMin = args === 'min'; 50 | const filename = isMin ? 'p5Custom.pre-min.js' : 'p5Custom.js'; 51 | 52 | // Target file path 53 | const libFilePath = path.resolve('lib/modules/' + filename); 54 | 55 | // Invoke Browserify programatically to bundle the code 56 | let browseified = browserify(tempFilePath, { 57 | standalone: 'p5sound' 58 | }); 59 | 60 | if (isMin) { 61 | browseified = browseified 62 | .exclude('../../docs/reference/data.json') 63 | .exclude('../../docs/parameterData.json'); 64 | } 65 | 66 | const babelifyOpts = { plugins: ['static-fs'] }; 67 | 68 | const bundle = browseified.transform('babelify', babelifyOpts).bundle(); 69 | 70 | // Start the generated output with the banner comment, 71 | let code = banner + '\n'; 72 | 73 | // Then read the bundle into memory so we can run it through derequire 74 | bundle 75 | .on('data', function(data) { 76 | code += data; 77 | }) 78 | .on('end', function() { 79 | // "code" is complete: create the distributable UMD build by running 80 | // the bundle through derequire 81 | // (Derequire changes the bundle's internal "require" function to 82 | // something that will not interfere with this module being used 83 | // within a separate browserify bundle.) 84 | code = derequire(code); 85 | 86 | // and prettify the code 87 | if (!isMin) { 88 | const prettyFast = require('pretty-fast'); 89 | code = prettyFast(code, { 90 | url: '(anonymous)', 91 | indent: ' ' 92 | }).code; 93 | } 94 | 95 | // finally, write it to disk and remove the temp file 96 | grunt.file.write(libFilePath, code); 97 | grunt.file.delete(tempFilePath); 98 | 99 | // Print a success message 100 | grunt.log.writeln( 101 | '>>'.green + ' Module ' + libFilePath.blue + ' created.' 102 | ); 103 | 104 | // Complete the task 105 | done(); 106 | }); 107 | } 108 | ); 109 | }; 110 | -------------------------------------------------------------------------------- /src/audioWorklet/amplitudeProcessor.js: -------------------------------------------------------------------------------- 1 | // import dependencies via preval.require so that they're available as values at compile time 2 | const processorNames = preval.require('./processorNames'); 3 | const RingBuffer = preval.require('./ringBuffer').default; 4 | 5 | class AmplitudeProcessor extends AudioWorkletProcessor { 6 | constructor(options) { 7 | super(); 8 | 9 | const processorOptions = options.processorOptions || {}; 10 | this.numOutputChannels = options.outputChannelCount || 1; 11 | this.numInputChannels = processorOptions.numInputChannels || 2; 12 | this.normalize = processorOptions.normalize || false; 13 | this.smoothing = processorOptions.smoothing || 0; 14 | 15 | this.bufferSize = processorOptions.bufferSize || 2048; 16 | this.inputRingBuffer = new RingBuffer( 17 | this.bufferSize, 18 | this.numInputChannels 19 | ); 20 | this.outputRingBuffer = new RingBuffer( 21 | this.bufferSize, 22 | this.numOutputChannels 23 | ); 24 | this.inputRingBufferArraySequence = new Array(this.numInputChannels) 25 | .fill(null) 26 | .map(() => new Float32Array(this.bufferSize)); 27 | 28 | this.stereoVol = [0, 0]; 29 | this.stereoVolNorm = [0, 0]; 30 | 31 | this.volMax = 0.001; 32 | 33 | this.port.onmessage = event => { 34 | const data = event.data; 35 | if (data.name === 'toggleNormalize') { 36 | this.normalize = data.normalize; 37 | } else if (data.name === 'smoothing') { 38 | this.smoothing = Math.max(0, Math.min(1, data.smoothing)); 39 | } 40 | }; 41 | } 42 | 43 | // TO DO make this stereo / dependent on # of audio channels 44 | process(inputs, outputs) { 45 | const input = inputs[0]; 46 | const output = outputs[0]; 47 | const smoothing = this.smoothing; 48 | 49 | this.inputRingBuffer.push(input); 50 | 51 | if (this.inputRingBuffer.framesAvailable >= this.bufferSize) { 52 | this.inputRingBuffer.pull(this.inputRingBufferArraySequence); 53 | 54 | for (let channel = 0; channel < this.numInputChannels; ++channel) { 55 | const inputBuffer = this.inputRingBufferArraySequence[channel]; 56 | const bufLength = inputBuffer.length; 57 | 58 | let sum = 0; 59 | for (let i = 0; i < bufLength; i++) { 60 | const x = inputBuffer[i]; 61 | if (this.normalize) { 62 | sum += 63 | Math.max(Math.min(x / this.volMax, 1), -1) * 64 | Math.max(Math.min(x / this.volMax, 1), -1); 65 | } else { 66 | sum += x * x; 67 | } 68 | } 69 | 70 | // ... then take the square root of the sum. 71 | const rms = Math.sqrt(sum / bufLength); 72 | 73 | this.stereoVol[channel] = Math.max( 74 | rms, 75 | this.stereoVol[channel] * smoothing 76 | ); 77 | this.volMax = Math.max(this.stereoVol[channel], this.volMax); 78 | } 79 | 80 | // calculate stero normalized volume and add volume from all channels together 81 | let volSum = 0; 82 | for (let index = 0; index < this.stereoVol.length; index++) { 83 | this.stereoVolNorm[index] = Math.max( 84 | Math.min(this.stereoVol[index] / this.volMax, 1), 85 | 0 86 | ); 87 | volSum += this.stereoVol[index]; 88 | } 89 | 90 | // volume is average of channels 91 | const volume = volSum / this.stereoVol.length; 92 | 93 | // normalized value 94 | const volNorm = Math.max(Math.min(volume / this.volMax, 1), 0); 95 | 96 | this.port.postMessage({ 97 | name: 'amplitude', 98 | volume: volume, 99 | volNorm: volNorm, 100 | stereoVol: this.stereoVol, 101 | stereoVolNorm: this.stereoVolNorm 102 | }); 103 | 104 | // pass input through to output 105 | this.outputRingBuffer.push(this.inputRingBufferArraySequence); 106 | } 107 | 108 | // pull 128 frames out of the ring buffer 109 | // if the ring buffer does not have enough frames, the output will be silent 110 | this.outputRingBuffer.pull(output); 111 | 112 | return true; 113 | } 114 | } 115 | 116 | registerProcessor(processorNames.amplitudeProcessor, AmplitudeProcessor); 117 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # p5.sound.js 2 | 3 | This repository was started during the 2023 p5.js sound fellowship. Please read the [announcement](https://medium.com/@ProcessingOrg/announcing-the-2023-p5-sound-fellow-aar%C3%B3n-montoya-moraga-7613450902f6) for more details. 4 | 5 | This repository will soon replace the previous version of the p5.sound library, which is currently hosted at [https://github.com/processing/p5.js-sound](https://github.com/processing/p5.js-sound). 6 | 7 | p5.sound Fellow 2023: aarón montoya-moraga(@[montoyamoraga](https://github.com/montoyamoraga)), 8 | p5.Sound Fellow Mentor 2023: Kristin Galvin (@[blechdom](https://github.com/blechdom)) 9 | 10 | ## Scope of the project 11 | 12 | This project is an update of the p5.sound.js library, with the following goals: 13 | 14 | - Code stability and readability 15 | - Updated and fewer dependencies 16 | - Only keeping the most used features 17 | - Deprecating the least used features 18 | 19 | ## Usage 20 | 21 | To use this library, make sure you have p5.js installed. Visit the [p5.js website](https://p5js.org/) for more information and installation instructions. 22 | 23 | Please let us know if you find any bugs or issues! 24 | 25 | ## Comparison with the previous version of the library 26 | 27 | ### Base classes 28 | 29 | | Name | Previous name | Dependencies | Tone.js dependencies | 30 | | :----------- | :------------ | :----------- | :------------------- | 31 | | audioContext | - | none | none | 32 | 33 | ### Oscillators 34 | 35 | | Name | Previous name | Dependencies | Tone.js dependencies | 36 | | :--------- | :------------ | :----------- | :------------------- | 37 | | Oscillator | - | audioContext | Add, Multiply, Scale | 38 | | SinOsc | - | Oscillator | | 39 | | TriOsc | - | Oscillator | | 40 | | SawOsc | - | Oscillator | | 41 | | Noise | - | Oscillator | | 42 | 43 | ### Effects 44 | 45 | | Name of class | Previous name | Dependencies | Tone.js dependencies | 46 | | :------------ | :------------ | :----------- | :------------------- | 47 | | BiquadFilter | Filter | Effect | TODO | 48 | | Delay | - | Effect | TODO | 49 | 50 | ### Utilities 51 | 52 | | Name of class | Previous name | Dependencies | Tone.js dependencies | 53 | | :------------ | :------------ | :----------- | :------------------- | 54 | | AnalyzerFFT | FFT | audioContext | none | 55 | | Gain | FFT | audioContext | none | 56 | | Envelope | FFT | audioContext | none | 57 | 58 | ### Currently broken / in progress 59 | 60 | | Name of class | Previous name | Dependencies | Tone.js dependencies | 61 | | :------------ | :------------ | :------------ | :------------------- | 62 | | AudioIn | - | audioWorklet/ | TODO | 63 | | SoundFile | - | audioWorklet/ | TODO | 64 | 65 | ## Deprecations 66 | 67 | | Name of class | Reason of deprecation | 68 | | :------------- | :--------------------------------------------------------- | 69 | | Convolver | Efforts focused on simpler effects | 70 | | MonoSynth | Efforts focused on developing dependencies like Oscillator | 71 | | Polysynth | Built on top of MonoSynth, already deprecate | 72 | | Part | Musical class, and out of scope for p5.sound | 73 | | Phrase | Musical class, and out of scope for p5.sound | 74 | | Score | Musical class, and out of scope for p5.sound | 75 | | SoundLoop | Efforts focused on developing dependency SoundFile | 76 | | userStartAudio | Bad practice | 77 | 78 | ## Dependencies 79 | 80 | After a fruitful discussion with the Tone.js team, we are keeping Tone.js as a dependency and updating this to the latest version 14.x.x. 81 | 82 | ## Build instructions 83 | 84 | To install the dependencies for building, please run this command. 85 | 86 | ```bash 87 | npm install 88 | ``` 89 | 90 | To build the library, please run this command. 91 | 92 | ```bash 93 | npm run build 94 | ``` 95 | --------------------------------------------------------------------------------