https://github.com/ooesili/sorceress
A Rust environment for sound synthesis and algorithmic composition.
https://github.com/ooesili/sorceress
audio crates music rust supercollider synthesizer
Last synced: about 2 months ago
JSON representation
A Rust environment for sound synthesis and algorithmic composition.
- Host: GitHub
- URL: https://github.com/ooesili/sorceress
- Owner: ooesili
- License: gpl-3.0
- Created: 2021-02-19T19:43:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-03-22T19:24:42.000Z (about 4 years ago)
- Last Synced: 2024-05-03T19:33:55.575Z (about 1 year ago)
- Topics: audio, crates, music, rust, supercollider, synthesizer
- Language: Rust
- Homepage:
- Size: 208 KB
- Stars: 110
- Watchers: 5
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: COPYING
Awesome Lists containing this project
README
# Sorceress
[](https://builtwithnix.org) [](https://ooesili.semaphoreci.com/projects/sorceress) [](https://crates.io/crates/sorceress) [](https://docs.rs/sorceress) [](https://gitter.im/sorceress-rs/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
A Rust environment for sound synthesis and algorithmic composition, powered by [SuperCollider](https://supercollider.github.io/).
## Overview
Sorceress is a Rust crate that provides a creative coding environment for:
* **Sound synthesis** - build audio synthesizers by connecting *unit generators* together into signal graphs. SuperCollider provides [hundreds of unit generators](https://doc.sccode.org/Browse.html#UGens) to choose from including things like wave generators, noise generators, filters, envelopes, compressors, resonators, physical simulations, Fourier transforms, and much more.
* **Algorithmic composition** - write code to create music, anywhere from using code as a musical notation system to full-fledged generative composition where large scale structures of a music piece are determined by computational algorithms.
### Why SuperCollider?
SuperCollider is a powerful and mature platform for audio synthesis with decades of development effort behind it. SuperCollider's [Client and Server](https://doc.sccode.org/Guides/ClientVsServer.html) architecture lets us to leverage all of the features offered by SuperCollider's audio synthesis server, from Rust:
* A real-time audio synthesis engine
* A massive library of unit generators
* Audio I/O with your operation system and sound card
### Why Rust?
There are projects in many other programming languages for interacting with SuperCollider including [Overtone](https://overtone.github.io/), [Tidal](https://tidalcycles.org/), and [Sonic Pi](https://sonic-pi.net/). I really like programming in Rust and I could not find any such project using Rust so I started building Sorceress.
## Example
This example plays a sine wave at 220 Hz for 1 second:
```rust
use sorceress::{
server::{self, Result, Server},
synthdef::{encoder::encode_synth_defs, SynthDef},
ugen,
};
use std::{thread::sleep, time::Duration};
fn main() -> Result<()> {
let server = Server::connect("127.0.0.1:57110")?;
let sine_wave = SynthDef::new("sine_wave", |_| {
ugen::Out::ar().channels(ugen::Pan2::ar().input(ugen::SinOsc::ar().freq(220)))
});
let encoded_synthdef = encode_synth_defs(vec![sine_wave]);
server.send_sync(server::SynthDefRecv::new(&encoded_synthdef))?;
server.send(server::SynthNew::new("sine_wave", 1))?;
sleep(Duration::from_secs(1));
server.reset()?;
Ok(())
}
```
## Setup
With [cargo-edit](https://github.com/killercup/cargo-edit) installed run:
```
$ cargo add sorceress
```
You must [install SuperCollider](https://supercollider.github.io/download) separately from the `sorceress` crate.
**Note:** Sorceress does not run SuperCollider for you at this time, so you must boot a server yourself. The recommended way to do this by starting the server in **scide**, SuperCollider's built in IDE.
## Documentation
The primary source of documentation for Sorceress is the [crate documentation on docs.rs](https://docs.rs/sorceress).
## Contributing
See [CONTRIBUTING](CONTRIBUTING.md) for details on creating issues or making pull requests.
## License
Sorceress is free software available under Version 3 the GNU General Public License. See [COPYING](COPYING) for details.