engines/gig/Voice.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005, 2006 Christian Schoenebeck                        *
 *                                                                         *
 *   This program 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 program 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 program; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#ifndef __LS_GIG_VOICE_H__
#define __LS_GIG_VOICE_H__

#include "../../common/global.h"

#include <gig.h>

#include "../../common/RTMath.h"
#include "../../common/RingBuffer.h"
#include "../../common/Pool.h"
#include "../../drivers/audio/AudioOutputDevice.h"
#include "../common/BiquadFilter.h"
#include "Engine.h"
#include "EngineChannel.h"
#include "Stream.h"
#include "DiskThread.h"
#include "EGADSR.h"
#include "EGDecay.h"
#include "Filter.h"
#include "../common/LFOBase.h"
#include "SynthesisParam.h"

// include the appropriate (unsigned) triangle LFO implementation
#if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
# include "../common/LFOTriangleIntMath.h"
#elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
# include "../common/LFOTriangleIntAbsMath.h"
#elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
# include "../common/LFOTriangleDiHarmonic.h"
#else
# error "Unknown or no (unsigned) triangle LFO implementation selected!"
#endif

// include the appropriate (signed) triangle LFO implementation
#if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
# include "../common/LFOTriangleIntMath.h"
#elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
# include "../common/LFOTriangleIntAbsMath.h"
#elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
# include "../common/LFOTriangleDiHarmonic.h"
#else
# error "Unknown or no (signed) triangle LFO implementation selected!"
#endif

namespace LinuxSampler { namespace gig {

    class Engine;

    /// Reflects a MIDI controller
    struct midi_ctrl {
        uint8_t controller; ///< MIDI control change controller number
        uint8_t value;      ///< Current MIDI controller value
        float   fvalue;     ///< Transformed / effective value (e.g. volume level or filter cutoff frequency)
    };

    #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
    typedef LFOTriangleIntMath<range_unsigned> LFOUnsigned;
    #elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
    typedef LFOTriangleIntAbsMath<range_unsigned> LFOUnsigned;
    #elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
    typedef LFOTriangleDiHarmonic<range_unsigned> LFOUnsigned;
    #endif

    #if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
    typedef LFOTriangleIntMath<range_signed> LFOSigned;
    #elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
    typedef LFOTriangleIntAbsMath<range_signed> LFOSigned;
    #elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
    typedef LFOTriangleDiHarmonic<range_signed> LFOSigned;
    #endif

    /** Gig Voice
     *
     * Renders a voice for the Gigasampler format.
     */
    class Voice {
        public:
            // Types
            enum type_t {
                type_normal,
                type_release_trigger_required,  ///< If the key of this voice will be released, it causes a release triggered voice to be spawned
                type_release_trigger            ///< Release triggered voice which cannot be killed by releasing its key
            };
            
            // Attributes
            type_t       Type;         ///< Voice Type
            int          MIDIKey;      ///< MIDI key number of the key that triggered the voice
            uint         KeyGroup;
            DiskThread*  pDiskThread;  ///< Pointer to the disk thread, to be able to order a disk stream and later to delete the stream again

            // Methods
            Voice();
            virtual ~Voice();
            void Kill(Pool<Event>::Iterator& itKillEvent);
            void Render(uint Samples);
            void Reset();
            void SetOutput(AudioOutputDevice* pAudioOutputDevice);
            void SetEngine(Engine* pEngine);
            int  Trigger(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int PitchBend, ::gig::DimensionRegion* pDimRgn, type_t VoiceType, int iKeyGroup);
            inline bool IsActive() { return PlaybackState; }
            inline bool IsStealable() { return !itKillEvent && PlaybackState >= playback_state_ram; }
            void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);

        //private:
            // Types
            enum playback_state_t {
                playback_state_end  = 0,
                playback_state_init = 1,
                playback_state_ram  = 2,
                playback_state_disk = 3
            };

