usfx 0.1.4

Realtime procedurally generated sound effects
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

<h1 align="center">μsfx</h1>
	
<p align="center">
	<a href="https://github.com/tversteeg/usfx/actions"><img src="https://github.com/tversteeg/usfx/workflows/CI/badge.svg" alt="CI"/></a>
	<a href="https://crates.io/crates/usfx"><img src="https://img.shields.io/crates/v/usfx.svg" alt="Version"/></a>
	<a href="https://docs.rs/usfx"><img src="https://img.shields.io/badge/api-rustdoc-blue.svg" alt="Rust Documentation"/></a>
	<img src="https://img.shields.io/crates/l/usfx.svg" alt="License"/>
	<br/>
</p>

<!-- cargo-rdme start -->

Generate sound effects for your game in realtime.

## Example

```rust
// Create a simple blip sound
let mut sample = usfx::Sample::default();
sample.volume(0.5);

// Use a sine wave oscillator at 500 hz
sample.osc_type(usfx::OscillatorType::Sine);
sample.osc_frequency(500);

// Set the envelope
sample.env_attack(0.02);
sample.env_decay(0.05);
sample.env_sustain(0.2);
sample.env_release(0.5);

// Add some distortion
sample.dis_crunch(0.5);
sample.dis_drive(0.9);

// Create a mixer so we can play the sound
let mut mixer = usfx::Mixer::default();

// Play our sample
mixer.play(sample);

// Plug our mixer into the audio device loop
// ...
mixer.generate(&mut audio_device_buffer);
```

<!-- cargo-rdme end -->

The [`cpal`](examples/cpal.rs) & [`sdl`](examples/sdl2.rs) examples illustrate how to use it with different audio libraries. The [`music`](examples/music.rs) example shows how to create procedurally generated music with it (don't expect a masterpiece though, it's obvious I'm not a musician).

### CPAL Example

To build the [`cpal`](examples/cpal.rs) & [`music`](examples/music.rs) examples on Linux you will need to have the alsa development libraries:

```bash
sudo apt install libasound2-dev
```

### SDL Example

To build the [`sdl`](examples/sdl2.rs) you will need the SDL2 development libraries, on Linux:

```bash
sudo apt install libsdl2-dev
```

## Special Thanks

- [sfxr-rs](https://github.com/bzar/sfxr-rs) - inspiration
- [amsynth](https://github.com/amsynth/amsynth) - distortion algorithm