finalized bw_satur + examples + fix reset in bw_clip
This commit is contained in:
parent
dae41a3831
commit
a3f42c8c57
@ -33,7 +33,7 @@ void bw_example_fx_satur_set_sample_rate(bw_example_fx_satur *instance, float sa
|
||||
|
||||
void bw_example_fx_satur_reset(bw_example_fx_satur *instance) {
|
||||
bw_satur_reset_coeffs(&instance->satur_coeffs);
|
||||
bw_satur_reset_state(&instance->satur_coeffs, &instance->satur_state);
|
||||
bw_satur_reset_state(&instance->satur_coeffs, &instance->satur_state, 0.f);
|
||||
bw_src_int_reset_state(&instance->src_up_coeffs, &instance->src_up_state, 0.f);
|
||||
bw_src_int_reset_state(&instance->src_down_coeffs, &instance->src_down_state, 0.f);
|
||||
}
|
||||
|
||||
@ -4,3 +4,6 @@ NAME := bw_example_fx_satur
|
||||
SOURCES = ${SOURCES_COMMON} ${ROOT_DIR}/../src/bw_example_fx_satur.c
|
||||
|
||||
include ${ROOT_DIR}/../../common/vst3/vst3.mk
|
||||
|
||||
CXXFLAGS += -DRELEASE=1 -DNDEBUG -DBW_NO_DEBUG
|
||||
#CXXFLAGS += -DDEVELOPMENT=1 -DBW_DEBUG_DEEP
|
||||
|
||||
@ -4,3 +4,6 @@ NAME := bw_example_fxpp_satur
|
||||
SOURCES = ${SOURCES_COMMON} ${ROOT_DIR}/../src/bw_example_fxpp_satur.cpp
|
||||
|
||||
include ${ROOT_DIR}/../../common/vst3/vst3.mk
|
||||
|
||||
CXXFLAGS += -DRELEASE=1 -DNDEBUG -DBW_NO_DEBUG
|
||||
#CXXFLAGS += -DDEVELOPMENT=1 -DBW_DEBUG_DEEP
|
||||
|
||||
@ -422,11 +422,12 @@ static inline float bw_clip_reset_state(
|
||||
BW_ASSERT(bw_is_finite(x_0));
|
||||
|
||||
const float x = bw_one_pole_get_y_z1(&coeffs->smooth_gain_state) * x_0 + bw_one_pole_get_y_z1(&coeffs->smooth_bias_state);
|
||||
const float a = bw_absf(x_0);
|
||||
const float a = bw_absf(x);
|
||||
const float F = a > 1.f ? a - 0.5f : 0.5f * a * a;
|
||||
const float yb = bw_clipf(x, -1.f, 1.f);
|
||||
const float y = yb - coeffs->bias_dc;
|
||||
state->x_z1 = x;
|
||||
state->F_z1 = a > 1.f ? a - 0.5f : 0.5f * a * a;
|
||||
state->F_z1 = F;
|
||||
|
||||
#ifdef BW_DEBUG_DEEP
|
||||
state->hash = bw_hash_sdbm("bw_clip_state");
|
||||
|
||||
@ -35,7 +35,7 @@
|
||||
* As a side effect, antialiasing causes attenuation at higher frequencies
|
||||
* (about 3 dB at 0.5 × Nyquist frequency and rapidly increasing at higher
|
||||
* frequencies).
|
||||
*
|
||||
*
|
||||
* The antialiasing technique used here is described in
|
||||
*
|
||||
* J. D. Parker, V. Zavalishin, and E. Le Bivic, "Reducing the Aliasing of
|
||||
@ -48,6 +48,14 @@
|
||||
* <li>Version <strong>1.0.0</strong>:
|
||||
* <ul>
|
||||
* <li>Changed default value for gain compensation to off.</li>
|
||||
* <li>Added initial input value to
|
||||
* <code>bw_satur_reset_state()</code>.</li>
|
||||
* <li>Added <code>bw_satur_reset_state_multi()</code> and updated C++
|
||||
* API in this regard.</li>
|
||||
* <li>Now <code>bw_satur_reset_state()</code> returns the initial
|
||||
* output value.</li>
|
||||
* <li>Added overloaded C++ <code>reset()</code> functions taking
|
||||
* arrays as arguments.</li>
|
||||
* <li><code>bw_satur_process()</code> and
|
||||
* <code>bw_satur_process_multi()</code> now use
|
||||
* <code>size_t</code> to count samples and channels.</li>
|
||||
@ -57,6 +65,8 @@
|
||||
* <li>Added overloaded C++ <code>process()</code> function taking
|
||||
* C-style arrays as arguments.</li>
|
||||
* <li>Removed usage of reserved identifiers.</li>
|
||||
* <li>Clearly specified parameter validity ranges.</li>
|
||||
* <li>Added debugging code.</li>
|
||||
* </ul>
|
||||
* </li>
|
||||
* <li>Version <strong>0.6.0</strong>:
|
||||
@ -110,44 +120,79 @@ typedef struct bw_satur_state bw_satur_state;
|
||||
*
|
||||
* #### bw_satur_init()
|
||||
* ```>>> */
|
||||
static inline void bw_satur_init(bw_satur_coeffs *BW_RESTRICT coeffs);
|
||||
static inline void bw_satur_init(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs);
|
||||
/*! <<<```
|
||||
* Initializes input parameter values in `coeffs`.
|
||||
*
|
||||
* #### bw_satur_set_sample_rate()
|
||||
* ```>>> */
|
||||
static inline void bw_satur_set_sample_rate(bw_satur_coeffs *BW_RESTRICT coeffs, float sample_rate);
|
||||
static inline void bw_satur_set_sample_rate(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
float sample_rate);
|
||||
/*! <<<```
|
||||
* Sets the `sample_rate` (Hz) value in `coeffs`.
|
||||
*
|
||||
* #### bw_satur_reset_coeffs()
|
||||
* ```>>> */
|
||||
static inline void bw_satur_reset_coeffs(bw_satur_coeffs *BW_RESTRICT coeffs);
|
||||
static inline void bw_satur_reset_coeffs(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs);
|
||||
/*! <<<```
|
||||
* Resets coefficients in `coeffs` to assume their target values.
|
||||
*
|
||||
* #### bw_satur_reset_state()
|
||||
* ```>>> */
|
||||
static inline void bw_satur_reset_state(const bw_satur_coeffs *BW_RESTRICT coeffs, bw_satur_state *BW_RESTRICT state);
|
||||
static inline float bw_satur_reset_state(
|
||||
const bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
bw_satur_state * BW_RESTRICT state,
|
||||
float x_0);
|
||||
/*! <<<```
|
||||
* Resets the given `state` to its initial values using the given `coeffs`.
|
||||
* Resets the given `state` to its initial values using the given `coeffs`
|
||||
* and the initial input value `x_0`.
|
||||
*
|
||||
* Returns the corresponding initial output value.
|
||||
*
|
||||
* #### bw_satur_reset_state_multi()
|
||||
* ```>>> */
|
||||
static inline void bw_satur_reset_state_multi(
|
||||
const bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
bw_satur_state * BW_RESTRICT const * BW_RESTRICT state,
|
||||
const float * x_0,
|
||||
float * y_0,
|
||||
size_t n_channels);
|
||||
/*! <<<```
|
||||
* Resets each of the `n_channels` `state`s to its initial values using the
|
||||
* given `coeffs` and the corresponding initial input value in the `x_0`
|
||||
* array.
|
||||
*
|
||||
* The corresponding initial output values are written into the `y_0` array,
|
||||
* if not `NULL`.
|
||||
*
|
||||
* #### bw_satur_update_coeffs_ctrl()
|
||||
* ```>>> */
|
||||
static inline void bw_satur_update_coeffs_ctrl(bw_satur_coeffs *BW_RESTRICT coeffs);
|
||||
static inline void bw_satur_update_coeffs_ctrl(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs);
|
||||
/*! <<<```
|
||||
* Triggers control-rate update of coefficients in `coeffs`.
|
||||
*
|
||||
* #### bw_satur_update_coeffs_audio()
|
||||
* ```>>> */
|
||||
static inline void bw_satur_update_coeffs_audio(bw_satur_coeffs *BW_RESTRICT coeffs);
|
||||
static inline void bw_satur_update_coeffs_audio(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs);
|
||||
/*! <<<```
|
||||
* Triggers audio-rate update of coefficients in `coeffs`.
|
||||
*
|
||||
* #### bw_satur_process1()
|
||||
* ```>>> */
|
||||
static inline float bw_satur_process1(const bw_satur_coeffs *BW_RESTRICT coeffs, bw_satur_state *BW_RESTRICT state, float x);
|
||||
static inline float bw_satur_process1_comp(const bw_satur_coeffs *BW_RESTRICT coeffs, bw_satur_state *BW_RESTRICT state, float x);
|
||||
static inline float bw_satur_process1(
|
||||
const bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
bw_satur_state * BW_RESTRICT state,
|
||||
float x);
|
||||
|
||||
static inline float bw_satur_process1_comp(
|
||||
const bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
bw_satur_state * BW_RESTRICT state,
|
||||
float x);
|
||||
/*! <<<```
|
||||
* These function process one input sample `x` using `coeffs`, while using
|
||||
* and updating `state`. They return the corresponding output sample.
|
||||
@ -156,9 +201,16 @@ static inline float bw_satur_process1_comp(const bw_satur_coeffs *BW_RESTRICT co
|
||||
* * `bw_satur_process1()` assumes that gain compensation is disabled;
|
||||
* * `bw_satur_process1_comp()` assumes that gain compensation is enabled.
|
||||
*
|
||||
* The actual gain compensation parameter value is ignored.
|
||||
*
|
||||
* #### bw_satur_process()
|
||||
* ```>>> */
|
||||
static inline void bw_satur_process(bw_satur_coeffs *BW_RESTRICT coeffs, bw_satur_state *BW_RESTRICT state, const float *x, float *y, size_t n_samples);
|
||||
static inline void bw_satur_process(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
bw_satur_state * BW_RESTRICT state,
|
||||
const float * x,
|
||||
float * y,
|
||||
size_t 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
|
||||
@ -166,7 +218,13 @@ static inline void bw_satur_process(bw_satur_coeffs *BW_RESTRICT coeffs, bw_satu
|
||||
*
|
||||
* #### bw_satur_process_multi()
|
||||
* ```>>> */
|
||||
static inline void bw_satur_process_multi(bw_satur_coeffs *BW_RESTRICT coeffs, bw_satur_state *BW_RESTRICT const *BW_RESTRICT state, const float * const *x, float * const *y, size_t n_channels, size_t n_samples);
|
||||
static inline void bw_satur_process_multi(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
bw_satur_state * BW_RESTRICT const * BW_RESTRICT state,
|
||||
const float * const * x,
|
||||
float * const * y,
|
||||
size_t n_channels,
|
||||
size_t n_samples);
|
||||
/*! <<<```
|
||||
* Processes the first `n_samples` of the `n_channels` input buffers `x` and
|
||||
* fills the first `n_samples` of the `n_channels` output buffers `y`, while
|
||||
@ -175,30 +233,66 @@ static inline void bw_satur_process_multi(bw_satur_coeffs *BW_RESTRICT coeffs, b
|
||||
*
|
||||
* #### bw_satur_set_bias()
|
||||
* ```>>> */
|
||||
static inline void bw_satur_set_bias(bw_satur_coeffs *BW_RESTRICT coeffs, float value);
|
||||
static inline void bw_satur_set_bias(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
float value);
|
||||
/*! <<<```
|
||||
* Sets the input bias `value` in `coeffs`.
|
||||
*
|
||||
* Valid range: [`-1e12f`, `1e12f`].
|
||||
*
|
||||
* Default value: `0.f`.
|
||||
*
|
||||
* #### bw_satur_set_gain()
|
||||
* ```>>> */
|
||||
static inline void bw_satur_set_gain(bw_satur_coeffs *BW_RESTRICT coeffs, float value);
|
||||
static inline void bw_satur_set_gain(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
float value);
|
||||
/*! <<<```
|
||||
* Sets the gain `value` in `coeffs`.
|
||||
*
|
||||
* Do not set it to `0.f`, obviously.
|
||||
* Valid range: [`1e-12f`, `1e12f`].
|
||||
*
|
||||
* Default value: `1.f`.
|
||||
*
|
||||
* #### bw_satur_set_gain_compensation()
|
||||
* ```>>> */
|
||||
static inline void bw_satur_set_gain_compensation(bw_satur_coeffs *BW_RESTRICT coeffs, char value);
|
||||
static inline void bw_satur_set_gain_compensation(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
char value);
|
||||
/*! <<<```
|
||||
* Sets whether the output should be divided by gain (`value` non-`0`) or not
|
||||
* (`0`).
|
||||
*
|
||||
* Default value: `0` (off).
|
||||
*
|
||||
* #### bw_satur_coeffs_is_valid()
|
||||
* ```>>> */
|
||||
static inline char bw_satur_coeffs_is_valid(
|
||||
const bw_satur_coeffs * BW_RESTRICT coeffs);
|
||||
/*! <<<```
|
||||
* Tries to determine whether `coeffs` is valid and returns non-`0` if it
|
||||
* seems to be the case and `0` if it is certainly not. False positives are
|
||||
* possible, false negatives are not.
|
||||
*
|
||||
* `coeffs` must at least point to a readable memory block of size greater
|
||||
* than or equal to that of `bw_satur_coeffs`.
|
||||
*
|
||||
* #### bw_satur_state_is_valid()
|
||||
* ```>>> */
|
||||
static inline char bw_satur_state_is_valid(
|
||||
const bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
const bw_satur_state * BW_RESTRICT state);
|
||||
/*! <<<```
|
||||
* Tries to determine whether `state` is valid and returns non-`0` if it
|
||||
* seems to be the case and `0` if it is certainly not. False positives are
|
||||
* possible, false negatives are not.
|
||||
*
|
||||
* If `coeffs` is not `NULL` extra cross-checks might be performed (`state`
|
||||
* is supposed to be associated to `coeffs`).
|
||||
*
|
||||
* `state` must at least point to a readable memory block of size greater
|
||||
* than or equal to that of `bw_satur_state`.
|
||||
* }}} */
|
||||
|
||||
#ifdef __cplusplus
|
||||
@ -217,48 +311,96 @@ static inline void bw_satur_set_gain_compensation(bw_satur_coeffs *BW_RESTRICT c
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#ifdef BW_DEBUG_DEEP
|
||||
enum bw_satur_coeffs_state {
|
||||
bw_satur_coeffs_state_invalid,
|
||||
bw_satur_coeffs_state_init,
|
||||
bw_satur_coeffs_state_set_sample_rate,
|
||||
bw_satur_coeffs_state_reset_coeffs
|
||||
};
|
||||
#endif
|
||||
|
||||
struct bw_satur_coeffs {
|
||||
#ifdef BW_DEBUG_DEEP
|
||||
uint32_t hash;
|
||||
enum bw_satur_coeffs_state state;
|
||||
uint32_t reset_id;
|
||||
#endif
|
||||
|
||||
// Sub-components
|
||||
bw_one_pole_coeffs smooth_coeffs;
|
||||
bw_one_pole_state smooth_bias_state;
|
||||
bw_one_pole_state smooth_gain_state;
|
||||
|
||||
bw_one_pole_coeffs smooth_coeffs;
|
||||
bw_one_pole_state smooth_bias_state;
|
||||
bw_one_pole_state smooth_gain_state;
|
||||
|
||||
// Coefficients
|
||||
float bias_dc;
|
||||
float inv_gain;
|
||||
float bias_dc;
|
||||
float inv_gain;
|
||||
|
||||
// Parameters
|
||||
float bias;
|
||||
float gain;
|
||||
char gain_compensation;
|
||||
float bias;
|
||||
float gain;
|
||||
char gain_compensation;
|
||||
};
|
||||
|
||||
struct bw_satur_state {
|
||||
float x_z1;
|
||||
float F_z1;
|
||||
#ifdef BW_DEBUG_DEEP
|
||||
uint32_t hash;
|
||||
uint32_t coeffs_reset_id;
|
||||
#endif
|
||||
|
||||
// States
|
||||
float x_z1;
|
||||
float F_z1;
|
||||
};
|
||||
|
||||
static inline float bw_satur_tanhf(float x) {
|
||||
static inline float bw_satur_tanhf(
|
||||
float x) {
|
||||
const float xm = bw_clipf(x, -2.115287308554551f, 2.115287308554551f);
|
||||
const float axm = bw_absf(xm);
|
||||
return xm * axm * (0.01218073260037716f * axm - 0.2750231331124371f) + xm;
|
||||
}
|
||||
|
||||
static inline void bw_satur_init(bw_satur_coeffs *BW_RESTRICT coeffs) {
|
||||
static inline void bw_satur_init(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs) {
|
||||
BW_ASSERT(coeffs != NULL);
|
||||
|
||||
bw_one_pole_init(&coeffs->smooth_coeffs);
|
||||
bw_one_pole_set_tau(&coeffs->smooth_coeffs, 0.005f);
|
||||
bw_one_pole_set_sticky_thresh(&coeffs->smooth_coeffs, 1e-3f);
|
||||
coeffs->bias = 0.f;
|
||||
coeffs->gain = 1.f;
|
||||
coeffs->gain_compensation = 0;
|
||||
|
||||
#ifdef BW_DEBUG_DEEP
|
||||
coeffs->hash = bw_hash_sdbm("bw_satur_coeffs");
|
||||
coeffs->state = bw_satur_coeffs_state_init;
|
||||
coeffs->reset_id = coeffs->hash + 1;
|
||||
#endif
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state == bw_satur_coeffs_state_init);
|
||||
}
|
||||
|
||||
static inline void bw_satur_set_sample_rate(bw_satur_coeffs *BW_RESTRICT coeffs, float sample_rate) {
|
||||
static inline void bw_satur_set_sample_rate(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
float sample_rate) {
|
||||
BW_ASSERT(coeffs != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_init);
|
||||
BW_ASSERT(bw_is_finite(sample_rate) && sample_rate > 0.f);
|
||||
|
||||
bw_one_pole_set_sample_rate(&coeffs->smooth_coeffs, sample_rate);
|
||||
bw_one_pole_reset_coeffs(&coeffs->smooth_coeffs);
|
||||
|
||||
#ifdef BW_DEBUG_DEEP
|
||||
coeffs->state = bw_satur_coeffs_state_set_sample_rate;
|
||||
#endif
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state == bw_satur_coeffs_state_set_sample_rate);
|
||||
}
|
||||
|
||||
static inline void bw_satur_do_update_coeffs(bw_satur_coeffs *BW_RESTRICT coeffs, char force) {
|
||||
static inline void bw_satur_do_update_coeffs(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
char force) {
|
||||
float bias_cur = bw_one_pole_get_y_z1(&coeffs->smooth_bias_state);
|
||||
if (force || coeffs->bias != bias_cur) {
|
||||
bias_cur = bw_one_pole_process1_sticky_abs(&coeffs->smooth_coeffs, &coeffs->smooth_bias_state, coeffs->bias);
|
||||
@ -271,43 +413,163 @@ static inline void bw_satur_do_update_coeffs(bw_satur_coeffs *BW_RESTRICT coeffs
|
||||
}
|
||||
}
|
||||
|
||||
static inline void bw_satur_reset_coeffs(bw_satur_coeffs *BW_RESTRICT coeffs) {
|
||||
static inline void bw_satur_reset_coeffs(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs) {
|
||||
BW_ASSERT(coeffs != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_set_sample_rate);
|
||||
|
||||
bw_one_pole_reset_state(&coeffs->smooth_coeffs, &coeffs->smooth_bias_state, coeffs->bias);
|
||||
bw_one_pole_reset_state(&coeffs->smooth_coeffs, &coeffs->smooth_gain_state, coeffs->gain);
|
||||
bw_satur_do_update_coeffs(coeffs, 1);
|
||||
|
||||
#ifdef BW_DEBUG_DEEP
|
||||
coeffs->state = bw_satur_coeffs_state_reset_coeffs;
|
||||
coeffs->reset_id++;
|
||||
#endif
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state == bw_satur_coeffs_state_reset_coeffs);
|
||||
}
|
||||
|
||||
static inline void bw_satur_reset_state(const bw_satur_coeffs *BW_RESTRICT coeffs, bw_satur_state *BW_RESTRICT state) {
|
||||
state->x_z1 = bw_one_pole_get_y_z1(&coeffs->smooth_bias_state);
|
||||
const float ax = bw_absf(state->x_z1);
|
||||
state->F_z1 = ax >= 2.115287308554551f ? ax - 0.6847736211329452f : ax * ax * ((0.00304518315009429f * ax - 0.09167437770414569f) * ax + 0.5f);
|
||||
static inline float bw_satur_reset_state(
|
||||
const bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
bw_satur_state * BW_RESTRICT state,
|
||||
float x_0) {
|
||||
BW_ASSERT(coeffs != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_reset_coeffs);
|
||||
BW_ASSERT(state != NULL);
|
||||
BW_ASSERT(bw_is_finite(x_0));
|
||||
|
||||
const float x = bw_one_pole_get_y_z1(&coeffs->smooth_gain_state) * x_0 + bw_one_pole_get_y_z1(&coeffs->smooth_bias_state);
|
||||
const float ax = bw_absf(x);
|
||||
const float F = ax >= 2.115287308554551f ? ax - 0.6847736211329452f : ax * ax * ((0.00304518315009429f * ax - 0.09167437770414569f) * ax + 0.5f);
|
||||
const float yb = bw_satur_tanhf(x);
|
||||
const float y = yb - coeffs->bias_dc;
|
||||
state->x_z1 = x;
|
||||
state->F_z1 = F;
|
||||
|
||||
#ifdef BW_DEBUG_DEEP
|
||||
state->hash = bw_hash_sdbm("bw_satur_state");
|
||||
state->coeffs_reset_id = coeffs->reset_id;
|
||||
#endif
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_reset_coeffs);
|
||||
BW_ASSERT_DEEP(bw_satur_state_is_valid(coeffs, state));
|
||||
BW_ASSERT(bw_is_finite(y));
|
||||
|
||||
return y;
|
||||
}
|
||||
|
||||
static inline void bw_satur_update_coeffs_ctrl(bw_satur_coeffs *BW_RESTRICT coeffs) {
|
||||
static inline void bw_satur_reset_state_multi(
|
||||
const bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
bw_satur_state * BW_RESTRICT const * BW_RESTRICT state,
|
||||
const float * x_0,
|
||||
float * y_0,
|
||||
size_t n_channels) {
|
||||
BW_ASSERT(coeffs != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_reset_coeffs);
|
||||
BW_ASSERT(state != NULL);
|
||||
BW_ASSERT(x_0 != NULL);
|
||||
|
||||
if (y_0 != NULL)
|
||||
for (size_t i = 0; i < n_channels; i++)
|
||||
y_0[i] = bw_satur_reset_state(coeffs, state[i], x_0[i]);
|
||||
else
|
||||
for (size_t i = 0; i < n_channels; i++)
|
||||
bw_satur_reset_state(coeffs, state[i], x_0[i]);
|
||||
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_reset_coeffs);
|
||||
BW_ASSERT_DEEP(y_0 != NULL ? bw_has_only_finite(y_0, n_channels) : 1);
|
||||
}
|
||||
|
||||
static inline void bw_satur_update_coeffs_ctrl(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs) {
|
||||
BW_ASSERT(coeffs != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_reset_coeffs);
|
||||
|
||||
(void)coeffs;
|
||||
}
|
||||
|
||||
static inline void bw_satur_update_coeffs_audio(bw_satur_coeffs *BW_RESTRICT coeffs) {
|
||||
static inline void bw_satur_update_coeffs_audio(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs) {
|
||||
BW_ASSERT(coeffs != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_reset_coeffs);
|
||||
|
||||
bw_satur_do_update_coeffs(coeffs, 0);
|
||||
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_reset_coeffs);
|
||||
}
|
||||
|
||||
static inline float bw_satur_process1(const bw_satur_coeffs *BW_RESTRICT coeffs, bw_satur_state *BW_RESTRICT state, float x) {
|
||||
static inline float bw_satur_process1(
|
||||
const bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
bw_satur_state * BW_RESTRICT state,
|
||||
float x) {
|
||||
BW_ASSERT(coeffs != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_reset_coeffs);
|
||||
BW_ASSERT(state != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_state_is_valid(coeffs, state));
|
||||
BW_ASSERT(bw_is_finite(x));
|
||||
|
||||
x = bw_one_pole_get_y_z1(&coeffs->smooth_gain_state) * x + bw_one_pole_get_y_z1(&coeffs->smooth_bias_state);
|
||||
const float ax = bw_absf(x);
|
||||
const float F = ax >= 2.115287308554551f ? ax - 0.6847736211329452f : ax * ax * ((0.00304518315009429f * ax - 0.09167437770414569f) * ax + 0.5f);
|
||||
const float d = x - state->x_z1;
|
||||
const float y = d * d < 1e-6f ? bw_satur_tanhf(0.5f * (x + state->x_z1)) : (F - state->F_z1) * bw_rcpf(d);
|
||||
const float yb = d * d < 1e-6f ? bw_satur_tanhf(0.5f * (x + state->x_z1)) : (F - state->F_z1) * bw_rcpf(d);
|
||||
const float y = yb - coeffs->bias_dc;
|
||||
state->x_z1 = x;
|
||||
state->F_z1 = F;
|
||||
return y - coeffs->bias_dc;
|
||||
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_reset_coeffs);
|
||||
BW_ASSERT_DEEP(bw_satur_state_is_valid(coeffs, state));
|
||||
BW_ASSERT(bw_is_finite(y));
|
||||
|
||||
return y;
|
||||
}
|
||||
|
||||
static inline float bw_satur_process1_comp(const bw_satur_coeffs *BW_RESTRICT coeffs, bw_satur_state *BW_RESTRICT state, float x) {
|
||||
float y = bw_satur_process1(coeffs, state, x);
|
||||
return coeffs->inv_gain * y;
|
||||
static inline float bw_satur_process1_comp(
|
||||
const bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
bw_satur_state * BW_RESTRICT state,
|
||||
float x) {
|
||||
BW_ASSERT(coeffs != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_reset_coeffs);
|
||||
BW_ASSERT(state != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_state_is_valid(coeffs, state));
|
||||
BW_ASSERT(bw_is_finite(x));
|
||||
|
||||
const float y = coeffs->inv_gain * bw_satur_process1(coeffs, state, x);
|
||||
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_reset_coeffs);
|
||||
BW_ASSERT_DEEP(bw_satur_state_is_valid(coeffs, state));
|
||||
BW_ASSERT(bw_is_finite(y));
|
||||
|
||||
return y;
|
||||
}
|
||||
|
||||
static inline void bw_satur_process(bw_satur_coeffs *BW_RESTRICT coeffs, bw_satur_state *BW_RESTRICT state, const float *x, float *y, size_t n_samples) {
|
||||
static inline void bw_satur_process(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
bw_satur_state * BW_RESTRICT state,
|
||||
const float * x,
|
||||
float * y,
|
||||
size_t n_samples) {
|
||||
BW_ASSERT(coeffs != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_reset_coeffs);
|
||||
BW_ASSERT(state != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_state_is_valid(coeffs, state));
|
||||
BW_ASSERT(x != NULL);
|
||||
BW_ASSERT_DEEP(bw_has_only_finite(x, n_samples));
|
||||
BW_ASSERT(y != NULL);
|
||||
|
||||
if (coeffs->gain_compensation)
|
||||
for (size_t i = 0; i < n_samples; i++) {
|
||||
bw_satur_update_coeffs_audio(coeffs);
|
||||
@ -318,27 +580,133 @@ static inline void bw_satur_process(bw_satur_coeffs *BW_RESTRICT coeffs, bw_satu
|
||||
bw_satur_update_coeffs_audio(coeffs);
|
||||
y[i] = bw_satur_process1(coeffs, state, x[i]);
|
||||
}
|
||||
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_reset_coeffs);
|
||||
BW_ASSERT_DEEP(bw_satur_state_is_valid(coeffs, state));
|
||||
BW_ASSERT_DEEP(bw_has_only_finite(y, n_samples));
|
||||
}
|
||||
|
||||
static inline void bw_satur_process_multi(bw_satur_coeffs *BW_RESTRICT coeffs, bw_satur_state *BW_RESTRICT const *BW_RESTRICT state, const float * const *x, float * const *y, size_t n_channels, size_t n_samples) {
|
||||
static inline void bw_satur_process_multi(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
bw_satur_state * BW_RESTRICT const * BW_RESTRICT state,
|
||||
const float * const * x,
|
||||
float * const * y,
|
||||
size_t n_channels,
|
||||
size_t n_samples) {
|
||||
BW_ASSERT(coeffs != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_reset_coeffs);
|
||||
BW_ASSERT(state != NULL);
|
||||
BW_ASSERT(x != NULL);
|
||||
BW_ASSERT(y != NULL);
|
||||
|
||||
bw_satur_update_coeffs_ctrl(coeffs);
|
||||
for (size_t i = 0; i < n_samples; i++) {
|
||||
bw_satur_update_coeffs_audio(coeffs);
|
||||
for (size_t j = 0; j < n_channels; j++)
|
||||
y[j][i] = bw_satur_process1(coeffs, state[j], x[j][i]);
|
||||
}
|
||||
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_reset_coeffs);
|
||||
}
|
||||
|
||||
static inline void bw_satur_set_bias(bw_satur_coeffs *BW_RESTRICT coeffs, float value) {
|
||||
static inline void bw_satur_set_bias(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
float value) {
|
||||
BW_ASSERT(coeffs != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_init);
|
||||
BW_ASSERT(bw_is_finite(value));
|
||||
BW_ASSERT(value >= -1e12f && value <= 1e12f);
|
||||
|
||||
coeffs->bias = value;
|
||||
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_init);
|
||||
}
|
||||
|
||||
static inline void bw_satur_set_gain(bw_satur_coeffs *BW_RESTRICT coeffs, float value) {
|
||||
static inline void bw_satur_set_gain(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
float value) {
|
||||
BW_ASSERT(coeffs != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_init);
|
||||
BW_ASSERT(bw_is_finite(value));
|
||||
BW_ASSERT(value >= 1e-12f && value <= 1e12f);
|
||||
|
||||
coeffs->gain = value;
|
||||
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_init);
|
||||
}
|
||||
|
||||
static inline void bw_satur_set_gain_compensation(bw_satur_coeffs *BW_RESTRICT coeffs, char value) {
|
||||
static inline void bw_satur_set_gain_compensation(
|
||||
bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
char value) {
|
||||
BW_ASSERT(coeffs != NULL);
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_init);
|
||||
|
||||
coeffs->gain_compensation = value;
|
||||
|
||||
BW_ASSERT_DEEP(bw_satur_coeffs_is_valid(coeffs));
|
||||
BW_ASSERT_DEEP(coeffs->state >= bw_satur_coeffs_state_init);
|
||||
}
|
||||
|
||||
static inline char bw_satur_coeffs_is_valid(
|
||||
const bw_satur_coeffs * BW_RESTRICT coeffs) {
|
||||
BW_ASSERT(coeffs != NULL);
|
||||
|
||||
#ifdef BW_DEBUG_DEEP
|
||||
if (coeffs->hash != bw_hash_sdbm("bw_satur_coeffs"))
|
||||
return 0;
|
||||
if (coeffs->state < bw_satur_coeffs_state_init || coeffs->state > bw_satur_coeffs_state_reset_coeffs)
|
||||
return 0;
|
||||
#endif
|
||||
|
||||
if (!bw_is_finite(coeffs->bias) || coeffs->bias < -1e12f || coeffs->bias > 1e12f)
|
||||
return 0;
|
||||
if (!bw_is_finite(coeffs->gain) || coeffs->gain < 1e-12f || coeffs->gain > 1e12f)
|
||||
return 0;
|
||||
|
||||
if (!bw_one_pole_coeffs_is_valid(&coeffs->smooth_coeffs))
|
||||
return 0;
|
||||
|
||||
#ifdef BW_DEBUG_DEEP
|
||||
if (coeffs->state >= bw_satur_coeffs_state_reset_coeffs) {
|
||||
if (!bw_one_pole_state_is_valid(&coeffs->smooth_coeffs, &coeffs->smooth_bias_state))
|
||||
return 0;
|
||||
if (!bw_one_pole_state_is_valid(&coeffs->smooth_coeffs, &coeffs->smooth_gain_state))
|
||||
return 0;
|
||||
|
||||
if (!bw_is_finite(coeffs->bias_dc) || coeffs->bias_dc < -1.f || coeffs->bias_dc > 1.f)
|
||||
return 0;
|
||||
if (!bw_is_finite(coeffs->inv_gain) || coeffs->inv_gain <= 0.f)
|
||||
return 0;
|
||||
}
|
||||
#endif
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
static inline char bw_satur_state_is_valid(
|
||||
const bw_satur_coeffs * BW_RESTRICT coeffs,
|
||||
const bw_satur_state * BW_RESTRICT state) {
|
||||
BW_ASSERT(state != NULL);
|
||||
|
||||
#ifdef BW_DEBUG_DEEP
|
||||
if (state->hash != bw_hash_sdbm("bw_satur_state"))
|
||||
return 0;
|
||||
|
||||
if (coeffs != NULL && coeffs->reset_id != state->coeffs_reset_id)
|
||||
return 0;
|
||||
#endif
|
||||
|
||||
(void)coeffs;
|
||||
|
||||
return bw_is_finite(state->x_z1) && bw_is_finite(state->F_z1);
|
||||
}
|
||||
|
||||
#ifdef __cplusplus
|
||||
@ -358,20 +726,43 @@ class Satur {
|
||||
public:
|
||||
Satur();
|
||||
|
||||
void setSampleRate(float sampleRate);
|
||||
void reset();
|
||||
void setSampleRate(
|
||||
float sampleRate);
|
||||
|
||||
void reset(
|
||||
float x0 = 0.f,
|
||||
float * BW_RESTRICT y0 = nullptr);
|
||||
|
||||
void reset(
|
||||
float x0,
|
||||
std::array<float, N_CHANNELS> * BW_RESTRICT y0);
|
||||
|
||||
void reset(
|
||||
const float * x0,
|
||||
float * y0 = nullptr);
|
||||
|
||||
void reset(
|
||||
std::array<float, N_CHANNELS> x0,
|
||||
std::array<float, N_CHANNELS> * BW_RESTRICT y0 = nullptr);
|
||||
|
||||
void process(
|
||||
const float * const *x,
|
||||
float * const *y,
|
||||
size_t nSamples);
|
||||
const float * const * x,
|
||||
float * const * y,
|
||||
size_t nSamples);
|
||||
|
||||
void process(
|
||||
std::array<const float *, N_CHANNELS> x,
|
||||
std::array<float *, N_CHANNELS> y,
|
||||
size_t nSamples);
|
||||
std::array<float *, N_CHANNELS> y,
|
||||
size_t nSamples);
|
||||
|
||||
void setBias(float value);
|
||||
void setGain(float value);
|
||||
void setGainCompensation(bool value);
|
||||
void setBias(
|
||||
float value);
|
||||
|
||||
void setGain(
|
||||
float value);
|
||||
|
||||
void setGainCompensation(
|
||||
bool value);
|
||||
/*! <<<...
|
||||
* }
|
||||
* ```
|
||||
@ -383,9 +774,9 @@ public:
|
||||
* change at any time in future versions. Please, do not use it directly. */
|
||||
|
||||
private:
|
||||
bw_satur_coeffs coeffs;
|
||||
bw_satur_state states[N_CHANNELS];
|
||||
bw_satur_state *BW_RESTRICT statesP[N_CHANNELS];
|
||||
bw_satur_coeffs coeffs;
|
||||
bw_satur_state states[N_CHANNELS];
|
||||
bw_satur_state * BW_RESTRICT statesP[N_CHANNELS];
|
||||
};
|
||||
|
||||
template<size_t N_CHANNELS>
|
||||
@ -396,45 +787,77 @@ inline Satur<N_CHANNELS>::Satur() {
|
||||
}
|
||||
|
||||
template<size_t N_CHANNELS>
|
||||
inline void Satur<N_CHANNELS>::setSampleRate(float sampleRate) {
|
||||
inline void Satur<N_CHANNELS>::setSampleRate(
|
||||
float sampleRate) {
|
||||
bw_satur_set_sample_rate(&coeffs, sampleRate);
|
||||
}
|
||||
|
||||
template<size_t N_CHANNELS>
|
||||
inline void Satur<N_CHANNELS>::reset() {
|
||||
inline void Satur<N_CHANNELS>::reset(
|
||||
float x0,
|
||||
float * BW_RESTRICT y0) {
|
||||
bw_satur_reset_coeffs(&coeffs);
|
||||
for (size_t i = 0; i < N_CHANNELS; i++)
|
||||
bw_satur_reset_state(&coeffs, states + i);
|
||||
if (y0 != nullptr)
|
||||
for (size_t i = 0; i < N_CHANNELS; i++)
|
||||
y0[i] = bw_satur_reset_state(&coeffs, states + i, x0);
|
||||
else
|
||||
for (size_t i = 0; i < N_CHANNELS; i++)
|
||||
bw_satur_reset_state(&coeffs, states + i, x0);
|
||||
}
|
||||
|
||||
template<size_t N_CHANNELS>
|
||||
inline void Satur<N_CHANNELS>::reset(
|
||||
float x0,
|
||||
std::array<float, N_CHANNELS> * BW_RESTRICT y0) {
|
||||
reset(x0, y0 != nullptr ? y0->data() : nullptr);
|
||||
}
|
||||
|
||||
template<size_t N_CHANNELS>
|
||||
inline void Satur<N_CHANNELS>::reset(
|
||||
const float * x0,
|
||||
float * y0) {
|
||||
bw_satur_reset_coeffs(&coeffs);
|
||||
bw_satur_reset_state_multi(&coeffs, statesP, x0, y0, N_CHANNELS);
|
||||
}
|
||||
|
||||
template<size_t N_CHANNELS>
|
||||
inline void Satur<N_CHANNELS>::reset(
|
||||
std::array<float, N_CHANNELS> x0,
|
||||
std::array<float, N_CHANNELS> * BW_RESTRICT y0) {
|
||||
reset(x0.data(), y0 != nullptr ? y0->data() : nullptr);
|
||||
}
|
||||
|
||||
template<size_t N_CHANNELS>
|
||||
inline void Satur<N_CHANNELS>::process(
|
||||
const float * const *x,
|
||||
float * const *y,
|
||||
size_t nSamples) {
|
||||
const float * const * x,
|
||||
float * const * y,
|
||||
size_t nSamples) {
|
||||
bw_satur_process_multi(&coeffs, statesP, x, y, N_CHANNELS, nSamples);
|
||||
}
|
||||
|
||||
template<size_t N_CHANNELS>
|
||||
inline void Satur<N_CHANNELS>::process(
|
||||
std::array<const float *, N_CHANNELS> x,
|
||||
std::array<float *, N_CHANNELS> y,
|
||||
size_t nSamples) {
|
||||
std::array<float *, N_CHANNELS> y,
|
||||
size_t nSamples) {
|
||||
process(x.data(), y.data(), nSamples);
|
||||
}
|
||||
|
||||
template<size_t N_CHANNELS>
|
||||
inline void Satur<N_CHANNELS>::setBias(float value) {
|
||||
inline void Satur<N_CHANNELS>::setBias(
|
||||
float value) {
|
||||
bw_satur_set_bias(&coeffs, value);
|
||||
}
|
||||
|
||||
template<size_t N_CHANNELS>
|
||||
inline void Satur<N_CHANNELS>::setGain(float value) {
|
||||
inline void Satur<N_CHANNELS>::setGain(
|
||||
float value) {
|
||||
bw_satur_set_gain(&coeffs, value);
|
||||
}
|
||||
|
||||
template<size_t N_CHANNELS>
|
||||
inline void Satur<N_CHANNELS>::setGainCompensation(bool value) {
|
||||
inline void Satur<N_CHANNELS>::setGainCompensation(
|
||||
bool value) {
|
||||
bw_satur_set_gain_compensation(&coeffs, value);
|
||||
}
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user