Commit 68556168 authored by David Reid's avatar David Reid

Update documentation to mention Brownian noise.

parent 479d36c2
...@@ -143,9 +143,9 @@ waveform you want to generated via the `ma_waveform_config` object which you can ...@@ -143,9 +143,9 @@ waveform you want to generated via the `ma_waveform_config` object which you can
Noise Generation Noise Generation
---------------- ----------------
A noise generation API has been added. This is used via the `ma_noise` API. Currently white and pink noise is supported. The `ma_noise` API is similar to the A noise generation API has been added. This is used via the `ma_noise` API. Currently white, pink and brownian noise is supported. The `ma_noise` API is
waveform API. Use `ma_noise_config_init()` to initialize a config object, and then pass it into `ma_noise_init()` to initialize a `ma_noise` object. Then use similar to the waveform API. Use `ma_noise_config_init()` to initialize a config object, and then pass it into `ma_noise_init()` to initialize a `ma_noise`
`ma_noise_read_pcm_frames()` to read PCM data. object. Then use `ma_noise_read_pcm_frames()` to read PCM data.
Miscellaneous Changes Miscellaneous Changes
...@@ -1085,7 +1085,7 @@ Below are the supported waveform types: ...@@ -1085,7 +1085,7 @@ Below are the supported waveform types:
Noise Noise
----- -----
miniaudio supports generation of white and pink noise via the `ma_noise` API. Example: miniaudio supports generation of white, pink and brownian noise via the `ma_noise` API. Example:
```c ```c
ma_noise_config config = ma_noise_config_init(FORMAT, CHANNELS, ma_noise_type_white, SEED, amplitude); ma_noise_config config = ma_noise_config_init(FORMAT, CHANNELS, ma_noise_type_white, SEED, amplitude);
...@@ -1113,12 +1113,13 @@ side. To instead have each channel use the same random value, set the `duplicate ...@@ -1113,12 +1113,13 @@ side. To instead have each channel use the same random value, set the `duplicate
Below are the supported noise types. Below are the supported noise types.
|-----------------------| |------------------------|
| Enum Name | | Enum Name |
|-----------------------| |------------------------|
| ma_noise_type_white | | ma_noise_type_white |
| ma_noise_type_pink | | ma_noise_type_pink |
|-----------------------| | ma_noise_type_brownian |
|------------------------|
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment