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"

#if DEBUG_HEADERS
# warning Voice.h included
#endif // DEBUG_HEADERS

#include "../../common/RTMath.h"
#include "../../common/RingBuffer.h"
#include "../../common/Pool.h"
#include "../../drivers/audio/AudioOutputDevice.h"
#include "../../lib/fileloader/libgig/gig.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
            RTList<Voice>::Iterator itChildVoice; ///< Points to the next layer voice (if any). This field is currently only used by the voice stealing algorithm.

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