Brickworks > API documentation > bw_ring_mod



Ring modulator with variable modulation amount.


Module type: dsp

Version: 1.0.0




typedef struct bw_ring_mod_coeffs bw_ring_mod_coeffs;

Coefficients and related.


static inline void bw_ring_mod_init(
	bw_ring_mod_coeffs * BW_RESTRICT coeffs);

Initializes input parameter values in coeffs.


static inline void bw_ring_mod_set_sample_rate(
	bw_ring_mod_coeffs * BW_RESTRICT coeffs,
	float                            sample_rate);

Sets the sample_rate (Hz) value in coeffs.


static inline void bw_ring_mod_reset_coeffs(
	bw_ring_mod_coeffs * BW_RESTRICT coeffs);

Resets coefficients in coeffs to assume their target values.


static inline void bw_ring_mod_update_coeffs_ctrl(
	bw_ring_mod_coeffs * BW_RESTRICT coeffs);

Triggers control-rate update of coefficients in coeffs.


static inline void bw_ring_mod_update_coeffs_audio(
	bw_ring_mod_coeffs * BW_RESTRICT coeffs);

Triggers audio-rate update of coefficients in coeffs.


static inline float bw_ring_mod_process1(
	const bw_ring_mod_coeffs * BW_RESTRICT coeffs,
	float                                  x_mod,
	float                                  x_car);

Processes one modulation input sample x_mod and one carrier input sample x_car using coeffs and returns the corresponding output sample.


static inline void bw_ring_mod_process(
	bw_ring_mod_coeffs * BW_RESTRICT coeffs,
	const float *                    x_mod,
	const float *                    x_car,
	float *                          y,
	size_t                           n_samples);

Processes the first n_samples of the modulation input buffer x_mod and of the carrier input buffer x_car and fills the first n_samples of the output buffer y, while using and updating coeffs (control and audio rate).


static inline void bw_ring_mod_process_multi(
	bw_ring_mod_coeffs * BW_RESTRICT coeffs,
	const float * const *            x_mod,
	const float * const *            x_car,
	float * const *                  y,
	size_t                           n_channels,
	size_t                           n_samples);

Processes the first n_samples of the n_channels modulation input buffers x_mod and of the n_channels carrier input buffers x_car, and fills the first n_samples of the n_channels output buffers y, while using and updating the common coeffs (control and audio rate).


static inline void bw_ring_mod_set_amount(
	bw_ring_mod_coeffs * BW_RESTRICT coeffs,
	float                            value);

Sets the modulation amount parameter to the given value (0.f = no modulation, 1.f = full modulation, -1.f = full modulation with inverted polarity) in coeffs.

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

Default value: 1.f.


static inline char bw_ring_mod_coeffs_is_valid(
	const bw_ring_mod_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_ring_mod_coeffs.

C++ wrapper

template<size_t N_CHANNELS>
class RingMod {

	void setSampleRate(
		float sampleRate);

	void reset();

	void process(
		const float * const * xMod,
		const float * const * xCar,
		float * const *       y,
		size_t                nSamples);

	void process(
		std::array<const float *, N_CHANNELS> xMod,
		std::array<const float *, N_CHANNELS> xCar,
		std::array<float *, N_CHANNELS>       y,
		size_t                                nSamples);

	void setAmount(float value);