engines/gig/Engine.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005-2007 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/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);
            ::gig::DimensionRegion** ChangeInstrument(EngineChannel* pEngineChannel, ::gig::Instrument* pInstrument);
            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);
            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();

            static const float* VolumeCurve;    ///< Table that maps volume control change values 0..127 to amplitude. Unity gain is at 90.
            static const float* PanCurve;       ///< Table that maps pan control change values 0..128 to right channel amplitude. Unity gain is at 64 (center).
            static const float* 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                     MaxFadeOutPos;         ///< The last position in an audio fragment to allow 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).

            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:

            /// Command used by the instrument loader thread to
            /// request an instrument change on a channel.
            struct instrument_change_command_t {
                EngineChannel* pEngineChannel;
                ::gig::Instrument* pInstrument;
            };
            struct instrument_change_reply_t {
                int dummy;
            };
            RingBuffer<instrument_change_command_t,false>* InstrumentChangeQueue;      ///< Contains the instrument change command
            RingBuffer<instrument_change_reply_t,false>*   InstrumentChangeReplyQueue; ///< Contains the acknowledge of an instrument change
           ::gig::DimensionRegion** pDimRegionsInUse; ///< After an instrument change, this contains a list of dimension regions that are still in use by playing voices

            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	capela	1012	* Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck *
