engines/common/LFOSine.h

/*
 * Copyright (c) 2019 Christian Schoenebeck
 *
 * http://www.linuxsampler.org
 *
 * This file is part of LinuxSampler and released under the same terms.
 * See README file for details.
 */

#ifndef LS_LFOSINE_H
#define LS_LFOSINE_H

#include "LFOBase.h"

namespace LinuxSampler {

    /** @brief Sine LFO (numeric, complex nr implementation)
     *
     * This is a Sinus Low Frequency Oscillator implementation using a complex
     * number with numeric (descrete) math as basis for its oscillation.
     */
    template<LFO::range_type_t RANGE>
    class LFOSine : public LFOBase<RANGE> {
        public:

            /**
             * Constructor
             *
             * @param Max - maximum value of the output levels
             */
            LFOSine(float Max) : LFOBase<RANGE>::LFOBase(Max) {
            }

            /**
             * Calculates exactly one sample point of the LFO wave.
             *
             * @returns next LFO level
             */
            inline float render() {
                real -= c * imag;
                imag += c * real;
                if (RANGE == LFO::range_unsigned)
                    return real * normalizer + offset;
                else /* signed range */
                    return real * normalizer;
            }

            /**
             * Update LFO depth with a new external controller value.
             *
             * @param ExtControlValue - new external controller value
             */
            inline void updateByMIDICtrlValue(const uint16_t& ExtControlValue) {
                this->ExtControlValue = ExtControlValue;

                const float max = (this->InternalDepth + ExtControlValue * this->ExtControlDepthCoeff) * this->ScriptDepthFactor;
                if (RANGE == LFO::range_unsigned) {
                    normalizer = max * 0.5f;
                    offset     = normalizer;
                } else { // signed range
                    normalizer = max;
                }
            }

            /**
             * Will be called by the voice when the key / voice was triggered.
             *
             * @param Frequency       - frequency of the oscillator in Hz
             * @param StartLevel      - on which level the wave should start
             * @param InternalDepth   - firm, internal oscillator amplitude
             * @param ExtControlDepth - defines how strong the external MIDI
             *                          controller has influence on the
             *                          oscillator amplitude
             * @param FlipPhase       - inverts the oscillator wave against
             *                          a horizontal axis
             * @param SampleRate      - current sample rate of the engines
             *                          audio output signal
             */
            void trigger(float Frequency, LFO::start_level_t StartLevel, uint16_t InternalDepth, uint16_t ExtControlDepth, bool FlipPhase, unsigned int SampleRate) {
                this->Frequency = Frequency;
                this->ScriptFrequencyFactor = this->ScriptDepthFactor = 1.f; // reset for new voice
                this->InternalDepth = (InternalDepth / 1200.0f) * this->Max;
                this->ExtControlDepthCoeff = (((float) ExtControlDepth / 1200.0f) / 127.0f) * this->Max;
                this->pFinalDepth = NULL;
                this->pFinalFrequency = NULL;

                const float freq = Frequency * this->ScriptFrequencyFactor;
                c = 2.0f * M_PI * freq / (float) SampleRate;

                switch (StartLevel) {
                    case LFO::start_level_mid:
                        this->startPhase = (FlipPhase) ? 0.5 * M_PI : 1.5 * M_PI; // 90� or 270�
                        break;
                    case LFO::start_level_max:
                        this->startPhase = (FlipPhase) ? M_PI : 0.0; // 180� or 0�
                        break;
                    case LFO::start_level_min:
                        this->startPhase = (FlipPhase) ? 0.0 : M_PI; // 0� or 180�
                        break;
                }
                real = cos(this->startPhase);
                imag = sin(this->startPhase);
            }

            /**
             * Should be invoked after the LFO is triggered with StartLevel
             * start_level_min.
             * @param phase From 0 to 360 degrees.
             */
            void setPhase(float phase) {
                if (phase < 0) phase = 0;
                if (phase > 360) phase = 360;
                phase = phase / 360.0f * 2 * M_PI;
                real = cos(this->startPhase + phase);
                imag = sin(this->startPhase + phase);
            }

