engines/common/LFOTriangleDiHarmonic.h

/***************************************************************************
 *                                                                         *
 *   Copyright (C) 2005 - 2019 Christian Schoenebeck                       *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this library; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#ifndef __LS_LFOTRIANGLEDIHARMONIC_H__
#define __LS_LFOTRIANGLEDIHARMONIC_H__

#include "LFOBase.h"

// amplitue of 2nd harmonic (to approximate the triangular wave)
#define AMP2    -0.11425509f

namespace LinuxSampler {

    /** @brief Triangle LFO (di-harmonic implementation)
     *
     * This is a triangle Low Frequency Oscillator implementation which uses
     * a di-harmonic solution. This means it sums up two harmonics
     * (sinusoids) to approximate a triangular wave.
     */
    template<range_type_t RANGE>
    class LFOTriangleDiHarmonic : public LFOBase<RANGE> {
        public:

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

            /**
             * Calculates exactly one sample point of the LFO wave.
             *
             * @returns next LFO level
             */
            inline float render() {
                real1 -= c1 * imag1;
                imag1 += c1 * real1;
                real2 -= c2 * imag2;
                imag2 += c2 * real2;
                if (RANGE == range_unsigned)
                    return (real1 + real2 * AMP2) * normalizer + offset;
                else /* signed range */
                    return (real1 + real2 * AMP2) * 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 == range_unsigned) {
                    const float harmonicCompensation = 1.0f + fabsf(AMP2); // to compensate the compensation ;) (see trigger())
                    normalizer = max * 0.5f;
                    offset     = normalizer * harmonicCompensation;
                } 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, 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
                const float harmonicCompensation = 1.0f + fabsf(AMP2); // to compensate the 2nd harmonic's amplitude overhead
                this->InternalDepth        = (InternalDepth / 1200.0f) * this->Max / harmonicCompensation;
                this->ExtControlDepthCoeff = (((float) ExtControlDepth / 1200.0f) / 127.0f) * this->Max / harmonicCompensation;
                this->pFinalDepth = NULL;
                this->pFinalFrequency = NULL;

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

                double phi; // phase displacement
                switch (StartLevel) {
                    case start_level_mid:
                        //FIXME: direct jumping to 90� and 270� doesn't work out due to numeric accuracy problems (causes wave deformation)
                        //phi = (FlipPhase) ? 0.5 * M_PI : 1.5 * M_PI; // 90� or 270�
                        //break;
                    case start_level_max:
                        phi = (FlipPhase) ? M_PI : 0.0; // 180� or 0�
                        break;
                    case start_level_min:
                        phi = (FlipPhase) ? 0.0 : M_PI; // 0� or 180�
                        break;
                }
                real1 = real2 = cos(phi);
                imag1 = imag2 = sin(phi);
            }
            
            /**
             * 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 /= 360.0f;
                
                // FIXME: too heavy?
                float steps = 1.0f / (c1 / (2.0f * M_PI)); // number of steps for one cycle
                steps *= phase + 0.25f;
                for (int i = 0; i < steps; i++) render();
            }
            
            void setFrequency(float Frequency, unsigned int SampleRate) {
                this->Frequency = Frequency;
                const float freq = Frequency * this->ScriptFrequencyFactor;
                c1 = 2.0f * M_PI * freq / (float) SampleRate;
                c2 = 2.0f * M_PI * freq / (float) SampleRate * 3.0f;
            }

            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 c1;
            float c2;
            float real1;
            float imag1;
            float real2;
            float imag2;
            float normalizer;
            float offset;
    };

} // namespace LinuxSampler

#endif // __LS_LFOTRIANGLEDIHARMONIC_H__
1	schoenebeck	717	/***************************************************************************
2			* *
3	schoenebeck	3561	* Copyright (C) 2005 - 2019 Christian Schoenebeck *
4	schoenebeck	717	* *
5			* This library is free software; you can redistribute it and/or modify *
6			* it under the terms of the GNU General Public License as published by *
7			* the Free Software Foundation; either version 2 of the License, or *
8			* (at your option) any later version. *
9			* *
10			* This library is distributed in the hope that it will be useful, *
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of *
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13			* GNU General Public License for more details. *
14			* *
15			* You should have received a copy of the GNU General Public License *
16			* along with this library; if not, write to the Free Software *
17			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
18			* MA 02111-1307 USA *
19			***************************************************************************/
20
21			#ifndef __LS_LFOTRIANGLEDIHARMONIC_H__
22			#define __LS_LFOTRIANGLEDIHARMONIC_H__
23
24			#include "LFOBase.h"
25
26			// amplitue of 2nd harmonic (to approximate the triangular wave)
27	schoenebeck	1681	#define AMP2 -0.11425509f
28	schoenebeck	717
29			namespace LinuxSampler {
30
31			/** @brief Triangle LFO (di-harmonic implementation)
32			*
33			* This is a triangle Low Frequency Oscillator implementation which uses
34			* a di-harmonic solution. This means it sums up two harmonics
35			* (sinusoids) to approximate a triangular wave.
36			*/
37			template<range_type_t RANGE>
38			class LFOTriangleDiHarmonic : public LFOBase<RANGE> {
39			public:
40
41			/**
42			* Constructor
43			*
44			* @param Max - maximum value of the output levels
45			*/
46			LFOTriangleDiHarmonic(float Max) : LFOBase<RANGE>::LFOBase(Max) {
47			}
48
49			/**
50			* Calculates exactly one sample point of the LFO wave.
51			*
52			* @returns next LFO level
53			*/
54			inline float render() {
55			real1 -= c1 * imag1;
56			imag1 += c1 * real1;
57			real2 -= c2 * imag2;
58			imag2 += c2 * real2;
59			if (RANGE == range_unsigned)
60	schoenebeck	721	return (real1 + real2 * AMP2) * normalizer + offset;
61	schoenebeck	717	else /* signed range */
62			return (real1 + real2 * AMP2) * normalizer;
63			}
64
65			/**
66			* Update LFO depth with a new external controller value.
67			*
68			* @param ExtControlValue - new external controller value
69			*/
70	schoenebeck	3118	inline void updateByMIDICtrlValue(const uint16_t& ExtControlValue) {
71			this->ExtControlValue = ExtControlValue;
72
73			const float max = (this->InternalDepth + ExtControlValue * this->ExtControlDepthCoeff) * this->ScriptDepthFactor;
74	schoenebeck	721	if (RANGE == range_unsigned) {
75	schoenebeck	1681	const float harmonicCompensation = 1.0f + fabsf(AMP2); // to compensate the compensation ;) (see trigger())
76	schoenebeck	717	normalizer = max * 0.5f;
77	schoenebeck	721	offset = normalizer * harmonicCompensation;
78			} else { // signed range
79	schoenebeck	717	normalizer = max;
80	schoenebeck	721	}
81	schoenebeck	717	}
82
83			/**
84			* Will be called by the voice when the key / voice was triggered.
85			*
86			* @param Frequency - frequency of the oscillator in Hz
87			* @param StartLevel - on which level the wave should start
88			* @param InternalDepth - firm, internal oscillator amplitude
89			* @param ExtControlDepth - defines how strong the external MIDI
90			* controller has influence on the
91			* oscillator amplitude
92	schoenebeck	721	* @param FlipPhase - inverts the oscillator wave against
93			* a horizontal axis
94	schoenebeck	717	* @param SampleRate - current sample rate of the engines
95			* audio output signal
96			*/
97			void trigger(float Frequency, start_level_t StartLevel, uint16_t InternalDepth, uint16_t ExtControlDepth, bool FlipPhase, unsigned int SampleRate) {
98	schoenebeck	3118	this->Frequency = Frequency;
99			this->ScriptFrequencyFactor = this->ScriptDepthFactor = 1.f; // reset for new voice
100	schoenebeck	1681	const float harmonicCompensation = 1.0f + fabsf(AMP2); // to compensate the 2nd harmonic's amplitude overhead
101			this->InternalDepth = (InternalDepth / 1200.0f) * this->Max / harmonicCompensation;
102	schoenebeck	721	this->ExtControlDepthCoeff = (((float) ExtControlDepth / 1200.0f) / 127.0f) * this->Max / harmonicCompensation;
103	schoenebeck	3561	this->pFinalDepth = NULL;
104			this->pFinalFrequency = NULL;
105	schoenebeck	717
106	schoenebeck	3118	const float freq = Frequency * this->ScriptFrequencyFactor;
107			c1 = 2.0f * M_PI * freq / (float) SampleRate;
108			c2 = 2.0f * M_PI * freq / (float) SampleRate * 3.0f;
109	schoenebeck	717
110	schoenebeck	721	double phi; // phase displacement
111	schoenebeck	717	switch (StartLevel) {
112	schoenebeck	721	case start_level_mid:
113			//FIXME: direct jumping to 90� and 270� doesn't work out due to numeric accuracy problems (causes wave deformation)
114			//phi = (FlipPhase) ? 0.5 * M_PI : 1.5 * M_PI; // 90� or 270�
115			//break;
116	schoenebeck	717	case start_level_max:
117	schoenebeck	721	phi = (FlipPhase) ? M_PI : 0.0; // 180� or 0�
118	schoenebeck	717	break;
119			case start_level_min:
120	schoenebeck	721	phi = (FlipPhase) ? 0.0 : M_PI; // 0� or 180�
121	schoenebeck	717	break;
122			}
123			real1 = real2 = cos(phi);
124			imag1 = imag2 = sin(phi);
125			}
126	iliev	2225
127			/**
128			* Should be invoked after the LFO is triggered with StartLevel
129			* start_level_min.
130			* @param phase From 0 to 360 degrees.
131			*/
132			void setPhase(float phase) {
133			if (phase < 0) phase = 0;
134			if (phase > 360) phase = 360;
135			phase /= 360.0f;
136
137			// FIXME: too heavy?
138			float steps = 1.0f / (c1 / (2.0f * M_PI)); // number of steps for one cycle
139			steps *= phase + 0.25f;
140			for (int i = 0; i < steps; i++) render();
141			}
142	iliev	2227
143			void setFrequency(float Frequency, unsigned int SampleRate) {
144	schoenebeck	3118	this->Frequency = Frequency;
145			const float freq = Frequency * this->ScriptFrequencyFactor;
146			c1 = 2.0f * M_PI * freq / (float) SampleRate;
147			c2 = 2.0f * M_PI * freq / (float) SampleRate * 3.0f;
148	iliev	2227	}
149	schoenebeck	717
150	schoenebeck	3561	void setScriptDepthFactor(float factor, bool isFinal) {
151	schoenebeck	3118	this->ScriptDepthFactor = factor;
152	schoenebeck	3561	// set or reset this script depth parameter to be the sole
153			// source for the LFO depth
154			if (isFinal && !this->pFinalDepth)
155			this->pFinalDepth = &this->ScriptDepthFactor;
156			else if (!isFinal && this->pFinalDepth == &this->ScriptDepthFactor)
157			this->pFinalDepth = NULL;
158			// recalculate upon new depth
159	schoenebeck	3118	updateByMIDICtrlValue(this->ExtControlValue);
160			}
161
162			void setScriptFrequencyFactor(float factor, unsigned int SampleRate) {
163			this->ScriptFrequencyFactor = factor;
164	schoenebeck	3561	// in case script frequency was set as "final" value before,
165			// reset it so that all sources are processed from now on
166			if (this->pFinalFrequency == &this->ScriptFrequencyFactor)
167			this->pFinalFrequency = NULL;
168			// recalculate upon new frequency
169	schoenebeck	3118	setFrequency(this->Frequency, SampleRate);
170			}
171
172	schoenebeck	3561	void setScriptFrequencyFinal(float hz, unsigned int SampleRate) {
173			this->ScriptFrequencyFactor = hz;
174			// assign script's given frequency as sole source for the LFO
175			// frequency, thus ignore all other sources
176			if (!this->pFinalFrequency)
177			this->pFinalFrequency = &this->ScriptFrequencyFactor;
178			// recalculate upon new frequency
179			setFrequency(this->Frequency, SampleRate);
180			}
181
182	schoenebeck	717	private:
183			float c1;
184			float c2;
185			float real1;
186			float imag1;
187			float real2;
188			float imag2;
189			float normalizer;
190	schoenebeck	721	float offset;
191	schoenebeck	717	};
192
193			} // namespace LinuxSampler
194
195			#endif // __LS_LFOTRIANGLEDIHARMONIC_H__