6			* Copyright (C) 2005-2007 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	schoenebeck	53	#include "../../common/ConditionServer.h"
37	schoenebeck	890	#include "../Engine.h"
38	schoenebeck	53	#include "../common/Event.h"
39			#include "../../network/lscp.h"
40	schoenebeck	411	#include "EngineChannel.h"
41	schoenebeck	53
42	schoenebeck	475	// identifier of this sampler engine
43	schoenebeck	727	#define LS_GIG_ENGINE_NAME "GIG"
44	schoenebeck	475
45	schoenebeck	53	namespace LinuxSampler { namespace gig {
46
47			// just symbol prototyping
48			class Voice;
49			class DiskThread;
50			class InstrumentResourceManager;
51	schoenebeck	411	class midi_key_info_t;
52			class EngineChannel;
53	schoenebeck	53
54			/**
55			* Sampler engine for the Gigasampler format.
56			*/
57	schoenebeck	411	class Engine : public LinuxSampler::Engine {
58	persson	438	public:
59	schoenebeck	53	// methods
60			Engine();
61	letz	502	virtual ~Engine();
62	schoenebeck	411	void Connect(AudioOutputDevice* pAudioOut);
63	persson	1038	::gig::DimensionRegion** ChangeInstrument(EngineChannel* pEngineChannel, ::gig::Instrument* pInstrument);
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	411	virtual void SendSysex(void* pData, uint Size);
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	832	static const float* VolumeCurve; ///< Table that maps volume control change values 0..127 to amplitude. Unity gain is at 90.
88			static const float* PanCurve; ///< Table that maps pan control change values 0..128 to right channel amplitude. Unity gain is at 64 (center).
89			static const float* CrossfadeCurve; ///< Table that maps crossfade control change values 0..127 to amplitude. Unity gain is at 127.
90	persson	831
91	persson	438	//protected:
92	schoenebeck	411	static InstrumentResourceManager instruments;
93	schoenebeck	53
94			AudioOutputDevice* pAudioOutputDevice;
95	schoenebeck	225	uint SampleRate; ///< Sample rate of the engines output audio signal (in Hz)
96			uint MaxSamplesPerCycle; ///< Size of each audio output buffer
97	persson	438	DiskThread* pDiskThread;
98	schoenebeck	970	RingBuffer<Event,false>* pEventQueue; ///< Input event queue for engine global events (e.g. SysEx messages).
99	persson	438	Pool<Voice>* pVoicePool; ///< Contains all voices that can be activated.
100			EventGenerator* pEventGenerator;
101	schoenebeck	271	RTList<Event>* pVoiceStealingQueue; ///< All voice-launching events which had to be postponed due to free voice shortage.
102	schoenebeck	460	RTList<Event>* pGlobalEvents; ///< All engine global events for the current audio fragment (usually only SysEx messages).
103	schoenebeck	411	Pool<Event>* pEventPool; ///< Contains all Event objects that can be used.
104	schoenebeck	970	RingBuffer<uint8_t,false>* pSysexBuffer; ///< Input buffer for MIDI system exclusive messages.
105	schoenebeck	412	int ActiveVoiceCount; ///< number of currently active voices (this value will be returned for public calls)
106			int ActiveVoiceCountTemp; ///< number of currently active voices (for internal usage, will be used for incrementation)
107	schoenebeck	53	int ActiveVoiceCountMax; ///< the maximum voice usage since application start
108	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.
109	schoenebeck	460	RTList<Voice>::Iterator itLastStolenVoice; ///< Only for voice stealing: points to the last voice which was theft in current audio fragment, NULL otherwise.
110			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.
111	schoenebeck	659	EngineChannel* pLastStolenChannel; ///< Only for voice stealing: points to the engine channel on which the previous voice was stolen in this audio fragment.
112	schoenebeck	649	RTList<Voice>::Iterator itLastStolenVoiceGlobally; ///< Same as itLastStolenVoice, but engine globally
113			RTList<uint>::Iterator iuiLastStolenKeyGlobally; ///< Same as iuiLastStolenKey, but engine globally
114	schoenebeck	53	bool SuspensionRequested;
115			ConditionServer EngineDisabled;
116	persson	438	int8_t ScaleTuning[12]; ///< contains optional detune factors (-64..+63 cents) for all 12 semitones of an octave
117	schoenebeck	411	int MaxFadeOutPos; ///< The last position in an audio fragment to allow an instant fade out (e.g. for voice stealing) without leading to clicks.
118	persson	438	uint32_t RandomSeed; ///< State of the random number generator used by the random dimension.
119	persson	846	Mutex ResetInternalMutex; ///< Mutex to protect the ResetInternal function for concurrent usage (e.g. by the lscp and instrument loader threads).
120	schoenebeck	53
121	schoenebeck	460	void ProcessEvents(EngineChannel* pEngineChannel, uint Samples);
122			void RenderActiveVoices(EngineChannel* pEngineChannel, uint Samples);
123			void RenderStolenVoices(uint Samples);
124	schoenebeck	1001	void RouteAudio(EngineChannel* pEngineChannel, uint Samples);
125	schoenebeck	460	void PostProcess(EngineChannel* pEngineChannel);
126	persson	438	void ClearEventLists();
127	schoenebeck	460	void ImportEvents(uint Samples);
128	schoenebeck	411	void ProcessNoteOn(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent);
129			void ProcessNoteOff(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOffEvent);
130			void ProcessPitchbend(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itPitchbendEvent);
131			void ProcessControlChange(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itControlChangeEvent);
132	schoenebeck	271	void ProcessSysex(Pool<Event>::Iterator& itSysexEvent);
133	schoenebeck	1321	void ProcessSuspensionsChanges();
134			void ProcessPendingStreamDeletions();
135	schoenebeck	668	Pool<Voice>::Iterator LaunchVoice(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing, bool HandleKeyGroupConflicts);
136	schoenebeck	473	int StealVoice(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent);
137	schoenebeck	411	void FreeVoice(EngineChannel* pEngineChannel, Pool<Voice>::Iterator& itVoice);
138			void FreeKey(EngineChannel* pEngineChannel, midi_key_info_t* pKey);
139	schoenebeck	53	void ResetInternal();
140	schoenebeck	659	void ResetScaleTuning();
141	schoenebeck	1321	void ResetSuspendedRegions();
142	schoenebeck	53
143	schoenebeck	411	static Engine* AcquireEngine(LinuxSampler::gig::EngineChannel* pChannel, AudioOutputDevice* pDevice);
144			static void FreeEngine(LinuxSampler::gig::EngineChannel* pChannel, AudioOutputDevice* pDevice);
145
146			void DisableAndLock(); // FIXME: should at least be protected
147
148	schoenebeck	53	friend class Voice;
149			private:
150	persson	1038
151			/// Command used by the instrument loader thread to
152			/// request an instrument change on a channel.
153			struct instrument_change_command_t {
154			EngineChannel* pEngineChannel;
155			::gig::Instrument* pInstrument;
156			};
157			struct instrument_change_reply_t {
158			int dummy;
159			};
160			RingBuffer<instrument_change_command_t,false>* InstrumentChangeQueue; ///< Contains the instrument change command
161			RingBuffer<instrument_change_reply_t,false>* InstrumentChangeReplyQueue; ///< Contains the acknowledge of an instrument change
162			::gig::DimensionRegion** pDimRegionsInUse; ///< After an instrument change, this contains a list of dimension regions that are still in use by playing voices
163
164	schoenebeck	1321	Pool< ::gig::Region*> SuspendedRegions;
165			Mutex SuspendedRegionsMutex;
166			Condition SuspensionChangeOngoing;
167			::gig::Region* pPendingRegionSuspension;
168			::gig::Region* pPendingRegionResumption;
169			int iPendingStreamDeletions;
170
171	schoenebeck	460	ArrayList<EngineChannel*> engineChannels; ///< All engine channels of a gig::Engine instance.
172	persson	438
173	schoenebeck	411	static std::map<AudioOutputDevice,Engine> engines; ///< All instances of gig::Engine.
174	persson	438
175	iliev	776	int SostenutoKeys[128];
176			int SostenutoKeyCount;
177
178	schoenebeck	970	uint8_t GSCheckSum(const RingBuffer<uint8_t,false>::NonVolatileReader AddrReader, uint DataSize);
179	schoenebeck	244	void AdjustScale(int8_t ScaleTunes[12]);
180	schoenebeck	473	void ReleaseAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itReleaseEvent);
181			void KillAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itKillEvent);
182	iliev	776	bool ShouldReleaseVoice(EngineChannel* pEngineChannel, int Key);
183	schoenebeck	1321	bool RegionSuspended(::gig::Region* pRegion);
184	persson	831	static float* InitVolumeCurve();
185			static float* InitPanCurve();
186	persson	832	static float* InitCrossfadeCurve();
187	persson	831	static float* InitCurve(const float* segments, int size = 128);
188	persson	630
189			unsigned long FrameTime; ///< Time in frames of the start of the current audio fragment
190	schoenebeck	53	};
191
192			}} // namespace LinuxSampler::gig
193
194			#endif // __LS_GIG_ENGINE_H__