orastron/brickworks
2
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

doc updates + fix bw_one_pole doc and a bug

Browse Source
This commit is contained in:
Stefano D'Angelo 2022-12-03 13:07:44 +01:00
parent 76a27fe17c
commit fb91abdec3
4 changed files with 140 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/bw_env_follow.h
View File

@ -55,13 +55,13 @@ extern "C" {
* ```>>> */
typedef struct _bw_env_follow_coeffs bw_env_follow_coeffs;
/*! <<<```
* Coefficients and input parameter values.
* Coefficients and related.
*
* #### bw_env_follow_state
* ```>>> */
typedef struct _bw_env_follow_state bw_env_follow_state;
/*! <<<```
* Internal state and output parameter values.
* Internal state and related.
*
* #### bw_env_follow_init()
* ```>>> */

14
include/bw_env_gen.h
View File

@ -67,13 +67,13 @@ extern "C" {
* ```>>> */
typedef struct _bw_env_gen_coeffs bw_env_gen_coeffs;
/*! <<<```
* Coefficients and input parameter values.
* Coefficients and related.
*
* #### bw_env_gen_state
* ```>>> */
typedef struct _bw_env_gen_state bw_env_gen_state;
/*! <<<```
* Internal state and output parameter values.
* Internal state and related.
*
* #### bw_env_gen_phase
* ```>>> */
@ -198,19 +198,17 @@ static inline void bw_env_gen_set_release(bw_env_gen_coeffs *BW_RESTRICT coeffs,
*
* #### bw_env_gen_get_phase()
* ```>>> */
static inline bw_env_gen_phase bw_env_gen_get_phase(bw_env_gen_state *state);
static inline bw_env_gen_phase bw_env_gen_get_phase(const bw_env_gen_state *state);
/*! <<<```
* Returns the current envelope generator phase as stored in `state`.
*
* #### bw_env_gen_get_y_z1()
* ```>>> */
static inline float bw_env_gen_get_y_z1(bw_env_gen_state *state);
static inline float bw_env_gen_get_y_z1(const bw_env_gen_state *state);
/*! <<<```
* Returns the last output sample stored in `state`.
* }}} */
static inline float bw_env_gen_get_y_z1(bw_env_gen_state *state);
/*** Implementation ***/
/* WARNING: This part of the file is not part of the public API. Its content may
@ -380,11 +378,11 @@ static inline void bw_env_gen_set_release(bw_env_gen_coeffs *BW_RESTRICT coeffs,
}
}
static inline bw_env_gen_phase bw_env_gen_get_phase(bw_env_gen_state *state) {
static inline bw_env_gen_phase bw_env_gen_get_phase(const bw_env_gen_state *state) {
return state->phase;
}
static inline float bw_env_gen_get_y_z1(bw_env_gen_state *state) {
static inline float bw_env_gen_get_y_z1(const bw_env_gen_state *state) {
return state->y_z1;
}

56
include/bw_noise_gen.h
View File

@ -23,6 +23,10 @@
* requires {{{ bw_config bw_common bw_math bw_rand }}}
* description {{{
* Generator of white noise with uniform distribution.
*
* This module has no internal state, rather its state is stored into a
* `uint64_t` value to which the API user supplies a pointer (as in
* [bw\_rand](bw_rand)).
* }}}
* changelog {{{
* <ul>
@ -54,51 +58,59 @@ extern "C" {
* ```>>> */
typedef struct _bw_noise_gen_coeffs bw_noise_gen_coeffs;
/*! <<<```
* Coefficients.
* Coefficients and related.
*
* #### bw_noise_gen_init()
* ```>>> */
static inline void bw_noise_gen_init(bw_noise_gen_coeffs *BW_RESTRICT coeffs, uint64_t *BW_RESTRICT state);
/*! <<<```
* Initializes `coeffs` and lets it use the given `state` pointer to obtain
* pseudo-random numbers.
* Initializes input parameter values and sets the `state` pointer to obtain
* pseudo-random numbers in `coeffs`.
*
* #### bw_noise_gen_set_sample_rate()
* ```>>> */
static inline void bw_noise_gen_set_sample_rate(bw_noise_gen_coeffs *BW_RESTRICT coeffs, float sample_rate);
/*! <<<```
* Sets the `sample_rate` (Hz) value for the given `coeffs`.
* >>> */
* Sets the `sample_rate` (Hz) value in `coeffs`.
*
* #### bw_noise_gen_process1\*()
* ```>>> */
static inline float bw_noise_gen_process1(const bw_noise_gen_coeffs *BW_RESTRICT coeffs);
static inline float bw_noise_gen_process1_scaling(const bw_noise_gen_coeffs *BW_RESTRICT coeffs);
/*! ...
* #### bw_noise_gen_process()
/*! <<<```
* These functions generates and return one sample using `coeffs`, where:
* * `bw_noise_gen_process1()` assumes that sample rate scaling is disabled;
* * `bw_noise_gen_process1_scaling()` assumes that sample rate scaling is
* enabled.
*
* #### bw_env_gen_process()
* ```>>> */
static inline void bw_noise_gen_process(bw_noise_gen_coeffs *BW_RESTRICT coeffs, float *BW_RESTRICT y, int n_samples);
/*! <<<```
* Lets the given `instance` generate `n_samples` samples and puts them in
* the output buffer `y`.
* >>> */
/*! ...
* Generates and fills the first `n_samples` of the output buffer `y` using
* `coeffs`.
*
* #### bw_noise_gen_set_sample_rate_scaling()
* ```>>> */
static inline void bw_noise_gen_set_sample_rate_scaling(bw_noise_gen_coeffs *BW_RESTRICT coeffs, char value);
/*! <<<```
* Sets whether the output should be scaled (`value` non-`0`) or not (`0`)
* according to the sample rate by the given `instance`.
* according to the sample rate in `coeffs`.
*
* In order to maintain the perceived loudness at different sample rates, a
* white noise signal with uniform distribution should be accordingly scaled.
* In this module the 44100 Hz sample rate is used as a reference (that is,
* the scaling factor at that sample rate is `1.f`).
* In order to maintain the same perceived loudness at different sample
* rates, a white noise signal with uniform distribution should be
* accordingly scaled. The 44100 Hz sample rate is used as a reference (that
* is, the scaling factor at that sample rate is `1.f`).
*
* Default value: `0`.
* }}} */
* Default value: `0` (off).
*
* #### bw_noise_gen_get_scaling_k()
* ```>>> */
static inline float bw_noise_gen_get_scaling_k(bw_noise_gen_coeffs *BW_RESTRICT coeffs);
/*! <<<```
* Returns the sample rate scaling factor that is applied or would be applied
* if sample rate scaling were enabled, as stored in `coeffs`.
* }}} */
/*** Implementation ***/

