[p5.js 2.0+ Bug Report]: Wrong version of p5-sound included in complete library zip

[fadookie]

Most appropriate sub-area of p5.js?

• Accessibility
• Color
• Core/Environment/Rendering
• Data
• DOM
• Events
• Image
• IO
• Math
• Typography
• Utilities
• WebGL
• WebGPU
• p5.strands
• Build process
• Unit testing
• Internationalization
• Friendly errors
• Other (specify if possible)

p5.js version

v2.3.1

Web browser and version

Vivaldi Version: 8.1.4087.58 (Official Build) (arm64) Chromium Version: 150.0.7871.208 Channel: Official Build Platform / OS: macOS Version 26.6 (Build 25G72) Executable Path: /Applications/Vivaldi.app/Contents/MacOS/Vivaldi Command Line: /Applications/Vivaldi.app/Contents/MacOS/Vivaldi --flag-switches-begin --flag-switches-end --origin-trial-disabled-features=CanvasTextNg|WebAssemblyCustomDescriptors --disable-smooth-scrolling

Operating system

macOS 26.6

Steps to reproduce this

Steps:

1. Download the p5.js complete library from https://p5js.org/download/
2. Uncomment the line that says <script src="../addons/p5.sound.js"></script>
3. Start a webserver to serve the sketch, e.g. python3 -m http.server 8080 and navigate to the example page. With this python command it would be http://localhost:8080/empty-example/
4. Open web inspector console

Expected

Sound plays with no error

Actual

An error is logged to the console:

Uncaught TypeError: p5.prototype.registerMethod is not a function
    at Module.<anonymous> (p5.sound.js:1195:14)
    at __webpack_require__ (p5.sound.js:84:22)
    at p5.sound.js:120:10
    at p5.sound.js:122:2

Pre-constructed repro case:

p5js-sound-error-repro.zip

It seems as if the wrong version of p5 sound may be included with the current distribution of p5.js.

[AmanUllah687]

Dug into this a bit. The lib/addons/p5.sound.js file bundled in this repo (and copied verbatim into the release zip by the release workflow) is a stale build — the header says Version: 1.0.1 - 2021-05-25, and it's still calling the legacy p5.prototype.registerMethod API that was removed in the 2.x core rewrite. There's a newer p5.sound addon repo (processing/p5.sound.js) referenced in the steward guidelines that looks like it should be the source of truth here, but its build output never made it into lib/addons/ in this repo.

Happy to help fix — looks like this needs either a one-time update of lib/addons/p5.sound.js to the current build from processing/p5.sound.js, plus ideally some way to keep it in sync going forward so it doesn't drift again. Let me know if a steward can confirm the sub-area (Build process?) and give the go-ahead, and I can put a PR together.

[ksen0]

Thanks for this thorough report! As Ken notes on discord, the packaged p5.sound is the older version which does not work with p5.js 2.x. If you need sound support, you can use the latest version: https://www.jsdelivr.com/package/npm/p5.sound

The sound library should not be included in the v2 bundle at all. Additionally the website download page should provide a link to get the https://www.jsdelivr.com/package/npm/p5.sound (the latest versions of each are global vars on the website repo). The change should be on the website repo first, to mak it clear how to get the sound library; and then here in p5.js repo.

These are separate projects so I dont think it makes sense to bundle the p5.sound at all with p5.js zip

@fadookie would you like to work on this, or is it open to volunteers?

[ksen0]

Hi @AmanUllah687 thanks for your interest, and welcome to the project! Please check the notes above. If the original reported is not interested in working on this one, then it can be yours but please wait for them to confirm. If they dont respond by end of day on aug 11th, then you can claim.

[fadookie]

Thanks. I was just reporting the issue not laying claim to making the fix myself. I'm pretty busy atm, anyone who wants to should go for it 😉

[AmanUllah687]

Thanks @ksen0 — since @fadookie has confirmed they're not working on this, I'd like to claim it. I'll start with the p5.js-website repo change first (adding the jsDelivr link/instructions to the download page) per your note, then follow up with the p5.js repo change to remove the bundled p5.sound.js from the release/zip.

[AmanUllah687]

Opened processing/p5.js-website#1560 to add the p5.sound CDN link to the
download page. Once that's reviewed and merged, I'll follow up with the
p5.js repo change to remove the stale bundled p5.sound files from the
release zip.