brickworks/include/bw_fuzz.h

/*
 * 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 <http://www.gnu.org/licenses/>.
 *
 * File author: Stefano D'Angelo
 */

/*!
 *  module_type {{{ dsp }}}
 *  version {{{ 1.0.0 }}}
 *  requires {{{
 *    bw_common bw_gain bw_hp1 bw_lp1 bw_math bw_mm2 bw_one_pole bw_peak
 *    bw_satur bw_svf
 *  }}}
 *  description {{{
 *    Fuzz effect.
 *
 *    Loosely inspired to the "smiling" fuzz pedal.
 *  }}}
 *  changelog {{{
 *    <ul>
 *      <li>Version <strong>1.0.0</strong>:
 *        <ul>
 *          <li>Improved algorithm to be a bit more faithful to the
 *              original.</li>
 *          <li><code>bw_fuzz_process()</code> and
 *              <code>bw_fuzz_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 overladed C++ <code>process()</code> function taking
 *              C-style arrays as arguments.</li>
 *          <li>Removed usage of reserved identifiers.</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>First release.</li>
 *        </ul>
 *      </li>
 *    </ul>
 *  }}}
 */

#ifndef BW_FUZZ_H
#define BW_FUZZ_H

#include <bw_common.h>

#ifdef __cplusplus
extern "C" {
#endif

/*! api {{{
 *    #### bw_fuzz_coeffs
 *  ```>>> */
typedef struct bw_fuzz_coeffs bw_fuzz_coeffs;
/*! <<<```
 *    Coefficients and related.
 *
 *    #### bw_fuzz_state
 *  ```>>> */
typedef struct bw_fuzz_state bw_fuzz_state;
/*! <<<```
 *    Internal state and related.
 *
 *    #### bw_fuzz_init()
 *  ```>>> */
static inline void bw_fuzz_init(bw_fuzz_coeffs *BW_RESTRICT coeffs);
/*! <<<```
 *    Initializes input parameter values in `coeffs`.
 *
 *    #### bw_fuzz_set_sample_rate()
 *  ```>>> */
static inline void bw_fuzz_set_sample_rate(bw_fuzz_coeffs *BW_RESTRICT coeffs, float sample_rate);
/*! <<<```
 *    Sets the `sample_rate` (Hz) value in `coeffs`.
 *
 *    #### bw_fuzz_reset_coeffs()
 *  ```>>> */
static inline void bw_fuzz_reset_coeffs(bw_fuzz_coeffs *BW_RESTRICT coeffs);
/*! <<<```
 *    Resets coefficients in `coeffs` to assume their target values.
 *
 *    #### bw_fuzz_reset_state()
 *  ```>>> */
static inline void bw_fuzz_reset_state(const bw_fuzz_coeffs *BW_RESTRICT coeffs, bw_fuzz_state *BW_RESTRICT state);
/*! <<<```
 *    Resets the given `state` to its initial values using the given `coeffs`.
 *
 *    #### bw_fuzz_update_coeffs_ctrl()
 *  ```>>> */
static inline void bw_fuzz_update_coeffs_ctrl(bw_fuzz_coeffs *BW_RESTRICT coeffs);
/*! <<<```
 *    Triggers control-rate update of coefficients in `coeffs`.
 *
 *    #### bw_fuzz_update_coeffs_audio()
 *  ```>>> */
static inline void bw_fuzz_update_coeffs_audio(bw_fuzz_coeffs *BW_RESTRICT coeffs);
/*! <<<```
 *    Triggers audio-rate update of coefficients in `coeffs`.
 *
 *    #### bw_fuzz_process1()
 *  ```>>> */
static inline float bw_fuzz_process1(const bw_fuzz_coeffs *BW_RESTRICT coeffs, bw_fuzz_state *BW_RESTRICT state, float x);
/*! <<<```
 *    Processes one input sample `x` using `coeffs`, while using and updating
 *    `state`. Returns the corresponding output sample.
 *
 *    #### bw_fuzz_process()
 *  ```>>> */
static inline void bw_fuzz_process(bw_fuzz_coeffs *BW_RESTRICT coeffs, bw_fuzz_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
 *    `coeffs` and `state` (control and audio rate).
 *
 *    #### bw_fuzz_process_multi()
 *  ```>>> */
static inline void bw_fuzz_process_multi(bw_fuzz_coeffs *BW_RESTRICT coeffs, bw_fuzz_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
 *    using and updating both the common `coeffs` and each of the `n_channels`
 *    `state`s (control and audio rate).
 *
 *    #### bw_fuzz_set_fuzz()
 *  ```>>> */
static inline void bw_fuzz_set_fuzz(bw_fuzz_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
 *    Sets the fuzz (input gain, approximately) to the given `value` in [`0.f`,
 *    `1.f`] in `coeffs`.
 *
 *    Default value: `0.f`.
 *
 *    #### bw_fuzz_set_volume()
 *  ```>>> */
static inline void bw_fuzz_set_volume(bw_fuzz_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
 *    Sets the volume (output gain) to the given `value` in [`0.f`, `1.f`] in
 *    `coeffs`.
 *
 *    Default value: `1.f`.
 *  }}} */

#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_hp1.h>
#include <bw_svf.h>
#include <bw_peak.h>
#include <bw_satur.h>
#include <bw_hp1.h>
#include <bw_gain.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bw_fuzz_coeffs {
	// Sub-components
	bw_hp1_coeffs	hp1_in_coeffs;
	bw_svf_coeffs	lp2_coeffs;
	bw_peak_coeffs	peak_coeffs;
	bw_satur_coeffs	satur_coeffs;
	bw_hp1_coeffs	hp1_out_coeffs;
	bw_gain_coeffs	gain_coeffs;
};

struct bw_fuzz_state {
	// Sub-components
	bw_hp1_state	hp1_in_state;
	bw_svf_state	lp2_1_state;
	bw_svf_state	lp2_2_state;
	bw_peak_state	peak_state;
	bw_satur_state	satur_state;
	bw_hp1_state	hp1_out_state;
};

static inline void bw_fuzz_init(bw_fuzz_coeffs *BW_RESTRICT coeffs) {
	bw_hp1_init(&coeffs->hp1_in_coeffs);
	bw_svf_init(&coeffs->lp2_coeffs);
	bw_peak_init(&coeffs->peak_coeffs);
	bw_satur_init(&coeffs->satur_coeffs);
	bw_hp1_init(&coeffs->hp1_out_coeffs);
	bw_gain_init(&coeffs->gain_coeffs);
	bw_hp1_set_cutoff(&coeffs->hp1_in_coeffs, 4.f);
	bw_svf_set_cutoff(&coeffs->lp2_coeffs, 7e3f);
	bw_peak_set_cutoff(&coeffs->peak_coeffs, 500.f);
	bw_peak_set_bandwidth(&coeffs->peak_coeffs, 6.6f);
	bw_satur_set_bias(&coeffs->satur_coeffs, 0.145f);
	bw_hp1_set_cutoff(&coeffs->hp1_out_coeffs, 30.f);
}

static inline void bw_fuzz_set_sample_rate(bw_fuzz_coeffs *BW_RESTRICT coeffs, float sample_rate) {
	bw_hp1_set_sample_rate(&coeffs->hp1_in_coeffs, sample_rate);
	bw_svf_set_sample_rate(&coeffs->lp2_coeffs, sample_rate);
	bw_peak_set_sample_rate(&coeffs->peak_coeffs, sample_rate);
	bw_satur_set_sample_rate(&coeffs->satur_coeffs, sample_rate);
	bw_hp1_set_sample_rate(&coeffs->hp1_out_coeffs, sample_rate);
	bw_gain_set_sample_rate(&coeffs->gain_coeffs, sample_rate);
	bw_hp1_reset_coeffs(&coeffs->hp1_in_coeffs);
	bw_svf_reset_coeffs(&coeffs->lp2_coeffs);
	bw_satur_reset_coeffs(&coeffs->satur_coeffs);
	bw_hp1_reset_coeffs(&coeffs->hp1_out_coeffs);
}

static inline void bw_fuzz_reset_coeffs(bw_fuzz_coeffs *BW_RESTRICT coeffs) {
	bw_peak_reset_coeffs(&coeffs->peak_coeffs);
	bw_gain_reset_coeffs(&coeffs->gain_coeffs);
}

static inline void bw_fuzz_reset_state(const bw_fuzz_coeffs *BW_RESTRICT coeffs, bw_fuzz_state *BW_RESTRICT state) {
	bw_hp1_reset_state(&coeffs->hp1_in_coeffs, &state->hp1_in_state, 0.f);
	bw_svf_reset_state(&coeffs->lp2_coeffs, &state->lp2_1_state, 0.f);
	bw_svf_reset_state(&coeffs->lp2_coeffs, &state->lp2_2_state, 0.f);
	bw_peak_reset_state(&coeffs->peak_coeffs, &state->peak_state, 0.f);
	bw_satur_reset_state(&coeffs->satur_coeffs, &state->satur_state);
	bw_hp1_reset_state(&coeffs->hp1_out_coeffs, &state->hp1_out_state, 0.f);
}

static inline void bw_fuzz_update_coeffs_ctrl(bw_fuzz_coeffs *BW_RESTRICT coeffs) {
	bw_peak_update_coeffs_ctrl(&coeffs->peak_coeffs);
	bw_gain_update_coeffs_ctrl(&coeffs->gain_coeffs);
}

static inline void bw_fuzz_update_coeffs_audio(bw_fuzz_coeffs *BW_RESTRICT coeffs) {
	bw_peak_update_coeffs_audio(&coeffs->peak_coeffs);
	bw_gain_update_coeffs_audio(&coeffs->gain_coeffs);
}

static inline float bw_fuzz_process1(const bw_fuzz_coeffs *BW_RESTRICT coeffs, bw_fuzz_state *BW_RESTRICT state, float x) {
	float y = bw_hp1_process1(&coeffs->hp1_in_coeffs, &state->hp1_in_state, x);
	float v_lp, v_hp, v_bp;
	bw_svf_process1(&coeffs->lp2_coeffs, &state->lp2_1_state, x, &v_lp, &v_bp, &v_hp);
	bw_svf_process1(&coeffs->lp2_coeffs, &state->lp2_2_state, v_lp, &v_lp, &v_bp, &v_hp);
	y = bw_peak_process1(&coeffs->peak_coeffs, &state->peak_state, v_lp);
	y = bw_satur_process1(&coeffs->satur_coeffs, &state->satur_state, y);
	y = bw_hp1_process1(&coeffs->hp1_out_coeffs, &state->hp1_out_state, y);
	return bw_gain_process1(&coeffs->gain_coeffs, y);
}

static inline void bw_fuzz_process(bw_fuzz_coeffs *BW_RESTRICT coeffs, bw_fuzz_state *BW_RESTRICT state, const float *x, float *y, size_t n_samples) {
	bw_fuzz_update_coeffs_ctrl(coeffs);
	for (size_t i = 0; i < n_samples; i++) {
		bw_fuzz_update_coeffs_audio(coeffs);
		y[i] = bw_fuzz_process1(coeffs, state, x[i]);
	}
}

static inline void bw_fuzz_process_multi(bw_fuzz_coeffs *BW_RESTRICT coeffs, bw_fuzz_state *BW_RESTRICT const *BW_RESTRICT state, const float * const *x, float * const *y, size_t n_channels, size_t n_samples) {
	bw_fuzz_update_coeffs_ctrl(coeffs);
	for (size_t i = 0; i < n_samples; i++) {
		bw_fuzz_update_coeffs_audio(coeffs);
		for (size_t j = 0; j < n_channels; j++)
			y[j][i] = bw_fuzz_process1(coeffs, state[j], x[j][i]);
	}
}

static inline void bw_fuzz_set_fuzz(bw_fuzz_coeffs *BW_RESTRICT coeffs, float value) {
	bw_peak_set_peak_gain_dB(&coeffs->peak_coeffs, 30.f * value);
}

static inline void bw_fuzz_set_volume(bw_fuzz_coeffs *BW_RESTRICT coeffs, float value) {
	bw_gain_set_gain_lin(&coeffs->gain_coeffs, value * value * value);
}

#ifdef __cplusplus
}

#include <array>

namespace Brickworks {

/*** Public C++ API ***/

/*! api_cpp {{{
 *    ##### Brickworks::Fuzz
 *  ```>>> */
template<size_t N_CHANNELS>
class Fuzz {
public:
	Fuzz();

	void setSampleRate(float sampleRate);
	void reset();
	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 setFuzz(float value);
	void setVolume(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_fuzz_coeffs	 coeffs;
	bw_fuzz_state	 states[N_CHANNELS];
	bw_fuzz_state	*BW_RESTRICT statesP[N_CHANNELS];
};

template<size_t N_CHANNELS>
inline Fuzz<N_CHANNELS>::Fuzz() {
	bw_fuzz_init(&coeffs);
	for (size_t i = 0; i < N_CHANNELS; i++)
		statesP[i] = states + i;
}

template<size_t N_CHANNELS>
inline void Fuzz<N_CHANNELS>::setSampleRate(float sampleRate) {
	bw_fuzz_set_sample_rate(&coeffs, sampleRate);
}

template<size_t N_CHANNELS>
inline void Fuzz<N_CHANNELS>::reset() {
	bw_fuzz_reset_coeffs(&coeffs);
	for (size_t i = 0; i < N_CHANNELS; i++)
		bw_fuzz_reset_state(&coeffs, states + i);
}

template<size_t N_CHANNELS>
inline void Fuzz<N_CHANNELS>::process(
		const float * const *x,
		float * const *y,
		size_t nSamples) {
	bw_fuzz_process_multi(&coeffs, statesP, x, y, N_CHANNELS, nSamples);
}

template<size_t N_CHANNELS>
inline void Fuzz<N_CHANNELS>::process(
		std::array<const float *, N_CHANNELS> x,
		std::array<float *, N_CHANNELS> y,
		size_t nSamples) {
	process(x.data(), y.data(), nSamples);
}

template<size_t N_CHANNELS>
inline void Fuzz<N_CHANNELS>::setFuzz(float value) {
	bw_fuzz_set_fuzz(&coeffs, value);
}

template<size_t N_CHANNELS>
inline void Fuzz<N_CHANNELS>::setVolume(float value) {
	bw_fuzz_set_volume(&coeffs, value);
}

}
#endif

#endif