engines/common/AbstractVoice.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck    *
 *   Copyright (C) 2005-2008 Christian Schoenebeck                         *
 *   Copyright (C) 2009-2012 Christian Schoenebeck and Grigor Iliev        *
 *                                                                         *
 *   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_ABSTRACTVOICE_H__
#define __LS_ABSTRACTVOICE_H__

#include "Voice.h"

#include "../../common/global_private.h"
#include "../AbstractEngineChannel.h"
#include "LFOBase.h"
#include "Fade.h"
#include "../EngineBase.h"
#include "EG.h"
#include "../gig/EGADSR.h"
#include "../gig/EGDecay.h"
#include "../gig/SmoothVolume.h"
#include "../gig/Synthesizer.h"
#include "../gig/Profiler.h"
#include "SignalUnitRack.h"

// include the appropriate (unsigned) triangle LFO implementation
#if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
# include "LFOTriangleIntMath.h"
#elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
# include "LFOTriangleIntAbsMath.h"
#elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
# include "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 "LFOTriangleIntMath.h"
#elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
# include "LFOTriangleIntAbsMath.h"
#elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
# include "LFOTriangleDiHarmonic.h"
#else
# error "Unknown or no (signed) triangle LFO implementation selected!"
#endif

namespace LinuxSampler {

    #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

    class AbstractVoice : public Voice {
        public:
            type_t       Type;         ///< Voice Type (bit field, a voice may have several types)
            NoteBase*    pNote;        ///< Note this voice belongs to and was caused by.
            int          MIDIPan;      ///< the current MIDI pan value plus the value from RegionInfo

            SignalUnitRack* const pSignalUnitRack;

            AbstractVoice(SignalUnitRack* pRack);
            virtual ~AbstractVoice();

            inline bool IsActive() { return PlaybackState; }
            inline bool IsStealable() { return !itKillEvent && PlaybackState >= playback_state_ram; }

            virtual void Reset();

            virtual int Trigger (
                AbstractEngineChannel*  pEngineChannel,
                Pool<Event>::Iterator&  itNoteOnEvent,
                int                     PitchBend,
                type_t                  VoiceType,
                int                     iKeyGroup
            );

            /** Invoked when the voice is freed - gone from active to inactive. */
            virtual void VoiceFreed() { }

            virtual void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
            
            uint GetSampleRate() { return GetEngine()->SampleRate; }
            
            uint8_t GetControllerValue(uint8_t Controller) {
                return (Controller > 128) ? 0 : pEngineChannel->ControllerTable[Controller];
            }

            /// Keyboard key on which this voice should listen to transitional events (i.e. note-off events to release the voice).
            inline uint8_t HostKey() const { return pNote->hostKey; }
            /// Keyboard key which the voice should use for calculating any synthesis relevant parameters (i.e. pitch).
            inline uint8_t MIDIKey() const { return pNote->cause.Param.Note.Key; }
            /// MIDI note-on velocity value which the voice should use for calculating any synthesis relevant parameters (i.e. amplitude).
            inline uint8_t MIDIVelocity() const { return pNote->cause.Param.Note.Velocity; }

