Brickworks > API documentation > bw_trem

bw_trem

Description

Tremolo with variable speed and amount.

Info

Module type: dsp

Version: 1.1.0

Requires:

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 float bw_trem_reset_state(
	const bw_trem_coeffs * BW_RESTRICT coeffs,
	bw_trem_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.

bw_trem_reset_state_multi()

static inline void bw_trem_reset_state_multi(
	const bw_trem_coeffs * BW_RESTRICT              coeffs,
	bw_trem_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.

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,
	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_trem_process_multi()

static inline void bw_trem_process_multi(
	bw_trem_coeffs * BW_RESTRICT                    coeffs,
	bw_trem_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).

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.

value must be finite.

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.

Valid range: [-1.f (full tremolo with inverted polarity), 1.f (full tremolo)].

Default value: 1.f.

bw_trem_coeffs_is_valid()

static inline char bw_trem_coeffs_is_valid(
	const bw_trem_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_trem_coeffs.

bw_trem_state_is_valid()

static inline char bw_trem_state_is_valid(
	const bw_trem_coeffs * BW_RESTRICT coeffs,
	const bw_trem_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 bw_trem_state.

C++ wrapper

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

	void setSampleRate(
		float sampleRate);

	void reset(
		float               x0 = 0.f,
		float * BW_RESTRICT y0 = nullptr);

#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 = nullptr);

#ifndef BW_CXX_NO_ARRAY
	void reset(
		std::array<float, N_CHANNELS>               x0,
		std::array<float, N_CHANNELS> * BW_RESTRICT y0 = nullptr);
#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 setRate(
		float value);

	void setAmount(
		float value);
...
}

ChangeLog