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

//   Copyright 2019 Waver Contributors
//
//   Licensed under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.
//   You may obtain a copy of the License at
//
//       http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.

//! # Waver: waveform generation library
//!
//! A waveform can be the fundamental sinusoidal wave or a complex waveform of varying
//! frequency, phase shift or amplitude. Waver is useful where there's a need to generate
//! a simple sinusoidal sound wave or for constructing a frequency or amplitude
//! modulated carrier wave in bare-metal Arduino or a Raspberry Pi.
//!
//! ## Features
//!
//! * Arbitrary quantization levels. Specify the bit depth when constructing `Waveform`.
//! * Online wave generation. No buffers, infinite iterators.
//! * Wave superposition with weighted amplitudes.
//! * Modulate signal's frequency, amplitude or phase.
//! * Numerically stable, prevents clipping.
//!
//! ## Example
//!
//! ```rust
//! use std::{vec::Vec, f32::consts::PI};
//! use waver::{Waveform, Wave, WaveFunc};
//!
//! // 44.1Khz sampling rate and 16-bit depth.
//! let mut wf = waver::Waveform::<i16>::new(44100.0);
//!
//! // Superpose a sine wave, a cosine wave and a triangle function.
//! wf.superpose(Wave { frequency: 2600.0, ..Default::default() })
//!   .superpose(Wave { frequency: 2600.0, phase: PI / 2.0, ..Default::default() })
//!   .superpose(Wave { frequency: 2600.0, func: WaveFunc::Triangle, ..Default::default() })
//!   .normalize_amplitudes();
//!
//! // Quantization of 100 samples
//! let _output: Vec<i16> = wf.iter().take(100).collect();
//! ```

#![cfg_attr(not(test), no_std)]

extern crate alloc;

mod wave;
mod waveform;

pub use wave::{Wave, WaveFunc, WaveIterator};
pub use waveform::{Waveform, WaveformIterator};

// Test README.md
#[cfg(doctest)]
mod readme {
    use doc_comment::doctest;
    doctest!("../README.md");
}