# wavegen

[![github](https://img.shields.io/badge/github-spitfire05/wavegen--rs-lightgrey?style=for-the-badge&logo=github)](https://github.com/spitfire05/wavegen-rs)
[![Crates.io](https://img.shields.io/crates/v/wavegen?style=for-the-badge&logo=rust)](https://crates.io/crates/wavegen)
[![docs](https://img.shields.io/docsrs/wavegen?style=for-the-badge&logo=docs.rs)](https://docs.rs/wavegen)
[![Build status](https://img.shields.io/github/actions/workflow/status/spitfire05/wavegen-rs/check-build.yml?style=for-the-badge&branch=master)](https://github.com/spitfire05/wavegen-rs/actions/workflows/check-build.yml)

`wavegen` is a wavefrom generator made with 🦀

## How to use it?

1) Add `wavegen` to your project:

```toml
[dependencies]
wavegen = "0.4"
```
Or, to use the *no_std* version (custom global allocator is required):

```toml
[dependencies]
wavegen = { version = "0.4", default-features = false, features = ["libm"] }
```

2) Define a waveform with sampling frequency and function components:

```rust
let waveform = wf!(f64, 200., sine!(frequency: 100., amplitude: 10.), dc_bias!(20.));
```

3) Turn it into an iterator and sample:

```rust
let some_samples: Vec<f64> = waveform.iter().take(200).collect();
```

Refer to [documentation](https://docs.rs/wavegen) for more exhaustive usage examples.

## Show me some examples!

### Interactive demo

Check out the demo at https://wavegen-demo.netlify.app

### Plot charts

* Simple sine

![Sine plot](img/sine.png)

* Two superposed phase-shifted sines

![Superposed sines plot](img/sine_double.png)

* "Real life" example: 300Hz sine signal with 50Hz interference noise

![300_50_hz_sines](img/sines_300_50_hz.png)

* Sawtooth

![Sawtooth plot](img/sawtooth.png)

* Superposition of sine + sawtooth

![Sine and sawtooth superposed](img/sawtooth_sinesised.png)

* Square wave

![Square wave](img/square.png)

* Superposition of Sine, Square and Sawtooth with different frequencies

![Something funky](img/funky.png)

All above examples are generated with simple program found in `examples/plot.rs`. Run `cargo run --example plot` to generate them yourself.

## MSRV

The *Minimum Supported Rust Version* is `1.60`.

## Similar crates
* [Waver](https://github.com/amrali/waver/) which was the inspiration for this crate

## Breaking changes

### 0.2

- Braking change in how macros are annotated, changing the annotation form from `frequency = n` to `frequency: n`

### 0.4

- `Waveform::get_sample_rate` renamed to `Waveform::sample_rate` and now returns a borrowed values, as per rust API specs.
- `Waveform::get_components_len` removed. The functionality can be achieved by a new getter `Waveform::components`.