            // Attributes
            EngineChannel*              pEngineChannel;
            Engine*                     pEngine;            ///< Pointer to the sampler engine, to be able to access the event lists.
            float                       Volume;             ///< Volume level of the voice
            float                       PanLeft;
            float                       PanRight;
            float                       CrossfadeVolume;    ///< Current attenuation level caused by a crossfade (only if a crossfade is defined of course)
            double                      Pos;                ///< Current playback position in sample
            float                       PitchBase;          ///< Basic pitch depth, stays the same for the whole life time of the voice
            float                       PitchBend;          ///< Current pitch value of the pitchbend wheel
            float                       CutoffBase;         ///< Cutoff frequency before control change, EG and LFO are applied
            ::gig::Sample*              pSample;            ///< Pointer to the sample to be played back
            ::gig::DimensionRegion*     pDimRgn;            ///< Pointer to the articulation information of current dimension region of this voice
            playback_state_t            PlaybackState;      ///< When a sample will be triggered, it will be first played from RAM cache and after a couple of sample points it will switch to disk streaming and at the end of a disk stream we have to add null samples, so the interpolator can do it's work correctly
            bool                        DiskVoice;          ///< If the sample is very short it completely fits into the RAM cache and doesn't need to be streamed from disk, in that case this flag is set to false
            Stream::reference_t         DiskStreamRef;      ///< Reference / link to the disk stream
            int                         RealSampleWordsLeftToRead; ///< Number of samples left to read, not including the silence added for the interpolator
            unsigned long               MaxRAMPos;          ///< The upper allowed limit (not actually the end) in the RAM sample cache, after that point it's not safe to chase the interpolator another time over over the current cache position, instead we switch to disk then.
            bool                        RAMLoop;            ///< If this voice has a loop defined which completely fits into the cached RAM part of the sample, in this case we handle the looping within the voice class, else if the loop is located in the disk stream part, we let the disk stream handle the looping
            //uint                        LoopCyclesLeft;     ///< In case there is a RAMLoop and it's not an endless loop; reflects number of loop cycles left to be passed
            uint                        Delay;              ///< Number of sample points the rendering process of this voice should be delayed (jitter correction), will be set to 0 after the first audio fragment cycle
            EGADSR                      EG1;                ///< Envelope Generator 1 (Amplification)
            EGADSR                      EG2;                ///< Envelope Generator 2 (Filter cutoff frequency)
            EGDecay                     EG3;                ///< Envelope Generator 3 (Pitch)
            midi_ctrl                   VCFCutoffCtrl;
            midi_ctrl                   VCFResonanceCtrl;
            static const float          FILTER_CUTOFF_COEFF;
            LFOUnsigned*                pLFO1;               ///< Low Frequency Oscillator 1 (Amplification)
            LFOUnsigned*                pLFO2;               ///< Low Frequency Oscillator 2 (Filter cutoff frequency)
            LFOSigned*                  pLFO3;               ///< Low Frequency Oscillator 3 (Pitch)
            bool                        bLFO1Enabled;        ///< Should we use the Amplitude LFO for this voice?
            bool                        bLFO2Enabled;        ///< Should we use the Filter Cutoff LFO for this voice?
            bool                        bLFO3Enabled;        ///< Should we use the Pitch LFO for this voice?
            Pool<Event>::Iterator       itTriggerEvent;      ///< First event on the key's list the voice should process (only needed for the first audio fragment in which voice was triggered, after that it will be set to NULL).
        //public: // FIXME: just made public for debugging (sanity check in Engine::RenderAudio()), should be changed to private before the final release
            Pool<Event>::Iterator       itKillEvent;         ///< Event which caused this voice to be killed
        //private:
            int                         SynthesisMode;
            float                       fFinalVolume;
            float                       fFinalCutoff;
            float                       fFinalResonance;
            SynthesisParam              finalSynthesisParameters;
            Loop                        loop;

            // Static Methods
            static float CalculateFilterCutoffCoeff();

