new bw_clip and fx_clip

This commit is contained in:
Stefano D'Angelo 2023-04-26 01:48:01 +02:00
parent 6228fba4d5
commit e6466ce0c8
10 changed files with 629 additions and 0 deletions

View File

@ -0,0 +1,7 @@
ROOT_DIR := $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
TARGET = bw_example_fx_clip
C_SOURCES += ${ROOT_DIR}/../src/bw_example_fx_clip.c
include ${ROOT_DIR}/../../common/daisy-seed/daisy-seed.mk

View File

@ -0,0 +1,36 @@
/*
* 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 authors: Stefano D'Angelo
*/
#ifndef _CONFIG_DAISY_SEED_H
#define _CONFIG_DAISY_SEED_H
struct config_pin {
int param_index;
int pin;
};
#define NUM_PINS 2
static struct config_pin config_pins[NUM_PINS] = {
{ 0, 15 },
{ 1, 16 }
};
#endif

View File

@ -0,0 +1,65 @@
/*
* 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
*/
#include "bw_example_fx_clip.h"
void bw_example_fx_clip_init(bw_example_fx_clip *instance) {
bw_clip_init(&instance->clip_coeffs);
bw_src_int_init(&instance->src_up_coeffs, 2);
bw_src_int_init(&instance->src_down_coeffs, -2);
}
void bw_example_fx_clip_set_sample_rate(bw_example_fx_clip *instance, float sample_rate) {
bw_clip_set_sample_rate(&instance->clip_coeffs, 2.f * sample_rate);
}
void bw_example_fx_clip_reset(bw_example_fx_clip *instance) {
bw_clip_reset_coeffs(&instance->clip_coeffs);
bw_clip_reset_state(&instance->clip_coeffs, &instance->clip_state);
bw_src_int_reset_state(&instance->src_up_coeffs, &instance->src_up_state, 0.f);
bw_src_int_reset_state(&instance->src_down_coeffs, &instance->src_down_state, 0.f);
}
void bw_example_fx_clip_process(bw_example_fx_clip *instance, const float** x, float** y, int n_samples) {
int i = 0;
while (i < n_samples) {
int n = bw_mini32(n_samples - i, BUF_SIZE >> 1);
bw_src_int_process(&instance->src_up_coeffs, &instance->src_up_state, x[0] + i, instance->buf, n);
bw_clip_process(&instance->clip_coeffs, &instance->clip_state, instance->buf, instance->buf, n << 1);
bw_src_int_process(&instance->src_down_coeffs, &instance->src_down_state, instance->buf, y[0] + i, n << 1);
i += n;
}
}
void bw_example_fx_clip_set_parameter(bw_example_fx_clip *instance, int index, float value) {
instance->params[index] = value;
switch (index) {
case p_bias:
bw_clip_set_bias(&instance->clip_coeffs, 5.f * value - 2.5f);
break;
case p_gain:
bw_clip_set_gain(&instance->clip_coeffs, 0.1f + (10.f - 0.1f) * value * value * value);
break;
}
}
float bw_example_fx_clip_get_parameter(bw_example_fx_clip *instance, int index) {
return instance->params[index];
}

View File

@ -0,0 +1,67 @@
/*
* 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 <http://www.gnu.org/licenses/>.
*
* File author: Stefano D'Angelo
*/
#ifndef _BW_EXAMPLE_FX_CLIP_H
#define _BW_EXAMPLE_FX_CLIP_H
#ifdef __cplusplus
extern "C" {
#endif
#include <bw_clip.h>
#include <bw_src_int.h>
enum {
p_bias,
p_gain,
p_n
};
#define BUF_SIZE 32
struct _bw_example_fx_clip {
// Sub-components
bw_clip_coeffs clip_coeffs;
bw_clip_state clip_state;
bw_src_int_coeffs src_up_coeffs;
bw_src_int_state src_up_state;
bw_src_int_coeffs src_down_coeffs;
bw_src_int_state src_down_state;
// Parameters
float params[p_n];
// Buffers
float buf[BUF_SIZE];
};
typedef struct _bw_example_fx_clip bw_example_fx_clip;
void bw_example_fx_clip_init(bw_example_fx_clip *instance);
void bw_example_fx_clip_set_sample_rate(bw_example_fx_clip *instance, float sample_rate);
void bw_example_fx_clip_reset(bw_example_fx_clip *instance);
void bw_example_fx_clip_process(bw_example_fx_clip *instance, const float** x, float** y, int n_samples);
void bw_example_fx_clip_set_parameter(bw_example_fx_clip *instance, int index, float value);
float bw_example_fx_clip_get_parameter(bw_example_fx_clip *instance, int index);
#ifdef __cplusplus
}
#endif
#endif

