engines/sf2/Voice.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 - 2013 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_SF2_VOICE_H__
#define __LS_SF2_VOICE_H__

#include "../../common/global_private.h"

#include "../../common/RTMath.h"
#include "../../common/Pool.h"
#include "../../drivers/audio/AudioOutputDevice.h"
#include "Stream.h"
#include "DiskThread.h"
#include "../gig/EGADSR.h"
#include "../gig/Filter.h"
#include "../common/VoiceBase.h"
#include "../gig/SynthesisParam.h"
#include "../sfz/EGADSR.h"
#include "SF2SignalUnitRack.h"
#include "EngineChannel.h"

namespace LinuxSampler { namespace sf2 {
    class Engine;
    class EngineChannel;

    /** SoundFont Voice
     *
     * Renders a voice for the SoundFont format.
     */
    class Voice : public LinuxSampler::VoiceBase<EngineChannel, ::sf2::Region, ::sf2::Sample, DiskThread> {
        public:
            Voice();
            virtual ~Voice();
            void SetOutput(AudioOutputDevice* pAudioOutputDevice);
            void SetEngine(LinuxSampler::Engine* pEngine);
            void CalculateFadeOutCoeff(float FadeOutTime, float SampleRate);
            virtual release_trigger_t GetReleaseTriggerFlags() OVERRIDE;

        protected:
            virtual SampleInfo       GetSampleInfo() OVERRIDE;
            virtual RegionInfo       GetRegionInfo() OVERRIDE;
            virtual InstrumentInfo   GetInstrumentInfo() OVERRIDE;
            virtual double           CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) OVERRIDE;
            virtual AbstractEngine*  GetEngine() OVERRIDE { return (AbstractEngine*)pEngine; }
            virtual double           GetEG1ControllerValue(uint8_t MIDIKeyVelocity) OVERRIDE;
            virtual EGInfo           CalculateEG1ControllerInfluence(double eg1ControllerValue) OVERRIDE;
            virtual void             TriggerEG1(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) OVERRIDE { }
            virtual double           GetEG2ControllerValue(uint8_t MIDIKeyVelocity) OVERRIDE;
            virtual EGInfo           CalculateEG2ControllerInfluence(double eg2ControllerValue) OVERRIDE;
            virtual void             TriggerEG2(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) OVERRIDE { }
            virtual void             InitLFO1() OVERRIDE { }
            virtual void             InitLFO2() OVERRIDE { }
            virtual void             InitLFO3() OVERRIDE { }
            virtual float            CalculateCutoffBase(uint8_t MIDIKeyVelocity) OVERRIDE;
            virtual float            CalculateFinalCutoff(float cutoffBase) OVERRIDE;
            virtual uint8_t          GetVCFCutoffCtrl() OVERRIDE;
            virtual uint8_t          GetVCFResonanceCtrl() OVERRIDE;
            virtual void             ProcessCCEvent(RTList<Event>::Iterator& itEvent) OVERRIDE;
            virtual void             ProcessChannelPressureEvent(RTList<Event>::Iterator& itEvent) OVERRIDE;
            virtual void             ProcessPolyphonicKeyPressureEvent(RTList<Event>::Iterator& itEvent) OVERRIDE;
            virtual void             ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) OVERRIDE;
            virtual double           GetVelocityAttenuation(uint8_t MIDIKeyVelocity) OVERRIDE;
            virtual double           GetVelocityRelease(uint8_t MIDIKeyVelocity) OVERRIDE;
            virtual double           GetSampleAttenuation() OVERRIDE;
            virtual void             ProcessGroupEvent(RTList<Event>::Iterator& itEvent) OVERRIDE;
            virtual void             AboutToTrigger() OVERRIDE;
            virtual int              CalculatePan(uint8_t pan) OVERRIDE;

        private:
            ::sf2::Region* pPresetRegion;
            SF2SignalUnitRack SignalRack;

        public: // FIXME: just made public for debugging (sanity check in Engine::RenderAudio()), should be changed to private before the final release
            // Attributes
            Engine*                     pEngine;            ///< Pointer to the sampler engine, to be able to access the event lists.
            //uint                        LoopCyclesLeft;     ///< In case there is a RAMLoop and it's not an endless loop; reflects number of loop cycles left to be passed

