rs_audio/lib.rs
1//! * rs-audio is a Rust library for making retro music programmatically.<br>
2//! Currently, it has support for: <br>Sine waves,<br>Squares,<br>Sawtooths,<br>and Triangles.<br><br>
3//! * Usage:<br>
4//!
5//! To create a default song (to make sure everything is working):
6//! ```
7//! use rs_audio::*;
8//!
9//! let mut song = Song::default();
10//! song.play();
11//! ```
12//! <br>To create custom notes:
13//! ```
14//! use rs_audio::*;
15//!
16//! let mut song = Song::new(vec![
17//! Note { freq: 880.0, dur: 1.0, vol: 0.20, wave: WaveForm::Sine },
18//! Note { freq: 220.0, dur: 1.0, vol: 0.20, wave: WaveForm::Square },
19//! Note { freq: 880.0, dur: 1.0, vol: 0.20, wave: WaveForm::Sine },
20//! Note { freq: 220.0, dur: 1.0, vol: 0.20, wave: WaveForm::Triangle },
21//! ], BPMChoice::Default);
22//!
23//! song.play();
24//! ```
25//!
26//!
27
28pub mod assets;
29pub mod note;
30pub mod player;
31pub mod wav;
32pub mod waveform;
33
34pub use note::Note;
35pub use player::{BPMChoice, Song};
36pub use waveform::WaveForm;