View File

@ -0,0 +1,88 @@
/*
* 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 authors: Stefano D'Angelo
*/
#ifndef _CONFIG_H
#define _CONFIG_H
// Definitions
#define IO_MONO 1
#define IO_STEREO (1<<1)
struct config_io_bus {
const char *name;
char out;
char aux;
char cv;
char configs;
};
struct config_parameter {
const char *name;
const char *shortName;
const char *units;
char out;
char bypass;
int steps;
float defaultValueUnmapped;
};
// Data
#define COMPANY_NAME "Orastron"
#define COMPANY_WEBSITE "https://www.orastron.com/"
#define COMPANY_MAILTO "mailto:info@orastron.com"
#define PLUGIN_NAME "bw_example_fx_clip"
#define PLUGIN_VERSION "0.5.0"
#define NUM_BUSES_IN 1
#define NUM_BUSES_OUT 1
#define NUM_CHANNELS_IN 1
#define NUM_CHANNELS_OUT 1
static struct config_io_bus config_buses_in[NUM_BUSES_IN] = {
{ "Audio in", 0, 0, 0, IO_MONO }
};
static struct config_io_bus config_buses_out[NUM_BUSES_OUT] = {
{ "Audio out", 1, 0, 0, IO_MONO }
};
#define NUM_PARAMETERS 2
static struct config_parameter config_parameters[NUM_PARAMETERS] = {
{ "Bias", "Bias", "", 0, 0, 0, 0.5f },
{ "Gain", "Gain", "", 0, 0, 0, 0.4641588833612779f }
};
// Internal API
#include "bw_example_fx_clip.h"
#define P_TYPE bw_example_fx_clip
#define P_INIT bw_example_fx_clip_init
#define P_SET_SAMPLE_RATE bw_example_fx_clip_set_sample_rate
#define P_RESET bw_example_fx_clip_reset
#define P_PROCESS bw_example_fx_clip_process
#define P_SET_PARAMETER bw_example_fx_clip_set_parameter
#define P_GET_PARAMETER bw_example_fx_clip_get_parameter
#endif

View File

@ -0,0 +1,6 @@
ROOT_DIR := $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
NAME := bw_example_fx_clip
SOURCES = ${SOURCES_COMMON} ${ROOT_DIR}/../src/bw_example_fx_clip.c
include ${ROOT_DIR}/../../common/vst3/vst3.mk

View File

@ -0,0 +1,36 @@
/*
* 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 authors: Stefano D'Angelo, Paolo Marrone
*/
#ifndef _VST3_CONFIG_H
#define _VST3_CONFIG_H
#define PLUGIN_SUBCATEGORY "Fx|Distortion"
#define PLUGIN_GUID_1 0x68ff2868
#define PLUGIN_GUID_2 0x4e5945bc
#define PLUGIN_GUID_3 0xaea771e5
#define PLUGIN_GUID_4 0xcc2aceab
#define CTRL_GUID_1 0x161edf17
#define CTRL_GUID_2 0x7df0487e
#define CTRL_GUID_3 0xa80af243
#define CTRL_GUID_4 0xc36f5d66
#endif

View File

@ -0,0 +1,4 @@
ROOT_DIR := $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
SOURCES = ${SOURCES_COMMON} ${ROOT_DIR}/../src/bw_example_fx_clip.c
include ${ROOT_DIR}/../../common/web/web.mk

View File

@ -0,0 +1,43 @@
/*
* 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
*/
var buses = [
{
stereo: false,
output: false
},
{
stereo: false,
output: true
}
];
var parameters = [
{
name: "Bias",
output: false,
defaultValue: 0.5
},
{
name: "Gain",
output: false,
defaultValue: 0.4641588833612779
}
];

277
include/bw_clip.h Normal file
View File