            // Static Methods
            static float CalculateFilterCutoffCoeff();

            // Methods
            void ProcessEvents(uint Samples);
            void processCrossFadeEvent(RTList<Event>::Iterator& itEvent);

            EngineChannel* GetSf2EngineChannel();

            friend class EGUnit;
            friend class VolEGUnit;
            friend class ModEGUnit;
            friend class ModLfoUnit;
            friend class VibLfoUnit;
            friend class EndpointUnit;
            friend class SF2SignalUnitRack;

        protected:
            virtual uint8_t CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) OVERRIDE {
                /*uint8_t c = std::max(CrossfadeControllerValue, pRegion->AttenuationControllerThreshold);
                c = (!pRegion->Crossfade.out_end) ? c     // 0,0,0,0 means no crossfade defined
                          : (c < pRegion->Crossfade.in_end) ?
                                ((c <= pRegion->Crossfade.in_start) ? 0
                                : 127 * (c - pRegion->Crossfade.in_start) / (pRegion->Crossfade.in_end - pRegion->Crossfade.in_start))
                          : (c <= pRegion->Crossfade.out_start) ? 127
                          : (c < pRegion->Crossfade.out_end) ? 127 * (pRegion->Crossfade.out_end - c) / (pRegion->Crossfade.out_end - pRegion->Crossfade.out_start)
                          : 0;
                return pRegion->InvertAttenuationController ? 127 - c : c;*/ // TODO: ^^^
                return 0;
            }
    };

}} // namespace LinuxSampler::sf2

