diff --git a/examples/fx_ls1/vst3/Makefile b/examples/fx_ls1/vst3/Makefile
index 69e14e3..c6b5334 100644
--- a/examples/fx_ls1/vst3/Makefile
+++ b/examples/fx_ls1/vst3/Makefile
@@ -4,3 +4,6 @@ NAME := bw_example_fx_ls1
SOURCES = ${SOURCES_COMMON} ${ROOT_DIR}/../src/bw_example_fx_ls1.c
include ${ROOT_DIR}/../../common/vst3/vst3.mk
+
+CXXFLAGS += -DRELEASE=1 -DNDEBUG -DBW_NO_DEBUG
+#CXXFLAGS += -DDEVELOPMENT=1 -DBW_DEBUG_DEEP
diff --git a/examples/fxpp_ls1/vst3/Makefile b/examples/fxpp_ls1/vst3/Makefile
index 66f9377..1610979 100644
--- a/examples/fxpp_ls1/vst3/Makefile
+++ b/examples/fxpp_ls1/vst3/Makefile
@@ -4,3 +4,6 @@ NAME := bw_example_fxpp_ls1
SOURCES = ${SOURCES_COMMON} ${ROOT_DIR}/../src/bw_example_fxpp_ls1.cpp
include ${ROOT_DIR}/../../common/vst3/vst3.mk
+
+CXXFLAGS += -DRELEASE=1 -DNDEBUG -DBW_NO_DEBUG
+#CXXFLAGS += -DDEVELOPMENT=1 -DBW_DEBUG_DEEP
diff --git a/include/bw_hs1.h b/include/bw_hs1.h
index f8fd724..033d50d 100644
--- a/include/bw_hs1.h
+++ b/include/bw_hs1.h
@@ -41,6 +41,8 @@
*
Removed usage of reserved identifiers.
* Fixed bug when setting default parameter values in
* bw_hs1_init()
.
+ * Fixed documentation to indicate correct default parameter
+ * values.
* Clearly specificed parameter validity ranges.
* Added debugging code.
*
diff --git a/include/bw_ls1.h b/include/bw_ls1.h
index 985f88a..2b67c49 100644
--- a/include/bw_ls1.h
+++ b/include/bw_ls1.h
@@ -30,6 +30,7 @@
*
* - Version 1.0.0:
*
+ * - Added prewarp_at_cutoff and prewarp_freq parameters.
* bw_ls1_process()
and
* bw_ls1_process_multi()
now use size_t
* to count samples and channels.
@@ -39,6 +40,10 @@
* - Added overladed C++
process()
function taking
* C-style arrays as arguments.
* - Removed usage of reserved identifiers.
+ * - Fixed documentation to indicate correct default parameter
+ * values.
+ * - Clearly specificed parameter validity ranges.
+ * - Added debugging code.
*
*
* - Version 0.6.0:
@@ -91,51 +96,68 @@ typedef struct bw_ls1_state bw_ls1_state;
*
* #### bw_ls1_init()
* ```>>> */
-static inline void bw_ls1_init(bw_ls1_coeffs *BW_RESTRICT coeffs);
+static inline void bw_ls1_init(
+ bw_ls1_coeffs * BW_RESTRICT coeffs);
/*! <<<```
* Initializes input parameter values in `coeffs`.
*
* #### bw_ls1_set_sample_rate()
* ```>>> */
-static inline void bw_ls1_set_sample_rate(bw_ls1_coeffs *BW_RESTRICT coeffs, float sample_rate);
+static inline void bw_ls1_set_sample_rate(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ float sample_rate);
/*! <<<```
* Sets the `sample_rate` (Hz) value in `coeffs`.
*
* #### bw_ls1_reset_coeffs()
* ```>>> */
-static inline void bw_ls1_reset_coeffs(bw_ls1_coeffs *BW_RESTRICT coeffs);
+static inline void bw_ls1_reset_coeffs(
+ bw_ls1_coeffs * BW_RESTRICT coeffs);
/*! <<<```
* Resets coefficients in `coeffs` to assume their target values.
*
* #### bw_ls1_reset_state()
* ```>>> */
-static inline void bw_ls1_reset_state(const bw_ls1_coeffs *BW_RESTRICT coeffs, bw_ls1_state *BW_RESTRICT state, float x_0);
+static inline void bw_ls1_reset_state(
+ const bw_ls1_coeffs * BW_RESTRICT coeffs,
+ bw_ls1_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`.
*
* #### bw_ls1_update_coeffs_ctrl()
* ```>>> */
-static inline void bw_ls1_update_coeffs_ctrl(bw_ls1_coeffs *BW_RESTRICT coeffs);
+static inline void bw_ls1_update_coeffs_ctrl(
+ bw_ls1_coeffs * BW_RESTRICT coeffs);
/*! <<<```
* Triggers control-rate update of coefficients in `coeffs`.
*
* #### bw_ls1_update_coeffs_audio()
* ```>>> */
-static inline void bw_ls1_update_coeffs_audio(bw_ls1_coeffs *BW_RESTRICT coeffs);
+static inline void bw_ls1_update_coeffs_audio(
+ bw_ls1_coeffs * BW_RESTRICT coeffs);
/*! <<<```
* Triggers audio-rate update of coefficients in `coeffs`.
*
* #### bw_ls1_process1()
* ```>>> */
-static inline float bw_ls1_process1(const bw_ls1_coeffs *BW_RESTRICT coeffs, bw_ls1_state *BW_RESTRICT state, float x);
+static inline float bw_ls1_process1(
+ const bw_ls1_coeffs * BW_RESTRICT coeffs,
+ bw_ls1_state * BW_RESTRICT state,
+ float x);
/*! <<<```
* Processes one input sample `x` using `coeffs`, while using and updating
* `state`. Returns the corresponding output sample.
*
* #### bw_ls1_process()
* ```>>> */
-static inline void bw_ls1_process(bw_ls1_coeffs *BW_RESTRICT coeffs, bw_ls1_state *BW_RESTRICT state, const float *x, float *y, size_t n_samples);
+static inline void bw_ls1_process(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ bw_ls1_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
@@ -143,7 +165,13 @@ static inline void bw_ls1_process(bw_ls1_coeffs *BW_RESTRICT coeffs, bw_ls1_stat
*
* #### bw_ls1_process_multi()
* ```>>> */
-static inline void bw_ls1_process_multi(bw_ls1_coeffs *BW_RESTRICT coeffs, bw_ls1_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_ls1_process_multi(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ bw_ls1_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
@@ -152,27 +180,105 @@ static inline void bw_ls1_process_multi(bw_ls1_coeffs *BW_RESTRICT coeffs, bw_ls
*
* #### bw_ls1_set_cutoff()
* ```>>> */
-static inline void bw_ls1_set_cutoff(bw_ls1_coeffs *BW_RESTRICT coeffs, float value);
+static inline void bw_ls1_set_cutoff(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ float value);
/*! <<<```
* Sets the cutoff frequency `value` (Hz) in `coeffs`.
*
+ * `value` must be finite and positive.
+ *
+ * By the time `bw_ls1_update_coeffs_ctrl()`, `bw_ls1_update_coeffs_audio()`,
+ * `bw_ls1_process()`, or `bw_ls1_process_multi()` is called,
+ * `cutoff * bw_rcpf(bw_sqrtf(dc_gain))` must be in [`1e-6f`, `1e6f`].
+ *
+ * Default value: `1e3f`.
+ *
+ * #### bw_ls1_set_prewarp_at_cutoff()
+ * ```>>> */
+static inline void bw_ls1_set_prewarp_at_cutoff(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ char value);
+/*! <<<```
+ * Sets whether bilinear transform prewarping frequency should match the
+ * cutoff frequency (non-`0`) or not (`0`).
+ *
+ * Default value: non-`0` (on).
+ *
+ * #### bw_ls1_set_prewarp_freq()
+ * ```>>> */
+static inline void bw_ls1_set_prewarp_freq(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ float value);
+/*! <<<```
+ * Sets the prewarping frequency `value` (Hz) in `coeffs`.
+ *
+ * Only used when the prewarp\_at\_cutoff parameter is off and however
+ * internally limited to avoid instability.
+ *
+ * Valid range: [`1e-6f`, `1e6f`].
+ *
* Default value: `1e3f`.
*
* #### bw_ls1_set_dc_gain_lin()
* ```>>> */
-static inline void bw_ls1_set_dc_gain_lin(bw_ls1_coeffs *BW_RESTRICT coeffs, float value);
+static inline void bw_ls1_set_dc_gain_lin(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ float value);
/*! <<<```
* Sets the dc gain parameter to the given `value` (linear gain) in `coeffs`.
*
- * Default value: `0.f`.
+ * `value` must be finite and greater than or equal to `1e-30f`.
+ *
+ * By the time `bw_ls1_update_coeffs_ctrl()`, `bw_ls1_update_coeffs_audio()`,
+ * `bw_ls1_process()`, or `bw_ls1_process_multi()` is called,
+ * `cutoff * bw_rcpf(bw_sqrtf(dc_gain))` must be in [`1e-6f`, `1e6f`].
+ *
+ * Default value: `1.f`.
*
* #### bw_ls1_set_dc_gain_dB()
* ```>>> */
-static inline void bw_ls1_set_dc_gain_dB(bw_ls1_coeffs *BW_RESTRICT coeffs, float value);
+static inline void bw_ls1_set_dc_gain_dB(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ float value);
/*! <<<```
* Sets the dc gain parameter to the given `value` (dB) in `coeffs`.
*
- * Default value: `-INFINITY`.
+ * `value` must be finite and greater than or equal to `-600.f`.
+ *
+ * By the time `bw_ls1_update_coeffs_ctrl()`, `bw_ls1_update_coeffs_audio()`,
+ * `bw_ls1_process()`, or `bw_ls1_process_multi()` is called,
+ * `cutoff * bw_rcpf(bw_sqrtf(dc_gain))` must be in [`1e-6f`, `1e6f`].
+ *
+ * Default value: `0.f`.
+ *
+ * #### bw_ls1_coeffs_is_valid()
+ * ```>>> */
+static inline char bw_ls1_coeffs_is_valid(
+ const bw_ls1_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_ls1_coeffs`.
+ *
+ * #### bw_ls1_state_is_valid()
+ * ```>>> */
+static inline char bw_ls1_state_is_valid(
+ const bw_ls1_coeffs * BW_RESTRICT coeffs,
+ const bw_ls1_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_ls1_state`.
* }}} */
#ifdef __cplusplus
@@ -191,98 +297,348 @@ static inline void bw_ls1_set_dc_gain_dB(bw_ls1_coeffs *BW_RESTRICT coeffs, floa
extern "C" {
#endif
+#ifdef BW_DEBUG_DEEP
+enum bw_ls1_coeffs_state {
+ bw_ls1_coeffs_state_invalid,
+ bw_ls1_coeffs_state_init,
+ bw_ls1_coeffs_state_set_sample_rate,
+ bw_ls1_coeffs_state_reset_coeffs
+};
+#endif
+
struct bw_ls1_coeffs {
+#ifdef BW_DEBUG_DEEP
+ uint32_t hash;
+ enum bw_ls1_coeffs_state state;
+ uint32_t reset_id;
+#endif
+
// Sub-components
- bw_mm1_coeffs mm1_coeffs;
+ bw_mm1_coeffs mm1_coeffs;
// Parameters
- float cutoff;
- float dc_gain;
- char update;
+ float cutoff;
+ float prewarp_k;
+ float prewarp_freq;
+ float dc_gain;
+ char update;
};
struct bw_ls1_state {
+#ifdef BW_DEBUG_DEEP
+ uint32_t hash;
+ uint32_t coeffs_reset_id;
+#endif
+
bw_mm1_state mm1_state;
};
-static inline void bw_ls1_init(bw_ls1_coeffs *BW_RESTRICT coeffs) {
+static inline void bw_ls1_init(
+ bw_ls1_coeffs * BW_RESTRICT coeffs) {
+ BW_ASSERT(coeffs != NULL);
+
bw_mm1_init(&coeffs->mm1_coeffs);
bw_mm1_set_prewarp_at_cutoff(&coeffs->mm1_coeffs, 0);
bw_mm1_set_coeff_x(&coeffs->mm1_coeffs, 1.f);
bw_mm1_set_coeff_lp(&coeffs->mm1_coeffs, 0.f);
coeffs->cutoff = 1e3f;
+ coeffs->prewarp_k = 1.f;
+ coeffs->prewarp_freq = 1e3f;
coeffs->dc_gain = 1.f;
+
+#ifdef BW_DEBUG_DEEP
+ coeffs->hash = bw_hash_sdbm("bw_ls1_coeffs");
+ coeffs->state = bw_ls1_coeffs_state_init;
+ coeffs->reset_id = coeffs->hash + 1;
+#endif
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state == bw_ls1_coeffs_state_init);
}
-static inline void bw_ls1_set_sample_rate(bw_ls1_coeffs *BW_RESTRICT coeffs, float sample_rate) {
+static inline void bw_ls1_set_sample_rate(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ float sample_rate) {
+ BW_ASSERT(coeffs != NULL);
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_init);
+ BW_ASSERT(bw_is_finite(sample_rate) && sample_rate > 0.f);
+
bw_mm1_set_sample_rate(&coeffs->mm1_coeffs, sample_rate);
+
+#ifdef BW_DEBUG_DEEP
+ coeffs->state = bw_ls1_coeffs_state_set_sample_rate;
+#endif
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state == bw_ls1_coeffs_state_set_sample_rate);
}
-static inline void bw_ls1_update_mm1_params(bw_ls1_coeffs *BW_RESTRICT coeffs) {
+static inline void bw_ls1_update_mm1_params(
+ bw_ls1_coeffs * BW_RESTRICT coeffs) {
+ bw_mm1_set_prewarp_freq(&coeffs->mm1_coeffs, coeffs->prewarp_freq + coeffs->prewarp_k * (coeffs->cutoff - coeffs->prewarp_freq));
if (coeffs->update) {
bw_mm1_set_cutoff(&coeffs->mm1_coeffs, coeffs->cutoff * bw_rcpf(bw_sqrtf(coeffs->dc_gain)));
bw_mm1_set_coeff_lp(&coeffs->mm1_coeffs, coeffs->dc_gain - 1.f);
- bw_mm1_set_prewarp_freq(&coeffs->mm1_coeffs, coeffs->cutoff);
coeffs->update = 0;
}
}
-static inline void bw_ls1_reset_coeffs(bw_ls1_coeffs *BW_RESTRICT coeffs) {
+static inline void bw_ls1_reset_coeffs(
+ bw_ls1_coeffs * BW_RESTRICT coeffs) {
+ BW_ASSERT(coeffs != NULL);
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_set_sample_rate);
+
coeffs->update = 1;
bw_ls1_update_mm1_params(coeffs);
bw_mm1_reset_coeffs(&coeffs->mm1_coeffs);
+
+#ifdef BW_DEBUG_DEEP
+ coeffs->state = bw_ls1_coeffs_state_reset_coeffs;
+ coeffs->reset_id++;
+#endif
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state == bw_ls1_coeffs_state_reset_coeffs);
}
-static inline void bw_ls1_reset_state(const bw_ls1_coeffs *BW_RESTRICT coeffs, bw_ls1_state *BW_RESTRICT state, float x_0) {
+static inline void bw_ls1_reset_state(
+ const bw_ls1_coeffs * BW_RESTRICT coeffs,
+ bw_ls1_state * BW_RESTRICT state,
+ float x_0) {
+ BW_ASSERT(coeffs != NULL);
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_reset_coeffs);
+ BW_ASSERT(state != NULL);
+ BW_ASSERT(bw_is_finite(x_0));
+
bw_mm1_reset_state(&coeffs->mm1_coeffs, &state->mm1_state, x_0);
+
+#ifdef BW_DEBUG_DEEP
+ state->hash = bw_hash_sdbm("bw_ls1_state");
+ state->coeffs_reset_id = coeffs->reset_id;
+#endif
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_reset_coeffs);
+ BW_ASSERT_DEEP(bw_ls1_state_is_valid(coeffs, state));
}
-static inline void bw_ls1_update_coeffs_ctrl(bw_ls1_coeffs *BW_RESTRICT coeffs) {
+static inline void bw_ls1_update_coeffs_ctrl(
+ bw_ls1_coeffs * BW_RESTRICT coeffs) {
+ BW_ASSERT(coeffs != NULL);
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_reset_coeffs);
+ BW_ASSERT_DEEP(coeffs->cutoff * bw_rcpf(bw_sqrtf(coeffs->dc_gain)) >= 1e-6f && coeffs->cutoff * bw_rcpf(bw_sqrtf(coeffs->dc_gain)) <= 1e6f);
+
bw_ls1_update_mm1_params(coeffs);
bw_mm1_update_coeffs_ctrl(&coeffs->mm1_coeffs);
+
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_reset_coeffs);
}
-static inline void bw_ls1_update_coeffs_audio(bw_ls1_coeffs *BW_RESTRICT coeffs) {
+static inline void bw_ls1_update_coeffs_audio(
+ bw_ls1_coeffs * BW_RESTRICT coeffs) {
+ BW_ASSERT(coeffs != NULL);
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_reset_coeffs);
+ BW_ASSERT_DEEP(coeffs->cutoff * bw_rcpf(bw_sqrtf(coeffs->dc_gain)) >= 1e-6f && coeffs->cutoff * bw_rcpf(bw_sqrtf(coeffs->dc_gain)) <= 1e6f);
+
bw_mm1_update_coeffs_audio(&coeffs->mm1_coeffs);
+
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_reset_coeffs);
}
-static inline float bw_ls1_process1(const bw_ls1_coeffs *BW_RESTRICT coeffs, bw_ls1_state *BW_RESTRICT state, float x) {
- return bw_mm1_process1(&coeffs->mm1_coeffs, &state->mm1_state, x);
+static inline float bw_ls1_process1(
+ const bw_ls1_coeffs * BW_RESTRICT coeffs,
+ bw_ls1_state * BW_RESTRICT state,
+ float x) {
+ BW_ASSERT(coeffs != NULL);
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_reset_coeffs);
+ BW_ASSERT(state != NULL);
+ BW_ASSERT_DEEP(bw_ls1_state_is_valid(coeffs, state));
+ BW_ASSERT(bw_is_finite(x));
+
+ const float y = bw_mm1_process1(&coeffs->mm1_coeffs, &state->mm1_state, x);
+
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_reset_coeffs);
+ BW_ASSERT_DEEP(bw_ls1_state_is_valid(coeffs, state));
+ BW_ASSERT(bw_is_finite(y));
+
+ return y;
}
-static inline void bw_ls1_process(bw_ls1_coeffs *BW_RESTRICT coeffs, bw_ls1_state *BW_RESTRICT state, const float *x, float *y, size_t n_samples) {
+static inline void bw_ls1_process(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ bw_ls1_state * BW_RESTRICT state,
+ const float * x,
+ float * y,
+ size_t n_samples) {
+ BW_ASSERT(coeffs != NULL);
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_reset_coeffs);
+ BW_ASSERT(state != NULL);
+ BW_ASSERT_DEEP(bw_ls1_state_is_valid(coeffs, state));
+ BW_ASSERT(x != NULL);
+ BW_ASSERT_DEEP(bw_has_only_finite(x, n_samples));
+ BW_ASSERT(y != NULL);
+
bw_ls1_update_coeffs_ctrl(coeffs);
for (size_t i = 0; i < n_samples; i++) {
bw_ls1_update_coeffs_audio(coeffs);
y[i] = bw_ls1_process1(coeffs, state, x[i]);
}
+
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_reset_coeffs);
+ BW_ASSERT_DEEP(bw_ls1_state_is_valid(coeffs, state));
+ BW_ASSERT_DEEP(bw_has_only_finite(y, n_samples));
}
-static inline void bw_ls1_process_multi(bw_ls1_coeffs *BW_RESTRICT coeffs, bw_ls1_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_ls1_process_multi(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ bw_ls1_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_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_reset_coeffs);
+ BW_ASSERT(state != NULL);
+ BW_ASSERT(x != NULL);
+ BW_ASSERT(y != NULL);
+
bw_ls1_update_coeffs_ctrl(coeffs);
for (size_t i = 0; i < n_samples; i++) {
bw_ls1_update_coeffs_audio(coeffs);
for (size_t j = 0; j < n_channels; j++)
y[j][i] = bw_ls1_process1(coeffs, state[j], x[j][i]);
}
+
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_reset_coeffs);
}
-static inline void bw_ls1_set_cutoff(bw_ls1_coeffs *BW_RESTRICT coeffs, float value) {
+static inline void bw_ls1_set_cutoff(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ float value) {
+ BW_ASSERT(coeffs != NULL);
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_init);
+ BW_ASSERT(bw_is_finite(value));
+ BW_ASSERT(value > 0.f);
+
if (value != coeffs->cutoff) {
coeffs->cutoff = value;
coeffs->update = 1;
}
+
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_init);
}
-static inline void bw_ls1_set_dc_gain_lin(bw_ls1_coeffs *BW_RESTRICT coeffs, float value) {
+static inline void bw_ls1_set_prewarp_at_cutoff(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ char value) {
+ BW_ASSERT(coeffs != NULL);
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_init);
+
+ coeffs->prewarp_k = value ? 1.f : 0.f;
+
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_init);
+}
+
+static inline void bw_ls1_set_prewarp_freq(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ float value) {
+ BW_ASSERT(coeffs != NULL);
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_init);
+ BW_ASSERT(bw_is_finite(value));
+ BW_ASSERT(value >= 1e-6f && value <= 1e6f);
+
+ coeffs->prewarp_freq = value;
+
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_init);
+}
+
+static inline void bw_ls1_set_dc_gain_lin(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ float value) {
+ BW_ASSERT(coeffs != NULL);
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_init);
+ BW_ASSERT(bw_is_finite(value));
+ BW_ASSERT(value >= 1e-30f);
+
if (value != coeffs->dc_gain) {
coeffs->dc_gain = value;
coeffs->update = 1;
}
+
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_init);
}
-static inline void bw_ls1_set_dc_gain_dB(bw_ls1_coeffs *BW_RESTRICT coeffs, float value) {
+static inline void bw_ls1_set_dc_gain_dB(
+ bw_ls1_coeffs * BW_RESTRICT coeffs,
+ float value) {
+ BW_ASSERT(coeffs != NULL);
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_init);
+ BW_ASSERT(bw_is_finite(value));
+ BW_ASSERT(value >= -600.f);
+
bw_ls1_set_dc_gain_lin(coeffs, bw_dB2linf(value));
+
+ BW_ASSERT_DEEP(bw_ls1_coeffs_is_valid(coeffs));
+ BW_ASSERT_DEEP(coeffs->state >= bw_ls1_coeffs_state_init);
+}
+
+static inline char bw_ls1_coeffs_is_valid(
+ const bw_ls1_coeffs * BW_RESTRICT coeffs) {
+ BW_ASSERT(coeffs != NULL);
+
+#ifdef BW_DEBUG_DEEP
+ if (coeffs->hash != bw_hash_sdbm("bw_ls1_coeffs"))
+ return 0;
+ if (coeffs->state < bw_ls1_coeffs_state_init || coeffs->state > bw_ls1_coeffs_state_reset_coeffs)
+ return 0;
+#endif
+
+ if (!bw_is_finite(coeffs->cutoff) || coeffs->cutoff <= 0.f)
+ return 0;
+ if (coeffs->prewarp_k != 0.f && coeffs->prewarp_k != 1.f)
+ return 0;
+ if (coeffs->prewarp_freq < 1e-6f || coeffs->prewarp_freq > 1e6f)
+ return 0;
+ if (!bw_is_finite(coeffs->dc_gain) || coeffs->dc_gain < 1e-30f)
+ return 0;
+
+ return bw_mm1_coeffs_is_valid(&coeffs->mm1_coeffs);
+}
+
+static inline char bw_ls1_state_is_valid(
+ const bw_ls1_coeffs * BW_RESTRICT coeffs,
+ const bw_ls1_state * BW_RESTRICT state) {
+ BW_ASSERT(state != NULL);
+
+#ifdef BW_DEBUG_DEEP
+ if (state->hash != bw_hash_sdbm("bw_ls1_state"))
+ return 0;
+
+ if (coeffs != NULL && coeffs->reset_id != state->coeffs_reset_id)
+ return 0;
+#endif
+
+ (void)coeffs;
+
+ return bw_mm1_state_is_valid(&coeffs->mm1_coeffs, &state->mm1_state);
}
#ifdef __cplusplus
@@ -302,20 +658,35 @@ class LS1 {
public:
LS1();
- void setSampleRate(float sampleRate);
- void reset(float x_0 = 0.f);
+ void setSampleRate(
+ float sampleRate);
+
+ void reset(float x0 = 0.f);
+
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 x,
- std::array y,
- size_t nSamples);
+ std::array y,
+ size_t nSamples);
- void setCutoff(float value);
- void setDcGainLin(float value);
- void setDcGainDB(float value);
+ void setCutoff(
+ float value);
+
+ void setPrewarpAtCutoff(
+ bool value);
+
+ void setPrewarpFreq(
+ float value);
+
+ void setDcGainLin(
+ float value);
+
+ void setDcGainDB(
+ float value);
/*! <<<...
* }
* ```
@@ -340,45 +711,62 @@ inline LS1::LS1() {
}
template
-inline void LS1::setSampleRate(float sampleRate) {
+inline void LS1::setSampleRate(
+ float sampleRate) {
bw_ls1_set_sample_rate(&coeffs, sampleRate);
}
template
-inline void LS1::reset(float x_0) {
+inline void LS1::reset(
+ float x0) {
bw_ls1_reset_coeffs(&coeffs);
for (size_t i = 0; i < N_CHANNELS; i++)
- bw_ls1_reset_state(&coeffs, states + i, x_0);
+ bw_ls1_reset_state(&coeffs, states + i, x0);
}
template
inline void LS1::process(
- const float * const *x,
- float * const *y,
- size_t nSamples) {
+ const float * const * x,
+ float * const * y,
+ size_t nSamples) {
bw_ls1_process_multi(&coeffs, statesP, x, y, N_CHANNELS, nSamples);
}
template
inline void LS1::process(
std::array x,
- std::array y,
- size_t nSamples) {
+ std::array y,
+ size_t nSamples) {
process(x.data(), y.data(), nSamples);
}
template
-inline void LS1::setCutoff(float value) {
+inline void LS1::setCutoff(
+ float value) {
bw_ls1_set_cutoff(&coeffs, value);
}
template
-inline void LS1::setDcGainLin(float value) {
+inline void LS1::setPrewarpAtCutoff(
+ bool value) {
+ bw_ls1_set_prewarp_at_cutoff(&coeffs, value);
+}
+
+template
+inline void LS1::setPrewarpFreq(
+ float value) {
+ bw_ls1_set_prewarp_freq(&coeffs, value);
+}
+
+template
+inline void LS1::setDcGainLin(
+ float value) {
bw_ls1_set_dc_gain_lin(&coeffs, value);
}
template
-inline void LS1::setDcGainDB(float value) {
+inline void LS1::setDcGainDB(
+ float value) {
bw_ls1_set_dc_gain_dB(&coeffs, value);
}