Brickworks > API documentation > bw_gain

bw_gain

Description

Gain.

Info

Module type: dsp

Version: 1.0.0

Requires:

API

bw_gain_coeffs

typedef struct bw_gain_coeffs bw_gain_coeffs;

Coefficients and related.

bw_gain_init()

static inline void bw_gain_init(
	bw_gain_coeffs * BW_RESTRICT coeffs);

Initializes input parameter values in coeffs.

bw_gain_set_sample_rate()

static inline void bw_gain_set_sample_rate(
	bw_gain_coeffs * BW_RESTRICT coeffs,
	float                        sample_rate);

Sets the sample_rate (Hz) value in coeffs.

bw_gain_reset_coeffs()

static inline void bw_gain_reset_coeffs(
	bw_gain_coeffs * BW_RESTRICT coeffs);

Resets coefficients in coeffs to assume their target values.

bw_gain_update_coeffs_ctrl()

static inline void bw_gain_update_coeffs_ctrl(
	bw_gain_coeffs * BW_RESTRICT coeffs);

Triggers control-rate update of coefficients in coeffs.

bw_gain_update_coeffs_audio()

static inline void bw_gain_update_coeffs_audio(
	bw_gain_coeffs * BW_RESTRICT coeffs);

Triggers audio-rate update of coefficients in coeffs.

bw_gain_process1()

static inline float bw_gain_process1(
	const bw_gain_coeffs * BW_RESTRICT coeffs,
	float                              x);

Processes one input sample x using coeffs and returns the corresponding output sample.

bw_gain_process()

static inline void bw_gain_process(
	bw_gain_coeffs * BW_RESTRICT coeffs,
	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 coeffs (control and audio rate).

bw_gain_process_multi()

static inline void bw_gain_process_multi(
	bw_gain_coeffs * BW_RESTRICT coeffs,
	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 the common coeffs (control and audio rate).

bw_gain_set_gain_lin()

static inline void bw_gain_set_gain_lin(
	bw_gain_coeffs * BW_RESTRICT coeffs,
	float                        value);

Sets the gain parameter to the given value (linear gain) in coeffs.

value must be finite.

Default value: 1.f.

bw_gain_set_gain_dB()

static inline void bw_gain_set_gain_dB(
	bw_gain_coeffs * BW_RESTRICT coeffs,
	float                        value);

Sets the gain parameter to the given value (dB) in coeffs.

value must be less than or equal to 770.630f.

Default value: 0.f.

bw_gain_set_smooth_tau()

static inline void bw_gain_set_smooth_tau(
	bw_gain_coeffs * BW_RESTRICT coeffs,
	float                        value);

Sets the smoothing time constant value (s) in coeffs.

value must be non-negative.

Default value: 0.05f.

bw_gain_get_gain_lin()

static inline float bw_gain_get_gain_lin(
	const bw_gain_coeffs * BW_RESTRICT coeffs);

Returns the current gain parameter value (linear gain) in coeffs.

bw_gain_get_gain_cur()

static inline float bw_gain_get_gain_cur(
	const bw_gain_coeffs * BW_RESTRICT coeffs);

Returns the actual current gain coefficient (linear gain) in coeffs.

bw_gain_coeffs_is_valid()

static inline char bw_gain_coeffs_is_valid(
	const bw_gain_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 bw_gain_coeffs.

C++ wrapper

Brickworks::Gain
template<size_t N_CHANNELS>
class Gain {
public:
	Gain();

	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 setGainLin(
		float value);

	void setGainDB(
		float value);

	void setSmoothTau(
		float value);

	float getGainLin();

	float getGainCur();
...
}

ChangeLog