engines/gig/Engine.h

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

#include "../../common/global.h"

#include <map>
#include <gig.h>

#include "EngineGlobals.h"
#include "../../common/RingBuffer.h"
#include "../../common/Pool.h"
#include "../../common/ArrayList.h"
#include "../../common/Condition.h"
#include "../../common/ConditionServer.h"
#include "../Engine.h"
#include "../common/Event.h"
#include "../../network/lscp.h"
#include "EngineChannel.h"

// identifier of this sampler engine
#define LS_GIG_ENGINE_NAME "GIG"

namespace LinuxSampler { namespace gig {

    // just symbol prototyping
    class Voice;
    class DiskThread;
    class InstrumentResourceManager;
    class midi_key_info_t;
    class EngineChannel;

    /**
     * Sampler engine for the Gigasampler format.
     */
    class Engine : public LinuxSampler::Engine {
        public:
            // methods
            Engine();
            virtual ~Engine();
            void Connect(AudioOutputDevice* pAudioOut);
            void SuspendAll();
            void ResumeAll();
            void Suspend(::gig::Region* pRegion);
            void Resume(::gig::Region* pRegion);

            // implementation of abstract methods derived from class 'LinuxSampler::Engine'
            virtual int    RenderAudio(uint Samples);
            virtual void   SendSysex(void* pData, uint Size, MidiInputPort* pSender);
            virtual void   Reset();
            virtual void   Enable();
            virtual void   Disable();
            virtual uint   VoiceCount();
            virtual uint   VoiceCountMax();
            virtual bool   DiskStreamSupported();
            virtual uint   DiskStreamCount();
            virtual uint   DiskStreamCountMax();
            virtual String DiskStreamBufferFillBytes();
            virtual String DiskStreamBufferFillPercentage();
            virtual String Description();
            virtual String Version();
            virtual String EngineName();
            virtual InstrumentManager* GetInstrumentManager();

            // Simple array wrapper just to make sure memory is freed
            // when liblinuxsampler is unloaded
            class FloatTable {
            private:
                const float* array;
            public:
                FloatTable(const float* array) : array(array) { }
                ~FloatTable() { delete[] array; }
                const float& operator[](int i) const { return array[i]; }
            };

            static const FloatTable VolumeCurve;    ///< Table that maps volume control change values 0..127 to amplitude. Unity gain is at 90.
            static const FloatTable PanCurve;       ///< Table that maps pan control change values 0..128 to right channel amplitude. Unity gain is at 64 (center).
            static const FloatTable CrossfadeCurve; ///< Table that maps crossfade control change values 0..127 to amplitude. Unity gain is at 127.

        //protected:
            static InstrumentResourceManager instruments;

            AudioOutputDevice*      pAudioOutputDevice;
            uint                    SampleRate;            ///< Sample rate of the engines output audio signal (in Hz)
            uint                    MaxSamplesPerCycle;    ///< Size of each audio output buffer
            DiskThread*             pDiskThread;
            RingBuffer<Event,false>* pEventQueue;          ///< Input event queue for engine global events (e.g. SysEx messages).
            Pool<Voice>*            pVoicePool;            ///< Contains all voices that can be activated.
            EventGenerator*         pEventGenerator;
            RTList<Event>*          pVoiceStealingQueue;   ///< All voice-launching events which had to be postponed due to free voice shortage.
            RTList<Event>*          pGlobalEvents;         ///< All engine global events for the current audio fragment (usually only SysEx messages).
            Pool<Event>*            pEventPool;            ///< Contains all Event objects that can be used.
            RingBuffer<uint8_t,false>* pSysexBuffer;       ///< Input buffer for MIDI system exclusive messages.
            int                     ActiveVoiceCount;      ///< number of currently active voices (this value will be returned for public calls)
            int                     ActiveVoiceCountTemp;  ///< number of currently active voices (for internal usage, will be used for incrementation)
            int                     ActiveVoiceCountMax;   ///< the maximum voice usage since application start
            int                     VoiceSpawnsLeft;       ///< We only allow CONFIG_MAX_VOICES voices to be spawned per audio fragment, we use this variable to ensure this limit.
            RTList<Voice>::Iterator itLastStolenVoice;     ///< Only for voice stealing: points to the last voice which was theft in current audio fragment, NULL otherwise.
            RTList<uint>::Iterator  iuiLastStolenKey;      ///< Only for voice stealing: key number of last key on which the last voice was theft in current audio fragment, NULL otherwise.
            EngineChannel*          pLastStolenChannel;    ///< Only for voice stealing: points to the engine channel on which the previous voice was stolen in this audio fragment.
            RTList<Voice>::Iterator itLastStolenVoiceGlobally; ///< Same as itLastStolenVoice, but engine globally
            RTList<uint>::Iterator  iuiLastStolenKeyGlobally;  ///< Same as iuiLastStolenKey, but engine globally
            bool                    SuspensionRequested;
            ConditionServer         EngineDisabled;
            int8_t                  ScaleTuning[12];       ///< contains optional detune factors (-64..+63 cents) for all 12 semitones of an octave
            int                     MinFadeOutSamples;     ///< The number of samples needed to make an instant fade out (e.g. for voice stealing) without leading to clicks.
            uint32_t                RandomSeed;            ///< State of the random number generator used by the random dimension.
            Mutex                   ResetInternalMutex;    ///< Mutex to protect the ResetInternal function for concurrent usage (e.g. by the lscp and instrument loader threads).
            Pool< ::gig::DimensionRegion*>* pDimRegionPool[2]; ///< Double buffered pool, used by the engine channels to keep track of dimension regions in use.

            void ProcessEvents(EngineChannel* pEngineChannel, uint Samples);
            void RenderActiveVoices(EngineChannel* pEngineChannel, uint Samples);
            void RenderStolenVoices(uint Samples);
            void RouteAudio(EngineChannel* pEngineChannel, uint Samples);
            void PostProcess(EngineChannel* pEngineChannel);
            void ClearEventLists();
            void ImportEvents(uint Samples);
            void ProcessNoteOn(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent);
            void ProcessNoteOff(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOffEvent);
            void ProcessPitchbend(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itPitchbendEvent);
            void ProcessControlChange(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itControlChangeEvent);
            void ProcessSysex(Pool<Event>::Iterator& itSysexEvent);
            void ProcessSuspensionsChanges();
            void ProcessPendingStreamDeletions();
            Pool<Voice>::Iterator LaunchVoice(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing, bool HandleKeyGroupConflicts);
            int  StealVoice(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent);
            void FreeVoice(EngineChannel* pEngineChannel, Pool<Voice>::Iterator& itVoice);
            void FreeKey(EngineChannel* pEngineChannel, midi_key_info_t* pKey);
            void ResetInternal();
            void ResetScaleTuning();
            void ResetSuspendedRegions();

            static Engine* AcquireEngine(LinuxSampler::gig::EngineChannel* pChannel, AudioOutputDevice* pDevice);
            static void    FreeEngine(LinuxSampler::gig::EngineChannel* pChannel, AudioOutputDevice* pDevice);

            void DisableAndLock(); // FIXME: should at least be protected

            friend class Voice;
        private:
            Pool< ::gig::Region*> SuspendedRegions;
            Mutex                 SuspendedRegionsMutex;
            Condition             SuspensionChangeOngoing;
            ::gig::Region*        pPendingRegionSuspension;
            ::gig::Region*        pPendingRegionResumption;
            int                   iPendingStreamDeletions;

            ArrayList<EngineChannel*> engineChannels; ///< All engine channels of a gig::Engine instance.

            static std::map<AudioOutputDevice*,Engine*> engines; ///< All instances of gig::Engine.

            int SostenutoKeys[128];
            int SostenutoKeyCount;

