mirror/miniaudio
1
0
Fork 0
mirror of https://github.com/mackron/miniaudio.git synced 2026-04-22 00:06:59 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation to mention Brownian noise.

Browse Source
This commit is contained in:
David Reid
2020-02-25 19:09:54 +10:00
parent 479d36c2a1
commit 68556168b0
1 changed files with 11 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
miniaudio.h
+11 -10
View File
@@ -143,9 +143,9 @@ waveform you want to generated via the `ma_waveform_config` object which you can
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
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
`ma_noise_read_pcm_frames()` to read PCM data.
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
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`
object. Then use `ma_noise_read_pcm_frames()` to read PCM data.
Miscellaneous Changes
@@ -1085,7 +1085,7 @@ Below are the supported waveform types:
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
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
Below are the supported noise types.
|-----------------------|
| Enum Name |
|-----------------------|
| ma_noise_type_white |
| ma_noise_type_pink |
|-----------------------|
|------------------------|
| Enum Name |
|------------------------|
| ma_noise_type_white |
| ma_noise_type_pink |
| ma_noise_type_brownian |
|------------------------|