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 - 2011 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"

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

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

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