            uint8_t GSCheckSum(const RingBuffer<uint8_t,false>::NonVolatileReader AddrReader, uint DataSize);
            void    AdjustScale(int8_t ScaleTunes[12]);
            void    ReleaseAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itReleaseEvent);
            void    KillAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itKillEvent);
            bool    ShouldReleaseVoice(EngineChannel* pEngineChannel, int Key);
            bool    RegionSuspended(::gig::Region* pRegion);
            static float* InitVolumeCurve();
            static float* InitPanCurve();
            static float* InitCrossfadeCurve();
            static float* InitCurve(const float* segments, int size = 128);

            unsigned long FrameTime; ///< Time in frames of the start of the current audio fragment
    };

}} // namespace LinuxSampler::gig

#endif // __LS_GIG_ENGINE_H__
1	schoenebeck	53	/***************************************************************************
2			* *
3			* LinuxSampler - modular, streaming capable sampler *
4			* *
5	persson	1644	* Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck *
6			* Copyright (C) 2005-2008 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_ENGINE_H__
25			#define __LS_GIG_ENGINE_H__
26
27			#include "../../common/global.h"
28
29	schoenebeck	239	#include <map>
30	schoenebeck	505	#include <gig.h>
31	schoenebeck	239
32	schoenebeck	411	#include "EngineGlobals.h"
33	schoenebeck	53	#include "../../common/RingBuffer.h"
34	schoenebeck	271	#include "../../common/Pool.h"
35	schoenebeck	460	#include "../../common/ArrayList.h"
36	persson	1764	#include "../../common/Condition.h"
37	schoenebeck	53	#include "../../common/ConditionServer.h"
38	schoenebeck	890	#include "../Engine.h"
39	schoenebeck	53	#include "../common/Event.h"
40			#include "../../network/lscp.h"
41	schoenebeck	411	#include "EngineChannel.h"
42	schoenebeck	53
43	schoenebeck	475	// identifier of this sampler engine
44	schoenebeck	727	#define LS_GIG_ENGINE_NAME "GIG"
45	schoenebeck	475
46	schoenebeck	53	namespace LinuxSampler { namespace gig {
47
48			// just symbol prototyping
49			class Voice;
50			class DiskThread;
51			class InstrumentResourceManager;
52	schoenebeck	411	class midi_key_info_t;
53			class EngineChannel;
54	schoenebeck	53
55			/**
56			* Sampler engine for the Gigasampler format.
57			*/
58	schoenebeck	411	class Engine : public LinuxSampler::Engine {
59	persson	438	public:
60	schoenebeck	53	// methods
61			Engine();
62	letz	502	virtual ~Engine();
63	schoenebeck	411	void Connect(AudioOutputDevice* pAudioOut);
64	schoenebeck	1321	void SuspendAll();
65			void ResumeAll();
66			void Suspend(::gig::Region* pRegion);
67			void Resume(::gig::Region* pRegion);
68	schoenebeck	53
69	schoenebeck	411	// implementation of abstract methods derived from class 'LinuxSampler::Engine'
70	schoenebeck	412	virtual int RenderAudio(uint Samples);
71	schoenebeck	1751	virtual void SendSysex(void* pData, uint Size, MidiInputPort* pSender);
72	schoenebeck	53	virtual void Reset();
73			virtual void Enable();
74			virtual void Disable();
75			virtual uint VoiceCount();
76			virtual uint VoiceCountMax();
77			virtual bool DiskStreamSupported();
78			virtual uint DiskStreamCount();
79			virtual uint DiskStreamCountMax();
80			virtual String DiskStreamBufferFillBytes();
81			virtual String DiskStreamBufferFillPercentage();
82			virtual String Description();
83			virtual String Version();
84	senkov	112	virtual String EngineName();
85	schoenebeck	947	virtual InstrumentManager* GetInstrumentManager();
86	persson	438
87	persson	1644	// Simple array wrapper just to make sure memory is freed
88			// when liblinuxsampler is unloaded
89			class FloatTable {
90			private:
91			const float* array;
92			public:
93			FloatTable(const float* array) : array(array) { }
94			~FloatTable() { delete[] array; }
95			const float& operator[](int i) const { return array[i]; }
96			};
97	persson	831
98	persson	1644	static const FloatTable VolumeCurve; ///< Table that maps volume control change values 0..127 to amplitude. Unity gain is at 90.
99			static const FloatTable PanCurve; ///< Table that maps pan control change values 0..128 to right channel amplitude. Unity gain is at 64 (center).
100			static const FloatTable CrossfadeCurve; ///< Table that maps crossfade control change values 0..127 to amplitude. Unity gain is at 127.
101
102	persson	438	//protected:
103	schoenebeck	411	static InstrumentResourceManager instruments;
104	schoenebeck	53
105			AudioOutputDevice* pAudioOutputDevice;
106	schoenebeck	225	uint SampleRate; ///< Sample rate of the engines output audio signal (in Hz)
107			uint MaxSamplesPerCycle; ///< Size of each audio output buffer
108	persson	438	DiskThread* pDiskThread;
109	schoenebeck	970	RingBuffer<Event,false>* pEventQueue; ///< Input event queue for engine global events (e.g. SysEx messages).
110	persson	438	Pool<Voice>* pVoicePool; ///< Contains all voices that can be activated.
111			EventGenerator* pEventGenerator;
112	schoenebeck	271	RTList<Event>* pVoiceStealingQueue; ///< All voice-launching events which had to be postponed due to free voice shortage.
113	schoenebeck	460	RTList<Event>* pGlobalEvents; ///< All engine global events for the current audio fragment (usually only SysEx messages).
114	schoenebeck	411	Pool<Event>* pEventPool; ///< Contains all Event objects that can be used.
115	schoenebeck	970	RingBuffer<uint8_t,false>* pSysexBuffer; ///< Input buffer for MIDI system exclusive messages.
116	schoenebeck	412	int ActiveVoiceCount; ///< number of currently active voices (this value will be returned for public calls)
117			int ActiveVoiceCountTemp; ///< number of currently active voices (for internal usage, will be used for incrementation)
118	schoenebeck	53	int ActiveVoiceCountMax; ///< the maximum voice usage since application start
119	schoenebeck	663	int VoiceSpawnsLeft; ///< We only allow CONFIG_MAX_VOICES voices to be spawned per audio fragment, we use this variable to ensure this limit.
120	schoenebeck	460	RTList<Voice>::Iterator itLastStolenVoice; ///< Only for voice stealing: points to the last voice which was theft in current audio fragment, NULL otherwise.
121			RTList<uint>::Iterator iuiLastStolenKey; ///< Only for voice stealing: key number of last key on which the last voice was theft in current audio fragment, NULL otherwise.
122	schoenebeck	659	EngineChannel* pLastStolenChannel; ///< Only for voice stealing: points to the engine channel on which the previous voice was stolen in this audio fragment.
123	schoenebeck	649	RTList<Voice>::Iterator itLastStolenVoiceGlobally; ///< Same as itLastStolenVoice, but engine globally
124			RTList<uint>::Iterator iuiLastStolenKeyGlobally; ///< Same as iuiLastStolenKey, but engine globally
125	schoenebeck	53	bool SuspensionRequested;
126			ConditionServer EngineDisabled;
127	persson	438	int8_t ScaleTuning[12]; ///< contains optional detune factors (-64..+63 cents) for all 12 semitones of an octave
128	persson	1748	int MinFadeOutSamples; ///< The number of samples needed to make an instant fade out (e.g. for voice stealing) without leading to clicks.
129	persson	438	uint32_t RandomSeed; ///< State of the random number generator used by the random dimension.
130	persson	846	Mutex ResetInternalMutex; ///< Mutex to protect the ResetInternal function for concurrent usage (e.g. by the lscp and instrument loader threads).
131	persson	1646	Pool< ::gig::DimensionRegion> pDimRegionPool[2]; ///< Double buffered pool, used by the engine channels to keep track of dimension regions in use.
132	schoenebeck	53
133	schoenebeck	460	void ProcessEvents(EngineChannel* pEngineChannel, uint Samples);
134			void RenderActiveVoices(EngineChannel* pEngineChannel, uint Samples);
135			void RenderStolenVoices(uint Samples);
136	schoenebeck	1001	void RouteAudio(EngineChannel* pEngineChannel, uint Samples);
137	schoenebeck	460	void PostProcess(EngineChannel* pEngineChannel);
138	persson	438	void ClearEventLists();
139	schoenebeck	460	void ImportEvents(uint Samples);
140	schoenebeck	411	void ProcessNoteOn(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent);
141			void ProcessNoteOff(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOffEvent);
142			void ProcessPitchbend(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itPitchbendEvent);
143			void ProcessControlChange(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itControlChangeEvent);
144	schoenebeck	271	void ProcessSysex(Pool<Event>::Iterator& itSysexEvent);
145	schoenebeck	1321	void ProcessSuspensionsChanges();
146			void ProcessPendingStreamDeletions();
147	schoenebeck	668	Pool<Voice>::Iterator LaunchVoice(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing, bool HandleKeyGroupConflicts);
148	schoenebeck	473	int StealVoice(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent);
149	schoenebeck	411	void FreeVoice(EngineChannel* pEngineChannel, Pool<Voice>::Iterator& itVoice);
150			void FreeKey(EngineChannel* pEngineChannel, midi_key_info_t* pKey);
151	schoenebeck	53	void ResetInternal();
152	schoenebeck	659	void ResetScaleTuning();
153	schoenebeck	1321	void ResetSuspendedRegions();
154	schoenebeck	53
155	schoenebeck	411	static Engine* AcquireEngine(LinuxSampler::gig::EngineChannel* pChannel, AudioOutputDevice* pDevice);
156			static void FreeEngine(LinuxSampler::gig::EngineChannel* pChannel, AudioOutputDevice* pDevice);
157
158			void DisableAndLock(); // FIXME: should at least be protected
159
160	schoenebeck	53	friend class Voice;
161			private:
162	schoenebeck	1321	Pool< ::gig::Region*> SuspendedRegions;
163			Mutex SuspendedRegionsMutex;
164			Condition SuspensionChangeOngoing;
165			::gig::Region* pPendingRegionSuspension;
166			::gig::Region* pPendingRegionResumption;
167			int iPendingStreamDeletions;
168
169	schoenebeck	460	ArrayList<EngineChannel*> engineChannels; ///< All engine channels of a gig::Engine instance.
170	persson	438
171	schoenebeck	411	static std::map<AudioOutputDevice,Engine> engines; ///< All instances of gig::Engine.
172	persson	438
173	iliev	776	int SostenutoKeys[128];
174			int SostenutoKeyCount;
175
176	schoenebeck	970	uint8_t GSCheckSum(const RingBuffer<uint8_t,false>::NonVolatileReader AddrReader, uint DataSize);
177	schoenebeck	244	void AdjustScale(int8_t ScaleTunes[12]);
178	schoenebeck	473	void ReleaseAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itReleaseEvent);
179			void KillAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itKillEvent);
180	iliev	776	bool ShouldReleaseVoice(EngineChannel* pEngineChannel, int Key);
181	schoenebeck	1321	bool RegionSuspended(::gig::Region* pRegion);
182	persson	831	static float* InitVolumeCurve();
183			static float* InitPanCurve();
184	persson	832	static float* InitCrossfadeCurve();
185	persson	831	static float* InitCurve(const float* segments, int size = 128);
186	persson	630
187			unsigned long FrameTime; ///< Time in frames of the start of the current audio fragment
188	schoenebeck	53	};
189
190			}} // namespace LinuxSampler::gig
191
192			#endif // __LS_GIG_ENGINE_H__