987 lines
32 KiB
C++
987 lines
32 KiB
C++
/*
|
|
* Brickworks
|
|
*
|
|
* Copyright (C) 2022-2024 Orastron Srl unipersonale
|
|
*
|
|
* Brickworks is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, version 3 of the License.
|
|
*
|
|
* Brickworks is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with Brickworks. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* File author: Stefano D'Angelo
|
|
*/
|
|
|
|
/*!
|
|
* module_type {{{ dsp }}}
|
|
* version {{{ 1.1.0 }}}
|
|
* requires {{{ bw_common bw_env_follow bw_math bw_one_pole }}}
|
|
* description {{{
|
|
* Noise gate with independent sidechain input.
|
|
* }}}
|
|
* changelog {{{
|
|
* <ul>
|
|
* <li>Version <strong>1.1.0</strong>:
|
|
* <ul>
|
|
* <li>Relaxed <code>bw_noise_gate_reset_state_multi</code>,
|
|
* <code>bw_noise_gate_process</code>, and
|
|
* <code>bw_noise_gate_process_multi</code> APIs to accept
|
|
* <code>BW_NULL</code> as sidechain inputs.</li>
|
|
* <li>Now using <code>BW_NULL</code> and
|
|
* <code>BW_CXX_NO_ARRAY</code>.</li>
|
|
* <li>Added <code>setThreshLin()</code> and <code>setThreshDB()</code>
|
|
* methods to fix a typo in method names without breaking the
|
|
* API.</li>
|
|
* </ul>
|
|
* </li>
|
|
* <li>Version <strong>1.0.0</strong>:
|
|
* <ul>
|
|
* <li>Added initial input values to
|
|
* <code>bw_noise_gate_reset_state()</code>.</li>
|
|
* <li>Added <code>bw_noise_gate_reset_state_multi()</code> and updated
|
|
* C++ API in this regard.</li>
|
|
* <li>Now <code>bw_noise_gate_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_noise_gate_process()</code> and
|
|
* <code>bw_noise_gate_process_multi()</code> now use
|
|
* <code>size_t</code> to count samples and channels.</li>
|
|
* <li>Added more <code>const</code> and <code>BW_RESTRICT</code>
|
|
* specifiers to input arguments and implementation.</li>
|
|
* <li>Moved C++ code to C header.</li>
|
|
* <li>Added overloaded C++ <code>process()</code> function taking
|
|
* C-style arrays as arguments.</li>
|
|
* <li>Fixed missing smoothing filter initialization.</li>
|
|
* <li>Fixed missing forced coefficients' update in
|
|
* <code>bw_noise_gate_reset_coeffs()</code>.</li>
|
|
* <li>Improved and strengthened algorithm.</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>:
|
|
* <ul>
|
|
* <li>Removed dependency on bw_config.</li>
|
|
* </ul>
|
|
* </li>
|
|
* <li>Version <strong>0.5.0</strong>:
|
|
* <ul>
|
|
* <li>Added <code>bw_noise_gate_process_multi()</code>.</li>
|
|
* <li>Added C++ wrapper.</li>
|
|
* </ul>
|
|
* </li>
|
|
* <li>Version <strong>0.3.0</strong>:
|
|
* <ul>
|
|
* <li>First release.</li>
|
|
* </ul>
|
|
* </li>
|
|
* </ul>
|
|
* }}}
|
|
*/
|
|
|
|
#ifndef BW_NOISE_GATE_H
|
|
#define BW_NOISE_GATE_H
|
|
|
|
#include <bw_common.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*! api {{{
|
|
* #### bw_noise_gate_coeffs
|
|
* ```>>> */
|
|
typedef struct bw_noise_gate_coeffs bw_noise_gate_coeffs;
|
|
/*! <<<```
|
|
* Coefficients and related.
|
|
*
|
|
* #### bw_noise_gate_state
|
|
* ```>>> */
|
|
typedef struct bw_noise_gate_state bw_noise_gate_state;
|
|
/*! <<<```
|
|
* Internal state and related.
|
|
*
|
|
* #### bw_noise_gate_init()
|
|
* ```>>> */
|
|
static inline void bw_noise_gate_init(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs);
|
|
/*! <<<```
|
|
* Initializes input parameter values in `coeffs`.
|
|
*
|
|
* #### bw_noise_gate_set_sample_rate()
|
|
* ```>>> */
|
|
static inline void bw_noise_gate_set_sample_rate(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
float sample_rate);
|
|
/*! <<<```
|
|
* Sets the `sample_rate` (Hz) value in `coeffs`.
|
|
*
|
|
* #### bw_noise_gate_reset_coeffs()
|
|
* ```>>> */
|
|
static inline void bw_noise_gate_reset_coeffs(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs);
|
|
/*! <<<```
|
|
* Resets coefficients in `coeffs` to assume their target values.
|
|
*
|
|
* #### bw_noise_gate_reset_state()
|
|
* ```>>> */
|
|
static inline float bw_noise_gate_reset_state(
|
|
const bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
bw_noise_gate_state * BW_RESTRICT state,
|
|
float x_0,
|
|
float x_sc_0);
|
|
/*! <<<```
|
|
* Resets the given `state` to its initial values using the given `coeffs`
|
|
* and the initial input value `x_0` and sidechain input value `x_sc_0`.
|
|
*
|
|
* Returns the corresponding initial output value.
|
|
*
|
|
* #### bw_noise_gate_reset_state_multi()
|
|
* ```>>> */
|
|
static inline void bw_noise_gate_reset_state_multi(
|
|
const bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
bw_noise_gate_state * BW_RESTRICT const * BW_RESTRICT state,
|
|
const float * x_0,
|
|
const float * x_sc_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 and sidechain input value in the `x_sc_0` array.
|
|
*
|
|
* The corresponding initial output values are written into the `y_0` array,
|
|
* if not `BW_NULL`.
|
|
*
|
|
* If `x_sc_0` is `BW_NULL` the initial sidechain input values are assumed to
|
|
* be `0.f`.
|
|
*
|
|
* #### bw_noise_gate_update_coeffs_ctrl()
|
|
* ```>>> */
|
|
static inline void bw_noise_gate_update_coeffs_ctrl(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs);
|
|
/*! <<<```
|
|
* Triggers control-rate update of coefficients in `coeffs`.
|
|
*
|
|
* #### bw_noise_gate_update_coeffs_audio()
|
|
* ```>>> */
|
|
static inline void bw_noise_gate_update_coeffs_audio(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs);
|
|
/*! <<<```
|
|
* Triggers audio-rate update of coefficients in `coeffs`.
|
|
*
|
|
* #### bw_noise_gate_process1()
|
|
* ```>>> */
|
|
static inline float bw_noise_gate_process1(
|
|
const bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
bw_noise_gate_state * BW_RESTRICT state,
|
|
float x,
|
|
float x_sc);
|
|
/*! <<<```
|
|
* Processes one input sample `x` and the corresponding sidechain input
|
|
* sample `x_sc` using `coeffs`, while using and updating `state`. Returns
|
|
* the corresponding output sample.
|
|
*
|
|
* #### bw_noise_gate_process()
|
|
* ```>>> */
|
|
static inline void bw_noise_gate_process(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
bw_noise_gate_state * BW_RESTRICT state,
|
|
const float * x,
|
|
const float * x_sc,
|
|
float * y,
|
|
size_t n_samples);
|
|
/*! <<<```
|
|
* Processes the first `n_samples` of the input buffer `x` and the first
|
|
* `n_samples` of the sidechain input buffer `x_sc`, and fills the first
|
|
* `n_samples` of the output buffer `y`, while using and updating both
|
|
* `coeffs` and `state` (control and audio rate).
|
|
*
|
|
* If `x_sc` is `BW_NULL` it behaves as if a zero-filled buffer was passed
|
|
* instead.
|
|
*
|
|
* #### bw_noise_gate_process_multi()
|
|
* ```>>> */
|
|
static inline void bw_noise_gate_process_multi(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
bw_noise_gate_state * BW_RESTRICT const * BW_RESTRICT state,
|
|
const float * const * x,
|
|
const float * const * x_sc,
|
|
float * const * y,
|
|
size_t n_channels,
|
|
size_t n_samples);
|
|
/*! <<<```
|
|
* Processes the first `n_samples` of the `n_channels` input buffers `x` and
|
|
* the first `n_samples` of the `n_channels` sidechain input buffers `x_sc`,
|
|
* and fills the first `n_samples` of the `n_channels` output buffers `y`,
|
|
* while using and updating both the common `coeffs` and each of the
|
|
* `n_channels` `state`s (control and audio rate).
|
|
*
|
|
* If `x_sc` is `BW_NULL` it behaves as if zero-filled buffers were passed
|
|
* instead.
|
|
*
|
|
* #### bw_noise_gate_set_thresh_lin()
|
|
* ```>>> */
|
|
static inline void bw_noise_gate_set_thresh_lin(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
float value);
|
|
/*! <<<```
|
|
* Sets the threshold `value` (linear) in `coeffs`.
|
|
*
|
|
* Valid range: [`1e-20f`, `1e20f`].
|
|
*
|
|
* Default value: `1.f`.
|
|
*
|
|
* #### bw_noise_gate_set_thresh_dBFS()
|
|
* ```>>> */
|
|
static inline void bw_noise_gate_set_thresh_dBFS(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
float value);
|
|
/*! <<<```
|
|
* Sets the threshold `value` (dBFS) in `coeffs`.
|
|
*
|
|
* Valid range: [`-400.f`, `400.f`].
|
|
*
|
|
* Default value: `0.f`.
|
|
*
|
|
* #### bw_noise_gate_set_ratio()
|
|
* ```>>> */
|
|
static inline void bw_noise_gate_set_ratio(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
float value);
|
|
/*! <<<```
|
|
* Sets the copmpression ratio `value` in `coeffs`.
|
|
*
|
|
* `value` is actually the slope of the gain curve below the threshold, hence
|
|
* `1.f` means no gating and `INIFINITY` leads to a hard gate.
|
|
*
|
|
* `value` must be greater than or equal to `1.f`.
|
|
*
|
|
* Default value: `1.f`.
|
|
*
|
|
* #### bw_noise_gate_set_attack_tau()
|
|
* ```>>> */
|
|
static inline void bw_noise_gate_set_attack_tau(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
float value);
|
|
/*! <<<```
|
|
* Sets the attack time constant `value` (s) in `coeffs`.
|
|
*
|
|
* `value` must be non-negative.
|
|
*
|
|
* Default value: `0.f`.
|
|
*
|
|
* #### bw_noise_gate_set_release_tau()
|
|
* ```>>> */
|
|
static inline void bw_noise_gate_set_release_tau(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
float value);
|
|
/*! <<<```
|
|
* Sets the release time constant `value` (s) in `coeffs`.
|
|
*
|
|
* `value` must be non-negative.
|
|
*
|
|
* Default value: `0.f`.
|
|
*
|
|
* #### bw_noise_gate_coeffs_is_valid()
|
|
* ```>>> */
|
|
static inline char bw_noise_gate_coeffs_is_valid(
|
|
const bw_noise_gate_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_noise_gate_coeffs`.
|
|
*
|
|
* #### bw_noise_gate_state_is_valid()
|
|
* ```>>> */
|
|
static inline char bw_noise_gate_state_is_valid(
|
|
const bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
const bw_noise_gate_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 `BW_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_noise_gate_state`.
|
|
* }}} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
/*** Implementation ***/
|
|
|
|
/* WARNING: This part of the file is not part of the public API. Its content may
|
|
* change at any time in future versions. Please, do not use it directly. */
|
|
|
|
#include <bw_math.h>
|
|
#include <bw_env_follow.h>
|
|
#include <bw_one_pole.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#ifdef BW_DEBUG_DEEP
|
|
enum bw_noise_gate_coeffs_state {
|
|
bw_noise_gate_coeffs_state_invalid,
|
|
bw_noise_gate_coeffs_state_init,
|
|
bw_noise_gate_coeffs_state_set_sample_rate,
|
|
bw_noise_gate_coeffs_state_reset_coeffs
|
|
};
|
|
#endif
|
|
|
|
struct bw_noise_gate_coeffs {
|
|
#ifdef BW_DEBUG_DEEP
|
|
uint32_t hash;
|
|
enum bw_noise_gate_coeffs_state state;
|
|
uint32_t reset_id;
|
|
#endif
|
|
|
|
// Sub-components
|
|
bw_env_follow_coeffs env_follow_coeffs;
|
|
bw_one_pole_coeffs smooth_coeffs;
|
|
bw_one_pole_state smooth_thresh_state;
|
|
bw_one_pole_state smooth_ratio_state;
|
|
|
|
// Coefficients
|
|
float kc;
|
|
float lt;
|
|
|
|
// Parameters
|
|
float thresh;
|
|
float ratio;
|
|
};
|
|
|
|
struct bw_noise_gate_state {
|
|
#ifdef BW_DEBUG_DEEP
|
|
uint32_t hash;
|
|
uint32_t coeffs_reset_id;
|
|
#endif
|
|
|
|
// Sub-components
|
|
bw_env_follow_state env_follow_state;
|
|
};
|
|
|
|
static inline void bw_noise_gate_init(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
|
|
bw_env_follow_init(&coeffs->env_follow_coeffs);
|
|
bw_one_pole_init(&coeffs->smooth_coeffs);
|
|
bw_one_pole_set_tau(&coeffs->smooth_coeffs, 0.05f);
|
|
coeffs->thresh = 1.f;
|
|
coeffs->ratio = 1.f;
|
|
|
|
#ifdef BW_DEBUG_DEEP
|
|
coeffs->hash = bw_hash_sdbm("bw_noise_gate_coeffs");
|
|
coeffs->state = bw_noise_gate_coeffs_state_init;
|
|
coeffs->reset_id = coeffs->hash + 1;
|
|
#endif
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state == bw_noise_gate_coeffs_state_init);
|
|
}
|
|
|
|
static inline void bw_noise_gate_set_sample_rate(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
float sample_rate) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_init);
|
|
BW_ASSERT(bw_is_finite(sample_rate) && sample_rate > 0.f);
|
|
|
|
bw_env_follow_set_sample_rate(&coeffs->env_follow_coeffs, sample_rate);
|
|
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_noise_gate_coeffs_state_set_sample_rate;
|
|
#endif
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state == bw_noise_gate_coeffs_state_set_sample_rate);
|
|
}
|
|
|
|
static inline void bw_noise_gate_do_update_coeffs_audio(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs) {
|
|
bw_env_follow_update_coeffs_audio(&coeffs->env_follow_coeffs);
|
|
bw_one_pole_process1(&coeffs->smooth_coeffs, &coeffs->smooth_thresh_state, coeffs->thresh);
|
|
const float rev_ratio = bw_one_pole_process1(&coeffs->smooth_coeffs, &coeffs->smooth_ratio_state, coeffs->ratio > 1e12f ? 0.f : bw_rcpf(coeffs->ratio));
|
|
coeffs->kc = rev_ratio < 1e-12f ? -INFINITY : 1.f - bw_rcpf(rev_ratio);
|
|
coeffs->lt = bw_log2f(bw_one_pole_get_y_z1(&coeffs->smooth_thresh_state));
|
|
}
|
|
|
|
static inline void bw_noise_gate_reset_coeffs(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_set_sample_rate);
|
|
|
|
bw_env_follow_reset_coeffs(&coeffs->env_follow_coeffs);
|
|
bw_one_pole_reset_state(&coeffs->smooth_coeffs, &coeffs->smooth_thresh_state, coeffs->thresh);
|
|
bw_one_pole_reset_state(&coeffs->smooth_coeffs, &coeffs->smooth_ratio_state, coeffs->ratio > 1e12f ? 0.f : bw_rcpf(coeffs->ratio));
|
|
bw_noise_gate_do_update_coeffs_audio(coeffs);
|
|
|
|
#ifdef BW_DEBUG_DEEP
|
|
coeffs->state = bw_noise_gate_coeffs_state_reset_coeffs;
|
|
coeffs->reset_id++;
|
|
#endif
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state == bw_noise_gate_coeffs_state_reset_coeffs);
|
|
}
|
|
|
|
static inline float bw_noise_gate_reset_state(
|
|
const bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
bw_noise_gate_state * BW_RESTRICT state,
|
|
float x_0,
|
|
float x_sc_0) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_reset_coeffs);
|
|
BW_ASSERT(state != BW_NULL);
|
|
BW_ASSERT(bw_is_finite(x_0));
|
|
BW_ASSERT(bw_is_finite(x_sc_0));
|
|
|
|
const float env = bw_env_follow_reset_state(&coeffs->env_follow_coeffs, &state->env_follow_state, x_sc_0);
|
|
const float y = env < bw_one_pole_get_y_z1(&coeffs->smooth_thresh_state) ? (env >= 1e-30f ? bw_pow2f(coeffs->kc * (coeffs->lt - bw_log2f(env))) * x_0 : 0.f) : x_0;
|
|
|
|
#ifdef BW_DEBUG_DEEP
|
|
state->hash = bw_hash_sdbm("bw_noise_gate_state");
|
|
state->coeffs_reset_id = coeffs->reset_id;
|
|
#endif
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_reset_coeffs);
|
|
BW_ASSERT_DEEP(bw_noise_gate_state_is_valid(coeffs, state));
|
|
BW_ASSERT(bw_is_finite(y));
|
|
|
|
return y;
|
|
}
|
|
|
|
static inline void bw_noise_gate_reset_state_multi(
|
|
const bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
bw_noise_gate_state * BW_RESTRICT const * BW_RESTRICT state,
|
|
const float * x_0,
|
|
const float * x_sc_0,
|
|
float * y_0,
|
|
size_t n_channels) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_reset_coeffs);
|
|
BW_ASSERT(state != BW_NULL);
|
|
#ifndef BW_NO_DEBUG
|
|
for (size_t i = 0; i < n_channels; i++)
|
|
for (size_t j = i + 1; j < n_channels; j++)
|
|
BW_ASSERT(state[i] != state[j]);
|
|
#endif
|
|
BW_ASSERT(x_0 != BW_NULL);
|
|
|
|
if (x_sc_0 != BW_NULL) {
|
|
if (y_0 != BW_NULL)
|
|
for (size_t i = 0; i < n_channels; i++)
|
|
y_0[i] = bw_noise_gate_reset_state(coeffs, state[i], x_0[i], x_sc_0[i]);
|
|
else
|
|
for (size_t i = 0; i < n_channels; i++)
|
|
bw_noise_gate_reset_state(coeffs, state[i], x_0[i], x_sc_0[i]);
|
|
} else {
|
|
if (y_0 != BW_NULL)
|
|
for (size_t i = 0; i < n_channels; i++)
|
|
y_0[i] = bw_noise_gate_reset_state(coeffs, state[i], x_0[i], 0.f);
|
|
else
|
|
for (size_t i = 0; i < n_channels; i++)
|
|
bw_noise_gate_reset_state(coeffs, state[i], x_0[i], 0.f);
|
|
|
|
}
|
|
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_reset_coeffs);
|
|
BW_ASSERT_DEEP(bw_has_only_finite(y_0, n_channels));
|
|
BW_ASSERT_DEEP(y_0 != BW_NULL ? bw_has_only_finite(y_0, n_channels) : 1);
|
|
}
|
|
|
|
static inline void bw_noise_gate_update_coeffs_ctrl(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_reset_coeffs);
|
|
|
|
bw_env_follow_update_coeffs_ctrl(&coeffs->env_follow_coeffs);
|
|
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_reset_coeffs);
|
|
}
|
|
|
|
static inline void bw_noise_gate_update_coeffs_audio(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_reset_coeffs);
|
|
|
|
bw_noise_gate_do_update_coeffs_audio(coeffs);
|
|
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_reset_coeffs);
|
|
}
|
|
|
|
static inline float bw_noise_gate_process1(
|
|
const bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
bw_noise_gate_state * BW_RESTRICT state,
|
|
float x,
|
|
float x_sc) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_reset_coeffs);
|
|
BW_ASSERT(state != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_state_is_valid(coeffs, state));
|
|
BW_ASSERT(bw_is_finite(x));
|
|
BW_ASSERT(bw_is_finite(x_sc));
|
|
|
|
const float env = bw_env_follow_process1(&coeffs->env_follow_coeffs, &state->env_follow_state, x_sc);
|
|
const float y = env < bw_one_pole_get_y_z1(&coeffs->smooth_thresh_state) ? (env >= 1e-30f ? bw_pow2f(coeffs->kc * (coeffs->lt - bw_log2f(env))) * x : 0.f) : x;
|
|
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_reset_coeffs);
|
|
BW_ASSERT_DEEP(bw_noise_gate_state_is_valid(coeffs, state));
|
|
BW_ASSERT(bw_is_finite(y));
|
|
|
|
return y;
|
|
}
|
|
|
|
static inline void bw_noise_gate_process(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
bw_noise_gate_state * BW_RESTRICT state,
|
|
const float * x,
|
|
const float * x_sc,
|
|
float * y,
|
|
size_t n_samples) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_reset_coeffs);
|
|
BW_ASSERT(state != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_state_is_valid(coeffs, state));
|
|
BW_ASSERT(x != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_has_only_finite(x, n_samples));
|
|
BW_ASSERT_DEEP(x_sc != BW_NULL ? bw_has_only_finite(x_sc, n_samples) : 1);
|
|
BW_ASSERT(y != BW_NULL);
|
|
|
|
bw_noise_gate_update_coeffs_ctrl(coeffs);
|
|
if (x_sc != BW_NULL)
|
|
for (size_t i = 0; i < n_samples; i++) {
|
|
bw_noise_gate_update_coeffs_audio(coeffs);
|
|
y[i] = bw_noise_gate_process1(coeffs, state, x[i], x_sc[i]);
|
|
}
|
|
else
|
|
for (size_t i = 0; i < n_samples; i++) {
|
|
bw_noise_gate_update_coeffs_audio(coeffs);
|
|
y[i] = bw_noise_gate_process1(coeffs, state, x[i], 0.f);
|
|
}
|
|
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_reset_coeffs);
|
|
BW_ASSERT_DEEP(bw_noise_gate_state_is_valid(coeffs, state));
|
|
BW_ASSERT_DEEP(bw_has_only_finite(y, n_samples));
|
|
}
|
|
|
|
static inline void bw_noise_gate_process_multi(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
bw_noise_gate_state * BW_RESTRICT const * BW_RESTRICT state,
|
|
const float * const * x, const float * const * x_sc,
|
|
float * const * y,
|
|
size_t n_channels,
|
|
size_t n_samples) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_reset_coeffs);
|
|
BW_ASSERT(state != BW_NULL);
|
|
#ifndef BW_NO_DEBUG
|
|
for (size_t i = 0; i < n_channels; i++)
|
|
for (size_t j = i + 1; j < n_channels; j++)
|
|
BW_ASSERT(state[i] != state[j]);
|
|
#endif
|
|
BW_ASSERT(x != BW_NULL);
|
|
BW_ASSERT(y != BW_NULL);
|
|
#ifndef BW_NO_DEBUG
|
|
for (size_t i = 0; i < n_channels; i++)
|
|
for (size_t j = i + 1; j < n_channels; j++)
|
|
BW_ASSERT(y[i] != y[j]);
|
|
#endif
|
|
|
|
bw_noise_gate_update_coeffs_ctrl(coeffs);
|
|
if (x_sc != BW_NULL)
|
|
for (size_t i = 0; i < n_samples; i++) {
|
|
bw_noise_gate_update_coeffs_audio(coeffs);
|
|
for (size_t j = 0; j < n_channels; j++)
|
|
y[j][i] = bw_noise_gate_process1(coeffs, state[j], x[j][i], x_sc[j] != BW_NULL ? x_sc[j][i] : 0.f);
|
|
}
|
|
else
|
|
for (size_t i = 0; i < n_samples; i++) {
|
|
bw_noise_gate_update_coeffs_audio(coeffs);
|
|
for (size_t j = 0; j < n_channels; j++)
|
|
y[j][i] = bw_noise_gate_process1(coeffs, state[j], x[j][i], 0.f);
|
|
}
|
|
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_reset_coeffs);
|
|
}
|
|
|
|
static inline void bw_noise_gate_set_thresh_lin(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
float value) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_init);
|
|
BW_ASSERT(bw_is_finite(value));
|
|
BW_ASSERT(value >= 1e-20f && value <= 1e20f);
|
|
|
|
coeffs->thresh = value;
|
|
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_init);
|
|
}
|
|
|
|
static inline void bw_noise_gate_set_thresh_dBFS(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
float value) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_init);
|
|
BW_ASSERT(bw_is_finite(value));
|
|
BW_ASSERT(value >= -400.f && value <= 400.f);
|
|
|
|
coeffs->thresh = bw_dB2linf(value);
|
|
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_init);
|
|
}
|
|
|
|
static inline void bw_noise_gate_set_ratio(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
float value) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_init);
|
|
BW_ASSERT(!bw_is_nan(value));
|
|
BW_ASSERT(value >= 1.f);
|
|
|
|
coeffs->ratio = value;
|
|
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_init);
|
|
}
|
|
|
|
static inline void bw_noise_gate_set_attack_tau(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
float value) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_init);
|
|
BW_ASSERT(!bw_is_nan(value));
|
|
BW_ASSERT(value >= 0.f);
|
|
|
|
bw_env_follow_set_attack_tau(&coeffs->env_follow_coeffs, value);
|
|
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_init);
|
|
}
|
|
|
|
static inline void bw_noise_gate_set_release_tau(
|
|
bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
float value) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_init);
|
|
BW_ASSERT(!bw_is_nan(value));
|
|
BW_ASSERT(value >= 0.f);
|
|
|
|
bw_env_follow_set_release_tau(&coeffs->env_follow_coeffs, value);
|
|
|
|
BW_ASSERT_DEEP(bw_noise_gate_coeffs_is_valid(coeffs));
|
|
BW_ASSERT_DEEP(coeffs->state >= bw_noise_gate_coeffs_state_init);
|
|
}
|
|
|
|
static inline char bw_noise_gate_coeffs_is_valid(
|
|
const bw_noise_gate_coeffs * BW_RESTRICT coeffs) {
|
|
BW_ASSERT(coeffs != BW_NULL);
|
|
|
|
#ifdef BW_DEBUG_DEEP
|
|
if (coeffs->hash != bw_hash_sdbm("bw_noise_gate_coeffs"))
|
|
return 0;
|
|
if (coeffs->state < bw_noise_gate_coeffs_state_init || coeffs->state > bw_noise_gate_coeffs_state_reset_coeffs)
|
|
return 0;
|
|
#endif
|
|
|
|
if (!bw_is_finite(coeffs->thresh) || coeffs->thresh < 1e-20f || coeffs->thresh > 1e20f)
|
|
return 0;
|
|
if (bw_is_nan(coeffs->ratio) || coeffs->ratio < 1.f)
|
|
return 0;
|
|
|
|
if (!bw_one_pole_coeffs_is_valid(&coeffs->smooth_coeffs))
|
|
return 0;
|
|
|
|
#ifdef BW_DEBUG_DEEP
|
|
if (coeffs->state >= bw_noise_gate_coeffs_state_reset_coeffs) {
|
|
if (bw_is_nan(coeffs->kc) || coeffs->kc > 0.f)
|
|
return 0;
|
|
if (!bw_is_finite(coeffs->lt))
|
|
return 0;
|
|
|
|
if (!bw_one_pole_state_is_valid(&coeffs->smooth_coeffs, &coeffs->smooth_thresh_state))
|
|
return 0;
|
|
if (!bw_one_pole_state_is_valid(&coeffs->smooth_coeffs, &coeffs->smooth_ratio_state))
|
|
return 0;
|
|
}
|
|
#endif
|
|
|
|
return bw_env_follow_coeffs_is_valid(&coeffs->env_follow_coeffs);
|
|
}
|
|
|
|
static inline char bw_noise_gate_state_is_valid(
|
|
const bw_noise_gate_coeffs * BW_RESTRICT coeffs,
|
|
const bw_noise_gate_state * BW_RESTRICT state) {
|
|
BW_ASSERT(state != BW_NULL);
|
|
|
|
#ifdef BW_DEBUG_DEEP
|
|
if (state->hash != bw_hash_sdbm("bw_noise_gate_state"))
|
|
return 0;
|
|
|
|
if (coeffs != BW_NULL && coeffs->reset_id != state->coeffs_reset_id)
|
|
return 0;
|
|
#endif
|
|
|
|
return bw_env_follow_state_is_valid(coeffs ? &coeffs->env_follow_coeffs : BW_NULL, &state->env_follow_state);
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
|
|
#ifndef BW_CXX_NO_ARRAY
|
|
# include <array>
|
|
#endif
|
|
|
|
namespace Brickworks {
|
|
|
|
/*** Public C++ API ***/
|
|
|
|
/*! api_cpp {{{
|
|
* ##### Brickworks::NoiseGate
|
|
* ```>>> */
|
|
template<size_t N_CHANNELS>
|
|
class NoiseGate {
|
|
public:
|
|
NoiseGate();
|
|
|
|
void setSampleRate(
|
|
float sampleRate);
|
|
|
|
void reset(
|
|
float x0 = 0.f,
|
|
float xSc0 = 0.f,
|
|
float * BW_RESTRICT y0 = nullptr);
|
|
|
|
#ifndef BW_CXX_NO_ARRAY
|
|
void reset(
|
|
float x0,
|
|
float xSc0,
|
|
std::array<float, N_CHANNELS> * BW_RESTRICT y0);
|
|
#endif
|
|
|
|
void reset(
|
|
const float * x0,
|
|
const float * xSc0,
|
|
float * y0 = nullptr);
|
|
|
|
#ifndef BW_CXX_NO_ARRAY
|
|
void reset(
|
|
std::array<float, N_CHANNELS> x0,
|
|
std::array<float, N_CHANNELS> xSc0,
|
|
std::array<float, N_CHANNELS> * BW_RESTRICT y0 = nullptr);
|
|
#endif
|
|
|
|
void process(
|
|
const float * const * x,
|
|
const float * const * xSc,
|
|
float * const * y,
|
|
size_t nSamples);
|
|
|
|
#ifndef BW_CXX_NO_ARRAY
|
|
void process(
|
|
std::array<const float *, N_CHANNELS> x,
|
|
std::array<const float *, N_CHANNELS> xSc,
|
|
std::array<float *, N_CHANNELS> y,
|
|
size_t nSamples);
|
|
#endif
|
|
|
|
// >> the following 2 methods only exist because of a typo, don't use
|
|
void setTreshLin(
|
|
float value);
|
|
|
|
void setTreshDBFS(
|
|
float value);
|
|
// <<
|
|
|
|
void setThreshLin(
|
|
float value);
|
|
|
|
void setThreshDBFS(
|
|
float value);
|
|
|
|
void setRatio(
|
|
float value);
|
|
|
|
void setAttackTau(
|
|
float value);
|
|
|
|
void setReleaseTau(
|
|
float value);
|
|
/*! <<<...
|
|
* }
|
|
* ```
|
|
* }}} */
|
|
|
|
/*** Implementation ***/
|
|
|
|
/* WARNING: This part of the file is not part of the public API. Its content may
|
|
* change at any time in future versions. Please, do not use it directly. */
|
|
|
|
private:
|
|
bw_noise_gate_coeffs coeffs;
|
|
bw_noise_gate_state states[N_CHANNELS];
|
|
bw_noise_gate_state * BW_RESTRICT statesP[N_CHANNELS];
|
|
};
|
|
|
|
template<size_t N_CHANNELS>
|
|
inline NoiseGate<N_CHANNELS>::NoiseGate() {
|
|
bw_noise_gate_init(&coeffs);
|
|
for (size_t i = 0; i < N_CHANNELS; i++)
|
|
statesP[i] = states + i;
|
|
}
|
|
|
|
template<size_t N_CHANNELS>
|
|
inline void NoiseGate<N_CHANNELS>::setSampleRate(
|
|
float sampleRate) {
|
|
bw_noise_gate_set_sample_rate(&coeffs, sampleRate);
|
|
}
|
|
|
|
template<size_t N_CHANNELS>
|
|
inline void NoiseGate<N_CHANNELS>::reset(
|
|
float x0,
|
|
float xSc0,
|
|
float * BW_RESTRICT y0) {
|
|
bw_noise_gate_reset_coeffs(&coeffs);
|
|
if (y0 != nullptr)
|
|
for (size_t i = 0; i < N_CHANNELS; i++)
|
|
y0[i] = bw_noise_gate_reset_state(&coeffs, states + i, x0, xSc0);
|
|
else
|
|
for (size_t i = 0; i < N_CHANNELS; i++)
|
|
bw_noise_gate_reset_state(&coeffs, states + i, x0, xSc0);
|
|
}
|
|
|
|
#ifndef BW_CXX_NO_ARRAY
|
|
template<size_t N_CHANNELS>
|
|
inline void NoiseGate<N_CHANNELS>::reset(
|
|
float x0,
|
|
float xSc0,
|
|
std::array<float, N_CHANNELS> * BW_RESTRICT y0) {
|
|
reset(x0, xSc0, y0 != nullptr ? y0->data() : nullptr);
|
|
}
|
|
#endif
|
|
|
|
template<size_t N_CHANNELS>
|
|
inline void NoiseGate<N_CHANNELS>::reset(
|
|
const float * x0,
|
|
const float * xSc0,
|
|
float * y0) {
|
|
bw_noise_gate_reset_coeffs(&coeffs);
|
|
bw_noise_gate_reset_state_multi(&coeffs, statesP, x0, xSc0, y0, N_CHANNELS);
|
|
}
|
|
|
|
#ifndef BW_CXX_NO_ARRAY
|
|
template<size_t N_CHANNELS>
|
|
inline void NoiseGate<N_CHANNELS>::reset(
|
|
std::array<float, N_CHANNELS> x0,
|
|
std::array<float, N_CHANNELS> xSc0,
|
|
std::array<float, N_CHANNELS> * BW_RESTRICT y0) {
|
|
reset(x0.data(), xSc0.data(), y0 != nullptr ? y0->data() : nullptr);
|
|
}
|
|
#endif
|
|
|
|
template<size_t N_CHANNELS>
|
|
inline void NoiseGate<N_CHANNELS>::process(
|
|
const float * const * x,
|
|
const float * const * xSc,
|
|
float * const * y,
|
|
size_t nSamples) {
|
|
bw_noise_gate_process_multi(&coeffs, statesP, x, xSc, y, N_CHANNELS, nSamples);
|
|
}
|
|
|
|
#ifndef BW_CXX_NO_ARRAY
|
|
template<size_t N_CHANNELS>
|
|
inline void NoiseGate<N_CHANNELS>::process(
|
|
std::array<const float *, N_CHANNELS> x,
|
|
std::array<const float *, N_CHANNELS> xSc,
|
|
std::array<float *, N_CHANNELS> y,
|
|
size_t nSamples) {
|
|
process(x.data(), xSc.data(), y.data(), nSamples);
|
|
}
|
|
#endif
|
|
|
|
template<size_t N_CHANNELS>
|
|
inline void NoiseGate<N_CHANNELS>::setTreshLin(
|
|
float value) {
|
|
setThreshLin(value);
|
|
}
|
|
|
|
template<size_t N_CHANNELS>
|
|
inline void NoiseGate<N_CHANNELS>::setTreshDBFS(
|
|
float value) {
|
|
setThreshDBFS(value);
|
|
}
|
|
|
|
template<size_t N_CHANNELS>
|
|
inline void NoiseGate<N_CHANNELS>::setThreshLin(
|
|
float value) {
|
|
bw_noise_gate_set_thresh_lin(&coeffs, value);
|
|
}
|
|
|
|
template<size_t N_CHANNELS>
|
|
inline void NoiseGate<N_CHANNELS>::setThreshDBFS(
|
|
float value) {
|
|
bw_noise_gate_set_thresh_dBFS(&coeffs, value);
|
|
}
|
|
|
|
template<size_t N_CHANNELS>
|
|
inline void NoiseGate<N_CHANNELS>::setRatio(
|
|
float value) {
|
|
bw_noise_gate_set_ratio(&coeffs, value);
|
|
}
|
|
|
|
template<size_t N_CHANNELS>
|
|
inline void NoiseGate<N_CHANNELS>::setAttackTau(
|
|
float value) {
|
|
bw_noise_gate_set_attack_tau(&coeffs, value);
|
|
}
|
|
|
|
template<size_t N_CHANNELS>
|
|
inline void NoiseGate<N_CHANNELS>::setReleaseTau(
|
|
float value) {
|
|
bw_noise_gate_set_release_tau(&coeffs, value);
|
|
}
|
|
|
|
}
|
|
#endif
|
|
|
|
#endif
|