@soundworks/core

soundworks

Open-source creative coding framework for distributed applications based on Web technologies.

Primarily focused on music, soundworks aims at supporting rapid development of real-time distributed applications using JavaScript. It provides abstractions to hide the complexity of the network and to foster very rapid-prototyping and trial-and-error workflows that are typical in artistic practices.

WARNING: The version 4 of @soundworks/core is under heavy development.

Getting Started

The best and most simple way to start using soundworks is to use the @soundworks/create wizard.

npx @soundworks/create@latest

See https://soundworks.dev/tutorials/getting-started.html for more informations on the wizard and how to start with soundworks.

API

The API is not publicly published for now. To access the API documentation locally, just clone this repository, go to the v4 branch and launch some http server in the docs directory. For example, using the serve package:

git clone https://github.com/collective-soundworks/soundworks.git
cd soundworks
git checkout v4
serve docs

Feel welcome to open an issue or a PR if you find any inconsistency, error or missing information in the documentation.

Share with Us

If you made an application using soundworks please let us know here: https://github.com/collective-soundworks/soundworks/discussions/61

TypeScript Support

Basic TypeScript support will be proposed in a (hopefully) near future.

However, for maintenance reasons, we aim at following the TC39 and W3C specifications as close as possible. Therefore, we will wait for the https://github.com/tc39/proposal-type-annotations proposal to reach stage 3 to update the source code in a more integrated manner.

Install

Note that the @soundworks/core package is automatically installed when creating an application using the @soundworks/create wizard, so most of the time you should not have to install this package manually. See https://soundworks.dev/guides/getting-started.html for more informations on the soundworks wizard.

npm install @soundworks/core

Credits

soundworks has been initiated by Norbert Schnell, Sébastien Robaszkiewicz, and Benjamin Matuszewski at the ISMM team at Ircam - Centre Pompidou in the context of the CoSiMa research project founded by the French National Research Agency (ANR).

Development is now led by Benjamin Matuszewski, in the Sound Music Movement Interaction Team from the Ircam's STMS-LAB.

Supporting Research Projects

Initial and futher developments has been supported by the following research projects:

• The DOTS project, funded by the French National Research Agency (ANR)
• The Ircam projects BeCoMe and SO(a)P
• The Constella(c)tions residency, funded by the STARTS program of the European Commission
• The RAPID-MIX project, funded by the European Union’s Horizon 2020 research and innovation program
• The CoSiMa project, funded by the French National Research Agency (ANR)

Academic Papers

• Benjamin Matuszewski. A Web-Based Framework for Distributed Music System Research and Creation. AES - Journal of the Audio Engineering Society Audio-Accoustics-Application, Audio Engineering Society Inc, 2020. <hal-03033143>
• Benjamin Matuszewski. Soundworks - A Framework for Networked Music Systems on the Web - State of Affairs and New Developments. Proceedings of the Web Audio Conference (WAC) 2019, Dec 2019, Trondheim, Norway. <hal-02387783>
• Benjamin Matuszewski, Norbert Schnell, Frédéric Bevilacqua. Interaction Topologies in Mobile-Based Situated Networked Music Systems. Wireless Communications and Mobile Computing, Hindawi Publishing Corporation, 2019, 2019, pp.9142490. ⟨10.1155/2019/9142490⟩. <hal-02086673>
• Norbert Schnell, Sébastien Robaszkiewicz. Soundworks – A playground for artists and developers to create collaborative mobile web performances. `Proceedings of the Web Audio Conference (WAC'15), 2015, Paris, France. <hal-01580797>

License

BSD-3-Clause