WebPd是一个用于Pure Data音频编程语言的编译器,允许在网页中运行**.pd**补丁。
WebPd高度模块化,采用白盒方法进行音频编程。它将补丁中的音频图和处理对象转换为纯人类可读的JavaScript或AssemblyScript (*)。生成的纯音频代码随后可以直接集成到任何web应用中,无需再使用WebPd或Pure Data 🌈。
() AssemblyScript是一种类似TypeScript的语言,可编译为WebAssembly。*
使用案例示例
- 在网络上发布生成式音乐作品
- 在任何机器上集体执行、调整和分享补丁
- 从基于网络的应用程序和游戏中实时生成、过滤和回放声音和音乐数据
集成和范围
有很多优秀的JavaScript库可用于构建交互式视觉界面,如Three.js、p5.js、传统的JavaScript / HTML / CSS等。将它们与WebPd补丁集成应该相当容易。这种集成的一个例子是补丁播放器演示,可通过网页编译器获得。
WebPd本身不是像Pure Data那样的完整编辑器和现场表演平台。Pure Data图形界面以及GEM都不在WebPd的范围内。WebPd也不是像libpd那样的简单执行器。它更像是一个精简的音频编译器,可生成高性能、人类可读且易于集成的音频代码,没有冗余。
使用方法
网页编译器和播放器
网页编译器和补丁播放器在线地址:https://sebpiq.github.io/WebPd_website
只需上传或提供补丁的URL(),即时编译并生成一个界面,允许在浏览器中实时播放该补丁。编译成功后,您可以复制并与他人分享播放器生成的URL(**)。这个URL包含了您播放时修改的所有补丁参数,因此可以完全按照当前*状态进行分享。
() 您可以使用在网上找到的任何公开补丁URL(如GitHub、Pure Data论坛等)。*
(**) 如果您使用本地文件进行编译,则无法分享编译后的补丁。
命令行界面
注意:运行CLI需要node.js 18或更高版本。
命令行界面(CLI)提供更多自定义选项,包括生成一个功能完整(但基础)的网页来嵌入您的补丁。
打开终端,使用node / npm安装CLI,运行以下命令:
npm install -g webpd
通过运行以下命令验证安装是否成功:
webpd --help
这应该会输出CLI的帮助信息,希望能帮助您开始使用。
编写WebPd兼容补丁的建议
- 确保只使用支持的功能。
- 始终使用
[trigger]
对象使消息发送顺序明确(包括使用[loadbang]
进行初始化和加载音频文件时)。事实上,由于不同的限制,Pd和WebPd的消息排序可能不同。 - 使用[samplerate~]对象而不是硬编码固定值的采样率。
获取帮助
如果您感到困惑,有很多地方可以寻求帮助。我特别推荐discord服务器,您可以在那里快速获得帮助并得到社区的支持。
如果您认为可能遇到了bug,请按照这些简单的指南报告。
您正在使用WebPd?
太好了🌱!听到有人在使用它对我的动力帮助很大。不要犹豫,可以在twitter上通知我@sebpiq,或者直接给我发电子邮件。
如果您有能力,也可以捐赠以帮助推进开发。
开发
状态和路线图
WebPd目前正在大力开发中,但仍在进行中。已实现的对象、功能和路线图在这里。
该项目目前处于alpha发布状态,这意味着许多补丁可能无法直接使用。确实还有许多对象和功能缺失。如果您认为有bug,请按照这些简单的指南报告。如果您觉得可以开发WebPd中缺少的对象来播放特定补丁,请参阅贡献。
报告bug
如果您想报告bug:
- 首先缩小范围。移除补丁中与bug无关的所有对象。尝试找到可以重现此bug的最简单补丁。
- 然后在github上使用以下模板提交bug报告:
补丁和描述 -> 上传您的最小补丁
当前行为 -> 简要描述目前的工作方式
预期行为 -> 简要描述应该如何工作
贡献
非常欢迎一次性贡献或定期参与库的工作!贡献指南即将推出,同时如果您有时间并真的想参与其中,请在GitHub的问题追踪器上联系我。我很乐意帮助您开始贡献。
如果您想尝试开发新对象,以下是一些很好的起点示例:
如果您想深入了解代码,WebPd除了这个包含所有内容的主包外,还由几个子包构建而成:
- Pd文件解析器:https://github.com/sebpiq/WebPd_pd-parser
- WebPd编译器:https://github.com/sebpiq/WebPd_compiler
- WebPd运行时:https://github.com/sebpiq/WebPd_runtime
许可证
WebPd是自由软件:您可以根据自由软件基金会发布的GNU Lesser General Public License版本3的条款重新分发和/或修改它。
WebPd的分发希望能够有所帮助,但不提供任何保证;甚至不提供对适销性或特定用途适用性的暗示保证。有关更多详细信息,请参阅GNU Lesser General Public License或阅读COPYING.LESSER文件。
作者
- Sébastien Piquemal sebpiq@protonmail.com
- Chris McCormick
- Brandon James
- mgsx-dev
- Atul Varma
- Ulric Wilfred
- Paul Money
致谢和赞助商
本项目得到了DAFNE+欧洲研究项目的赞助,该项目由欧盟"地平线欧洲"计划资助(拨款协议101061548),以及IRCAM在2022年12月至2023年3月期间WAM团队的支持。