162
include/bw_one_pole.h
View File

@ -55,13 +55,13 @@ extern "C" {
* ```>>> */
typedef struct _bw_one_pole_coeffs bw_one_pole_coeffs;
/*! <<<```
* Coefficients.
* Coefficients and related.
*
* ### bw_one_pole_state
* >>> */
* #### bw_one_pole_state
* ```>>> */
typedef struct _bw_one_pole_state bw_one_pole_state;
/*! <<<```
* State.
* Internal state and related.
*
* #### bw_one_pole_sticky_mode
* ```>>> */
@ -79,138 +79,164 @@ typedef enum {
* ```>>> */
static inline void bw_one_pole_init(bw_one_pole_coeffs *BW_RESTRICT coeffs);
/*! <<<```
* Initializes `coeffs`.
* Initializes input parameter values in `coeffs`.
*
* #### bw_one_pole_set_sample_rate()
* ```>>> */
static inline void bw_one_pole_set_sample_rate(bw_one_pole_coeffs *BW_RESTRICT coeffs, float sample_rate);
/*! <<<```
* Sets the `sample_rate` (Hz) value for the given `coeffs`.
* Sets the `sample_rate` (Hz) value in `coeffs`.
*
* #### bw_one_pole_reset_coeffs()
* ```>>> */
static inline void bw_one_pole_reset_coeffs(bw_one_pole_coeffs *BW_RESTRICT coeffs);
/*! <<<```
* Resets coefficients in `coeffs` to assume their target values.
*
* #### bw_one_pole_reset_state()
* ```>>> */
static inline void bw_one_pole_reset_state(const bw_one_pole_coeffs *BW_RESTRICT coeffs, bw_one_pole_state *BW_RESTRICT state, float y_z1);
/*! <<<```
* Resets the given `state` to the initial state using the given `coeffs`.
* >>> */
static inline void bw_one_pole_reset_coeffs(bw_one_pole_coeffs *BW_RESTRICT coeffs);
* Resets the given `state` to its initial values using the given `coeffs`
* and the quiescent/equilibrium value `y_z1`.
*
* #### bw_one_pole_update_coeffs_ctrl()
* ```>>> */
static inline void bw_one_pole_update_coeffs_ctrl(bw_one_pole_coeffs *BW_RESTRICT coeffs);
/*! <<<```
* Triggers control-rate update of coefficients in `coeffs`.
*
* #### bw_one_pole_update_coeffs_audio()
* ```>>> */
static inline void bw_one_pole_update_coeffs_audio(bw_one_pole_coeffs *BW_RESTRICT coeffs);
/*! <<<```
* Triggers audio-rate update of coefficients in `coeffs`.
*
* #### bw_one_pole_process1\*()
* ```>>> */
static inline float bw_one_pole_process1(const bw_one_pole_coeffs *BW_RESTRICT coeffs, bw_one_pole_state *BW_RESTRICT state, float x);
static inline float bw_one_pole_process1_sticky_abs(const bw_one_pole_coeffs *BW_RESTRICT coeffs, bw_one_pole_state *BW_RESTRICT state, float x);
static inline float bw_one_pole_process1_sticky_rel(const bw_one_pole_coeffs *BW_RESTRICT coeffs, bw_one_pole_state *BW_RESTRICT state, float x);
static inline float bw_one_pole_process1_asym(const bw_one_pole_coeffs *BW_RESTRICT coeffs, bw_one_pole_state *BW_RESTRICT state, float x);
static inline float bw_one_pole_process1_asym_sticky_abs(const bw_one_pole_coeffs *BW_RESTRICT coeffs, bw_one_pole_state *BW_RESTRICT state, float x);
static inline float bw_one_pole_process1_asym_sticky_rel(const bw_one_pole_coeffs *BW_RESTRICT coeffs, bw_one_pole_state *BW_RESTRICT state, float x);
/*! ...
/*! <<<```
* These function process one input sample `x` using `coeffs` and updating
* `state` (audio rate only). They return the corresponding output sample.
*
* In particular:
* * `bw_one_pole_process1()` assumes that upgoing and downgoing cutoff/tau
* are equal and the target-reach threshold is `0.f`;
* * `bw_one_pole_process1_sticky_abs()` assumes that upgoing and downgoing
* cutoff/tau are equal, that the target-reach threshold is not `0.f`,
* and that the distance metric for sticky behavior is set to
* `bw_one_pole_sticky_mode_abs`;
* * `bw_one_pole_process1_sticky_rel()` assumes that upgoing and downgoing
* cutoff/tau are equal, that the target-reach threshold is not `0.f`,
* and that the distance metric for sticky behavior is set to
* `bw_one_pole_sticky_mode_rel`;
* * `bw_one_pole_process1_asym()` assumes that upgoing and downgoing
* cutoff/tau are different and the target-reach threshold is `0.f`;
* * `bw_one_pole_process1_asym_sticky_abs()` assumes that upgoing and
* downgoing cutoff/tau are different, that the target-reach threshold is
* not `0.f`, and that the distance metric for sticky behavior is set to
* `bw_one_pole_sticky_mode_abs`;
* * `bw_one_pole_process1_asym_sticky_rel()` assumes that upgoing and
* downgoing cutoff/tau are different, that the target-reach threshold is
* not `0.f`, and that the distance metric for sticky behavior is set to
* `bw_one_pole_sticky_mode_rel`.
*
* #### bw_one_pole_process()
* ```>>> */
static inline void bw_one_pole_process(bw_one_pole_coeffs *BW_RESTRICT coeffs, bw_one_pole_state *BW_RESTRICT state, const float *x, float *y, int n_samples);
/*! <<<```
* Lets the given `instance` process `n_samples` samples from the input
* buffer `x` and fills the corresponding `n_samples` samples in the output
* buffer `y`.
* >>> */
/*! ...
* Processes the first `n_samples` of the input buffer `x` and fills the
* first `n_samples` of the output buffer `y`, while using and updating both
* `coeffs` and `state` (control and audio rate).
*
* `y` may be `NULL`.
*
* #### bw_one_pole_set_cutoff()
* ```>>> */
static inline void bw_one_pole_set_cutoff(bw_one_pole_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets both the upgoing (attack) and downgoing (decay) cutoff frequency to
* the given `value` (Hz) for the given `instance`.
* the given `value` (Hz) in `coeffs`.
*
* This is equivalent to calling both `bw_one_pole_set_cutoff_up()` and
* `bw_one_pole_set_cutoff_down()` with same `instance` and `value` or
* calling `bw_one_pole_set_tau()` with same `instance` and
* `bw_one_pole_set_cutoff_down()` with same `coeffs` and `value` or calling
* `bw_one_pole_set_tau()` with same `coeffs` and
* value = 1 / (2 * pi * `value`) (net of numerical errors).
*
* Default value: `INFINITY`.
* >>> */
/*! ...
*
* #### bw_one_pole_set_cutoff_up()
* ```>>> */
static inline void bw_one_pole_set_cutoff_up(bw_one_pole_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets the upgoing (attack) cutoff frequency to the given `value` (Hz) for
* the given `instance`.
* Sets the upgoing (attack) cutoff frequency to the given `value` (Hz) in
* `coeffs`.
*
* This is equivalent to calling `bw_one_pole_set_tau_up()` with same
* `instance` and value = 1 / (2 * pi * `value`) (net of numerical errors).
* `coeffs` and value = 1 / (2 * pi * `value`) (net of numerical errors).
*
* Default value: `INFINITY`.
* >>> */
/*! ...
*
* #### bw_one_pole_set_cutoff_down()
* ```>>> */
static inline void bw_one_pole_set_cutoff_down(bw_one_pole_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets the downgoing (attack) cutoff frequency to the given `value` (Hz)
* for the given `instance`.
* Sets the downgoing (attack) cutoff frequency to the given `value` (Hz) in
* `coeffs`.
*
* This is equivalent to calling `bw_one_pole_set_tau_down()` with same
* `instance` and value = 1 / (2 * pi * `value`) (net of numerical errors).
* `coeffs` and value = 1 / (2 * pi * `value`) (net of numerical errors).
*
* Default value: `INFINITY`.
* >>> */
/*! ...
*
* #### bw_one_pole_set_tau()
* ```>>> */
static inline void bw_one_pole_set_tau(bw_one_pole_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets both the upgoing (attack) and downgoing (decay) time constant to the
* given `value` (s) for the given `instance`.
* given `value` (s) in `coeffs`.
*
* This is equivalent to calling both `bw_one_pole_set_tau_up()` and
* `bw_one_pole_set_tau_down()` with same `instance` and `value` or calling
* `bw_one_pole_set_cutoff()` with same `instance` and
* `bw_one_pole_set_tau_down()` with same `coeffs` and `value` or calling
* `bw_one_pole_set_cutoff()` with same `coeffs` and
* value = 1 / (2 * pi * `value`) (net of numerical errors).
*
* Default value: `0.f`.
* >>> */
/*! ...
*
* #### bw_one_pole_set_tau_up()
* ```>>> */
static inline void bw_one_pole_set_tau_up(bw_one_pole_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets the upgoing (attack) time constant to the given `value` (s) for the
* given `instance`.
* Sets the upgoing (attack) time constant to the given `value` (s) in
* `coeffs`.
*
* This is equivalent to calling `bw_one_pole_set_cutoff_up()` with same
* `instance` and value = 1 / (2 * pi * `value`) (net of numerical errors).
* `coeffs` and value = 1 / (2 * pi * `value`) (net of numerical errors).
*
* Default value: `0.f`.
* >>> */
/*! ...
*
* #### bw_one_pole_set_tau_down()
* ```>>> */
static inline void bw_one_pole_set_tau_down(bw_one_pole_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets the downgoing (decay) time constant to the given `value` (s) for the
* given `instance`.
* Sets the downgoing (decay) time constant to the given `value` (s) in
* `coeffs`.
*
* This is equivalent to calling `bw_one_pole_set_cutoff_down()` with same
* `instance` and value = 1 / (2 * pi * `value`) (net of numerical errors).
* `coeffs` and value = 1 / (2 * pi * `value`) (net of numerical errors).
*
* Default value: `0.f`.
* >>> */
/*! ...
*
* #### bw_one_pole_set_sticky_thresh()
* ```>>> */
static inline void bw_one_pole_set_sticky_thresh(bw_one_pole_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets the target-reach threshold specified by `value` for the given
* `instance`.
* Sets the target-reach threshold specified by `value` in `coeffs`.
*
* When the difference between the output and the input would fall under such
* threshold according to the current distance metric (see
@ -218,17 +244,24 @@ static inline void bw_one_pole_set_sticky_thresh(bw_one_pole_coeffs *BW_RESTRICT
* to the input value.
*
* Default value: `0.f`.
* >>> */
/*! ...
*
* #### bw_one_pole_set_sticky_mode()
* ```>>> */
static inline void bw_one_pole_set_sticky_mode(bw_one_pole_coeffs *BW_RESTRICT coeffs, bw_one_pole_sticky_mode value);
/*! <<<```
* Sets the current distance metric for sticky behavior.
* Sets the current distance metric for sticky behavior to `value` in
* `coeffs`.
*
* Default value: `bw_one_pole_sticky_mode_abs`.
*
* #### bw_one_pole_get_y_z1()
* ```>>> */
static inline float bw_one_pole_get_y_z1(const bw_one_pole_state *BW_RESTRICT state);
/*! <<<```
* Returns the last output sample stored in `state`.
* }}} */
static inline float bw_one_pole_get_y_z1(const bw_one_pole_state *BW_RESTRICT state);
/*** Implementation ***/
@ -265,6 +298,7 @@ static inline void bw_one_pole_init(bw_one_pole_coeffs *BW_RESTRICT coeffs) {
coeffs->cutoff_up = INFINITY;
coeffs->cutoff_down = INFINITY;
coeffs->sticky_thresh = 0.f;
coeffs->sticky_mode = bw_one_pole_sticky_mode_abs;
}
static inline void bw_one_pole_set_sample_rate(bw_one_pole_coeffs *BW_RESTRICT coeffs, float sample_rate) {
@ -345,7 +379,7 @@ static inline float bw_one_pole_process1_asym_sticky_rel(const bw_one_pole_coeff
static inline void bw_one_pole_process(bw_one_pole_coeffs *BW_RESTRICT coeffs, bw_one_pole_state *BW_RESTRICT state, const float *x, float *y, int n_samples) {
bw_one_pole_update_coeffs_ctrl(coeffs);
if (y) {
if (y != NULL) {
if (coeffs->mA1u != coeffs->mA1d) {
if (coeffs->st2 != 0.f) {
if (coeffs->sticky_mode == bw_one_pole_sticky_mode_abs)