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

finalized bw_mm2 + examples

Browse Source
This commit is contained in:
Stefano D'Angelo 2023-09-08 22:21:08 +02:00
parent 04b027f564
commit d50e7536d5
3 changed files with 548 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
examples/fx_mm2/vst3/Makefile
View File

@ -4,3 +4,6 @@ NAME := bw_example_fx_mm2
SOURCES = ${SOURCES_COMMON} ${ROOT_DIR}/../src/bw_example_fx_mm2.c
include ${ROOT_DIR}/../../common/vst3/vst3.mk
CXXFLAGS += -DRELEASE=1 -DNDEBUG -DBW_NO_DEBUG
#CXXFLAGS += -DDEVELOPMENT=1 -DBW_DEBUG_DEEP

3
examples/fxpp_mm2/vst3/Makefile
View File

@ -4,3 +4,6 @@ NAME := bw_example_fxpp_mm2
SOURCES = ${SOURCES_COMMON} ${ROOT_DIR}/../src/bw_example_fxpp_mm2.cpp
include ${ROOT_DIR}/../../common/vst3/vst3.mk
CXXFLAGS += -DRELEASE=1 -DNDEBUG -DBW_NO_DEBUG
#CXXFLAGS += -DDEVELOPMENT=1 -DBW_DEBUG_DEEP

620
include/bw_mm2.h
View File

