BogaudioModules

commit e357d616c23128ac789cc0d8fec54483667abf4d
parent 3be9295219991151cfa676f6b76277ea9c15b42e
Author: Matt Demanett <matt@demanett.net>
Date:   Wed, 22 Sep 2021 22:45:52 -0400

LLFO: add option to reset the phase on waveform change. #182

Diffstat:
M
README-prerelease.md
 | 
2
++
M
src/LLFO.cpp
 | 
36
++++++++++++++++++++++++++----------
M
src/LLFO.hpp
 | 
4
++++

3 files changed, 32 insertions(+), 10 deletions(-)
diff --git a/README-prerelease.md b/README-prerelease.md
@@ -196,6 +196,8 @@ A 3HP LFO, with selectable waveform.  The features are a subset of LFO.  There a
 
 Sampling and smoothing functions are available on the context menu.
 
+Context menu option "Reset phase on wave change", if enabled, causes the waveform phase to be set to zero when the waveform is changed.  By default the continues to advance from wherever it was.  In either case, the output will typically jump to a new value, which may cause clicks or other undesirable effects depending on how the output is used; adding a bit of smoothing may help.
+
 _Polyphony:_ <a href="#polyphony">Polyphonic</a>, with channels defined by the V/OCT input.
 
 #### <a name="fourfo"></a> 4FO
diff --git a/src/LLFO.cpp b/src/LLFO.cpp
@@ -4,6 +4,7 @@
 #define OUTPUT_SAMPLING "output_sampling"
 #define PULSE_WIDTH "pulse_width"
 #define SMOOTHING "smoothing"
+#define RESET_ON_WAVE_CHANGE "reset_on_wave_change"
 
 void LLFO::reset() {
 	for (int c = 0; c < maxChannels; ++c) {
@@ -21,6 +22,7 @@ json_t* LLFO::toJson(json_t* root) {
 	json_object_set_new(root, OUTPUT_SAMPLING, json_real(_sample));
 	json_object_set_new(root, PULSE_WIDTH, json_real(_pulseWidth));
 	json_object_set_new(root, SMOOTHING, json_real(_smooth));
+	json_object_set_new(root, RESET_ON_WAVE_CHANGE, json_boolean(_resetOnWaveChange));
 	return root;
 }
 
@@ -39,6 +41,11 @@ void LLFO::fromJson(json_t* root) {
 	if (s) {
 		_smooth = json_real_value(s);
 	}
+
+	json_t* rowc = json_object_get(root, RESET_ON_WAVE_CHANGE);
+	if (rowc) {
+		_resetOnWaveChange = json_boolean_value(rowc);
+	}
 }
 
 bool LLFO::active() {
@@ -59,8 +66,17 @@ void LLFO::modulate() {
 	_slowMode = params[SLOW_PARAM].getValue() > 0.5f;
 
 	_invert = false;
-	Wave wave = (Wave)params[WAVE_PARAM].getValue();
-	switch (wave) {
+	Wave wave = (Wave)(1 + (int)params[WAVE_PARAM].getValue());
+	if (_wave != wave) {
+		_wave = wave;
+		if (_resetOnWaveChange) {
+			for (int c = 0; c < _channels; c++) {
+				_phasor[c].setPhase(0.0f);
+			}
+		}
+	}
+	switch (_wave) {
+		case UNINITIALIZED_WAVE:
 		case SINE_WAVE: {
 			_oscillator = &_sine;
 			_samplingEnabled = true;
@@ -125,14 +141,13 @@ void LLFO::modulateChannel(int c) {
 }
 
 void LLFO::processAlways(const ProcessArgs& args) {
-	Wave wave = (Wave)params[WAVE_PARAM].getValue();
-	lights[SINE_LIGHT].value = wave == SINE_WAVE;
-	lights[TRIANGLE_LIGHT].value = wave == TRIANGLE_WAVE;
-	lights[RAMP_UP_LIGHT].value = wave == RAMP_UP_WAVE;
-	lights[RAMP_DOWN_LIGHT].value = wave == RAMP_DOWN_WAVE;
-	lights[SQUARE_LIGHT].value = wave == SQUARE_WAVE;
-	lights[PULSE_LIGHT].value = wave == PULSE_WAVE;
-	lights[STEPPED_LIGHT].value = wave == STEPPED_WAVE;
+	lights[SINE_LIGHT].value = _wave == SINE_WAVE;
+	lights[TRIANGLE_LIGHT].value = _wave == TRIANGLE_WAVE;
+	lights[RAMP_UP_LIGHT].value = _wave == RAMP_UP_WAVE;
+	lights[RAMP_DOWN_LIGHT].value = _wave == RAMP_DOWN_WAVE;
+	lights[SQUARE_LIGHT].value = _wave == SQUARE_WAVE;
+	lights[PULSE_LIGHT].value = _wave == PULSE_WAVE;
+	lights[STEPPED_LIGHT].value = _wave == STEPPED_WAVE;
 }
 
 void LLFO::processChannel(const ProcessArgs& args, int c) {
@@ -331,6 +346,7 @@ struct LLFOWidget : BGModuleWidget {
 		menu->addChild(new LLFOSliderMenuItem<SampleQuantity>(m, "Output sampling"));
 		menu->addChild(new LLFOSliderMenuItem<PWQuantity>(m, "Pulse width"));
 		menu->addChild(new LLFOSliderMenuItem<SmoothQuantity>(m, "Smoothing"));
+		menu->addChild(new BoolOptionMenuItem("Reset phase on wave change", [m]() { return &m->_resetOnWaveChange; }));
 	}
 };
 
diff --git a/src/LLFO.hpp b/src/LLFO.hpp
@@ -42,6 +42,7 @@ struct LLFO : LFOBase {
 	};
 
 	enum Wave {
+		UNINITIALIZED_WAVE,
 		SINE_WAVE,
 		TRIANGLE_WAVE,
 		RAMP_UP_WAVE,
@@ -55,11 +56,14 @@ struct LLFO : LFOBase {
 	static constexpr float defaultSample = 0.0f;
 	static constexpr float defaultPulseWidth = -0.8510638; // 10% pulse.
 	static constexpr float defaultSmooth = 0.0f;
+
+	Wave _wave = UNINITIALIZED_WAVE;
 	float _offset = 0.0f;
 	float _scale = 0.0f;
 	float _sample = defaultSample;
 	float _pulseWidth = defaultPulseWidth;
 	float _smooth = defaultSmooth;
+	bool _resetOnWaveChange = false;
 
 	PositiveZeroCrossing _resetTrigger[maxChannels];
 	Phasor _phasor[maxChannels];