            // Methods
            void KillImmediately();
            void ProcessEvents(uint Samples);
            void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
            void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);
            void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);
            void processPitchEvent(RTList<Event>::Iterator& itEvent);
            void processCrossFadeEvent(RTList<Event>::Iterator& itEvent);
            void processCutoffEvent(RTList<Event>::Iterator& itEvent);
            void processResonanceEvent(RTList<Event>::Iterator& itEvent);

            inline float CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) {
                float att = (!pDimRgn->Crossfade.out_end) ? CrossfadeControllerValue / 127.0f /* 0,0,0,0 means no crossfade defined */
                          : (CrossfadeControllerValue < pDimRgn->Crossfade.in_end) ?
                                ((CrossfadeControllerValue <= pDimRgn->Crossfade.in_start) ? 0.0f
                                : float(CrossfadeControllerValue - pDimRgn->Crossfade.in_start) / float(pDimRgn->Crossfade.in_end - pDimRgn->Crossfade.in_start))
                          : (CrossfadeControllerValue <= pDimRgn->Crossfade.out_start) ? 1.0f
                          : (CrossfadeControllerValue < pDimRgn->Crossfade.out_end) ? float(pDimRgn->Crossfade.out_end - CrossfadeControllerValue) / float(pDimRgn->Crossfade.out_end - pDimRgn->Crossfade.out_start)
                          : 0.0f;
                return pDimRgn->InvertAttenuationController ? 1 - att : att;
            }

            inline float Constrain(float ValueToCheck, float Min, float Max) {
                if      (ValueToCheck > Max) ValueToCheck = Max;
                else if (ValueToCheck < Min) ValueToCheck = Min;
                return ValueToCheck;
            }
    };

}} // namespace LinuxSampler::gig

