Nonlinear digital model of the Ibanez® Tube Screamer® clipping stage circuit.
The cutoff frequencies of the two parts of the feedback network are controllable by means of parameters.
Version: 1.0.0
License: proprietary license
Requires:
We can privately hand you one or more example plugins if you are interested.
Module type: DSP
typedef struct bwp_pan_drive_clip_coeffs bwp_pan_drive_clip_coeffs;
Coefficients and related.
typedef struct bwp_pan_drive_clip_state bwp_pan_drive_clip_state;
Internal state and related.
static inline void bwp_pan_drive_clip_init(
bwp_pan_drive_clip_coeffs * BW_RESTRICT coeffs);
Initializes input parameter values in coeffs.
static inline void bwp_pan_drive_clip_set_sample_rate(
bwp_pan_drive_clip_coeffs * BW_RESTRICT coeffs,
float sample_rate);
Sets the sample_rate (Hz) value in coeffs.
static inline void bwp_pan_drive_clip_reset_coeffs(
bwp_pan_drive_clip_coeffs * BW_RESTRICT coeffs);
Resets coefficients in coeffs to assume their target values.
static inline float bwp_pan_drive_clip_reset_state(
const bwp_pan_drive_clip_coeffs * BW_RESTRICT coeffs,
bwp_pan_drive_clip_state * BW_RESTRICT state,
float x_0);
Resets the given state to its initial values using the given coeffs and the initial input value x_0.
Returns the corresponding initial output value.
static inline void bwp_pan_drive_clip_reset_state_multi(
const bwp_pan_drive_clip_coeffs * BW_RESTRICT coeffs,
bwp_pan_drive_clip_state * BW_RESTRICT const * BW_RESTRICT state,
const float * x_0,
float * y_0,
size_t n_channels);
Resets each of the n_channels states to its initial values using the given coeffs and the corresponding initial input value in the x_0 array.
The corresponding initial output values are written into the y_0 array, if not BW_NULL.
static inline void bwp_pan_drive_clip_update_coeffs_ctrl(
bwp_pan_drive_clip_coeffs * BW_RESTRICT coeffs);
Triggers control-rate update of coefficients in coeffs.
static inline void bwp_pan_drive_clip_update_coeffs_audio(
bwp_pan_drive_clip_coeffs * BW_RESTRICT coeffs);
Triggers audio-rate update of coefficients in coeffs.
static inline float bwp_pan_drive_clip_process1(
const bwp_pan_drive_clip_coeffs * BW_RESTRICT coeffs,
bwp_pan_drive_clip_state * BW_RESTRICT state,
float x);
Processes one input sample x using coeffs, while using and updating state. Returns the corresponding output sample.
static inline void bwp_pan_drive_clip_process(
bwp_pan_drive_clip_coeffs * BW_RESTRICT coeffs,
bwp_pan_drive_clip_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).
static inline void bwp_pan_drive_clip_process_multi(
bwp_pan_drive_clip_coeffs * BW_RESTRICT coeffs,
bwp_pan_drive_clip_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 states (control and audio rate).
static inline void bwp_pan_drive_clip_set_drive(
bwp_pan_drive_clip_coeffs * BW_RESTRICT coeffs,
float value);
Sets the drive potentiometer wiper position (linear mapping — beware, the original device uses a logarithmic pot) to the given value in coeffs.
Valid range: [0.f (low distortion/gain/resistance), 1.f (high distortion/gain/resistance)].
Default value: 0.f.
static inline void bwp_pan_drive_clip_set_cutoff_ground(
bwp_pan_drive_clip_coeffs * BW_RESTRICT coeffs,
float value);
Sets the cutoff frequency (Hz) of the of minus pin-to-ground part of the feedback network to the given value in coeffs.
Valid range: [1e-6f, 1e6f].
Default value: 720.4841244540306f.
static inline void bwp_pan_drive_clip_set_cutoff_feedback(
bwp_pan_drive_clip_coeffs * BW_RESTRICT coeffs,
float value);
Sets the cutoff frequency (Hz) of the of minus pin-to-output pin part of the feedback network when drive is at max to the given value in coeffs.
Valid range: [1e-6f, 1e6f].
Default value: 5663.675424073711f.
static inline char bwp_pan_drive_clip_coeffs_is_valid(
const bwp_pan_drive_clip_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 bwp_pan_drive_clip_coeffs.
static inline char bwp_pan_drive_clip_state_is_valid(
const bwp_pan_drive_clip_coeffs * BW_RESTRICT coeffs,
const bwp_pan_drive_clip_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 bwp_pan_drive_clip_state.
template<size_t N_CHANNELS = 1>
class PanDriveClip {
public:
PanDriveClip();
void setSampleRate(
float sampleRate);
void reset(
float x0 = 0.f,
float * BW_RESTRICT y0 = BW_NULL);
# ifndef BW_CXX_NO_ARRAY
void reset(
float x0,
std::array<float, N_CHANNELS> * BW_RESTRICT y0);
# endif
void reset(
const float * x0,
float * y0 = BW_NULL);
# ifndef BW_CXX_NO_ARRAY
void reset(
std::array<float, N_CHANNELS> x0,
std::array<float, N_CHANNELS> * BW_RESTRICT y0 = BW_NULL);
# endif
void process(
const float * const * x,
float * const * y,
size_t nSamples);
# ifndef BW_CXX_NO_ARRAY
void process(
std::array<const float *, N_CHANNELS> x,
std::array<float *, N_CHANNELS> y,
size_t nSamples);
# endif
void setDrive(
float value);
void setCutoffGround(
float value);
void setCutoffFeedback(
float value);
...
}