            void setFrequency(float Frequency, unsigned int SampleRate) {
                this->Frequency = Frequency;
                const float freq = Frequency * this->ScriptFrequencyFactor;
                c = 2.0f * M_PI * freq / (float) SampleRate;
            }

            void setScriptDepthFactor(float factor, bool isFinal) {
                this->ScriptDepthFactor = factor;
                // set or reset this script depth parameter to be the sole
                // source for the LFO depth
                if (isFinal && !this->pFinalDepth)
                    this->pFinalDepth = &this->ScriptDepthFactor;
                else if (!isFinal && this->pFinalDepth == &this->ScriptDepthFactor)
                    this->pFinalDepth = NULL;
                // recalculate upon new depth
                updateByMIDICtrlValue(this->ExtControlValue);
            }

            void setScriptFrequencyFactor(float factor, unsigned int SampleRate) {
                this->ScriptFrequencyFactor = factor;
                // in case script frequency was set as "final" value before,
                // reset it so that all sources are processed from now on
                if (this->pFinalFrequency == &this->ScriptFrequencyFactor)
                    this->pFinalFrequency = NULL;
                // recalculate upon new frequency
                setFrequency(this->Frequency, SampleRate);
            }

            void setScriptFrequencyFinal(float hz, unsigned int SampleRate) {
                this->ScriptFrequencyFactor = hz;
                // assign script's given frequency as sole source for the LFO
                // frequency, thus ignore all other sources
                if (!this->pFinalFrequency)
                    this->pFinalFrequency = &this->ScriptFrequencyFactor;
                // recalculate upon new frequency
                setFrequency(this->Frequency, SampleRate);
            }

        private:
            float c;
            float real;
            float imag;
            float normalizer;
            float offset;
            double startPhase;
    };

} // namespace LinuxSampler

