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

finalized bw_delay + examples

Browse Source
This commit is contained in:
Stefano D'Angelo 2023-09-22 11:21:08 +02:00
parent f267a015b7
commit 58a50b3ba1
4 changed files with 537 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
TODO
View File

@ -75,6 +75,7 @@ code:
* c++ get coeffs/state? or public? src nIn/OutSamples case (array vs single value pre 1.0.0), delay read/write, process1? process single? * c++ get coeffs/state? or public? src nIn/OutSamples case (array vs single value pre 1.0.0), delay read/write, process1? process single?
* bw_comb: should also modulate feedback? * bw_comb: should also modulate feedback?
* bw_comb: integer target delay values? * bw_comb: integer target delay values?
* are we sure about inlining everything?
build system: build system:
* make makefiles handle paths with spaces etc * make makefiles handle paths with spaces etc

3
examples/fx_delay/vst3/Makefile
View File

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

3
examples/fxpp_delay/vst3/Makefile
View File

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

638
include/bw_delay.h
View File

@ -33,8 +33,14 @@
* <ul> * <ul>
* <li>Version <strong>1.0.0</strong>: * <li>Version <strong>1.0.0</strong>:
* <ul> * <ul>
* <li>Removed <code>read()</code> and <code>write()</code> from C++
* API.</li>
* <li>Added initial value argument in * <li>Added initial value argument in
* <code>bw_delay_reset_state()</code>.</li> * <code>bw_delay_reset_state()</code>.</li>
* <li>Added <code>bw_delay_reset_state_multi()</code> and updated C++
* API in this regard.</li>
* <li>Now <code>bw_delay_reset_state()</code> returns the initial
* output value.</li>
* <li>Added overloaded C++ <code>reset()</code> functions taking * <li>Added overloaded C++ <code>reset()</code> functions taking
* arrays as arguments.</li> * arrays as arguments.</li>
* <li>Now using <code>size_t</code> instead of * <li>Now using <code>size_t</code> instead of
@ -48,6 +54,8 @@
* <li>Added overloaded C++ <code>process()</code> function taking * <li>Added overloaded C++ <code>process()</code> function taking
* C-style arrays as arguments.</li> * C-style arrays as arguments.</li>
* <li>Removed usage of reserved identifiers.</li> * <li>Removed usage of reserved identifiers.</li>
* <li>Clearly specified parameter validity ranges.</li>
* <li>Added debugging code.</li>
* </ul> * </ul>
* </li> * </li>
* <li>Version <strong>0.6.0</strong>: * <li>Version <strong>0.6.0</strong>:
@ -95,82 +103,131 @@ typedef struct bw_delay_state bw_delay_state;
* *
* #### bw_delay_init() * #### bw_delay_init()
* ```>>> */ * ```>>> */
static inline void bw_delay_init(bw_delay_coeffs *BW_RESTRICT coeffs, float max_delay); static inline void bw_delay_init(
bw_delay_coeffs * BW_RESTRICT coeffs,
float max_delay);
/*! <<<``` /*! <<<```
* Initializes input parameter values in `coeffs` using `max_delay` (s) as * Initializes input parameter values in `coeffs` using `max_delay` (s) as
* the maximum delay time. * the maximum delay time.
* *
* `max_delay` must be finite and non-negative.
*
* #### bw_delay_set_sample_rate() * #### bw_delay_set_sample_rate()
* ```>>> */ * ```>>> */
static inline void bw_delay_set_sample_rate(bw_delay_coeffs *BW_RESTRICT coeffs, float sample_rate); static inline void bw_delay_set_sample_rate(
bw_delay_coeffs * BW_RESTRICT coeffs,
float sample_rate);
/*! <<<``` /*! <<<```
* Sets the `sample_rate` (Hz) value in `coeffs`. * Sets the `sample_rate` (Hz) value in `coeffs`.
* *
* #### bw_delay_mem_req() * #### bw_delay_mem_req()
* ```>>> */ * ```>>> */
static inline size_t bw_delay_mem_req(const bw_delay_coeffs *BW_RESTRICT coeffs); static inline size_t bw_delay_mem_req(
const bw_delay_coeffs * BW_RESTRICT coeffs);
/*! <<<``` /*! <<<```
* Returns the size, in bytes, of contiguous memory to be supplied to * Returns the size, in bytes, of contiguous memory to be supplied to
* `bw_delay_mem_set()` using `coeffs`. * `bw_delay_mem_set()` using `coeffs`.
* *
* #### bw_delay_mem_set() * #### bw_delay_mem_set()
* ```>>> */ * ```>>> */
static inline void bw_delay_mem_set(const bw_delay_coeffs *BW_RESTRICT coeffs, bw_delay_state *BW_RESTRICT state, void *BW_RESTRICT mem); static inline void bw_delay_mem_set(
const bw_delay_coeffs * BW_RESTRICT coeffs,
bw_delay_state * BW_RESTRICT state,
void * BW_RESTRICT mem);
/*! <<<``` /*! <<<```
* Associates the contiguous memory block `mem` to the given `state`. * Associates the contiguous memory block `mem` to the given `state`.
* *
* #### bw_delay_reset_coeffs() * #### bw_delay_reset_coeffs()
* ```>>> */ * ```>>> */
static inline void bw_delay_reset_coeffs(bw_delay_coeffs *BW_RESTRICT coeffs); static inline void bw_delay_reset_coeffs(
bw_delay_coeffs * BW_RESTRICT coeffs);
/*! <<<``` /*! <<<```
* Resets coefficients in `coeffs` to assume their target values. * Resets coefficients in `coeffs` to assume their target values.
* *
* #### bw_delay_reset_state() * #### bw_delay_reset_state()
* ```>>> */ * ```>>> */
static inline void bw_delay_reset_state(const bw_delay_coeffs *BW_RESTRICT coeffs, bw_delay_state *BW_RESTRICT state, float x_0); static inline float bw_delay_reset_state(
const bw_delay_coeffs * BW_RESTRICT coeffs,
bw_delay_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 quiescent/initial input value `x_0`. * and the initial input value `x_0`.
*
* Returns the corresponding initial output value.
*
* #### bw_delay_reset_state_multi()
* ```>>> */
static inline void bw_delay_reset_state_multi(
const bw_delay_coeffs * BW_RESTRICT coeffs,
bw_delay_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_delay_read() * #### bw_delay_read()
* ```>>> */ * ```>>> */
static float bw_delay_read(const bw_delay_coeffs *BW_RESTRICT coeffs, const bw_delay_state *BW_RESTRICT state, size_t di, float df); static float bw_delay_read(
const bw_delay_coeffs * BW_RESTRICT coeffs,
const bw_delay_state * BW_RESTRICT state,
size_t di,
float df);
/*! <<<``` /*! <<<```
* Returns the interpolated value read from the delay line identified by * Returns the interpolated value read from the delay line identified by
* `coeffs` and `state` by applying a delay of `di` + `df` samples. * `coeffs` and `state` by applying a delay of `di` + `df` samples.
* *
* `df` must be in [`0.f`, `1.f`) and `di` + `df` must not exceed the delay * `df` must be in [`0.f`, `1.f`) and `di` + `df` must not exceed the delay
* line length (maximum delay times the sample rate). * line length (`max_delay * sample_rate`).
* *
* #### bw_delay_write() * #### bw_delay_write()
* ```>>> */ * ```>>> */
static void bw_delay_write(const bw_delay_coeffs *BW_RESTRICT coeffs, bw_delay_state *BW_RESTRICT state, float x); static void bw_delay_write(
const bw_delay_coeffs * BW_RESTRICT coeffs,
bw_delay_state * BW_RESTRICT state,
float x);
/*! <<<``` /*! <<<```
* Pushes the new sample `x` on the delay line identified by `coeffs` and * Pushes the new sample `x` on the delay line identified by `coeffs` and
* `state`. * `state`.
* *
* #### bw_delay_update_coeffs_ctrl() * #### bw_delay_update_coeffs_ctrl()
* ```>>> */ * ```>>> */
static inline void bw_delay_update_coeffs_ctrl(bw_delay_coeffs *BW_RESTRICT coeffs); static inline void bw_delay_update_coeffs_ctrl(
bw_delay_coeffs * BW_RESTRICT coeffs);
/*! <<<``` /*! <<<```
* Triggers control-rate update of coefficients in `coeffs`. * Triggers control-rate update of coefficients in `coeffs`.
* *
* #### bw_delay_update_coeffs_audio() * #### bw_delay_update_coeffs_audio()
* ```>>> */ * ```>>> */
static inline void bw_delay_update_coeffs_audio(bw_delay_coeffs *BW_RESTRICT coeffs); static inline void bw_delay_update_coeffs_audio(
bw_delay_coeffs * BW_RESTRICT coeffs);
/*! <<<``` /*! <<<```
* Triggers audio-rate update of coefficients in `coeffs`. * Triggers audio-rate update of coefficients in `coeffs`.
* *
* #### bw_delay_process1() * #### bw_delay_process1()
* ```>>> */ * ```>>> */
static inline float bw_delay_process1(const bw_delay_coeffs *BW_RESTRICT coeffs, bw_delay_state *BW_RESTRICT state, float x); static inline float bw_delay_process1(
const bw_delay_coeffs * BW_RESTRICT coeffs,
bw_delay_state * BW_RESTRICT state,
float x);
/*! <<<``` /*! <<<```
* Processes one input sample `x` using `coeffs`, while using and updating * Processes one input sample `x` using `coeffs`, while using and updating
* `state`. Returns the corresponding output sample. * `state`. Returns the corresponding output sample.
* *
* #### bw_delay_process() * #### bw_delay_process()
* ```>>> */ * ```>>> */
static inline void bw_delay_process(bw_delay_coeffs *BW_RESTRICT coeffs, bw_delay_state *BW_RESTRICT state, const float *x, float *y, size_t n_samples); static inline void bw_delay_process(
bw_delay_coeffs * BW_RESTRICT coeffs,
bw_delay_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 * 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 * first `n_samples` of the output buffer `y`, while using and updating both
@ -178,7 +235,13 @@ static inline void bw_delay_process(bw_delay_coeffs *BW_RESTRICT coeffs, bw_dela
* *
* #### bw_delay_process_multi() * #### bw_delay_process_multi()
* ```>>> */ * ```>>> */
static inline void bw_delay_process_multi(bw_delay_coeffs *BW_RESTRICT coeffs, bw_delay_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_delay_process_multi(
bw_delay_coeffs * BW_RESTRICT coeffs,
bw_delay_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 * 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 * fills the first `n_samples` of the `n_channels` output buffers `y`, while
@ -187,17 +250,50 @@ static inline void bw_delay_process_multi(bw_delay_coeffs *BW_RESTRICT coeffs, b
* *
* #### bw_delay_set_delay() * #### bw_delay_set_delay()
* ```>>> */ * ```>>> */
static inline void bw_delay_set_delay(bw_delay_coeffs *BW_RESTRICT coeffs, float value); static inline void bw_delay_set_delay(
bw_delay_coeffs * BW_RESTRICT coeffs,
float value);
/*! <<<``` /*! <<<```
* Sets the delay time `value` (s) in `coeffs`. * Sets the delay time `value` (s) in `coeffs`.
* *
* Valid range: [`0.f`, `max_delay`].
*
* Default value: `0.f`. * Default value: `0.f`.
* *
* #### bw_delay_get_length() * #### bw_delay_get_length()
* ```>>> */ * ```>>> */
static inline size_t bw_delay_get_length(const bw_delay_coeffs *BW_RESTRICT coeffs); static inline size_t bw_delay_get_length(
const bw_delay_coeffs * BW_RESTRICT coeffs);
/*! <<<``` /*! <<<```
* Returns the length of the delay line in samples. * Returns the length of the delay line in samples as stored in `coeffs`.
*
* #### bw_delay_coeffs_is_valid()
* ```>>> */
static inline char bw_delay_coeffs_is_valid(
const bw_delay_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_delay_coeffs`.
*
* #### bw_delay_state_is_valid()
* ```>>> */
static inline char bw_delay_state_is_valid(
const bw_delay_coeffs * BW_RESTRICT coeffs,
const bw_delay_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_delay_state`.
* }}} */ * }}} */
#ifdef __cplusplus #ifdef __cplusplus
@ -216,67 +312,107 @@ static inline size_t bw_delay_get_length(const bw_delay_coeffs *BW_RESTRICT coef
extern "C" { extern "C" {
#endif #endif
struct bw_delay_coeffs { #ifdef BW_DEBUG_DEEP
// Coefficients enum bw_delay_coeffs_state {
float fs; bw_delay_coeffs_state_invalid,
size_t len; bw_delay_coeffs_state_init,
bw_delay_coeffs_state_set_sample_rate,
bw_delay_coeffs_state_reset_coeffs
};
#endif
size_t di; struct bw_delay_coeffs {
float df; #ifdef BW_DEBUG_DEEP
uint32_t hash;
enum bw_delay_coeffs_state state;
uint32_t reset_id;
#endif
// Coefficients
float fs;
size_t len;
size_t di;
float df;
// Parameters // Parameters
float max_delay; float max_delay;
float delay; float delay;
char delay_changed; char delay_changed;
}; };
struct bw_delay_state { struct bw_delay_state {
float *BW_RESTRICT buf; #ifdef BW_DEBUG_DEEP
size_t idx; uint32_t hash;
uint32_t coeffs_reset_id;
#endif
// States
float * BW_RESTRICT buf;
size_t idx;
}; };
static inline void bw_delay_init(bw_delay_coeffs *BW_RESTRICT coeffs, float max_delay) { static inline void bw_delay_init(
bw_delay_coeffs * BW_RESTRICT coeffs,
float max_delay) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT(bw_is_finite(max_delay));
BW_ASSERT(max_delay >= 0.f);
coeffs->max_delay = max_delay; coeffs->max_delay = max_delay;
coeffs->delay = 0.f; coeffs->delay = 0.f;
#ifdef BW_DEBUG_DEEP
coeffs->hash = bw_hash_sdbm("bw_delay_coeffs");
coeffs->state = bw_delay_coeffs_state_init;
coeffs->reset_id = coeffs->hash + 1;
#endif
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state == bw_delay_coeffs_state_init);
} }
static inline void bw_delay_set_sample_rate(bw_delay_coeffs *BW_RESTRICT coeffs, float sample_rate) { static inline void bw_delay_set_sample_rate(
bw_delay_coeffs * BW_RESTRICT coeffs,
float sample_rate) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_init);
BW_ASSERT(bw_is_finite(sample_rate) && sample_rate > 0.f);
coeffs->fs = sample_rate; coeffs->fs = sample_rate;
coeffs->len = (size_t)bw_ceilf(coeffs->fs * coeffs->max_delay) + 1; coeffs->len = (size_t)bw_ceilf(coeffs->fs * coeffs->max_delay) + 1;
#ifdef BW_DEBUG_DEEP
coeffs->state = bw_delay_coeffs_state_set_sample_rate;
#endif
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state == bw_delay_coeffs_state_set_sample_rate);
} }
static inline size_t bw_delay_mem_req(const bw_delay_coeffs *BW_RESTRICT coeffs) { static inline size_t bw_delay_mem_req(
const bw_delay_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_set_sample_rate);
return coeffs->len * sizeof(float); return coeffs->len * sizeof(float);
} }
static inline void bw_delay_mem_set(const bw_delay_coeffs *BW_RESTRICT coeffs, bw_delay_state *BW_RESTRICT state, void *BW_RESTRICT mem) { static inline void bw_delay_mem_set(
const bw_delay_coeffs * BW_RESTRICT coeffs,
bw_delay_state * BW_RESTRICT state,
void * BW_RESTRICT mem) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_set_sample_rate);
BW_ASSERT(state != NULL);
BW_ASSERT(mem != NULL);
(void)coeffs; (void)coeffs;
state->buf = (float *)mem; state->buf = (float *)mem;
} }
static inline void bw_delay_reset_coeffs(bw_delay_coeffs *BW_RESTRICT coeffs) { static inline void bw_delay_do_update_coeffs_ctrl(bw_delay_coeffs *BW_RESTRICT coeffs) {
coeffs->delay_changed = 1;
bw_delay_update_coeffs_ctrl(coeffs);
}
static inline void bw_delay_reset_state(const bw_delay_coeffs *BW_RESTRICT coeffs, bw_delay_state *BW_RESTRICT state, float x_0) {
bw_buf_fill(x_0, state->buf, coeffs->len);
state->idx = 0;
}
static float bw_delay_read(const bw_delay_coeffs *BW_RESTRICT coeffs, const bw_delay_state *BW_RESTRICT state, size_t di, float df) {
const size_t n = (state->idx + (state->idx >= di ? 0 : coeffs->len)) - di;
const size_t p = (n ? n : coeffs->len) - 1;
return state->buf[n] + df * (state->buf[p] - state->buf[n]);
}
static void bw_delay_write(const bw_delay_coeffs *BW_RESTRICT coeffs, bw_delay_state *BW_RESTRICT state, float x) {
state->idx++;
state->idx = state->idx == coeffs->len ? 0 : state->idx;
state->buf[state->idx] = x;
}
static inline void bw_delay_update_coeffs_ctrl(bw_delay_coeffs *BW_RESTRICT coeffs) {
if (coeffs->delay_changed) { if (coeffs->delay_changed) {
float i; float i;
bw_intfracf(coeffs->fs * coeffs->delay, &i, &coeffs->df); bw_intfracf(coeffs->fs * coeffs->delay, &i, &coeffs->df);
@ -285,39 +421,297 @@ static inline void bw_delay_update_coeffs_ctrl(bw_delay_coeffs *BW_RESTRICT coef
} }
} }
static inline void bw_delay_update_coeffs_audio(bw_delay_coeffs *BW_RESTRICT coeffs) { static inline void bw_delay_reset_coeffs(
bw_delay_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_set_sample_rate);
coeffs->delay_changed = 1;
bw_delay_do_update_coeffs_ctrl(coeffs);
#ifdef BW_DEBUG_DEEP
coeffs->state = bw_delay_coeffs_state_reset_coeffs;
coeffs->reset_id++;
#endif
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state == bw_delay_coeffs_state_reset_coeffs);
}
static inline float bw_delay_reset_state(
const bw_delay_coeffs * BW_RESTRICT coeffs,
bw_delay_state * BW_RESTRICT state,
float x_0) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
BW_ASSERT(state != NULL);
BW_ASSERT(bw_is_finite(x_0));
bw_buf_fill(x_0, state->buf, coeffs->len);
state->idx = 0;
const float y = x_0;
#ifdef BW_DEBUG_DEEP
state->hash = bw_hash_sdbm("bw_delay_state");
state->coeffs_reset_id = coeffs->reset_id;
#endif
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
BW_ASSERT_DEEP(bw_delay_state_is_valid(coeffs, state));
BW_ASSERT(bw_is_finite(y));
return y;
}
static inline void bw_delay_reset_state_multi(
const bw_delay_coeffs * BW_RESTRICT coeffs,
bw_delay_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_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_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_delay_reset_state(coeffs, state[i], x_0[i]);
else
for (size_t i = 0; i < n_channels; i++)
bw_delay_reset_state(coeffs, state[i], x_0[i]);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
BW_ASSERT_DEEP(y_0 != NULL ? bw_has_only_finite(y_0, n_channels) : 1);
}
static float bw_delay_read(
const bw_delay_coeffs * BW_RESTRICT coeffs,
const bw_delay_state * BW_RESTRICT state,
size_t di,
float df) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
BW_ASSERT(state != NULL);
BW_ASSERT_DEEP(bw_delay_state_is_valid(coeffs, state));
BW_ASSERT(bw_is_finite(df));
BW_ASSERT(df >= 0.f && df < 1.f);
BW_ASSERT(di + df <= coeffs->len);
const size_t n = (state->idx + (state->idx >= di ? 0 : coeffs->len)) - di;
const size_t p = (n ? n : coeffs->len) - 1;
const float y = state->buf[n] + df * (state->buf[p] - state->buf[n]);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
BW_ASSERT_DEEP(bw_delay_state_is_valid(coeffs, state));
BW_ASSERT(bw_is_finite(y));
return y;
}
static void bw_delay_write(
const bw_delay_coeffs * BW_RESTRICT coeffs,
bw_delay_state * BW_RESTRICT state,
float x) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
BW_ASSERT(state != NULL);
BW_ASSERT_DEEP(bw_delay_state_is_valid(coeffs, state));
BW_ASSERT(bw_is_finite(x));
state->idx++;
state->idx = state->idx == coeffs->len ? 0 : state->idx;
state->buf[state->idx] = x;
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
BW_ASSERT_DEEP(bw_delay_state_is_valid(coeffs, state));
}
static inline void bw_delay_update_coeffs_ctrl(
bw_delay_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
bw_delay_do_update_coeffs_ctrl(coeffs);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
}
static inline void bw_delay_update_coeffs_audio(
bw_delay_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
(void)coeffs; (void)coeffs;
} }
static inline float bw_delay_process1(const bw_delay_coeffs *BW_RESTRICT coeffs, bw_delay_state *BW_RESTRICT state, float x) { static inline float bw_delay_process1(
const bw_delay_coeffs * BW_RESTRICT coeffs,
bw_delay_state * BW_RESTRICT state,
float x) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
BW_ASSERT(state != NULL);
BW_ASSERT_DEEP(bw_delay_state_is_valid(coeffs, state));
BW_ASSERT(bw_is_finite(x));
bw_delay_write(coeffs, state, x); bw_delay_write(coeffs, state, x);
return bw_delay_read(coeffs, state, coeffs->di, coeffs->df); const float y = bw_delay_read(coeffs, state, coeffs->di, coeffs->df);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
BW_ASSERT_DEEP(bw_delay_state_is_valid(coeffs, state));
BW_ASSERT(bw_is_finite(y));
return y;
} }
static inline void bw_delay_process(bw_delay_coeffs *BW_RESTRICT coeffs, bw_delay_state *BW_RESTRICT state, const float *x, float *y, size_t n_samples) { static inline void bw_delay_process(
bw_delay_coeffs * BW_RESTRICT coeffs,
bw_delay_state * BW_RESTRICT state,
const float * x,
float * y,
size_t n_samples) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
BW_ASSERT(state != NULL);
BW_ASSERT_DEEP(bw_delay_state_is_valid(coeffs, state));
BW_ASSERT(x != NULL);
BW_ASSERT_DEEP(bw_has_only_finite(x, n_samples));
BW_ASSERT(y != NULL);
bw_delay_update_coeffs_ctrl(coeffs); bw_delay_update_coeffs_ctrl(coeffs);
for (size_t i = 0; i < n_samples; i++) for (size_t i = 0; i < n_samples; i++)
y[i] = bw_delay_process1(coeffs, state, x[i]); y[i] = bw_delay_process1(coeffs, state, x[i]);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
BW_ASSERT_DEEP(bw_delay_state_is_valid(coeffs, state));
BW_ASSERT_DEEP(bw_has_only_finite(y, n_samples));
} }
static inline void bw_delay_process_multi(bw_delay_coeffs *BW_RESTRICT coeffs, bw_delay_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_delay_process_multi(
bw_delay_coeffs * BW_RESTRICT coeffs,
bw_delay_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_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
BW_ASSERT(state != NULL);
BW_ASSERT(x != NULL);
BW_ASSERT(y != NULL);
bw_delay_update_coeffs_ctrl(coeffs); bw_delay_update_coeffs_ctrl(coeffs);
for (size_t i = 0; i < n_samples; i++) for (size_t i = 0; i < n_samples; i++)
for (size_t j = 0; j < n_channels; j++) for (size_t j = 0; j < n_channels; j++)
y[j][i] = bw_delay_process1(coeffs, state[j], x[j][i]); y[j][i] = bw_delay_process1(coeffs, state[j], x[j][i]);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_reset_coeffs);
} }
static inline void bw_delay_set_delay(bw_delay_coeffs *BW_RESTRICT coeffs, float value) { static inline void bw_delay_set_delay(
bw_delay_coeffs * BW_RESTRICT coeffs,
float value) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_init);
BW_ASSERT(bw_is_finite(value));
if (value != coeffs->delay) { if (value != coeffs->delay) {
coeffs->delay = value; coeffs->delay = value;
coeffs->delay_changed = 1; coeffs->delay_changed = 1;
} }
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_init);
} }
static inline size_t bw_delay_get_length(const bw_delay_coeffs *BW_RESTRICT coeffs) { static inline size_t bw_delay_get_length(
const bw_delay_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != NULL);
BW_ASSERT_DEEP(bw_delay_coeffs_is_valid(coeffs));
BW_ASSERT_DEEP(coeffs->state >= bw_delay_coeffs_state_set_sample_rate);
return coeffs->len; return coeffs->len;
} }
static inline char bw_delay_coeffs_is_valid(
const bw_delay_coeffs * BW_RESTRICT coeffs) {
BW_ASSERT(coeffs != NULL);
#ifdef BW_DEBUG_DEEP
if (coeffs->hash != bw_hash_sdbm("bw_delay_coeffs"))
return 0;
if (coeffs->state < bw_delay_coeffs_state_init || coeffs->state > bw_delay_coeffs_state_reset_coeffs)
return 0;
#endif
if (!bw_is_finite(coeffs->max_delay) || coeffs->max_delay <= 0.f)
return 0;
if (!bw_is_finite(coeffs->delay) || coeffs->delay < 0.f || coeffs->delay > coeffs->max_delay)
return 0;
#ifdef BW_DEBUG_DEEP
if (coeffs->state >= bw_delay_coeffs_state_set_sample_rate) {
if (!bw_is_finite(coeffs->fs) || coeffs->fs <= 0.f)
return 0;
if (coeffs->len == 0)
return 0;
}
if (coeffs->state >= bw_delay_coeffs_state_reset_coeffs) {
if (!bw_is_finite(coeffs->df) || coeffs->df < 0.f || coeffs->df >= 1.f)
return 0;
if (coeffs->di + coeffs->df > coeffs->len)
return 0;
}
#endif
return 1;
}
static inline char bw_delay_state_is_valid(
const bw_delay_coeffs * BW_RESTRICT coeffs,
const bw_delay_state * BW_RESTRICT state) {
BW_ASSERT(state != NULL);
#ifdef BW_DEBUG_DEEP
if (state->hash != bw_hash_sdbm("bw_delay_state"))
return 0;
if (coeffs != NULL && coeffs->reset_id != state->coeffs_reset_id)
return 0;
#endif
(void)coeffs;
if (state->buf == NULL)
return 0;
#ifdef BW_DEBUG_DEEP
if (coeffs != NULL && coeffs->state >= bw_delay_coeffs_state_set_sample_rate && state->idx >= coeffs->len)
return 0;
#endif
return 1;
}
#ifdef __cplusplus #ifdef __cplusplus
} }
@ -333,26 +727,42 @@ namespace Brickworks {
template<size_t N_CHANNELS> template<size_t N_CHANNELS>
class Delay { class Delay {
public: public:
Delay(float maxDelay = 1.f); Delay(
float maxDelay = 1.f);
~Delay(); ~Delay();
void setSampleRate(float sampleRate); void setSampleRate(
void reset(float x_0 = 0.f); float sampleRate);
void reset(const float *BW_RESTRICT x_0);
void reset(const std::array<float, N_CHANNELS> x_0);
void process(
const float * const *x,
float * const *y,
size_t nSamples);
void process(
const std::array<const float *, N_CHANNELS> x,
const std::array<float *, N_CHANNELS> y,
size_t nSamples);
float read(size_t channel, size_t di, float df); void reset(
void write(size_t channel, float x); float x0 = 0.f,
float * BW_RESTRICT y0 = nullptr);
void setDelay(float value); 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);
void process(
std::array<const float *, N_CHANNELS> x,
std::array<float *, N_CHANNELS> y,
size_t nSamples);
void setDelay(
float value);
size_t getLength(); size_t getLength();
/*! <<<... /*! <<<...
@ -366,10 +776,10 @@ public:
* change at any time in future versions. Please, do not use it directly. */ * change at any time in future versions. Please, do not use it directly. */
private: private:
bw_delay_coeffs coeffs; bw_delay_coeffs coeffs;
bw_delay_state states[N_CHANNELS]; bw_delay_state states[N_CHANNELS];
bw_delay_state *BW_RESTRICT statesP[N_CHANNELS]; bw_delay_state * BW_RESTRICT statesP[N_CHANNELS];
void *BW_RESTRICT mem; void * BW_RESTRICT mem;
}; };
template<size_t N_CHANNELS> template<size_t N_CHANNELS>
@ -387,7 +797,8 @@ inline Delay<N_CHANNELS>::~Delay() {
} }
template<size_t N_CHANNELS> template<size_t N_CHANNELS>
inline void Delay<N_CHANNELS>::setSampleRate(float sampleRate) { inline void Delay<N_CHANNELS>::setSampleRate(
float sampleRate) {
bw_delay_set_sample_rate(&coeffs, sampleRate); bw_delay_set_sample_rate(&coeffs, sampleRate);
size_t req = bw_delay_mem_req(&coeffs); size_t req = bw_delay_mem_req(&coeffs);
if (mem != nullptr) if (mem != nullptr)
@ -399,52 +810,59 @@ inline void Delay<N_CHANNELS>::setSampleRate(float sampleRate) {
} }
template<size_t N_CHANNELS> template<size_t N_CHANNELS>
inline void Delay<N_CHANNELS>::reset(float x_0) { inline void Delay<N_CHANNELS>::reset(
float x0,
float * BW_RESTRICT y0) {
bw_delay_reset_coeffs(&coeffs); bw_delay_reset_coeffs(&coeffs);
for (size_t i = 0; i < N_CHANNELS; i++) if (y0 != nullptr)
bw_delay_reset_state(&coeffs, states + i, x_0); for (size_t i = 0; i < N_CHANNELS; i++)
y0[i] = bw_delay_reset_state(&coeffs, states + i, x0);
else
for (size_t i = 0; i < N_CHANNELS; i++)
bw_delay_reset_state(&coeffs, states + i, x0);
} }
template<size_t N_CHANNELS> template<size_t N_CHANNELS>
inline void Delay<N_CHANNELS>::reset(const float *BW_RESTRICT x_0) { inline void Delay<N_CHANNELS>::reset(
bw_delay_reset_coeffs(&coeffs); float x0,
for (size_t i = 0; i < N_CHANNELS; i++) std::array<float, N_CHANNELS> * BW_RESTRICT y0) {
bw_delay_reset_state(&coeffs, states + i, x_0[i]); reset(x0, y0 != nullptr ? y0->data() : nullptr);
} }
template<size_t N_CHANNELS> template<size_t N_CHANNELS>
inline void Delay<N_CHANNELS>::reset(const std::array<float, N_CHANNELS> x_0) { inline void Delay<N_CHANNELS>::reset(
reset(x_0.data()); const float * x0,
float * y0) {
bw_delay_reset_coeffs(&coeffs);
bw_delay_reset_state_multi(&coeffs, statesP, x0, y0, N_CHANNELS);
}
template<size_t N_CHANNELS>
inline void Delay<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> template<size_t N_CHANNELS>
inline void Delay<N_CHANNELS>::process( inline void Delay<N_CHANNELS>::process(
const float * const *x, const float * const * x,
float * const *y, float * const * y,
size_t nSamples) { size_t nSamples) {
bw_delay_process_multi(&coeffs, statesP, x, y, N_CHANNELS, nSamples); bw_delay_process_multi(&coeffs, statesP, x, y, N_CHANNELS, nSamples);
} }
template<size_t N_CHANNELS> template<size_t N_CHANNELS>
inline void Delay<N_CHANNELS>::process( inline void Delay<N_CHANNELS>::process(
const std::array<const float *, N_CHANNELS> x, std::array<const float *, N_CHANNELS> x,
const std::array<float *, N_CHANNELS> y, std::array<float *, N_CHANNELS> y,
size_t nSamples) { size_t nSamples) {
process(x.data(), y.data(), nSamples); process(x.data(), y.data(), nSamples);
} }
template<size_t N_CHANNELS> template<size_t N_CHANNELS>
inline float Delay<N_CHANNELS>::read(size_t channel, size_t di, float df) { inline void Delay<N_CHANNELS>::setDelay(
return bw_delay_read(&coeffs, states + channel, di, df); float value) {
}
template<size_t N_CHANNELS>
inline void Delay<N_CHANNELS>::write(size_t channel, float x) {
bw_delay_write(&coeffs, states + channel, x);
}
template<size_t N_CHANNELS>
inline void Delay<N_CHANNELS>::setDelay(float value) {
bw_delay_set_delay(&coeffs, value); bw_delay_set_delay(&coeffs, value);
} }