engines/gig/Voice.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005 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 "EngineGlobals.h"
#include "Engine.h"
#include "EngineChannel.h"
#include "Stream.h"
#include "DiskThread.h"

#include "EGDecay.h"
#include "Filter.h"
#include "../common/LFO.h"

namespace LinuxSampler { namespace gig {

    class Engine;
    class EGADSR;
    class EGDecay;
    class VCAManipulator;
    class VCFCManipulator;
    class VCOManipulator;

    /// 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)
    };

    /** 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::Instrument* pInstrument, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealingAllowed);
            inline bool IsActive() { return PlaybackState; }
        //private:
            // Types
            enum playback_state_t {
                playback_state_end  = 0,
                playback_state_ram  = 1,
                playback_state_disk = 2
            };

            // 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
            ::gig::Sample*              pSample;            ///< Pointer to the sample to be played back
            ::gig::Region*              pRegion;            ///< Pointer to the articulation information of the respective keyboard region of this voice
            ::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*                     pEG1;               ///< Envelope Generator 1 (Amplification)
            EGADSR*                     pEG2;               ///< Envelope Generator 2 (Filter cutoff frequency)
            EGDecay*                    pEG3;               ///< Envelope Generator 3 (Pitch)
            Filter                      FilterLeft;
            Filter                      FilterRight;
            midi_ctrl                   VCFCutoffCtrl;
            midi_ctrl                   VCFResonanceCtrl;
            int                         FilterUpdateCounter; ///< Used to update filter parameters all FILTER_UPDATE_PERIOD samples
            static const float          FILTER_CUTOFF_COEFF;
            static const int            FILTER_UPDATE_MASK;
            VCAManipulator*             pVCAManipulator;
            VCFCManipulator*            pVCFCManipulator;
            VCOManipulator*             pVCOManipulator;
            LFO<gig::VCAManipulator>*   pLFO1;              ///< Low Frequency Oscillator 1 (Amplification)
            LFO<gig::VCFCManipulator>*  pLFO2;             ///< Low Frequency Oscillator 2 (Filter cutoff frequency)
            LFO<gig::VCOManipulator>*   pLFO3;              ///< Low Frequency Oscillator 3 (Pitch)
            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;

            // Static Methods
            static float CalculateFilterCutoffCoeff();
            static int   CalculateFilterUpdateMask();

            // Methods
            void KillImmediately();
            void ProcessEvents(uint Samples);
            void CalculateBiquadParameters(uint Samples);
            void Synthesize(uint Samples, sample_t* pSrc, uint Skip);

            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	schoenebeck	53	/***************************************************************************
2			* *
3			* LinuxSampler - modular, streaming capable sampler *
4			* *
5	schoenebeck	56	* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6	schoenebeck	411	* Copyright (C) 2005 Christian Schoenebeck *
7	schoenebeck	53	* *
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	schoenebeck	505	#include <gig.h>
30
31	schoenebeck	53	#include "../../common/RTMath.h"
32			#include "../../common/RingBuffer.h"
33	schoenebeck	273	#include "../../common/Pool.h"
34	schoenebeck	203	#include "../../drivers/audio/AudioOutputDevice.h"
35	schoenebeck	80	#include "../common/BiquadFilter.h"
36	schoenebeck	411	//#include "EngineGlobals.h"
37	schoenebeck	53	#include "Engine.h"
38	schoenebeck	411	#include "EngineChannel.h"
39	schoenebeck	53	#include "Stream.h"
40			#include "DiskThread.h"
41
42			#include "EGDecay.h"
43			#include "Filter.h"
44			#include "../common/LFO.h"
45
46			namespace LinuxSampler { namespace gig {
47
48			class Engine;
49			class EGADSR;
50	schoenebeck	411	class EGDecay;
51	schoenebeck	53	class VCAManipulator;
52			class VCFCManipulator;
53			class VCOManipulator;
54
55			/// Reflects a MIDI controller
56			struct midi_ctrl {
57			uint8_t controller; ///< MIDI control change controller number
58			uint8_t value; ///< Current MIDI controller value
59			float fvalue; ///< Transformed / effective value (e.g. volume level or filter cutoff frequency)
60			};
61
62			/** Gig Voice
63			*
64			* Renders a voice for the Gigasampler format.
65			*/
66			class Voice {
67			public:
68	schoenebeck	242	// Types
69			enum type_t {
70			type_normal,
71			type_release_trigger_required, ///< If the key of this voice will be released, it causes a release triggered voice to be spawned
72			type_release_trigger ///< Release triggered voice which cannot be killed by releasing its key
73			};
74
75	schoenebeck	53	// Attributes
76	schoenebeck	242	type_t Type; ///< Voice Type
77	schoenebeck	53	int MIDIKey; ///< MIDI key number of the key that triggered the voice
78	schoenebeck	239	uint KeyGroup;
79	schoenebeck	53	DiskThread* pDiskThread; ///< Pointer to the disk thread, to be able to order a disk stream and later to delete the stream again
80
81			// Methods
82			Voice();
83	letz	502	virtual ~Voice();
84	schoenebeck	271	void Kill(Pool<Event>::Iterator& itKillEvent);
85	schoenebeck	53	void Render(uint Samples);
86			void Reset();
87			void SetOutput(AudioOutputDevice* pAudioOutputDevice);
88			void SetEngine(Engine* pEngine);
89	schoenebeck	460	int Trigger(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int PitchBend, ::gig::Instrument* pInstrument, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealingAllowed);
90	schoenebeck	285	inline bool IsActive() { return PlaybackState; }
91	schoenebeck	319	//private:
92	schoenebeck	53	// Types
93			enum playback_state_t {
94	schoenebeck	285	playback_state_end = 0,
95			playback_state_ram = 1,
96			playback_state_disk = 2
97	schoenebeck	53	};
98
99			// Attributes
100	schoenebeck	411	EngineChannel* pEngineChannel;
101			Engine* pEngine; ///< Pointer to the sampler engine, to be able to access the event lists.
102	schoenebeck	53	float Volume; ///< Volume level of the voice
103	schoenebeck	245	float PanLeft;
104			float PanRight;
105	schoenebeck	236	float CrossfadeVolume; ///< Current attenuation level caused by a crossfade (only if a crossfade is defined of course)
106	schoenebeck	53	double Pos; ///< Current playback position in sample
107	schoenebeck	319	float PitchBase; ///< Basic pitch depth, stays the same for the whole life time of the voice
108			float PitchBend; ///< Current pitch value of the pitchbend wheel
109	schoenebeck	53	::gig::Sample* pSample; ///< Pointer to the sample to be played back
110			::gig::Region* pRegion; ///< Pointer to the articulation information of the respective keyboard region of this voice
111	schoenebeck	236	::gig::DimensionRegion* pDimRgn; ///< Pointer to the articulation information of current dimension region of this voice
112	schoenebeck	53	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
113			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
114			Stream::reference_t DiskStreamRef; ///< Reference / link to the disk stream
115	schoenebeck	330	int RealSampleWordsLeftToRead; ///< Number of samples left to read, not including the silence added for the interpolator
116	schoenebeck	53	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.
117			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
118	schoenebeck	319	uint LoopCyclesLeft; ///< In case there is a RAMLoop and it's not an endless loop; reflects number of loop cycles left to be passed
119	schoenebeck	53	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
120			EGADSR* pEG1; ///< Envelope Generator 1 (Amplification)
121			EGADSR* pEG2; ///< Envelope Generator 2 (Filter cutoff frequency)
122			EGDecay* pEG3; ///< Envelope Generator 3 (Pitch)
123			Filter FilterLeft;
124			Filter FilterRight;
125			midi_ctrl VCFCutoffCtrl;
126			midi_ctrl VCFResonanceCtrl;
127			int FilterUpdateCounter; ///< Used to update filter parameters all FILTER_UPDATE_PERIOD samples
128			static const float FILTER_CUTOFF_COEFF;
129	schoenebeck	80	static const int FILTER_UPDATE_MASK;
130	schoenebeck	53	VCAManipulator* pVCAManipulator;
131			VCFCManipulator* pVCFCManipulator;
132			VCOManipulator* pVCOManipulator;
133			LFO<gig::VCAManipulator>* pLFO1; ///< Low Frequency Oscillator 1 (Amplification)
134			LFO<gig::VCFCManipulator>* pLFO2; ///< Low Frequency Oscillator 2 (Filter cutoff frequency)
135			LFO<gig::VCOManipulator>* pLFO3; ///< Low Frequency Oscillator 3 (Pitch)
136	schoenebeck	271	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).
137	schoenebeck	319	//public: // FIXME: just made public for debugging (sanity check in Engine::RenderAudio()), should be changed to private before the final release
138	schoenebeck	271	Pool<Event>::Iterator itKillEvent; ///< Event which caused this voice to be killed
139	schoenebeck	319	//private:
140			int SynthesisMode;
141	schoenebeck	53
142			// Static Methods
143			static float CalculateFilterCutoffCoeff();
144	schoenebeck	80	static int CalculateFilterUpdateMask();
145	schoenebeck	53
146			// Methods
147	schoenebeck	319	void KillImmediately();
148			void ProcessEvents(uint Samples);
149			void CalculateBiquadParameters(uint Samples);
150	senkov	325	void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
151	schoenebeck	245
152	schoenebeck	236	inline float CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) {
153	schoenebeck	348	float att = (!pDimRgn->Crossfade.out_end) ? CrossfadeControllerValue / 127.0f /* 0,0,0,0 means no crossfade defined */
154			: (CrossfadeControllerValue < pDimRgn->Crossfade.in_end) ?
155			((CrossfadeControllerValue <= pDimRgn->Crossfade.in_start) ? 0.0f
156			: float(CrossfadeControllerValue - pDimRgn->Crossfade.in_start) / float(pDimRgn->Crossfade.in_end - pDimRgn->Crossfade.in_start))
157			: (CrossfadeControllerValue <= pDimRgn->Crossfade.out_start) ? 1.0f
158			: (CrossfadeControllerValue < pDimRgn->Crossfade.out_end) ? float(pDimRgn->Crossfade.out_end - CrossfadeControllerValue) / float(pDimRgn->Crossfade.out_end - pDimRgn->Crossfade.out_start)
159			: 0.0f;
160			return pDimRgn->InvertAttenuationController ? 1 - att : att;
161	schoenebeck	236	}
162
163	schoenebeck	53	inline float Constrain(float ValueToCheck, float Min, float Max) {
164			if (ValueToCheck > Max) ValueToCheck = Max;
165			else if (ValueToCheck < Min) ValueToCheck = Min;
166			return ValueToCheck;
167			}
168			};
169
170			}} // namespace LinuxSampler::gig
171
172			#endif // __LS_GIG_VOICE_H__