@ -29,6 +29,12 @@
* <ul>
* <li>Version <strong>1.0.0</strong>:
* <ul>
* <li>Added <code>bw_mm2_reset_state_multi()</code> and updated C++
* API in this regard.</li>
* <li>Now <code>bw_mm2_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_mm2_process()</code> and
* <code>bw_mm2_process_multi()</code> now use <code>size_t</code>
* to count samples and channels.</li>
@ -38,6 +44,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>:
@ -90,51 +98,86 @@ typedef struct bw_mm2_state bw_mm2_state;
*
* #### bw_mm2_init()
* ```>>> */
static inline void bw_mm2_init(bw_mm2_coeffs *BW_RESTRICT coeffs);
static inline void bw_mm2_init(
bw_mm2_coeffs * BW_RESTRICT coeffs);
/*! <<<```
* Initializes input parameter values in `coeffs`.
*
* #### bw_mm2_set_sample_rate()
* ```>>> */
static inline void bw_mm2_set_sample_rate(bw_mm2_coeffs *BW_RESTRICT coeffs, float sample_rate);
static inline void bw_mm2_set_sample_rate(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float sample_rate);
/*! <<<```
* Sets the `sample_rate` (Hz) value in `coeffs`.
*
* #### bw_mm2_reset_coeffs()
* ```>>> */
static inline void bw_mm2_reset_coeffs(bw_mm2_coeffs *BW_RESTRICT coeffs);
static inline void bw_mm2_reset_coeffs(
bw_mm2_coeffs * BW_RESTRICT coeffs);
/*! <<<```
* Resets coefficients in `coeffs` to assume their target values.
*
* #### bw_mm2_reset_state()
* ```>>> */
static inline void bw_mm2_reset_state(const bw_mm2_coeffs *BW_RESTRICT coeffs, bw_mm2_state *BW_RESTRICT state, float x_0);
static inline float bw_mm2_reset_state(
const bw_mm2_coeffs * BW_RESTRICT coeffs,
bw_mm2_state * BW_RESTRICT state,
float x_0);
/*! <<<```
* Resets the given `state` to its initial values using the given `coeffs`
* and the quiescent/initial input value `x_0`.
*
* Returns the corresponding quiescent/initial output value.
*
* #### bw_mm2_reset_state_multi()
* ```>>> */
static inline void bw_mm2_reset_state_multi(
const bw_mm2_coeffs * BW_RESTRICT coeffs,
bw_mm2_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 quiescent/initial input value in the
* `x_0` array.
*
* The corresponding quiescent/initial output values are written into the
* `y_0` array, if not `NULL`.
*
* #### bw_mm2_update_coeffs_ctrl()
* ```>>> */
static inline void bw_mm2_update_coeffs_ctrl(bw_mm2_coeffs *BW_RESTRICT coeffs);
static inline void bw_mm2_update_coeffs_ctrl(
bw_mm2_coeffs * BW_RESTRICT coeffs);
/*! <<<```
* Triggers control-rate update of coefficients in `coeffs`.
*
* #### bw_mm2_update_coeffs_audio()
* ```>>> */
static inline void bw_mm2_update_coeffs_audio(bw_mm2_coeffs *BW_RESTRICT coeffs);
static inline void bw_mm2_update_coeffs_audio(
bw_mm2_coeffs * BW_RESTRICT coeffs);
/*! <<<```
* Triggers audio-rate update of coefficients in `coeffs`.
*
* #### bw_mm2_process1()
* ```>>> */
static inline float bw_mm2_process1(const bw_mm2_coeffs *BW_RESTRICT coeffs, bw_mm2_state *BW_RESTRICT state, float x);
static inline float bw_mm2_process1(
const bw_mm2_coeffs * BW_RESTRICT coeffs,
bw_mm2_state * BW_RESTRICT state,
float x);
/*! <<<```
* Processes one input sample `x` using `coeffs`, while using and updating
* `state`. Returns the corresponding output sample.
*
* #### bw_mm2_process()
* ```>>> */
static inline void bw_mm2_process(bw_mm2_coeffs *BW_RESTRICT coeffs, bw_mm2_state *BW_RESTRICT state, const float *x, float *y, size_t n_samples);
static inline void bw_mm2_process(
bw_mm2_coeffs * BW_RESTRICT coeffs,
bw_mm2_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
@ -142,7 +185,13 @@ static inline void bw_mm2_process(bw_mm2_coeffs *BW_RESTRICT coeffs, bw_mm2_stat
*
* #### bw_mm2_process_multi()
* ```>>> */
static inline void bw_mm2_process_multi(bw_mm2_coeffs *BW_RESTRICT coeffs, bw_mm2_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_mm2_process_multi(
bw_mm2_coeffs * BW_RESTRICT coeffs,
bw_mm2_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
@ -151,25 +200,33 @@ static inline void bw_mm2_process_multi(bw_mm2_coeffs *BW_RESTRICT coeffs, bw_mm
*
* #### bw_mm2_set_cutoff()
* ```>>> */
static inline void bw_mm2_set_cutoff(bw_mm2_coeffs *BW_RESTRICT coeffs, float value);
static inline void bw_mm2_set_cutoff(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float value);
/*! <<<```
* Sets the cutoff frequency `value` (Hz) in `coeffs`.
*
* Valid range: [`1e-6f`, `1e12f`].
*
* Default value: `1e3f`.
*
* #### bw_mm2_set_Q()
* ```>>> */
static inline void bw_mm2_set_Q(bw_mm2_coeffs *BW_RESTRICT coeffs, float value);
static inline void bw_mm2_set_Q(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float value);
/*! <<<```
* Sets the quality factor to the given `value` in `coeffs`.
*
* `value` must be equal or bigger than `0.5f`.
* Valid range: [`1e-6f`, `1e6f`].
*
* Default value: `0.5f`.
*
* #### bw_mm2_set_prewarp_at_cutoff()
* ```>>> */
static inline void bw_mm2_set_prewarp_at_cutoff(bw_mm2_coeffs *BW_RESTRICT coeffs, char value);
static inline void bw_mm2_set_prewarp_at_cutoff(
bw_mm2_coeffs * BW_RESTRICT coeffs,
char value);
/*! <<<```
* Sets whether bilinear transform prewarping frequency should match the
* cutoff frequency (non-`0`) or not (`0`).
@ -178,45 +235,94 @@ static inline void bw_mm2_set_prewarp_at_cutoff(bw_mm2_coeffs *BW_RESTRICT coeff
*
* #### bw_mm2_set_prewarp_freq()
* ```>>> */
static inline void bw_mm2_set_prewarp_freq(bw_mm2_coeffs *BW_RESTRICT coeffs, float value);
static inline void bw_mm2_set_prewarp_freq(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float value);
/*! <<<```
* Sets the prewarping frequency `value` (Hz) in `coeffs`.
*
* Only used when the prewarp\_at\_cutoff parameter is off.
* Only used when the prewarp\_at\_cutoff parameter is off and however
* internally limited to avoid instability.
*
* Valid range: [`1e-6f`, `1e12f`].
*
* Default value: `1e3f`.
*
* #### bw_mm2_set_coeff_x()
* ```>>> */
static inline void bw_mm2_set_coeff_x(bw_mm2_coeffs *BW_RESTRICT coeffs, float value);
static inline void bw_mm2_set_coeff_x(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float value);
/*! <<<```
* Sets the input mode coefficient `value` in `coeffs`.
*
* `value` must be finite.
*
* Default value: `1.f`.
*
* #### bw_mm2_set_coeff_lp()
* ```>>> */
static inline void bw_mm2_set_coeff_lp(bw_mm2_coeffs *BW_RESTRICT coeffs, float value);
static inline void bw_mm2_set_coeff_lp(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float value);
/*! <<<```
* Sets the lowpass mode coefficient `value` in `coeffs`.
*
* `value` must be finite.
*
* Default value: `0.f`.
*
* #### bw_mm2_set_coeff_bp()
* ```>>> */
static inline void bw_mm2_set_coeff_bp(bw_mm2_coeffs *BW_RESTRICT coeffs, float value);
static inline void bw_mm2_set_coeff_bp(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float value);
/*! <<<```
* Sets the bandpass mode coefficient `value` in `coeffs`.
*
* `value` must be finite.
*
* Default value: `0.f`.
*
* #### bw_mm2_set_coeff_hp()
* ```>>> */
static inline void bw_mm2_set_coeff_hp(bw_mm2_coeffs *BW_RESTRICT coeffs, float value);
static inline void bw_mm2_set_coeff_hp(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float value);
/*! <<<```
* Sets the highpass mode coefficient `value` in `coeffs`.
*
* `value` must be finite.
*
* Default value: `0.f`.
*
* #### bw_mm2_coeffs_is_valid()
* ```>>> */
static inline char bw_mm2_coeffs_is_valid(
const bw_mm2_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_mm2_coeffs`.
*
* #### bw_mm2_state_is_valid()
* ```>>> */
static inline char bw_mm2_state_is_valid(
const bw_mm2_coeffs * BW_RESTRICT coeffs,
const bw_mm2_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_mm2_state`.
* }}} */
#ifdef __cplusplus
@ -235,20 +341,43 @@ static inline void bw_mm2_set_coeff_hp(bw_mm2_coeffs *BW_RESTRICT coeffs, float
extern "C" {
#endif
#ifdef BW_DEBUG_DEEP
enum bw_mm2_coeffs_state {
bw_mm2_coeffs_state_invalid,
bw_mm2_coeffs_state_init,
bw_mm2_coeffs_state_set_sample_rate,
bw_mm2_coeffs_state_reset_coeffs
};
#endif
struct bw_mm2_coeffs {
#ifdef BW_DEBUG_DEEP
uint32_t hash;
enum bw_mm2_coeffs_state state;
uint32_t reset_id;
#endif
// Sub-components
bw_svf_coeffs svf_coeffs;
bw_gain_coeffs gain_x_coeffs;
bw_gain_coeffs gain_lp_coeffs;
bw_gain_coeffs gain_bp_coeffs;
bw_gain_coeffs gain_hp_coeffs;
bw_svf_coeffs svf_coeffs;
bw_gain_coeffs gain_x_coeffs;
bw_gain_coeffs gain_lp_coeffs;
bw_gain_coeffs gain_bp_coeffs;
bw_gain_coeffs gain_hp_coeffs;
};
struct bw_mm2_state {
#ifdef BW_DEBUG_DEEP
uint32_t hash;
uint32_t coeffs_reset_id;
#endif
bw_svf_state svf_state;
};
static inline void bw_mm2_init(bw_mm2_coeffs *BW_RESTRICT coeffs) {
static inline void bw_mm2_init(
bw_mm2_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != NULL);
bw_svf_init(&coeffs->svf_coeffs);
bw_gain_init(&coeffs->gain_x_coeffs);
bw_gain_init(&coeffs->gain_lp_coeffs);
@ -262,101 +391,366 @@ static inline void bw_mm2_init(bw_mm2_coeffs *BW_RESTRICT coeffs) {
bw_gain_set_gain_lin(&coeffs->gain_lp_coeffs, 0.f);
bw_gain_set_gain_lin(&coeffs->gain_bp_coeffs, 0.f);
bw_gain_set_gain_lin(&coeffs->gain_hp_coeffs, 0.f);
#ifdef BW_DEBUG_DEEP
coeffs->hash = bw_hash_sdbm("bw_mm2_coeffs");
coeffs->state = bw_mm2_coeffs_state_init;
coeffs->reset_id = coeffs->hash + 1;
#endif
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state == bw_mm2_coeffs_state_init);
}
static inline void bw_mm2_set_sample_rate(bw_mm2_coeffs *BW_RESTRICT coeffs, float sample_rate) {
static inline void bw_mm2_set_sample_rate(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float sample_rate) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
BW_ASSERT(bw_is_finite(sample_rate) && sample_rate > 0.f);
bw_svf_set_sample_rate(&coeffs->svf_coeffs, sample_rate);
bw_gain_set_sample_rate(&coeffs->gain_x_coeffs, sample_rate);
bw_gain_set_sample_rate(&coeffs->gain_lp_coeffs, sample_rate);
bw_gain_set_sample_rate(&coeffs->gain_bp_coeffs, sample_rate);
bw_gain_set_sample_rate(&coeffs->gain_hp_coeffs, sample_rate);
#ifdef BW_DEBUG_DEEP
coeffs->state = bw_mm2_coeffs_state_set_sample_rate;
#endif
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state == bw_mm2_coeffs_state_set_sample_rate);
}
static inline void bw_mm2_reset_coeffs(bw_mm2_coeffs *BW_RESTRICT coeffs) {
static inline void bw_mm2_reset_coeffs(
bw_mm2_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_set_sample_rate);
bw_svf_reset_coeffs(&coeffs->svf_coeffs);
bw_gain_reset_coeffs(&coeffs->gain_x_coeffs);
bw_gain_reset_coeffs(&coeffs->gain_lp_coeffs);
bw_gain_reset_coeffs(&coeffs->gain_bp_coeffs);
bw_gain_reset_coeffs(&coeffs->gain_hp_coeffs);
#ifdef BW_DEBUG_DEEP
coeffs->state = bw_mm2_coeffs_state_reset_coeffs;
coeffs->reset_id++;
#endif
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state == bw_mm2_coeffs_state_reset_coeffs);
}
static inline void bw_mm2_reset_state(const bw_mm2_coeffs *BW_RESTRICT coeffs, bw_mm2_state *BW_RESTRICT state, float x_0) {
bw_svf_reset_state(&coeffs->svf_coeffs, &state->svf_state, x_0);
static inline float bw_mm2_reset_state(
const bw_mm2_coeffs * BW_RESTRICT coeffs,
bw_mm2_state * BW_RESTRICT state,
float x_0) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_reset_coeffs);
BW_ASSERT(state != NULL);
BW_ASSERT(bw_is_finite(x_0));
const float y = (bw_gain_get_gain_lin(&coeffs->gain_x_coeffs) + bw_gain_get_gain_lin(&coeffs->gain_lp_coeffs)) * x_0;
float lp, bp, hp;
bw_svf_reset_state(&coeffs->svf_coeffs, &state->svf_state, x_0, &lp, &bp, &hp);
#ifdef BW_DEBUG_DEEP
state->hash = bw_hash_sdbm("bw_mm2_state");
state->coeffs_reset_id = coeffs->reset_id;
#endif
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_reset_coeffs);
BW_ASSERT_DEEP(bw_mm2_state_is_valid(coeffs, state));
BW_ASSERT(bw_is_finite(y));
return y;
}
static inline void bw_mm2_update_coeffs_ctrl(bw_mm2_coeffs *BW_RESTRICT coeffs) {
static inline void bw_mm2_reset_state_multi(
const bw_mm2_coeffs * BW_RESTRICT coeffs,
bw_mm2_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_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_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_mm2_reset_state(coeffs, state[i], x_0[i]);
else
for (size_t i = 0; i < n_channels; i++)
bw_mm2_reset_state(coeffs, state[i], x_0[i]);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_reset_coeffs);
BW_ASSERT_DEEP(y_0 != NULL ? bw_has_only_finite(y_0, n_channels) : 1);
}
static inline void bw_mm2_update_coeffs_ctrl(
bw_mm2_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_reset_coeffs);
bw_svf_update_coeffs_ctrl(&coeffs->svf_coeffs);
bw_gain_update_coeffs_ctrl(&coeffs->gain_x_coeffs);
bw_gain_update_coeffs_ctrl(&coeffs->gain_lp_coeffs);
bw_gain_update_coeffs_ctrl(&coeffs->gain_bp_coeffs);
bw_gain_update_coeffs_ctrl(&coeffs->gain_hp_coeffs);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_reset_coeffs);
}
static inline void bw_mm2_update_coeffs_audio(bw_mm2_coeffs *BW_RESTRICT coeffs) {
static inline void bw_mm2_update_coeffs_audio(
bw_mm2_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_reset_coeffs);
bw_svf_update_coeffs_audio(&coeffs->svf_coeffs);
bw_gain_update_coeffs_audio(&coeffs->gain_x_coeffs);
bw_gain_update_coeffs_audio(&coeffs->gain_lp_coeffs);
bw_gain_update_coeffs_audio(&coeffs->gain_bp_coeffs);
bw_gain_update_coeffs_audio(&coeffs->gain_hp_coeffs);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_reset_coeffs);
}
static inline float bw_mm2_process1(const bw_mm2_coeffs *BW_RESTRICT coeffs, bw_mm2_state *BW_RESTRICT state, float x) {
static inline float bw_mm2_process1(
const bw_mm2_coeffs * BW_RESTRICT coeffs,
bw_mm2_state * BW_RESTRICT state,
float x) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_reset_coeffs);
BW_ASSERT(state != NULL);
BW_ASSERT_DEEP(bw_mm2_state_is_valid(coeffs, state));
BW_ASSERT(bw_is_finite(x));
float lp, bp, hp;
bw_svf_process1(&coeffs->svf_coeffs, &state->svf_state, x, &lp, &bp, &hp);
const float vx = bw_gain_process1(&coeffs->gain_x_coeffs, x);
const float vlp = bw_gain_process1(&coeffs->gain_lp_coeffs, lp);
const float vbp = bw_gain_process1(&coeffs->gain_bp_coeffs, bp);
const float vhp = bw_gain_process1(&coeffs->gain_hp_coeffs, hp);
return vx + vlp + vbp + vhp;
const float y = vx + vlp + vbp + vhp;
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_reset_coeffs);
BW_ASSERT_DEEP(bw_mm2_state_is_valid(coeffs, state));
BW_ASSERT(bw_is_finite(y));
return y;
}
static inline void bw_mm2_process(bw_mm2_coeffs *BW_RESTRICT coeffs, bw_mm2_state *BW_RESTRICT state, const float *x, float *y, size_t n_samples) {
static inline void bw_mm2_process(
bw_mm2_coeffs * BW_RESTRICT coeffs,
bw_mm2_state * BW_RESTRICT state,
const float * x,
float * y,
size_t n_samples) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_reset_coeffs);
BW_ASSERT(state != NULL);
BW_ASSERT_DEEP(bw_mm2_state_is_valid(coeffs, state));
BW_ASSERT(x != NULL);
BW_ASSERT_DEEP(bw_has_only_finite(x, n_samples));
BW_ASSERT(y != NULL);
bw_mm2_update_coeffs_ctrl(coeffs);
for (size_t i = 0; i < n_samples; i++) {
bw_mm2_update_coeffs_audio(coeffs);
y[i] = bw_mm2_process1(coeffs, state, x[i]);
}
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_reset_coeffs);
BW_ASSERT_DEEP(bw_mm2_state_is_valid(coeffs, state));
BW_ASSERT_DEEP(bw_has_only_finite(y, n_samples));
}
static inline void bw_mm2_process_multi(bw_mm2_coeffs *BW_RESTRICT coeffs, bw_mm2_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_mm2_process_multi(
bw_mm2_coeffs * BW_RESTRICT coeffs,
bw_mm2_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_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_reset_coeffs);
BW_ASSERT(state != NULL);
BW_ASSERT(x != NULL);
BW_ASSERT(y != NULL);
bw_mm2_update_coeffs_ctrl(coeffs);
for (size_t i = 0; i < n_samples; i++) {
bw_mm2_update_coeffs_audio(coeffs);
for (size_t j = 0; j < n_channels; j++)
y[j][i] = bw_mm2_process1(coeffs, state[j], x[j][i]);
}
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_reset_coeffs);
}
static inline void bw_mm2_set_cutoff(bw_mm2_coeffs *BW_RESTRICT coeffs, float value) {
static inline void bw_mm2_set_cutoff(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float value) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
BW_ASSERT(bw_is_finite(value));
BW_ASSERT(value >= 1e-6f && value <= 1e12f);
bw_svf_set_cutoff(&coeffs->svf_coeffs, value);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
}
static inline void bw_mm2_set_Q(bw_mm2_coeffs *BW_RESTRICT coeffs, float value) {
static inline void bw_mm2_set_Q(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float value) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
BW_ASSERT(bw_is_finite(value));
BW_ASSERT(value >= 1e-6f && value <= 1e6f);
bw_svf_set_Q(&coeffs->svf_coeffs, value);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
}
static inline void bw_mm2_set_prewarp_at_cutoff(bw_mm2_coeffs *BW_RESTRICT coeffs, char value) {
static inline void bw_mm2_set_prewarp_at_cutoff(
bw_mm2_coeffs * BW_RESTRICT coeffs,
char value) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
bw_svf_set_prewarp_at_cutoff(&coeffs->svf_coeffs, value);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
}
static inline void bw_mm2_set_prewarp_freq(bw_mm2_coeffs *BW_RESTRICT coeffs, float value) {
static inline void bw_mm2_set_prewarp_freq(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float value) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
BW_ASSERT(bw_is_finite(value));
BW_ASSERT(value >= 1e-6f && value <= 1e12f);
bw_svf_set_prewarp_freq(&coeffs->svf_coeffs, value);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
}
static inline void bw_mm2_set_coeff_x(bw_mm2_coeffs *BW_RESTRICT coeffs, float value) {
static inline void bw_mm2_set_coeff_x(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float value) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
BW_ASSERT(bw_is_finite(value));
bw_gain_set_gain_lin(&coeffs->gain_x_coeffs, value);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
}
static inline void bw_mm2_set_coeff_lp(bw_mm2_coeffs *BW_RESTRICT coeffs, float value) {
static inline void bw_mm2_set_coeff_lp(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float value) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
BW_ASSERT(bw_is_finite(value));
bw_gain_set_gain_lin(&coeffs->gain_lp_coeffs, value);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
}
static inline void bw_mm2_set_coeff_bp(bw_mm2_coeffs *BW_RESTRICT coeffs, float value) {
static inline void bw_mm2_set_coeff_bp(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float value) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
BW_ASSERT(bw_is_finite(value));
bw_gain_set_gain_lin(&coeffs->gain_bp_coeffs, value);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
}
static inline void bw_mm2_set_coeff_hp(bw_mm2_coeffs *BW_RESTRICT coeffs, float value) {
static inline void bw_mm2_set_coeff_hp(
bw_mm2_coeffs * BW_RESTRICT coeffs,
float value) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
BW_ASSERT(bw_is_finite(value));
bw_gain_set_gain_lin(&coeffs->gain_hp_coeffs, value);
BW_ASSERT_DEEP(bw_mm2_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_mm2_coeffs_state_init);
}
static inline char bw_mm2_coeffs_is_valid(
const bw_mm2_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != NULL);
#ifdef BW_DEBUG_DEEP
if (coeffs->hash != bw_hash_sdbm("bw_mm2_coeffs"))
return 0;
if (coeffs->state < bw_mm2_coeffs_state_init || coeffs->state > bw_mm2_coeffs_state_reset_coeffs)
return 0;
#endif
return bw_svf_coeffs_is_valid(&coeffs->svf_coeffs)
&& bw_gain_coeffs_is_valid(&coeffs->gain_x_coeffs)
&& bw_gain_coeffs_is_valid(&coeffs->gain_lp_coeffs)
&& bw_gain_coeffs_is_valid(&coeffs->gain_bp_coeffs)
&& bw_gain_coeffs_is_valid(&coeffs->gain_hp_coeffs);
}
static inline char bw_mm2_state_is_valid(
const bw_mm2_coeffs * BW_RESTRICT coeffs,
const bw_mm2_state * BW_RESTRICT state) {
BW_ASSERT(state != NULL);
#ifdef BW_DEBUG_DEEP
if (state->hash != bw_hash_sdbm("bw_mm2_state"))
return 0;
if (coeffs != NULL && coeffs->reset_id != state->coeffs_reset_id)
return 0;
#endif
(void)coeffs;
return bw_svf_state_is_valid(&coeffs->svf_coeffs, &state->svf_state);
}
#ifdef __cplusplus
@ -376,25 +770,58 @@ class MM2 {
public:
MM2();
void setSampleRate(float sampleRate);
void reset(float x_0 = 0.f);
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 setCutoff(float value);
void setQ(float value);
void setPrewarpAtCutoff(bool value);
void setPrewarpFreq(float value);
void setCoeffX(float value);
void setCoeffLp(float value);
void setCoeffBp(float value);
void setCoeffHp(float value);
void setCutoff(
float value);
void setQ(
float value);
void setPrewarpAtCutoff(
bool value);
void setPrewarpFreq(
float value);
void setCoeffX(
float value);
void setCoeffLp(
float value);
void setCoeffBp(
float value);
void setCoeffHp(
float value);
/*! <<<...
* }
* ```
@ -406,9 +833,9 @@ public:
* change at any time in future versions. Please, do not use it directly. */
private:
bw_mm2_coeffs coeffs;
bw_mm2_state states[N_CHANNELS];
bw_mm2_state *BW_RESTRICT statesP[N_CHANNELS];
bw_mm2_coeffs coeffs;
bw_mm2_state states[N_CHANNELS];
bw_mm2_state * BW_RESTRICT statesP[N_CHANNELS];
};
template<size_t N_CHANNELS>
@ -419,70 +846,107 @@ inline MM2<N_CHANNELS>::MM2() {
}
template<size_t N_CHANNELS>
inline void MM2<N_CHANNELS>::setSampleRate(float sampleRate) {
inline void MM2<N_CHANNELS>::setSampleRate(
float sampleRate) {
bw_mm2_set_sample_rate(&coeffs, sampleRate);
}
template<size_t N_CHANNELS>
inline void MM2<N_CHANNELS>::reset(float x_0) {
inline void MM2<N_CHANNELS>::reset(
float x0,
float * BW_RESTRICT y0) {
bw_mm2_reset_coeffs(&coeffs);
for (size_t i = 0; i < N_CHANNELS; i++)
bw_mm2_reset_state(&coeffs, states + i, x_0);
if (y0 != nullptr)
for (size_t i = 0; i < N_CHANNELS; i++)
y0[i] = bw_mm2_reset_state(&coeffs, states + i, x0);
else
for (size_t i = 0; i < N_CHANNELS; i++)
bw_mm2_reset_state(&coeffs, states + i, x0);
}
template<size_t N_CHANNELS>
inline void MM2<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 MM2<N_CHANNELS>::reset(
const float * x0,
float * y0) {
bw_mm2_reset_coeffs(&coeffs);
bw_mm2_reset_state_multi(&coeffs, statesP, x0, y0, N_CHANNELS);
}
template<size_t N_CHANNELS>
inline void MM2<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 MM2<N_CHANNELS>::process(
const float * const *x,
float * const *y,
size_t nSamples) {
const float * const * x,
float * const * y,
size_t nSamples) {
bw_mm2_process_multi(&coeffs, statesP, x, y, N_CHANNELS, nSamples);
}
template<size_t N_CHANNELS>
inline void MM2<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 MM2<N_CHANNELS>::setCutoff(float value) {
inline void MM2<N_CHANNELS>::setCutoff(
float value) {
bw_mm2_set_cutoff(&coeffs, value);
}
template<size_t N_CHANNELS>
inline void MM2<N_CHANNELS>::setQ(float value) {
inline void MM2<N_CHANNELS>::setQ(
float value) {
bw_mm2_set_Q(&coeffs, value);
}
template<size_t N_CHANNELS>
inline void MM2<N_CHANNELS>::setPrewarpAtCutoff(bool value) {
inline void MM2<N_CHANNELS>::setPrewarpAtCutoff(
bool value) {
bw_mm2_set_prewarp_at_cutoff(&coeffs, value);
}
template<size_t N_CHANNELS>
inline void MM2<N_CHANNELS>::setPrewarpFreq(float value) {
inline void MM2<N_CHANNELS>::setPrewarpFreq(
float value) {
bw_mm2_set_prewarp_freq(&coeffs, value);
}
template<size_t N_CHANNELS>
inline void MM2<N_CHANNELS>::setCoeffX(float value) {
inline void MM2<N_CHANNELS>::setCoeffX(
float value) {
bw_mm2_set_coeff_x(&coeffs, value);
}
template<size_t N_CHANNELS>
inline void MM2<N_CHANNELS>::setCoeffLp(float value) {
inline void MM2<N_CHANNELS>::setCoeffLp(
float value) {
bw_mm2_set_coeff_lp(&coeffs, value);
}
template<size_t N_CHANNELS>
inline void MM2<N_CHANNELS>::setCoeffBp(float value) {
inline void MM2<N_CHANNELS>::setCoeffBp(
float value) {
bw_mm2_set_coeff_bp(&coeffs, value);
}
template<size_t N_CHANNELS>
inline void MM2<N_CHANNELS>::setCoeffHp(float value) {
inline void MM2<N_CHANNELS>::setCoeffHp(
float value) {
bw_mm2_set_coeff_hp(&coeffs, value);
}