#endif // __LS_GIG_VOICE_H__
1	/***************************************************************************
2	* *
3	* LinuxSampler - modular, streaming capable sampler *
4	* *
5	* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6	* Copyright (C) 2005, 2006 Christian Schoenebeck *
7	* *
8	* This program is free software; you can redistribute it and/or modify *
9	* it under the terms of the GNU General Public License as published by *
10	* the Free Software Foundation; either version 2 of the License, or *
11	* (at your option) any later version. *
12	* *
13	* This program is distributed in the hope that it will be useful, *
14	* but WITHOUT ANY WARRANTY; without even the implied warranty of *
15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16	* GNU General Public License for more details. *
17	* *
18	* You should have received a copy of the GNU General Public License *
19	* along with this program; if not, write to the Free Software *
20	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21	* MA 02111-1307 USA *
22	***************************************************************************/
23
24	#ifndef __LS_GIG_VOICE_H__
25	#define __LS_GIG_VOICE_H__
26
27	#include "../../common/global.h"
28
29	#include <gig.h>
30
31	#include "../../common/RTMath.h"
32	#include "../../common/RingBuffer.h"
33	#include "../../common/Pool.h"
34	#include "../../drivers/audio/AudioOutputDevice.h"
35	#include "../common/BiquadFilter.h"
36	#include "Engine.h"
37	#include "EngineChannel.h"
38	#include "Stream.h"
39	#include "DiskThread.h"
40	#include "EGADSR.h"
41	#include "EGDecay.h"
42	#include "Filter.h"
43	#include "../common/LFOBase.h"
44	#include "SynthesisParam.h"
45
46	// include the appropriate (unsigned) triangle LFO implementation
47	#if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
48	# include "../common/LFOTriangleIntMath.h"
49	#elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
50	# include "../common/LFOTriangleIntAbsMath.h"
51	#elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
52	# include "../common/LFOTriangleDiHarmonic.h"
53	#else
54	# error "Unknown or no (unsigned) triangle LFO implementation selected!"
55	#endif
56
57	// include the appropriate (signed) triangle LFO implementation
58	#if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
59	# include "../common/LFOTriangleIntMath.h"
60	#elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
61	# include "../common/LFOTriangleIntAbsMath.h"
62	#elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
63	# include "../common/LFOTriangleDiHarmonic.h"
64	#else
65	# error "Unknown or no (signed) triangle LFO implementation selected!"
66	#endif
67
68	namespace LinuxSampler { namespace gig {
69
70	class Engine;
71
72	/// Reflects a MIDI controller
73	struct midi_ctrl {
74	uint8_t controller; ///< MIDI control change controller number
75	uint8_t value; ///< Current MIDI controller value
76	float fvalue; ///< Transformed / effective value (e.g. volume level or filter cutoff frequency)
77	};
78
79	#if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
80	typedef LFOTriangleIntMath<range_unsigned> LFOUnsigned;
81	#elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
82	typedef LFOTriangleIntAbsMath<range_unsigned> LFOUnsigned;
83	#elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
84	typedef LFOTriangleDiHarmonic<range_unsigned> LFOUnsigned;
85	#endif
86
87	#if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
88	typedef LFOTriangleIntMath<range_signed> LFOSigned;
89	#elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
90	typedef LFOTriangleIntAbsMath<range_signed> LFOSigned;
91	#elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
92	typedef LFOTriangleDiHarmonic<range_signed> LFOSigned;
93	#endif
94
95	/** Gig Voice
96	*
97	* Renders a voice for the Gigasampler format.
98	*/
99	class Voice {
100	public:
101	// Types
102	enum type_t {
103	type_normal,
104	type_release_trigger_required, ///< If the key of this voice will be released, it causes a release triggered voice to be spawned
105	type_release_trigger ///< Release triggered voice which cannot be killed by releasing its key
106	};
107
108	// Attributes
109	type_t Type; ///< Voice Type
110	int MIDIKey; ///< MIDI key number of the key that triggered the voice
111	uint KeyGroup;
112	DiskThread* pDiskThread; ///< Pointer to the disk thread, to be able to order a disk stream and later to delete the stream again
113
114	// Methods
115	Voice();
116	virtual ~Voice();
117	void Kill(Pool<Event>::Iterator& itKillEvent);
118	void Render(uint Samples);
119	void Reset();
120	void SetOutput(AudioOutputDevice* pAudioOutputDevice);
121	void SetEngine(Engine* pEngine);
122	int Trigger(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int PitchBend, ::gig::DimensionRegion* pDimRgn, type_t VoiceType, int iKeyGroup);
123	inline bool IsActive() { return PlaybackState; }
124	inline bool IsStealable() { return !itKillEvent && PlaybackState >= playback_state_ram; }
125	void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);
126
127	//private:
128	// Types
129	enum playback_state_t {
130	playback_state_end = 0,
131	playback_state_init = 1,
132	playback_state_ram = 2,
133	playback_state_disk = 3
134	};
135
136	// Attributes
137	EngineChannel* pEngineChannel;
138	Engine* pEngine; ///< Pointer to the sampler engine, to be able to access the event lists.
139	float Volume; ///< Volume level of the voice
140	float PanLeft;
141	float PanRight;
142	float CrossfadeVolume; ///< Current attenuation level caused by a crossfade (only if a crossfade is defined of course)
143	double Pos; ///< Current playback position in sample
144	float PitchBase; ///< Basic pitch depth, stays the same for the whole life time of the voice
145	float PitchBend; ///< Current pitch value of the pitchbend wheel
146	float CutoffBase; ///< Cutoff frequency before control change, EG and LFO are applied
147	::gig::Sample* pSample; ///< Pointer to the sample to be played back
148	::gig::DimensionRegion* pDimRgn; ///< Pointer to the articulation information of current dimension region of this voice
149	playback_state_t PlaybackState; ///< When a sample will be triggered, it will be first played from RAM cache and after a couple of sample points it will switch to disk streaming and at the end of a disk stream we have to add null samples, so the interpolator can do it's work correctly
150	bool DiskVoice; ///< If the sample is very short it completely fits into the RAM cache and doesn't need to be streamed from disk, in that case this flag is set to false
151	Stream::reference_t DiskStreamRef; ///< Reference / link to the disk stream
152	int RealSampleWordsLeftToRead; ///< Number of samples left to read, not including the silence added for the interpolator
153	unsigned long MaxRAMPos; ///< The upper allowed limit (not actually the end) in the RAM sample cache, after that point it's not safe to chase the interpolator another time over over the current cache position, instead we switch to disk then.
154	bool RAMLoop; ///< If this voice has a loop defined which completely fits into the cached RAM part of the sample, in this case we handle the looping within the voice class, else if the loop is located in the disk stream part, we let the disk stream handle the looping
155	//uint LoopCyclesLeft; ///< In case there is a RAMLoop and it's not an endless loop; reflects number of loop cycles left to be passed
156	uint Delay; ///< Number of sample points the rendering process of this voice should be delayed (jitter correction), will be set to 0 after the first audio fragment cycle
157	EGADSR EG1; ///< Envelope Generator 1 (Amplification)
158	EGADSR EG2; ///< Envelope Generator 2 (Filter cutoff frequency)
159	EGDecay EG3; ///< Envelope Generator 3 (Pitch)
160	midi_ctrl VCFCutoffCtrl;
161	midi_ctrl VCFResonanceCtrl;
162	static const float FILTER_CUTOFF_COEFF;
163	LFOUnsigned* pLFO1; ///< Low Frequency Oscillator 1 (Amplification)
164	LFOUnsigned* pLFO2; ///< Low Frequency Oscillator 2 (Filter cutoff frequency)
165	LFOSigned* pLFO3; ///< Low Frequency Oscillator 3 (Pitch)
166	bool bLFO1Enabled; ///< Should we use the Amplitude LFO for this voice?
167	bool bLFO2Enabled; ///< Should we use the Filter Cutoff LFO for this voice?
168	bool bLFO3Enabled; ///< Should we use the Pitch LFO for this voice?
169	Pool<Event>::Iterator itTriggerEvent; ///< First event on the key's list the voice should process (only needed for the first audio fragment in which voice was triggered, after that it will be set to NULL).
170	//public: // FIXME: just made public for debugging (sanity check in Engine::RenderAudio()), should be changed to private before the final release
171	Pool<Event>::Iterator itKillEvent; ///< Event which caused this voice to be killed
172	//private:
173	int SynthesisMode;
174	float fFinalVolume;
175	float fFinalCutoff;
176	float fFinalResonance;
177	SynthesisParam finalSynthesisParameters;
178	Loop loop;
179
180	// Static Methods
181	static float CalculateFilterCutoffCoeff();
182
183	// Methods
184	void KillImmediately();
185	void ProcessEvents(uint Samples);
186	void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
187	void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);
188	void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);
189	void processPitchEvent(RTList<Event>::Iterator& itEvent);
190	void processCrossFadeEvent(RTList<Event>::Iterator& itEvent);
191	void processCutoffEvent(RTList<Event>::Iterator& itEvent);
192	void processResonanceEvent(RTList<Event>::Iterator& itEvent);
193
194	inline float CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) {
195	float att = (!pDimRgn->Crossfade.out_end) ? CrossfadeControllerValue / 127.0f /* 0,0,0,0 means no crossfade defined */
196	: (CrossfadeControllerValue < pDimRgn->Crossfade.in_end) ?
197	((CrossfadeControllerValue <= pDimRgn->Crossfade.in_start) ? 0.0f
198	: float(CrossfadeControllerValue - pDimRgn->Crossfade.in_start) / float(pDimRgn->Crossfade.in_end - pDimRgn->Crossfade.in_start))
199	: (CrossfadeControllerValue <= pDimRgn->Crossfade.out_start) ? 1.0f
200	: (CrossfadeControllerValue < pDimRgn->Crossfade.out_end) ? float(pDimRgn->Crossfade.out_end - CrossfadeControllerValue) / float(pDimRgn->Crossfade.out_end - pDimRgn->Crossfade.out_start)
201	: 0.0f;
202	return pDimRgn->InvertAttenuationController ? 1 - att : att;
203	}
204
205	inline float Constrain(float ValueToCheck, float Min, float Max) {
206	if (ValueToCheck > Max) ValueToCheck = Max;
207	else if (ValueToCheck < Min) ValueToCheck = Min;
208	return ValueToCheck;
209	}
210	};
211
212	}} // namespace LinuxSampler::gig
213
214	#endif // __LS_GIG_VOICE_H__