Files
rsgp/README.md
2025-10-12 18:25:44 +02:00

70 lines
2.2 KiB
Markdown

# poof
Audio synthesis web application for generating random sound samples. Users generate sounds via different synthesis engines, mutate parameters, apply audio processors in multiple passes, and export as WAV. Built for musicians seeking unexpected textures and one-shots.
## Technologies
- Svelte 5 + TypeScript
- Web Audio API
- Vite (rolldown-vite)
- pnpm
## Structure
```
src/
├── main.ts # Entry point
├── App.svelte # Main UI
└── lib/
├── components/ # UI components (waveform, VU meter, modals)
├── audio/
│ ├── engines/ # synthesis engines + registry
│ ├── processors/ # audio processors + registry
│ ├── services/ # AudioService (Web Audio API wrapper)
│ └── utils/ # WAVEncoder, AudioEdit
└── utils/ # Colors, keyboard, pitch, settings
public/
├── fonts/ # DepartureMono
└── wavetables/ # 1000+ AKWF wavetables
```
## Development
```sh
pnpm install
pnpm dev
pnpm build
```
## Docker
```sh
docker build -t poof .
docker run -p 8080:80 poof
```
Opens on http://localhost:8080
## Extending
### Adding Synthesis Engines
1. Create a single file in `src/lib/audio/engines/` implementing the `SynthEngine` interface
2. Implement `getName()`, `getDescription()`, `generate()`, `randomParams()`, and `mutateParams()`
3. Must return stereo output: `[Float32Array, Float32Array]`
4. Keep all DSP code, helpers, and types in the same file
5. Register in `src/lib/audio/engines/registry.ts`
### Adding Audio Processors
1. Create a single file in `src/lib/audio/processors/` implementing the `AudioProcessor` interface
2. Implement `getName()`, `getDescription()`, and `process()`
3. Must take and return stereo: `[Float32Array, Float32Array]`
4. Keep all processing logic, helpers, and types in the same file
5. Register in `src/lib/audio/processors/registry.ts`
## Credits
- Wavetables from [Adventure Kid Waveforms](https://www.adventurekid.se/akrt/waveforms/adventure-kid-waveforms/) by Kristoffer Ekstrand
- [Garten Salat](https://garten.salat.dev/) by Felix Roos for drum synthesis inspiration.