#endif // __LS_SF2_VOICE_H__
1	iliev	2012	/***************************************************************************
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	2390	* Copyright (C) 2009 - 2013 Christian Schoenebeck and Grigor Iliev *
8	iliev	2012	* *
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_SF2_VOICE_H__
26			#define __LS_SF2_VOICE_H__
27
28			#include "../../common/global_private.h"
29
30			#include "../../common/RTMath.h"
31			#include "../../common/Pool.h"
32			#include "../../drivers/audio/AudioOutputDevice.h"
33			#include "Stream.h"
34			#include "DiskThread.h"
35	persson	2055	#include "../gig/EGADSR.h"
36	iliev	2012	#include "../gig/Filter.h"
37			#include "../common/VoiceBase.h"
38			#include "../gig/SynthesisParam.h"
39	persson	2203	#include "../sfz/EGADSR.h"
40	iliev	2205	#include "SF2SignalUnitRack.h"
41	persson	2390	#include "EngineChannel.h"
42	iliev	2012
43			namespace LinuxSampler { namespace sf2 {
44			class Engine;
45			class EngineChannel;
46
47	iliev	2015	/** SoundFont Voice
48	iliev	2012	*
49	iliev	2015	* Renders a voice for the SoundFont format.
50	iliev	2012	*/
51	iliev	2015	class Voice : public LinuxSampler::VoiceBase<EngineChannel, ::sf2::Region, ::sf2::Sample, DiskThread> {
52	iliev	2012	public:
53			Voice();
54			virtual ~Voice();
55			void SetOutput(AudioOutputDevice* pAudioOutputDevice);
56			void SetEngine(LinuxSampler::Engine* pEngine);
57	persson	2327	void CalculateFadeOutCoeff(float FadeOutTime, float SampleRate);
58	schoenebeck	3444	virtual release_trigger_t GetReleaseTriggerFlags() OVERRIDE;
59	iliev	2012
60	iliev	2015	protected:
61	schoenebeck	3054	virtual SampleInfo GetSampleInfo() OVERRIDE;
62			virtual RegionInfo GetRegionInfo() OVERRIDE;
63			virtual InstrumentInfo GetInstrumentInfo() OVERRIDE;
64			virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) OVERRIDE;
65			virtual AbstractEngine* GetEngine() OVERRIDE { return (AbstractEngine*)pEngine; }
66			virtual double GetEG1ControllerValue(uint8_t MIDIKeyVelocity) OVERRIDE;
67			virtual EGInfo CalculateEG1ControllerInfluence(double eg1ControllerValue) OVERRIDE;
68			virtual void TriggerEG1(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) OVERRIDE { }
69			virtual double GetEG2ControllerValue(uint8_t MIDIKeyVelocity) OVERRIDE;
70			virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) OVERRIDE;
71			virtual void TriggerEG2(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) OVERRIDE { }
72			virtual void InitLFO1() OVERRIDE { }
73			virtual void InitLFO2() OVERRIDE { }
74			virtual void InitLFO3() OVERRIDE { }
75			virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) OVERRIDE;
76			virtual float CalculateFinalCutoff(float cutoffBase) OVERRIDE;
77			virtual uint8_t GetVCFCutoffCtrl() OVERRIDE;
78			virtual uint8_t GetVCFResonanceCtrl() OVERRIDE;
79	schoenebeck	2559	virtual void ProcessCCEvent(RTList<Event>::Iterator& itEvent) OVERRIDE;
80			virtual void ProcessChannelPressureEvent(RTList<Event>::Iterator& itEvent) OVERRIDE;
81			virtual void ProcessPolyphonicKeyPressureEvent(RTList<Event>::Iterator& itEvent) OVERRIDE;
82	schoenebeck	3054	virtual void ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) OVERRIDE;
83			virtual double GetVelocityAttenuation(uint8_t MIDIKeyVelocity) OVERRIDE;
84			virtual double GetVelocityRelease(uint8_t MIDIKeyVelocity) OVERRIDE;
85			virtual double GetSampleAttenuation() OVERRIDE;
86			virtual void ProcessGroupEvent(RTList<Event>::Iterator& itEvent) OVERRIDE;
87			virtual void AboutToTrigger() OVERRIDE;
88			virtual int CalculatePan(uint8_t pan) OVERRIDE;
89	iliev	2015
90			private:
91	persson	2203	::sf2::Region* pPresetRegion;
92	iliev	2205	SF2SignalUnitRack SignalRack;
93	persson	2055
94	iliev	2015	public: // FIXME: just made public for debugging (sanity check in Engine::RenderAudio()), should be changed to private before the final release
95	iliev	2012	// Attributes
96			Engine* pEngine; ///< Pointer to the sampler engine, to be able to access the event lists.
97			//uint LoopCyclesLeft; ///< In case there is a RAMLoop and it's not an endless loop; reflects number of loop cycles left to be passed
98
99			// Static Methods
100			static float CalculateFilterCutoffCoeff();
101
102			// Methods
103			void ProcessEvents(uint Samples);
104			void processCrossFadeEvent(RTList<Event>::Iterator& itEvent);
105
106	iliev	2015	EngineChannel* GetSf2EngineChannel();
107
108	iliev	2205	friend class EGUnit;
109			friend class VolEGUnit;
110			friend class ModEGUnit;
111	iliev	2207	friend class ModLfoUnit;
112	iliev	2205	friend class VibLfoUnit;
113			friend class EndpointUnit;
114			friend class SF2SignalUnitRack;
115
116	iliev	2015	protected:
117	schoenebeck	3054	virtual uint8_t CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) OVERRIDE {
118	iliev	2015	/*uint8_t c = std::max(CrossfadeControllerValue, pRegion->AttenuationControllerThreshold);
119			c = (!pRegion->Crossfade.out_end) ? c // 0,0,0,0 means no crossfade defined
120			: (c < pRegion->Crossfade.in_end) ?
121			((c <= pRegion->Crossfade.in_start) ? 0
122			: 127 * (c - pRegion->Crossfade.in_start) / (pRegion->Crossfade.in_end - pRegion->Crossfade.in_start))
123			: (c <= pRegion->Crossfade.out_start) ? 127
124			: (c < pRegion->Crossfade.out_end) ? 127 * (pRegion->Crossfade.out_end - c) / (pRegion->Crossfade.out_end - pRegion->Crossfade.out_start)
125			: 0;
126			return pRegion->InvertAttenuationController ? 127 - c : c;*/ // TODO: ^^^
127			return 0;
128	iliev	2012	}
129			};
130
131			}} // namespace LinuxSampler::sf2
132
133			#endif // __LS_SF2_VOICE_H__