/* * Brickworks * * Copyright (C) 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_math bw_one_pole bw_osc_sin bw_phase_gen bw_ringmod * }}} * description {{{ * Tremolo with variable speed and amount. * }}} * changelog {{{ * * }}} */ #ifndef _BW_TREM_H #define _BW_TREM_H #ifdef __cplusplus extern "C" { #endif #include /*! api {{{ * #### bw_trem_coeffs * ```>>> */ typedef struct _bw_trem_coeffs bw_trem_coeffs; /*! <<<``` * Coefficients and related. * * #### bw_trem_state * ```>>> */ typedef struct _bw_trem_state bw_trem_state; /*! <<<``` * Internal state and related. * * #### bw_trem_init() * ```>>> */ static inline void bw_trem_init(bw_trem_coeffs *BW_RESTRICT coeffs); /*! <<<``` * Initializes input parameter values in `coeffs`. * * #### bw_trem_set_sample_rate() * ```>>> */ static inline void bw_trem_set_sample_rate(bw_trem_coeffs *BW_RESTRICT coeffs, float sample_rate); /*! <<<``` * Sets the `sample_rate` (Hz) value in `coeffs`. * * #### bw_trem_reset_coeffs() * ```>>> */ static inline void bw_trem_reset_coeffs(bw_trem_coeffs *BW_RESTRICT coeffs); /*! <<<``` * Resets coefficients in `coeffs` to assume their target values. * * #### bw_trem_reset_state() * ```>>> */ static inline void bw_trem_reset_state(const bw_trem_coeffs *BW_RESTRICT coeffs, bw_trem_state *BW_RESTRICT state); /*! <<<``` * Resets the given `state` to its initial values using the given `coeffs`. * * #### bw_trem_update_coeffs_ctrl() * ```>>> */ static inline void bw_trem_update_coeffs_ctrl(bw_trem_coeffs *BW_RESTRICT coeffs); /*! <<<``` * Triggers control-rate update of coefficients in `coeffs`. * * #### bw_trem_update_coeffs_audio() * ```>>> */ static inline void bw_trem_update_coeffs_audio(bw_trem_coeffs *BW_RESTRICT coeffs); /*! <<<``` * Triggers audio-rate update of coefficients in `coeffs`. * * #### bw_trem_process1() * ```>>> */ static inline float bw_trem_process1(const bw_trem_coeffs *BW_RESTRICT coeffs, bw_trem_state *BW_RESTRICT state, float x); /*! <<<``` * Processes one input sample `x` using `coeffs`, while using and updating * `state`. Returns the corresponding output sample. * * #### bw_trem_process() * ```>>> */ static inline void bw_trem_process(bw_trem_coeffs *BW_RESTRICT coeffs, bw_trem_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_trem_process_multi() * ```>>> */ static inline void bw_trem_process_multi(bw_trem_coeffs *BW_RESTRICT coeffs, bw_trem_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_trem_set_rate() * ```>>> */ static inline void bw_trem_set_rate(bw_trem_coeffs *BW_RESTRICT coeffs, float value); /*! <<<``` * Sets the modulation rate `value` (Hz) in `coeffs`. * * Default value: `1.f`. * * #### bw_trem_set_amount() * ```>>> */ static inline void bw_trem_set_amount(bw_trem_coeffs *BW_RESTRICT coeffs, float value); /*! <<<``` * Sets the amount parameter to the given `value` (`0.f` = no tremolo, `1.f` * = full tremolo, `-1.f` = full tremolo with inverted polarity) in `coeffs`. * * Default value: `1.f`. * }}} */ /*** 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 #include struct _bw_trem_coeffs { // Sub-components bw_phase_gen_coeffs phase_gen_coeffs; bw_ringmod_coeffs ringmod_coeffs; }; struct _bw_trem_state { bw_phase_gen_state phase_gen_state; }; static inline void bw_trem_init(bw_trem_coeffs *BW_RESTRICT coeffs) { bw_phase_gen_init(&coeffs->phase_gen_coeffs); bw_ringmod_init(&coeffs->ringmod_coeffs); } static inline void bw_trem_set_sample_rate(bw_trem_coeffs *BW_RESTRICT coeffs, float sample_rate) { bw_phase_gen_set_sample_rate(&coeffs->phase_gen_coeffs, sample_rate); bw_ringmod_set_sample_rate(&coeffs->ringmod_coeffs, sample_rate); } static inline void bw_trem_reset_coeffs(bw_trem_coeffs *BW_RESTRICT coeffs) { bw_phase_gen_reset_coeffs(&coeffs->phase_gen_coeffs); bw_ringmod_reset_coeffs(&coeffs->ringmod_coeffs); } static inline void bw_trem_reset_state(const bw_trem_coeffs *BW_RESTRICT coeffs, bw_trem_state *BW_RESTRICT state) { bw_phase_gen_reset_state(&coeffs->phase_gen_coeffs, &state->phase_gen_state, 0.f); } static inline void bw_trem_update_coeffs_ctrl(bw_trem_coeffs *BW_RESTRICT coeffs) { bw_phase_gen_update_coeffs_ctrl(&coeffs->phase_gen_coeffs); bw_ringmod_update_coeffs_ctrl(&coeffs->ringmod_coeffs); } static inline void bw_trem_update_coeffs_audio(bw_trem_coeffs *BW_RESTRICT coeffs) { bw_phase_gen_update_coeffs_audio(&coeffs->phase_gen_coeffs); bw_ringmod_update_coeffs_audio(&coeffs->ringmod_coeffs); } static inline float bw_trem_process1(const bw_trem_coeffs *BW_RESTRICT coeffs, bw_trem_state *BW_RESTRICT state, float x) { float p, pi; bw_phase_gen_process1(&coeffs->phase_gen_coeffs, &state->phase_gen_state, &p, &pi); const float c = bw_osc_sin_process1(p); return bw_ringmod_process1(&coeffs->ringmod_coeffs, x, 1.f + c); } static inline void bw_trem_process(bw_trem_coeffs *BW_RESTRICT coeffs, bw_trem_state *BW_RESTRICT state, const float *x, float *y, int n_samples) { bw_trem_update_coeffs_ctrl(coeffs); for (int i = 0; i < n_samples; i++) { bw_trem_update_coeffs_audio(coeffs); y[i] = bw_trem_process1(coeffs, state, x[i]); } } static inline void bw_trem_process_multi(bw_trem_coeffs *BW_RESTRICT coeffs, bw_trem_state **BW_RESTRICT state, const float **x, float **y, int n_channels, int n_samples) { bw_trem_update_coeffs_ctrl(coeffs); for (int i = 0; i < n_samples; i++) { bw_trem_update_coeffs_audio(coeffs); for (int j = 0; j < n_channels; j++) y[j][i] = bw_trem_process1(coeffs, state[j], x[j][i]); } } static inline void bw_trem_set_rate(bw_trem_coeffs *BW_RESTRICT coeffs, float value) { bw_phase_gen_set_frequency(&coeffs->phase_gen_coeffs, value); } static inline void bw_trem_set_amount(bw_trem_coeffs *BW_RESTRICT coeffs, float value) { bw_ringmod_set_amount(&coeffs->ringmod_coeffs, value); } #ifdef __cplusplus } #endif #endif