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

added smoothing in bw_comp + fix docs + cosmetic changes

Browse Source
This commit is contained in:
Stefano D'Angelo 2022-12-05 13:39:28 +01:00
parent 11c399929f
commit 6206530309
2 changed files with 75 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
include/bw_comp.h
View File

@ -19,7 +19,7 @@
/*!
* module_type {{{ dsp }}}
* version {{{ 0.2.0 }}}
* version {{{ 0.3.0 }}}
* requires {{{ bw_config bw_common bw_env_follow bw_one_pole bw_math bw_vol }}}
* description {{{
* Feedforward compressor/limiter with independent sidechain input.
@ -97,57 +97,77 @@ static inline void bw_comp_update_coeffs_audio(bw_comp_coeffs *BW_RESTRICT coeff
* ```>>> */
static inline float bw_comp_process1(const bw_comp_coeffs *BW_RESTRICT coeffs, bw_comp_state *BW_RESTRICT state, float x, float x_sc);
/*! <<<```
* These function process one input sample `x` using `coeffs`, while using
* and updating `state`. They return the corresponding output sample.
*
* In particular:
* * `bw_comp_process1()` assumes that gain compensation is disabled;
* * `bw_comp_process1_comp()` assumes that gain compensation is enabled.
*
* ...
* Processes one input sample `x` and the corresponding sidechain input
* sample `x_sc` using `coeffs`, while using and updating `state`. Returns
* the corresponding output sample.
*
* #### bw_comp_process()
* ```>>> */
static inline void bw_comp_process(bw_comp_coeffs *BW_RESTRICT coeffs, bw_comp_state *BW_RESTRICT state, const float *x, const float *x_sc, float *y, int n_samples);
/*! <<<```
* 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
* Processes the first `n_samples` of the input buffer `x` and the first
* `n_samples` of the sidechain input buffer `x_sc`, and fills the first
* `n_samples` of the output buffer `y`, while using and updating both
* `coeffs` and `state` (control and audio rate).
*
* ...
*
* #### bw_comp_set_...()
* #### bw_comp_set_thresh_lin()
* ```>>> */
static inline void bw_comp_set_thresh_lin(bw_comp_coeffs *BW_RESTRICT coeffs, float value);
static inline void bw_comp_set_thresh_dBFS(bw_comp_coeffs *BW_RESTRICT coeffs, float value);
static inline void bw_comp_set_ratio(bw_comp_coeffs *BW_RESTRICT coeffs, float value);
static inline void bw_comp_set_attack_tau(bw_comp_coeffs *BW_RESTRICT coeffs, float value);
static inline void bw_comp_set_release_tau(bw_comp_coeffs *BW_RESTRICT coeffs, float value);
static inline void bw_comp_set_gain_lin(bw_comp_coeffs *BW_RESTRICT coeffs, float value);
static inline void bw_comp_set_gain_dB(bw_comp_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets the input bias `value` in `coeffs`.
*
* Default value: `0.f`.
*
* #### bw_comp_set_gain()
* ```>>> */
//static inline void bw_comp_set_gain(bw_comp_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets the gain `value` in `coeffs`.
*
* Do not set it to `0.f`, obviously.
* Sets the threshold `value` (linear) in `coeffs`.
*
* Default value: `1.f`.
*
* #### bw_comp_set_gain_compensation()
* #### bw_comp_set_thresh_dBFS()
* ```>>> */
//static inline void bw_comp_set_gain_compensation(bw_comp_coeffs *BW_RESTRICT coeffs, char value);
static inline void bw_comp_set_thresh_dBFS(bw_comp_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets whether the output should be divided by gain (`value` non-`0`) or not
* (`0`).
* Sets the threshold `value` (dBFS) in `coeffs`.
*
* Default value: `1` (on).
* Default value: `0.f`.
*
* #### bw_comp_set_ratio()
* ```>>> */
static inline void bw_comp_set_ratio(bw_comp_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets the copmpression ratio `value` in `coeffs`.
*
* `value` is actually the outcome of the division in the compression ratio,
* hence `1.f` means no compression and `0.f` is a hard limit.
*
* Default value: `1.f`.
*
* #### bw_comp_set_attack_tau()
* ```>>> */
static inline void bw_comp_set_attack_tau(bw_comp_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets the attack time constant `value` (s) in `coeffs`.
*
* Default value: `0.f`.
*
* #### bw_comp_set_release_tau()
* ```>>> */
static inline void bw_comp_set_release_tau(bw_comp_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets the release time constant `value` (s) in `coeffs`.
*
* Default value: `0.f`.
*
* #### bw_comp_set_gain_lin()
* ```>>> */
static inline void bw_comp_set_gain_lin(bw_comp_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets the output makeup gain `value` (linear ratio) in `coeffs`.
*
* Default value: `1.f`.
*
* #### bw_comp_set_gain_dB()
* ```>>> */
static inline void bw_comp_set_gain_dB(bw_comp_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets the output makeup gain `value` (dB) in `coeffs`.
*
* Default value: `0.f`.
* }}} */
/*** Implementation ***/
@ -158,11 +178,15 @@ static inline void bw_comp_set_gain_dB(bw_comp_coeffs *BW_RESTRICT coeffs, float
#include <bw_math.h>
#include <bw_env_follow.h>
#include <bw_vol.h>
#include <bw_one_pole.h>
struct _bw_comp_coeffs {
// Sub-components
bw_env_follow_coeffs env_follow_coeffs;
bw_vol_coeffs vol_coeffs;
bw_one_pole_coeffs smooth_coeffs;
bw_one_pole_state smooth_thresh_state;
bw_one_pole_state smooth_ratio_state;
// Coefficients
float kc;
@ -179,6 +203,7 @@ struct _bw_comp_state {
static inline void bw_comp_init(bw_comp_coeffs *BW_RESTRICT coeffs) {
bw_env_follow_init(&coeffs->env_follow_coeffs);
bw_vol_init(&coeffs->vol_coeffs);
bw_one_pole_set_tau(&coeffs->smooth_coeffs, 0.05f);
coeffs->thresh = 1.f;
coeffs->ratio = 1.f;
}
@ -186,11 +211,15 @@ static inline void bw_comp_init(bw_comp_coeffs *BW_RESTRICT coeffs) {
static inline void bw_comp_set_sample_rate(bw_comp_coeffs *BW_RESTRICT coeffs, float sample_rate) {
bw_env_follow_set_sample_rate(&coeffs->env_follow_coeffs, sample_rate);
bw_vol_set_sample_rate(&coeffs->vol_coeffs, sample_rate);
bw_one_pole_set_sample_rate(&coeffs->smooth_coeffs, sample_rate);
bw_one_pole_reset_coeffs(&coeffs->smooth_coeffs);
}
static inline void bw_comp_reset_coeffs(bw_comp_coeffs *BW_RESTRICT coeffs) {
bw_env_follow_reset_coeffs(&coeffs->env_follow_coeffs);
bw_vol_reset_coeffs(&coeffs->vol_coeffs);
bw_one_pole_reset_state(&coeffs->smooth_coeffs, &coeffs->smooth_thresh_state, coeffs->thresh);
bw_one_pole_reset_state(&coeffs->smooth_coeffs, &coeffs->smooth_ratio_state, coeffs->ratio);
}
static inline void bw_comp_reset_state(const bw_comp_coeffs *BW_RESTRICT coeffs, bw_comp_state *BW_RESTRICT state) {
@ -200,17 +229,19 @@ static inline void bw_comp_reset_state(const bw_comp_coeffs *BW_RESTRICT coeffs,
static inline void bw_comp_update_coeffs_ctrl(bw_comp_coeffs *BW_RESTRICT coeffs) {
bw_env_follow_update_coeffs_ctrl(&coeffs->env_follow_coeffs);
bw_vol_update_coeffs_ctrl(&coeffs->vol_coeffs);
coeffs->kc = 1.f - coeffs->ratio;
}
static inline void bw_comp_update_coeffs_audio(bw_comp_coeffs *BW_RESTRICT coeffs) {
bw_env_follow_update_coeffs_audio(&coeffs->env_follow_coeffs);
bw_vol_update_coeffs_audio(&coeffs->vol_coeffs);
bw_one_pole_process1(&coeffs->smooth_coeffs, &coeffs->smooth_thresh_state, coeffs->thresh);
coeffs->kc = 1.f - bw_one_pole_process1(&coeffs->smooth_coeffs, &coeffs->smooth_ratio_state, coeffs->ratio);
}
static inline float bw_comp_process1(const bw_comp_coeffs *BW_RESTRICT coeffs, bw_comp_state *BW_RESTRICT state, float x, float x_sc) {
const float env = bw_env_follow_process1(&coeffs->env_follow_coeffs, &state->env_follow_state, x_sc);
const float y = env > coeffs->thresh ? bw_pow2f_3(coeffs->kc * bw_log2f_3(coeffs->thresh * bw_rcpf_2(env))) * x : x;
const float thresh = bw_one_pole_get_y_z1(&coeffs->smooth_thresh_state);
const float y = env > thresh ? bw_pow2f_3(coeffs->kc * bw_log2f_3(thresh * bw_rcpf_2(env))) * x : x;
return bw_vol_process1(&coeffs->vol_coeffs, y);
}

10
include/bw_math.h
View File

@ -71,14 +71,16 @@
* <ul>
* <li>Version <strong>0.3.0</strong>:
* <ul>
* <li>Added bw_log10f_3(), bw_pow10f_3(), bw_dB2linf_3(), and
* bw_lin2dBf_3().</li>
* <li>Added <code>bw_log10f_3()</code>, <code>bw_pow10f_3()</code>,
* <code>bw_dB2linf_3()</code>, and
* <code>bw_lin2dBf_3()</code>.</li>
* </ul>
* </li>
* <li>Version <strong>0.2.0</strong>:
* <ul>
* <li>Added bw_sin2pif_3(), bw_cos2pif_3(), bw_tan2pif_3(),
* bw_omega_3lognr(), and bw_tanhf_3().</li>
* <li>Added <code>bw_sin2pif_3()</code>, <code>bw_cos2pif_3()</code>,
* <code>bw_tan2pif_3()</code>, <code>bw_omega_3lognr()</code>, and
* <code>bw_tanhf_3()</code>.</li>
* </ul>
* </li>
* <li>Version <strong>0.1.0</strong>: