/* * Brickworks * * Copyright (C) 2022, 2023 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 . * * File author: Stefano D'Angelo */ /*! * module_type {{{ dsp }}} * version {{{ 0.5.0 }}} * requires {{{ * bw_common bw_config bw_gain bw_math bw_mm2 bw_one_pole bw_svf * }}} * description {{{ * Second-order high shelf filter (12 dB/oct) with unitary DC gain. * }}} * changelog {{{ * * }}} */ #ifndef _BW_HS2_H #define _BW_HS2_H #ifdef __cplusplus extern "C" { #endif #include /*! api {{{ * #### bw_hs2_coeffs * ```>>> */ typedef struct _bw_hs2_coeffs bw_hs2_coeffs; /*! <<<``` * Coefficients and related. * * #### bw_hs2_state * ```>>> */ typedef struct _bw_hs2_state bw_hs2_state; /*! <<<``` * Internal state and related. * * #### bw_hs2_init() * ```>>> */ static inline void bw_hs2_init(bw_hs2_coeffs *BW_RESTRICT coeffs); /*! <<<``` * Initializes input parameter values in `coeffs`. * * #### bw_hs2_set_sample_rate() * ```>>> */ static inline void bw_hs2_set_sample_rate(bw_hs2_coeffs *BW_RESTRICT coeffs, float sample_rate); /*! <<<``` * Sets the `sample_rate` (Hz) value in `coeffs`. * * #### bw_hs2_reset_coeffs() * ```>>> */ static inline void bw_hs2_reset_coeffs(bw_hs2_coeffs *BW_RESTRICT coeffs); /*! <<<``` * Resets coefficients in `coeffs` to assume their target values. * * #### bw_hs2_reset_state() * ```>>> */ static inline void bw_hs2_reset_state(const bw_hs2_coeffs *BW_RESTRICT coeffs, bw_hs2_state *BW_RESTRICT state, float x0); /*! <<<``` * Resets the given `state` to its initial values using the given `coeffs` * and the quiescent/initial input value `x0`. * * #### bw_hs2_update_coeffs_ctrl() * ```>>> */ static inline void bw_hs2_update_coeffs_ctrl(bw_hs2_coeffs *BW_RESTRICT coeffs); /*! <<<``` * Triggers control-rate update of coefficients in `coeffs`. * * #### bw_hs2_update_coeffs_audio() * ```>>> */ static inline void bw_hs2_update_coeffs_audio(bw_hs2_coeffs *BW_RESTRICT coeffs); /*! <<<``` * Triggers audio-rate update of coefficients in `coeffs`. * * #### bw_hs2_process1() * ```>>> */ static inline float bw_hs2_process1(const bw_hs2_coeffs *BW_RESTRICT coeffs, bw_hs2_state *BW_RESTRICT state, float x); /*! <<<``` * Processes one input sample `x` using `coeffs`, while using and updating * `state`. Returns the corresponding output sample. * * #### bw_hs2_process() * ```>>> */ static inline void bw_hs2_process(bw_hs2_coeffs *BW_RESTRICT coeffs, bw_hs2_state *BW_RESTRICT state, const float *x, float *y, int 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 * `coeffs` and `state` (control and audio rate). * * #### bw_hs2_process_multi() * ```>>> */ static inline void bw_hs2_process_multi(bw_hs2_coeffs *BW_RESTRICT coeffs, bw_hs2_state **BW_RESTRICT state, const float **x, float **y, int n_channels, int 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 * using and updating both the common `coeffs` and each of the `n_channels` * `state`s (control and audio rate). * * #### bw_hs2_set_cutoff() * ```>>> */ static inline void bw_hs2_set_cutoff(bw_hs2_coeffs *BW_RESTRICT coeffs, float value); /*! <<<``` * Sets the cutoff frequency `value` (Hz) in `coeffs`. * * Default value: `1e3f`. * * #### bw_hs2_set_Q() * ```>>> */ static inline void bw_hs2_set_Q(bw_hs2_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`. * * Default value: `0.5f`. * * #### bw_hs2_set_high_gain_lin() * ```>>> */ static inline void bw_hs2_set_high_gain_lin(bw_hs2_coeffs *BW_RESTRICT coeffs, float value); /*! <<<``` * Sets the high-frequency gain parameter to the given `value` (linear gain) * in `coeffs`. * * Default value: `0.f`. * * #### bw_hs2_set_high_gain_dB() * ```>>> */ static inline void bw_hs2_set_high_gain_dB(bw_hs2_coeffs *BW_RESTRICT coeffs, float value); /*! <<<``` * Sets the high-frequency gain parameter to the given `value` (dB) in * `coeffs`. * * Default value: `-INFINITY`. * }}} */ /*** 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 #include struct _bw_hs2_coeffs { // Sub-components bw_mm2_coeffs mm2_coeffs; // Coefficients float sg; float ssg; // Parameters float high_gain; float cutoff; int param_changed; }; struct _bw_hs2_state { bw_mm2_state mm2_state; }; #define _BW_HS2_PARAM_HIGH_GAIN 1 #define _BW_HS2_PARAM_CUTOFF (1<<1) static inline void bw_hs2_init(bw_hs2_coeffs *BW_RESTRICT coeffs) { bw_mm2_init(&coeffs->mm2_coeffs); bw_mm2_set_prewarp_at_cutoff(&coeffs->mm2_coeffs, 0); coeffs->high_gain = 1.f; coeffs->cutoff = 1e3f; } static inline void bw_hs2_set_sample_rate(bw_hs2_coeffs *BW_RESTRICT coeffs, float sample_rate) { bw_mm2_set_sample_rate(&coeffs->mm2_coeffs, sample_rate); } static inline void _bw_hs2_update_mm2_params(bw_hs2_coeffs *BW_RESTRICT coeffs) { if (coeffs->param_changed) { if (coeffs->param_changed & _BW_HS2_PARAM_HIGH_GAIN) { coeffs->sg = bw_sqrtf_2(coeffs->high_gain); coeffs->ssg = bw_sqrtf_2(coeffs->sg); bw_mm2_set_coeff_x(&coeffs->mm2_coeffs, coeffs->sg); bw_mm2_set_coeff_lp(&coeffs->mm2_coeffs, 1.f - coeffs->sg); bw_mm2_set_coeff_hp(&coeffs->mm2_coeffs, coeffs->high_gain - coeffs->sg); } if (coeffs->param_changed & _BW_HS2_PARAM_CUTOFF) bw_mm2_set_prewarp_freq(&coeffs->mm2_coeffs, coeffs->cutoff); bw_mm2_set_cutoff(&coeffs->mm2_coeffs, coeffs->cutoff * coeffs->ssg); coeffs->param_changed = 0; } } static inline void bw_hs2_reset_coeffs(bw_hs2_coeffs *BW_RESTRICT coeffs) { coeffs->param_changed = ~0; _bw_hs2_update_mm2_params(coeffs); bw_mm2_reset_coeffs(&coeffs->mm2_coeffs); } static inline void bw_hs2_reset_state(const bw_hs2_coeffs *BW_RESTRICT coeffs, bw_hs2_state *BW_RESTRICT state, float x0) { bw_mm2_reset_state(&coeffs->mm2_coeffs, &state->mm2_state, x0); } static inline void bw_hs2_update_coeffs_ctrl(bw_hs2_coeffs *BW_RESTRICT coeffs) { _bw_hs2_update_mm2_params(coeffs); bw_mm2_update_coeffs_ctrl(&coeffs->mm2_coeffs); } static inline void bw_hs2_update_coeffs_audio(bw_hs2_coeffs *BW_RESTRICT coeffs) { bw_mm2_update_coeffs_audio(&coeffs->mm2_coeffs); } static inline float bw_hs2_process1(const bw_hs2_coeffs *BW_RESTRICT coeffs, bw_hs2_state *BW_RESTRICT state, float x) { return bw_mm2_process1(&coeffs->mm2_coeffs, &state->mm2_state, x); } static inline void bw_hs2_process(bw_hs2_coeffs *BW_RESTRICT coeffs, bw_hs2_state *BW_RESTRICT state, const float *x, float *y, int n_samples) { bw_hs2_update_coeffs_ctrl(coeffs); for (int i = 0; i < n_samples; i++) { bw_hs2_update_coeffs_audio(coeffs); y[i] = bw_hs2_process1(coeffs, state, x[i]); } } static inline void bw_hs2_process_multi(bw_hs2_coeffs *BW_RESTRICT coeffs, bw_hs2_state **BW_RESTRICT state, const float **x, float **y, int n_channels, int n_samples) { bw_hs2_update_coeffs_ctrl(coeffs); for (int i = 0; i < n_samples; i++) { bw_hs2_update_coeffs_audio(coeffs); for (int j = 0; j < n_channels; j++) y[j][i] = bw_hs2_process1(coeffs, state[j], x[j][i]); } } static inline void bw_hs2_set_cutoff(bw_hs2_coeffs *BW_RESTRICT coeffs, float value) { if (coeffs->cutoff) { coeffs->cutoff = value; coeffs->param_changed |= _BW_HS2_PARAM_CUTOFF; } } static inline void bw_hs2_set_Q(bw_hs2_coeffs *BW_RESTRICT coeffs, float value) { bw_mm2_set_Q(&coeffs->mm2_coeffs, value); } static inline void bw_hs2_set_high_gain_lin(bw_hs2_coeffs *BW_RESTRICT coeffs, float value) { if (coeffs->high_gain != value) { coeffs->high_gain = value; coeffs->param_changed |= _BW_HS2_PARAM_HIGH_GAIN; } } static inline void bw_hs2_set_high_gain_dB(bw_hs2_coeffs *BW_RESTRICT coeffs, float value) { bw_hs2_set_high_gain_lin(coeffs, bw_dB2linf_3(value)); } #undef _BW_HS2_PARAM_HIGH_GAIN #undef _BW_HS2_PARAM_CUTOFF #ifdef __cplusplus } #endif #endif