            void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);
            void processPitchEvent(RTList<Event>::Iterator& itEvent);
            void processResonanceEvent(RTList<Event>::Iterator& itEvent);
            void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);
            void processGroupEvents(RTList<Event>::Iterator& itEvent, uint End);
            void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);
            void Kill(Pool<Event>::Iterator& itKillEvent);
            void CreateEq();
            void onScaleTuningChanged();

            bool                Orphan;             ///< true if this voice is playing a sample from an instrument that is unloaded. When the voice dies, the sample (and dimension region) will be handed back to the instrument resource manager.
            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
            Stream::reference_t DiskStreamRef;      ///< Reference / link to the disk stream

            template<class TV, class TRR, class TR, class TD, class TIM, class TI> friend class EngineBase;

        #if CONFIG_DEVMODE
        public:
        #else
        protected:
        #endif
            SampleInfo      SmplInfo;
            RegionInfo      RgnInfo;
            InstrumentInfo  InstrInfo;
            AbstractEngineChannel* pEngineChannel;

            double                      Pos;                ///< Current playback position in sample
            PitchInfo                   Pitch;
            Fade                        NotePitch;          ///< Updated by calls to built-in instrument script function change_tune() (defaults to 1.0, that is neutral).
            float                       CutoffBase;         ///< Cutoff frequency before control change, EG and LFO are applied
            float                       VolumeLeft;         ///< Left channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
            float                       VolumeRight;        ///< Right channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
            Fade                        NotePan[2];         ///< Updated by calls to built-in instrument script function change_pan() (defaults to 1.0, that is neutral, index 0 for left pan, index 1 for right).
            float                       NoteCutoff;         ///< Updated by calls to built-in instrument script function change_cutoff() (defaults to 1.0, that is neutral).
            float                       NoteResonance;      ///< Updated by calls to built-in instrument script function change_reso() (defaults to 1.0, that is neutral).
            gig::SmoothVolume           CrossfadeSmoother;  ///< Crossfade volume, updated by crossfade CC events
            gig::SmoothVolume           VolumeSmoother;     ///< Volume, updated by CC 7 (volume) events
            gig::SmoothVolume           PanLeftSmoother;    ///< Left channel volume, updated by CC 10 (pan) events and change_pan() real-time instrument script calls.
            gig::SmoothVolume           PanRightSmoother;   ///< Right channel volume, updated by CC 10 (pan) events and change_pan() real-time instrument script calls.
            Fade                        NoteVolume;         ///< Note's global volume, updated by change_vol() real-time instrument script calls (defaults to 1.0, that is neutral).
            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
            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
            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.
            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
            EG*                         pEG1;               ///< Envelope Generator 1 (Amplification)
            EG*                         pEG2;               ///< Envelope Generator 2 (Filter cutoff frequency)
            gig::EGDecay                EG3;                ///< Envelope Generator 3 (Pitch) TODO: use common EG instead?
            midi_ctrl                   VCFCutoffCtrl;
            midi_ctrl                   VCFResonanceCtrl;
            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).
            Pool<Event>::Iterator       itKillEvent;         ///< Event which caused this voice to be killed
            int                         SynthesisMode;
            float                       fFinalCutoff;
            float                       fFinalResonance;
            gig::SynthesisParam         finalSynthesisParameters;
            gig::Loop                   loop;
            RTList<Event>*              pGroupEvents;        ///< Events directed to an exclusive group
            
            EqSupport* pEq;         ///< Used for per voice equalization
            bool       bEqSupport;
            
            void PrintEqInfo() {
                if (!bEqSupport || pEq == NULL) {
                    dmsg(1,("EQ support: no\n"));
                } else {
                    pEq->PrintInfo();
                }
            }

            virtual AbstractEngine* GetEngine() = 0;
            virtual SampleInfo      GetSampleInfo() = 0;
            virtual RegionInfo      GetRegionInfo() = 0;
            virtual InstrumentInfo  GetInstrumentInfo() = 0;

            /**
             * Most of the important members of the voice are set when the voice
             * is triggered (like pEngineChannel, pRegion, pSample, etc).
             * This method is called after these members are set and before
             * the voice is actually triggered.
             * Override this method if you need to do some additional
             * initialization which depends on these members before the voice
             * is triggered.
             */
            virtual void AboutToTrigger() { }

            virtual bool EG1Finished(); 

            /**
             * Gets the sample cache size in bytes.
             */
            virtual unsigned long GetSampleCacheSize() = 0;
            
            /**
             * Because in most cases we cache part of the sample in RAM, if the
             * offset is too big (will extend beyond the RAM cache if the cache contains
             * the beginning of the sample) we should cache in the RAM buffer not the
             * beginning of the sample but a part that starts from the sample offset point.
             * In that case the current sample position should start from zero (Pos).
             * When the offset fits into RAM buffer or the whole sample is cached
             * in RAM, Pos should contain the actual offset.
             * We don't trim the sample because it might have a defined
             * loop start point before the start point of the playback.
             */
            virtual void SetSampleStartOffset();

            /**
             * Returns the correct amplitude factor for the given \a MIDIKeyVelocity.
             * All involved parameters (VelocityResponseCurve, VelocityResponseDepth
             * and VelocityResponseCurveScaling) involved are taken into account to
             * calculate the amplitude factor. Use this method when a key was
             * triggered to get the volume with which the sample should be played
             * back.
             *
             * @param MIDIKeyVelocity  MIDI velocity value of the triggered key (between 0 and 127)
             * @returns                amplitude factor (between 0.0 and 1.0)
             */
            virtual double GetVelocityAttenuation(uint8_t MIDIKeyVelocity) = 0;

            virtual double GetSampleAttenuation() = 0;

            virtual double CalculateVolume(double velocityAttenuation);

            virtual float GetReleaseTriggerAttenuation(float noteLength);

            /**
             * Get starting crossfade volume level
             */
            virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;

            virtual MidiKeyBase* GetMidiKeyInfo(int MIDIKey) = 0;

            virtual int   OrderNewStream() = 0;

            virtual PitchInfo CalculatePitchInfo(int PitchBend);

            // TODO: cleanup the interface. The following two methods
            // are maybe not neccessary after the TriggerEG1 method
            // was added.

            /**
             * Get current value of EG1 controller.
             */
            virtual double GetEG1ControllerValue(uint8_t MIDIKeyVelocity) = 0;

            /**
             * Calculate influence of EG1 controller on EG1's parameters.
             */
            virtual EGInfo CalculateEG1ControllerInfluence(double eg1ControllerValue) = 0;

            // TODO: cleanup the interface. The velrelase and
            // velocityAttenuation parameters are perhaps too gig
            // specific.
            /**
             * Trigger the amplitude envelope generator.
             */
            virtual void TriggerEG1(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;

            /**
             * Get current value of EG2 controller.
             */
            virtual double GetEG2ControllerValue(uint8_t MIDIKeyVelocity) = 0;

            /**
             * Calculate influence of EG2 controller on EG2's parameters.
             */
            virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;

            virtual void TriggerEG2(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;

            virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;
            virtual float CalculateFinalCutoff(float cutoffBase) = 0;

            virtual void InitLFO1() = 0;
            virtual void InitLFO2() = 0;
            virtual void InitLFO3() = 0;

            virtual uint8_t GetVCFCutoffCtrl() = 0;
            virtual uint8_t GetVCFResonanceCtrl() = 0;
            virtual uint8_t CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) = 0;

            virtual void    GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0;
            virtual void    ProcessCCEvent(RTList<Event>::Iterator& itEvent) = 0;
            virtual void    ProcessChannelPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
            virtual void    ProcessPolyphonicKeyPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
            virtual void    ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) = 0;
            virtual double  GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;

            virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;

            virtual void    ProcessGroupEvent(RTList<Event>::Iterator& itEvent) = 0;
            void            EnterReleaseStage();

            virtual int     CalculatePan(uint8_t pan) = 0;
    };
} // namespace LinuxSampler