@ -0,0 +1,277 @@
/*
* 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 {{{ 0.5.0 }}}
* requires {{{ bw_config bw_common bw_math bw_one_pole }}}
* description {{{
* Antialiased hard clipper with parametric bias and gain
* (compensation) and output bias removal.
*
* In other words this implements (approximately)
*
* > y(n) = clip(gain \* x(n) + bias, -1, 1) - clip(bias, -1, 1)
*
* with antialiasing and optionally dividing the output by gain.
*
* As a side effect, antialiasing causes attenuation at higher frequencies
* (about 3 dB at 0.5 × Nyquist frequency and rapidly increasing at higher
* frequencies).
* }}}
* changelog {{{
* <ul>
* <li>Version <strong>0.5.0</strong>:
* <ul>
* <li>First release.</li>
* </ul>
* </li>
* </ul>
* }}}
*/
#ifndef _BW_CLIP_H
#define _BW_CLIP_H
#ifdef __cplusplus
extern "C" {
#endif
#include <bw_common.h>
/*! api {{{
* #### bw_clip_coeffs
* ```>>> */
typedef struct _bw_clip_coeffs bw_clip_coeffs;
/*! <<<```
* Coefficients and related.
*
* #### bw_clip_state
* ```>>> */
typedef struct _bw_clip_state bw_clip_state;
/*! <<<```
* Internal state and related.
*
* #### bw_clip_init()
* ```>>> */
static inline void bw_clip_init(bw_clip_coeffs *BW_RESTRICT coeffs);
/*! <<<```
* Initializes input parameter values in `coeffs`.
*
* #### bw_clip_set_sample_rate()
* ```>>> */
static inline void bw_clip_set_sample_rate(bw_clip_coeffs *BW_RESTRICT coeffs, float sample_rate);
/*! <<<```
* Sets the `sample_rate` (Hz) value in `coeffs`.
*
* #### bw_clip_reset_coeffs()
* ```>>> */
static inline void bw_clip_reset_coeffs(bw_clip_coeffs *BW_RESTRICT coeffs);
/*! <<<```
* Resets coefficients in `coeffs` to assume their target values.
*
* #### bw_clip_reset_state()
* ```>>> */
static inline void bw_clip_reset_state(const bw_clip_coeffs *BW_RESTRICT coeffs, bw_clip_state *BW_RESTRICT state);
/*! <<<```
* Resets the given `state` to its initial values using the given `coeffs`.
*
* #### bw_clip_update_coeffs_ctrl()
* ```>>> */
static inline void bw_clip_update_coeffs_ctrl(bw_clip_coeffs *BW_RESTRICT coeffs);
/*! <<<```
* Triggers control-rate update of coefficients in `coeffs`.
*
* #### bw_clip_update_coeffs_audio()
* ```>>> */
static inline void bw_clip_update_coeffs_audio(bw_clip_coeffs *BW_RESTRICT coeffs);
/*! <<<```
* Triggers audio-rate update of coefficients in `coeffs`.
*
* #### bw_clip_process1()
* ```>>> */
static inline float bw_clip_process1(const bw_clip_coeffs *BW_RESTRICT coeffs, bw_clip_state *BW_RESTRICT state, float x);
static inline float bw_clip_process1_comp(const bw_clip_coeffs *BW_RESTRICT coeffs, bw_clip_state *BW_RESTRICT state, float x);
/*! <<<```
* These function process one input sample `x` using `coeffs`, while using
* and updating `state`. They return the corresponding output sample.
*
* In particular:
* * `bw_clip_process1()` assumes that gain compensation is disabled;
* * `bw_clip_process1_comp()` assumes that gain compensation is enabled.
*
* #### bw_clip_process()
* ```>>> */
static inline void bw_clip_process(bw_clip_coeffs *BW_RESTRICT coeffs, bw_clip_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_clip_set_bias()
* ```>>> */
static inline void bw_clip_set_bias(bw_clip_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets the input bias `value` in `coeffs`.
*
* Default value: `0.f`.
*
* #### bw_clip_set_gain()
* ```>>> */
static inline void bw_clip_set_gain(bw_clip_coeffs *BW_RESTRICT coeffs, float value);
/*! <<<```
* Sets the gain `value` in `coeffs`.
*
* Do not set it to `0.f`, obviously.
*
* Default value: `1.f`.
*
* #### bw_clip_set_gain_compensation()
* ```>>> */
static inline void bw_clip_set_gain_compensation(bw_clip_coeffs *BW_RESTRICT coeffs, char value);
/*! <<<```
* Sets whether the output should be divided by gain (`value` non-`0`) or not
* (`0`).
*
* Default value: `1` (on).
* }}} */
/*** 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_one_pole.h>
struct _bw_clip_coeffs {
// Sub-components
bw_one_pole_coeffs smooth_coeffs;
bw_one_pole_state smooth_bias_state;
bw_one_pole_state smooth_gain_state;
// Coefficients
float bias_dc;
float inv_gain;
// Parameters
float bias;
float gain;
char gain_compensation;
};
struct _bw_clip_state {
float x_z1;
float F_z1;
};
static inline void bw_clip_init(bw_clip_coeffs *BW_RESTRICT coeffs) {
bw_one_pole_init(&coeffs->smooth_coeffs);
bw_one_pole_set_tau(&coeffs->smooth_coeffs, 0.005f);
bw_one_pole_set_sticky_thresh(&coeffs->smooth_coeffs, 1e-3f);
coeffs->bias = 0.f;
coeffs->gain = 1.f;
coeffs->gain_compensation = 1;
}
static inline void bw_clip_set_sample_rate(bw_clip_coeffs *BW_RESTRICT coeffs, float sample_rate) {
bw_one_pole_set_sample_rate(&coeffs->smooth_coeffs, sample_rate);
bw_one_pole_reset_coeffs(&coeffs->smooth_coeffs);
}
static inline void _bw_clip_do_update_coeffs(bw_clip_coeffs *BW_RESTRICT coeffs, char force) {
float bias_cur = bw_one_pole_get_y_z1(&coeffs->smooth_bias_state);
if (force || coeffs->bias != bias_cur) {
bias_cur = bw_one_pole_process1_sticky_abs(&coeffs->smooth_coeffs, &coeffs->smooth_bias_state, coeffs->bias);
coeffs->bias_dc = bw_clipf(bias_cur, -1.f, 1.f);
}
float gain_cur = bw_one_pole_get_y_z1(&coeffs->smooth_gain_state);
if (force || coeffs->gain != gain_cur) {
gain_cur = bw_one_pole_process1_sticky_rel(&coeffs->smooth_coeffs, &coeffs->smooth_gain_state, coeffs->gain);
coeffs->inv_gain = bw_rcpf_2(gain_cur);
}
}
static inline void bw_clip_reset_coeffs(bw_clip_coeffs *BW_RESTRICT coeffs) {
bw_one_pole_reset_state(&coeffs->smooth_coeffs, &coeffs->smooth_bias_state, coeffs->bias);
bw_one_pole_reset_state(&coeffs->smooth_coeffs, &coeffs->smooth_gain_state, coeffs->gain);
_bw_clip_do_update_coeffs(coeffs, 1);
}
static inline void bw_clip_reset_state(const bw_clip_coeffs *BW_RESTRICT coeffs, bw_clip_state *BW_RESTRICT state) {
(void)coeffs;
state->F_z1 = 0.f;
state->x_z1 = 0.f;
}
static inline void bw_clip_update_coeffs_ctrl(bw_clip_coeffs *BW_RESTRICT coeffs) {
(void)coeffs;
}
static inline void bw_clip_update_coeffs_audio(bw_clip_coeffs *BW_RESTRICT coeffs) {
_bw_clip_do_update_coeffs(coeffs, 0);
}
static inline float bw_clip_process1(const bw_clip_coeffs *BW_RESTRICT coeffs, bw_clip_state *BW_RESTRICT state, float x) {
x = bw_one_pole_get_y_z1(&coeffs->smooth_gain_state) * x + bw_one_pole_get_y_z1(&coeffs->smooth_bias_state);
const float a = bw_absf(x);
const float F = a > 1.f ? a - 0.5f : 0.5f * a * a;
const float d = x - state->x_z1;
const float y = d * d < 1e-6f ? bw_clipf(0.5f * (x + state->x_z1), -1.f, 1.f) : (F - state->F_z1) * bw_rcpf_2(d);
state->x_z1 = x;
state->F_z1 = F;
return y - coeffs->bias_dc;
}
static inline float bw_clip_process1_comp(const bw_clip_coeffs *BW_RESTRICT coeffs, bw_clip_state *BW_RESTRICT state, float x) {
float y = bw_clip_process1(coeffs, state, x);
return coeffs->inv_gain * y;
}
static inline void bw_clip_process(bw_clip_coeffs *BW_RESTRICT coeffs, bw_clip_state *BW_RESTRICT state, const float *x, float *y, int n_samples) {
if (coeffs->gain_compensation)
for (int i = 0; i < n_samples; i++) {
bw_clip_update_coeffs_audio(coeffs);
y[i] = bw_clip_process1_comp(coeffs, state, x[i]);
}
else
for (int i = 0; i < n_samples; i++) {
bw_clip_update_coeffs_audio(coeffs);
y[i] = bw_clip_process1(coeffs, state, x[i]);
}
}
static inline void bw_clip_set_bias(bw_clip_coeffs *BW_RESTRICT coeffs, float value) {
coeffs->bias = value;
}
static inline void bw_clip_set_gain(bw_clip_coeffs *BW_RESTRICT coeffs, float value) {
coeffs->gain = value;
}
static inline void bw_clip_set_gain_compensation(bw_clip_coeffs *BW_RESTRICT coeffs, char value) {
coeffs->gain_compensation = value;
}
#ifdef __cplusplus
}
#endif
#endif