Repository files navigation

p5.sound.js extends the musical and sonic capabilities ofp5.js. It is designed to be a minimal abstraction of theTone.js library with a feature set that is inspired by p5.js's approach to accessible and poetic creative coding. Key functionalities include audio input, sound file playback and manipulation, effects, synthesis and analysis.

• p5.sound example on p5.js editorhere
• Legacy p5.js Sound Tutorial by Dan Shiffman onYouTube

Interactive documentation can be found atp5js.org/reference/p5.sound

• Visithttp://p5js.org/download/ for the latest official release of p5.js with the latest p5.sound included.
• The p5.sound.js libraryhere is updated more frequently, and we occasionally offer newreleases before the release cycle of p5.js.

If you would like to contribute to this project, visithttps://github.com/processing/p5.js/tree/main/contributor_docs to get started.

If you have any questions or concerns regarding the project, you can reach out to ourDiscord andGitter communities. The p5.js team closely monitors all pull requests and issues on GitHub, so there's no need to also post them on Discord. Additionally, conversations about specific pull requests and issues should take place on GitHub, to ensure that people following along can see and take part in the discussion.

p5.sound is built usingTone.js, an interactive music framework developed byYotam Mann.

This repository is an update of theoriginal p5.sound library (initially authored byJason Sigal) made with the following goals in mind:

• Code stability and readability
• Updated and fewer dependencies
• Deprecating the least used features
• Greater consistency between classes and methods

The project was started by aarón montoya-moraga (montoyamoraga) during the 2023 p5.js sound fellowship (read theannouncement for more details) and was completed byTommy Martinez in September, 2024.

A changeleog of new and deprecated features in the new library can be viewed (here)

Core contributors:

• Tommy Martinez (ogbabydiesal)
• aarón montoya-moraga (montoyamoraga)

Project mentors and advisors:

• Kristin Galvin (blechdom)
• Kenneth Lim (limzykenneth)
• Rachel Lim (raclim)
• Yotam Mann (tambien)
• Dave Pagurek (davepagurek)
• Luisa Peirera (luisaph)
• Jason Sigal (therewasaguy)
• Cassie Tarakajian (catarak)
• Qianqian Ye (Qianqianye)

To use this library, make sure you have p5.js installed. Visit thep5.js website for more information and installation instructions.

Please let us know if you find any bugs or issues by creating a new issue in this repo!

installing the dependencies

npm install

building the library

npm run build

building reference pages (optional)

npx yuidoc .