#endif  /* __LS_ABSTRACTVOICE_H__ */
1	iliev	2015	/***************************************************************************
2			* *
3			* LinuxSampler - modular, streaming capable sampler *
4			* *
5			* Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck *
6	persson	2055	* Copyright (C) 2005-2008 Christian Schoenebeck *
7	persson	2382	* Copyright (C) 2009-2012 Christian Schoenebeck and Grigor Iliev *
8	iliev	2015	* *
9			* This program is free software; you can redistribute it and/or modify *
10			* it under the terms of the GNU General Public License as published by *
11			* the Free Software Foundation; either version 2 of the License, or *
12			* (at your option) any later version. *
13			* *
14			* This program is distributed in the hope that it will be useful, *
15			* but WITHOUT ANY WARRANTY; without even the implied warranty of *
16			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
17			* GNU General Public License for more details. *
18			* *
19			* You should have received a copy of the GNU General Public License *
20			* along with this program; if not, write to the Free Software *
21			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
22			* MA 02111-1307 USA *
23			***************************************************************************/
24
25			#ifndef __LS_ABSTRACTVOICE_H__
26	persson	2114	#define __LS_ABSTRACTVOICE_H__
27	iliev	2015
28			#include "Voice.h"
29
30			#include "../../common/global_private.h"
31			#include "../AbstractEngineChannel.h"
32	schoenebeck	3188	#include "LFOBase.h"
33	schoenebeck	3246	#include "Fade.h"
34	iliev	2015	#include "../EngineBase.h"
35	persson	2055	#include "EG.h"
36	iliev	2015	#include "../gig/EGADSR.h"
37			#include "../gig/EGDecay.h"
38			#include "../gig/SmoothVolume.h"
39			#include "../gig/Synthesizer.h"
40			#include "../gig/Profiler.h"
41	iliev	2205	#include "SignalUnitRack.h"
42	iliev	2015
43			// include the appropriate (unsigned) triangle LFO implementation
44			#if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
45	schoenebeck	3188	# include "LFOTriangleIntMath.h"
46	iliev	2015	#elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
47	schoenebeck	3188	# include "LFOTriangleIntAbsMath.h"
48	iliev	2015	#elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
49	schoenebeck	3188	# include "LFOTriangleDiHarmonic.h"
50	iliev	2015	#else
51			# error "Unknown or no (unsigned) triangle LFO implementation selected!"
52			#endif
53
54			// include the appropriate (signed) triangle LFO implementation
55			#if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
56	schoenebeck	3188	# include "LFOTriangleIntMath.h"
57	iliev	2015	#elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
58	schoenebeck	3188	# include "LFOTriangleIntAbsMath.h"
59	iliev	2015	#elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
60	schoenebeck	3188	# include "LFOTriangleDiHarmonic.h"
61	iliev	2015	#else
62			# error "Unknown or no (signed) triangle LFO implementation selected!"
63			#endif
64
65			namespace LinuxSampler {
66
67			#if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
68			typedef LFOTriangleIntMath<range_unsigned> LFOUnsigned;
69			#elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
70			typedef LFOTriangleIntAbsMath<range_unsigned> LFOUnsigned;
71			#elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
72			typedef LFOTriangleDiHarmonic<range_unsigned> LFOUnsigned;
73			#endif
74
75			#if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
76			typedef LFOTriangleIntMath<range_signed> LFOSigned;
77			#elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
78			typedef LFOTriangleIntAbsMath<range_signed> LFOSigned;
79			#elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
80			typedef LFOTriangleDiHarmonic<range_signed> LFOSigned;
81			#endif
82
83			class AbstractVoice : public Voice {
84			public:
85	persson	2115	type_t Type; ///< Voice Type (bit field, a voice may have several types)
86	schoenebeck	2879	NoteBase* pNote; ///< Note this voice belongs to and was caused by.
87	persson	2382	int MIDIPan; ///< the current MIDI pan value plus the value from RegionInfo
88	schoenebeck	2879
89	iliev	2217	SignalUnitRack* const pSignalUnitRack;
90	iliev	2015
91	iliev	2217	AbstractVoice(SignalUnitRack* pRack);
92	iliev	2015	virtual ~AbstractVoice();
93
94			inline bool IsActive() { return PlaybackState; }
95			inline bool IsStealable() { return !itKillEvent && PlaybackState >= playback_state_ram; }
96
97			virtual void Reset();
98
99			virtual int Trigger (
100			AbstractEngineChannel* pEngineChannel,
101			Pool<Event>::Iterator& itNoteOnEvent,
102			int PitchBend,
103			type_t VoiceType,
104			int iKeyGroup
105			);
106
107	iliev	2244	/** Invoked when the voice is freed - gone from active to inactive. */
108			virtual void VoiceFreed() { }
109
110	iliev	2015	virtual void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
111	iliev	2205
112			uint GetSampleRate() { return GetEngine()->SampleRate; }
113	iliev	2224
114			uint8_t GetControllerValue(uint8_t Controller) {
115			return (Controller > 128) ? 0 : pEngineChannel->ControllerTable[Controller];
116			}
117	iliev	2015
118	schoenebeck	2879	/// Keyboard key on which this voice should listen to transitional events (i.e. note-off events to release the voice).
119			inline uint8_t HostKey() const { return pNote->hostKey; }
120			/// Keyboard key which the voice should use for calculating any synthesis relevant parameters (i.e. pitch).
121			inline uint8_t MIDIKey() const { return pNote->cause.Param.Note.Key; }
122			/// MIDI note-on velocity value which the voice should use for calculating any synthesis relevant parameters (i.e. amplitude).
123			inline uint8_t MIDIVelocity() const { return pNote->cause.Param.Note.Velocity; }
124
125	iliev	2015	void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);
126			void processPitchEvent(RTList<Event>::Iterator& itEvent);
127			void processResonanceEvent(RTList<Event>::Iterator& itEvent);
128			void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);
129	persson	2114	void processGroupEvents(RTList<Event>::Iterator& itEvent, uint End);
130	iliev	2015	void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);
131			void Kill(Pool<Event>::Iterator& itKillEvent);
132	iliev	2298	void CreateEq();
133	schoenebeck	2448	void onScaleTuningChanged();
134	iliev	2015
135			bool Orphan; ///< true if this voice is playing a sample from an instrument that is unloaded. When the voice dies, the sample (and dimension region) will be handed back to the instrument resource manager.
136			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
137			Stream::reference_t DiskStreamRef; ///< Reference / link to the disk stream
138
139			template<class TV, class TRR, class TR, class TD, class TIM, class TI> friend class EngineBase;
140
141	schoenebeck	3306	#if CONFIG_DEVMODE
142			public:
143			#else
144	iliev	2015	protected:
145	schoenebeck	3306	#endif
146	iliev	2015	SampleInfo SmplInfo;
147			RegionInfo RgnInfo;
148			InstrumentInfo InstrInfo;
149			AbstractEngineChannel* pEngineChannel;
150
151			double Pos; ///< Current playback position in sample
152			PitchInfo Pitch;
153	schoenebeck	3246	Fade NotePitch; ///< Updated by calls to built-in instrument script function change_tune() (defaults to 1.0, that is neutral).
154	iliev	2015	float CutoffBase; ///< Cutoff frequency before control change, EG and LFO are applied
155			float VolumeLeft; ///< Left channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
156			float VolumeRight; ///< Right channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
157	schoenebeck	3335	Fade NotePan[2]; ///< Updated by calls to built-in instrument script function change_pan() (defaults to 1.0, that is neutral, index 0 for left pan, index 1 for right).
158	schoenebeck	2935	float NoteCutoff; ///< Updated by calls to built-in instrument script function change_cutoff() (defaults to 1.0, that is neutral).
159			float NoteResonance; ///< Updated by calls to built-in instrument script function change_reso() (defaults to 1.0, that is neutral).
160	iliev	2015	gig::SmoothVolume CrossfadeSmoother; ///< Crossfade volume, updated by crossfade CC events
161			gig::SmoothVolume VolumeSmoother; ///< Volume, updated by CC 7 (volume) events
162	schoenebeck	2931	gig::SmoothVolume PanLeftSmoother; ///< Left channel volume, updated by CC 10 (pan) events and change_pan() real-time instrument script calls.
163			gig::SmoothVolume PanRightSmoother; ///< Right channel volume, updated by CC 10 (pan) events and change_pan() real-time instrument script calls.
164	schoenebeck	3246	Fade NoteVolume; ///< Note's global volume, updated by change_vol() real-time instrument script calls (defaults to 1.0, that is neutral).
165	iliev	2015	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
166			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
167			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.
168			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
169	persson	2055	EG* pEG1; ///< Envelope Generator 1 (Amplification)
170	persson	2175	EG* pEG2; ///< Envelope Generator 2 (Filter cutoff frequency)
171	persson	2055	gig::EGDecay EG3; ///< Envelope Generator 3 (Pitch) TODO: use common EG instead?
172	iliev	2015	midi_ctrl VCFCutoffCtrl;
173			midi_ctrl VCFResonanceCtrl;
174			LFOUnsigned* pLFO1; ///< Low Frequency Oscillator 1 (Amplification)
175			LFOUnsigned* pLFO2; ///< Low Frequency Oscillator 2 (Filter cutoff frequency)
176			LFOSigned* pLFO3; ///< Low Frequency Oscillator 3 (Pitch)
177			bool bLFO1Enabled; ///< Should we use the Amplitude LFO for this voice?
178			bool bLFO2Enabled; ///< Should we use the Filter Cutoff LFO for this voice?
179			bool bLFO3Enabled; ///< Should we use the Pitch LFO for this voice?
180			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).
181			Pool<Event>::Iterator itKillEvent; ///< Event which caused this voice to be killed
182			int SynthesisMode;
183			float fFinalCutoff;
184			float fFinalResonance;
185			gig::SynthesisParam finalSynthesisParameters;
186			gig::Loop loop;
187	persson	2114	RTList<Event>* pGroupEvents; ///< Events directed to an exclusive group
188	iliev	2298
189			EqSupport* pEq; ///< Used for per voice equalization
190			bool bEqSupport;
191
192			void PrintEqInfo() {
193			if (!bEqSupport \|\| pEq == NULL) {
194			dmsg(1,("EQ support: no\n"));
195			} else {
196			pEq->PrintInfo();
197			}
198			}
199	iliev	2015
200			virtual AbstractEngine* GetEngine() = 0;
201			virtual SampleInfo GetSampleInfo() = 0;
202			virtual RegionInfo GetRegionInfo() = 0;
203			virtual InstrumentInfo GetInstrumentInfo() = 0;
204
205			/**
206	iliev	2205	* Most of the important members of the voice are set when the voice
207			* is triggered (like pEngineChannel, pRegion, pSample, etc).
208			* This method is called after these members are set and before
209			* the voice is actually triggered.
210			* Override this method if you need to do some additional
211			* initialization which depends on these members before the voice
212			* is triggered.
213			*/
214			virtual void AboutToTrigger() { }
215
216			virtual bool EG1Finished();
217
218			/**
219	iliev	2015	* Gets the sample cache size in bytes.
220			*/
221			virtual unsigned long GetSampleCacheSize() = 0;
222	iliev	2216
223			/**
224			* Because in most cases we cache part of the sample in RAM, if the
225			* offset is too big (will extend beyond the RAM cache if the cache contains
226			* the beginning of the sample) we should cache in the RAM buffer not the
227			* beginning of the sample but a part that starts from the sample offset point.
228			* In that case the current sample position should start from zero (Pos).
229			* When the offset fits into RAM buffer or the whole sample is cached
230			* in RAM, Pos should contain the actual offset.
231			* We don't trim the sample because it might have a defined
232			* loop start point before the start point of the playback.
233			*/
234			virtual void SetSampleStartOffset();
235	iliev	2015
236			/**
237			* Returns the correct amplitude factor for the given \a MIDIKeyVelocity.
238			* All involved parameters (VelocityResponseCurve, VelocityResponseDepth
239			* and VelocityResponseCurveScaling) involved are taken into account to
240			* calculate the amplitude factor. Use this method when a key was
241			* triggered to get the volume with which the sample should be played
242			* back.
243			*
244			* @param MIDIKeyVelocity MIDI velocity value of the triggered key (between 0 and 127)
245			* @returns amplitude factor (between 0.0 and 1.0)
246			*/
247			virtual double GetVelocityAttenuation(uint8_t MIDIKeyVelocity) = 0;
248
249			virtual double GetSampleAttenuation() = 0;
250
251			virtual double CalculateVolume(double velocityAttenuation);
252
253	persson	2061	virtual float GetReleaseTriggerAttenuation(float noteLength);
254
255	iliev	2015	/**
256			* Get starting crossfade volume level
257			*/
258			virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;
259
260	schoenebeck	2121	virtual MidiKeyBase* GetMidiKeyInfo(int MIDIKey) = 0;
261
262	iliev	2015	virtual int OrderNewStream() = 0;
263
264			virtual PitchInfo CalculatePitchInfo(int PitchBend);
265
266	persson	2055	// TODO: cleanup the interface. The following two methods
267			// are maybe not neccessary after the TriggerEG1 method
268			// was added.
269
270	iliev	2015	/**
271			* Get current value of EG1 controller.
272			*/
273			virtual double GetEG1ControllerValue(uint8_t MIDIKeyVelocity) = 0;
274
275			/**
276			* Calculate influence of EG1 controller on EG1's parameters.
277			*/
278			virtual EGInfo CalculateEG1ControllerInfluence(double eg1ControllerValue) = 0;
279
280	persson	2055	// TODO: cleanup the interface. The velrelase and
281			// velocityAttenuation parameters are perhaps too gig
282			// specific.
283	iliev	2015	/**
284	persson	2055	* Trigger the amplitude envelope generator.
285			*/
286			virtual void TriggerEG1(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
287
288			/**
289	iliev	2015	* Get current value of EG2 controller.
290			*/
291			virtual double GetEG2ControllerValue(uint8_t MIDIKeyVelocity) = 0;
292
293			/**
294			* Calculate influence of EG2 controller on EG2's parameters.
295			*/
296			virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;
297
298	persson	2175	virtual void TriggerEG2(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
299
300	iliev	2015	virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;
301			virtual float CalculateFinalCutoff(float cutoffBase) = 0;
302
303			virtual void InitLFO1() = 0;
304			virtual void InitLFO2() = 0;
305			virtual void InitLFO3() = 0;
306
307			virtual uint8_t GetVCFCutoffCtrl() = 0;
308			virtual uint8_t GetVCFResonanceCtrl() = 0;
309			virtual uint8_t CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) = 0;
310
311			virtual void GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0;
312			virtual void ProcessCCEvent(RTList<Event>::Iterator& itEvent) = 0;
313	schoenebeck	2559	virtual void ProcessChannelPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
314			virtual void ProcessPolyphonicKeyPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
315	iliev	2015	virtual void ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) = 0;
316			virtual double GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;
317
318			virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;
319	persson	2114
320			virtual void ProcessGroupEvent(RTList<Event>::Iterator& itEvent) = 0;
321			void EnterReleaseStage();
322	persson	2382
323			virtual int CalculatePan(uint8_t pan) = 0;
324	iliev	2015	};
325			} // namespace LinuxSampler
326
327	persson	2114	#endif /* __LS_ABSTRACTVOICE_H__ */