#endif // LS_LFOSINE_H
1	/*
2	* Copyright (c) 2019 Christian Schoenebeck
3	*
4	* http://www.linuxsampler.org
5	*
6	* This file is part of LinuxSampler and released under the same terms.
7	* See README file for details.
8	*/
9
10	#ifndef LS_LFOSINE_H
11	#define LS_LFOSINE_H
12
13	#include "LFOBase.h"
14
15	namespace LinuxSampler {
16
17	/** @brief Sine LFO (numeric, complex nr implementation)
18	*
19	* This is a Sinus Low Frequency Oscillator implementation using a complex
20	* number with numeric (descrete) math as basis for its oscillation.
21	*/
22	template<LFO::range_type_t RANGE>
23	class LFOSine : public LFOBase<RANGE> {
24	public:
25
26	/**
27	* Constructor
28	*
29	* @param Max - maximum value of the output levels
30	*/
31	LFOSine(float Max) : LFOBase<RANGE>::LFOBase(Max) {
32	}
33
34	/**
35	* Calculates exactly one sample point of the LFO wave.
36	*
37	* @returns next LFO level
38	*/
39	inline float render() {
40	real -= c * imag;
41	imag += c * real;
42	if (RANGE == LFO::range_unsigned)
43	return real * normalizer + offset;
44	else /* signed range */
45	return real * normalizer;
46	}
47
48	/**
49	* Update LFO depth with a new external controller value.
50	*
51	* @param ExtControlValue - new external controller value
52	*/
53	inline void updateByMIDICtrlValue(const uint16_t& ExtControlValue) {
54	this->ExtControlValue = ExtControlValue;
55
56	const float max = (this->InternalDepth + ExtControlValue * this->ExtControlDepthCoeff) * this->ScriptDepthFactor;
57	if (RANGE == LFO::range_unsigned) {
58	normalizer = max * 0.5f;
59	offset = normalizer;
60	} else { // signed range
61	normalizer = max;
62	}
63	}
64
65	/**
66	* Will be called by the voice when the key / voice was triggered.
67	*
68	* @param Frequency - frequency of the oscillator in Hz
69	* @param StartLevel - on which level the wave should start
70	* @param InternalDepth - firm, internal oscillator amplitude
71	* @param ExtControlDepth - defines how strong the external MIDI
72	* controller has influence on the
73	* oscillator amplitude
74	* @param FlipPhase - inverts the oscillator wave against
75	* a horizontal axis
76	* @param SampleRate - current sample rate of the engines
77	* audio output signal
78	*/
79	void trigger(float Frequency, LFO::start_level_t StartLevel, uint16_t InternalDepth, uint16_t ExtControlDepth, bool FlipPhase, unsigned int SampleRate) {
80	this->Frequency = Frequency;
81	this->ScriptFrequencyFactor = this->ScriptDepthFactor = 1.f; // reset for new voice
82	this->InternalDepth = (InternalDepth / 1200.0f) * this->Max;
83	this->ExtControlDepthCoeff = (((float) ExtControlDepth / 1200.0f) / 127.0f) * this->Max;
84	this->pFinalDepth = NULL;
85	this->pFinalFrequency = NULL;
86
87	const float freq = Frequency * this->ScriptFrequencyFactor;
88	c = 2.0f * M_PI * freq / (float) SampleRate;
89
90	switch (StartLevel) {
91	case LFO::start_level_mid:
92	this->startPhase = (FlipPhase) ? 0.5 * M_PI : 1.5 * M_PI; // 90� or 270�
93	break;
94	case LFO::start_level_max:
95	this->startPhase = (FlipPhase) ? M_PI : 0.0; // 180� or 0�
96	break;
97	case LFO::start_level_min:
98	this->startPhase = (FlipPhase) ? 0.0 : M_PI; // 0� or 180�
99	break;
100	}
101	real = cos(this->startPhase);
102	imag = sin(this->startPhase);
103	}
104
105	/**
106	* Should be invoked after the LFO is triggered with StartLevel
107	* start_level_min.
108	* @param phase From 0 to 360 degrees.
109	*/
110	void setPhase(float phase) {
111	if (phase < 0) phase = 0;
112	if (phase > 360) phase = 360;
113	phase = phase / 360.0f * 2 * M_PI;
114	real = cos(this->startPhase + phase);
115	imag = sin(this->startPhase + phase);
116	}
117
118	void setFrequency(float Frequency, unsigned int SampleRate) {
119	this->Frequency = Frequency;
120	const float freq = Frequency * this->ScriptFrequencyFactor;
121	c = 2.0f * M_PI * freq / (float) SampleRate;
122	}
123
124	void setScriptDepthFactor(float factor, bool isFinal) {
125	this->ScriptDepthFactor = factor;
126	// set or reset this script depth parameter to be the sole
127	// source for the LFO depth
128	if (isFinal && !this->pFinalDepth)
129	this->pFinalDepth = &this->ScriptDepthFactor;
130	else if (!isFinal && this->pFinalDepth == &this->ScriptDepthFactor)
131	this->pFinalDepth = NULL;
132	// recalculate upon new depth
133	updateByMIDICtrlValue(this->ExtControlValue);
134	}
135
136	void setScriptFrequencyFactor(float factor, unsigned int SampleRate) {
137	this->ScriptFrequencyFactor = factor;
138	// in case script frequency was set as "final" value before,
139	// reset it so that all sources are processed from now on
140	if (this->pFinalFrequency == &this->ScriptFrequencyFactor)
141	this->pFinalFrequency = NULL;
142	// recalculate upon new frequency
143	setFrequency(this->Frequency, SampleRate);
144	}
145
146	void setScriptFrequencyFinal(float hz, unsigned int SampleRate) {
147	this->ScriptFrequencyFactor = hz;
148	// assign script's given frequency as sole source for the LFO
149	// frequency, thus ignore all other sources
150	if (!this->pFinalFrequency)
151	this->pFinalFrequency = &this->ScriptFrequencyFactor;
152	// recalculate upon new frequency
153	setFrequency(this->Frequency, SampleRate);
154	}
155
156	private:
157	float c;
158	float real;
159	float imag;
160	float normalizer;
161	float offset;
162	double startPhase;
163	};
164
165	} // namespace LinuxSampler
166
167	#endif // LS_LFOSINE_H