engines/gig/Engine.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and 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"

#if DEBUG_HEADERS
# warning Engine.h included
#endif // DEBUG_HEADERS

#include <map>

#include "../../common/RingBuffer.h"
#include "../../common/RTELMemoryPool.h"
#include "../../common/ConditionServer.h"
#include "../common/Engine.h"
#include "../common/Event.h"
#include "../common/BiquadFilter.h"
#include "../../lib/fileloader/libgig/gig.h"
#include "InstrumentResourceManager.h"
#include "../../network/lscp.h"

#define PITCHBEND_SEMITONES             12
#define MAX_AUDIO_VOICES                128
#define SYSEX_BUFFER_SIZE               2048  // 2kB
#define VOICE_STEAL_ALGORITHM           voice_steal_algo_oldestkey  ///< @see voice_steal_algo_t for available voice stealing algorithms

namespace LinuxSampler { namespace gig {

    using std::map;

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

    /**
     * Sampler engine for the Gigasampler format.
     */
    class gig::Engine : public LinuxSampler::Engine, public InstrumentConsumer {
        public:
            // types
            enum voice_steal_algo_t {
                voice_steal_algo_none,
                voice_steal_algo_keymask,
                voice_steal_algo_oldestkey
            };

            // methods
            Engine();
           ~Engine();

            // abstract methods derived from class 'LinuxSampler::Engine'
            virtual void   LoadInstrument(const char* FileName, uint Instrument);
            virtual void   Reset();
            virtual void   Enable();
            virtual void   Disable();
            virtual void   SendNoteOn(uint8_t Key, uint8_t Velocity);
            virtual void   SendNoteOff(uint8_t Key, uint8_t Velocity);
            virtual void   SendPitchbend(int Pitch);
            virtual void   SendControlChange(uint8_t Controller, uint8_t Value);
            virtual void   SendSysex(void* pData, uint Size);
            virtual float  Volume();
            virtual void   Volume(float f);
            virtual uint   Channels();
            virtual void   Connect(AudioOutputDevice* pAudioOut);
            virtual void   DisconnectAudioOutputDevice();
            virtual void   SetOutputChannel(uint EngineAudioChannel, uint AudioDeviceChannel);
            virtual int    OutputChannel(uint EngineAudioChannel);
            virtual int    RenderAudio(uint Samples);
            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 String InstrumentFileName();
            virtual int    InstrumentIndex();
            virtual int    InstrumentStatus();

            // abstract methods derived from interface class 'InstrumentConsumer'
            virtual void ResourceToBeUpdated(::gig::Instrument* pResource, void*& pUpdateArg);
            virtual void ResourceUpdated(::gig::Instrument* pOldResource, ::gig::Instrument* pNewResource, void* pUpdateArg);
        protected:
            struct midi_key_info_t {
                RTEList<Voice>* pActiveVoices;  ///< Contains the active voices associated with the MIDI key.
                bool            KeyPressed;     ///< Is true if the respective MIDI key is currently pressed.
                bool            Active;         ///< If the key contains active voices.
                bool            ReleaseTrigger; ///< If we have to launch release triggered voice(s) when the key is released
                uint*           pSelf;          ///< hack to allow fast deallocation of the key from the list of active keys
                RTEList<Event>* pEvents;        ///< Key specific events (only Note-on, Note-off and sustain pedal currently)
            };

            static InstrumentResourceManager Instruments;

            AudioOutputDevice*      pAudioOutputDevice;
            float*                  pOutputLeft;           ///< Audio output channel buffer (left)
            float*                  pOutputRight;          ///< Audio output channel buffer (right)
            int                     AudioDeviceChannelLeft;  ///< audio device channel number to which the left channel is connected to
            int                     AudioDeviceChannelRight; ///< audio device channel number to which the right channel is connected to
            uint                    SampleRate;            ///< Sample rate of the engines output audio signal (in Hz)
            uint                    MaxSamplesPerCycle;    ///< Size of each audio output buffer
            DiskThread*             pDiskThread;
            uint8_t                 ControllerTable[128];  ///< Reflects the current values (0-127) of all MIDI controllers for this engine / sampler channel.
            RingBuffer<Event>*      pEventQueue;           ///< Input event queue.
            RingBuffer<uint8_t>*    pSysexBuffer;          ///< Input buffer for MIDI system exclusive messages.
            midi_key_info_t         pMIDIKeyInfo[128];     ///< Contains all active voices sorted by MIDI key number and other informations to the respective MIDI key
            RTELMemoryPool<Voice>*  pVoicePool;            ///< Contains all voices that can be activated.
            RTELMemoryPool<uint>*   pActiveKeys;           ///< Holds all keys in it's allocation list with active voices.
            RTELMemoryPool<Event>*  pEventPool;            ///< Contains all Event objects that can be used.
            EventGenerator*         pEventGenerator;
            RTEList<Event>*         pVoiceStealingQueue;   ///< All voice-launching events which had to be postponed due to free voice shortage.
            RTEList<Event>*         pEvents;               ///< All events for the current audio fragment.
            RTEList<Event>*         pCCEvents;             ///< All control change events for the current audio fragment.
            RTEList<Event>*         pSynthesisEvents[Event::destination_count];     ///< Events directly affecting synthesis parameter (like pitch, volume and filter).
            float*                  pSynthesisParameters[Event::destination_count]; ///< Matrix with final synthesis parameters for the current audio fragment which will be used in the main synthesis loop.
            biquad_param_t*         pBasicFilterParameters; ///< Biquad parameters of the basic bandpass filter.
            biquad_param_t*         pMainFilterParameters;  ///< Main biquad parameters of the individual filter (lowpass / bandpass / highpass).
            map<uint,uint*>         ActiveKeyGroups;        ///< Contains active keys (in case they belong to a key group) ordered by key group ID.
            RIFF::File*             pRIFF;
            ::gig::File*            pGig;
            ::gig::Instrument*      pInstrument;
            bool                    SustainPedal;          ///< true if sustain pedal is down
            double                  GlobalVolume;          ///< overall volume (a value < 1.0 means attenuation, a value > 1.0 means amplification)
            int                     Pitch;                 ///< Current (absolute) MIDI pitch value.
            int                     ActiveVoiceCount;      ///< number of currently active voices
            int                     ActiveVoiceCountMax;   ///< the maximum voice usage since application start
            bool                    SuspensionRequested;
            ConditionServer         EngineDisabled;
            String                  InstrumentFile;
            int                     InstrumentIdx;
            int                     InstrumentStat;
            int8_t                  ScaleTuning[12];       ///< contains optional detune factors (-64..+63 cents) for all 12 semitones of an octave
            Voice*                  pLastStolenVoice;      ///< Only for voice stealing: points to the last voice which was theft in current audio fragment, NULL otherwise.
            uint*                   puiLastStolenKey;      ///< Only for voice stealing: key number of last key on which the last voice was theft in current audio fragment, NULL otherwise.

            void ProcessNoteOn(Event* pNoteOnEvent);
            void ProcessNoteOff(Event* pNoteOffEvent);
            void ProcessPitchbend(Event* pPitchbendEvent);
            void ProcessControlChange(Event* pControlChangeEvent);
            void ProcessSysex(Event* pSysexEvent);
            Voice* LaunchVoice(Event* pNoteOnEvent, int iLayer = 0, bool ReleaseTriggerVoice = false, bool VoiceStealing = true);
            void StealVoice(Event* pNoteOnEvent, int iLayer, bool ReleaseTriggerVoice);
            void KillVoiceImmediately(Voice* pVoice);
            void ResetSynthesisParameters(Event::destination_t dst, float val);
            void ResetInternal();

            friend class Voice;
            friend class EGADSR;
            friend class EGDecay;
            friend class VCAManipulator;
            friend class VCFCManipulator;
            friend class VCOManipulator;
            friend class InstrumentResourceManager;
        private:
            void    DisableAndLock();
            uint8_t GSCheckSum(const RingBuffer<uint8_t>::NonVolatileReader AddrReader, uint DataSize);
            void    AdjustScale(int8_t ScaleTunes[12]);
    };

}} // namespace LinuxSampler::gig

#endif // __LS_GIG_ENGINE_H__
1	/***************************************************************************
2	* *
3	* LinuxSampler - modular, streaming capable sampler *
4	* *
5	* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6	* *
7	* This program is free software; you can redistribute it and/or modify *
8	* it under the terms of the GNU General Public License as published by *
9	* the Free Software Foundation; either version 2 of the License, or *
10	* (at your option) any later version. *
11	* *
12	* This program is distributed in the hope that it will be useful, *
13	* but WITHOUT ANY WARRANTY; without even the implied warranty of *
14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15	* GNU General Public License for more details. *
16	* *
17	* You should have received a copy of the GNU General Public License *
18	* along with this program; if not, write to the Free Software *
19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
20	* MA 02111-1307 USA *
21	***************************************************************************/
22
23	#ifndef __LS_GIG_ENGINE_H__
24	#define __LS_GIG_ENGINE_H__
25
26	#include "../../common/global.h"
27
28	#if DEBUG_HEADERS
29	# warning Engine.h included
30	#endif // DEBUG_HEADERS
31
32	#include <map>
33
34	#include "../../common/RingBuffer.h"
35	#include "../../common/RTELMemoryPool.h"
36	#include "../../common/ConditionServer.h"
37	#include "../common/Engine.h"
38	#include "../common/Event.h"
39	#include "../common/BiquadFilter.h"
40	#include "../../lib/fileloader/libgig/gig.h"
41	#include "InstrumentResourceManager.h"
42	#include "../../network/lscp.h"
43
44	#define PITCHBEND_SEMITONES 12
45	#define MAX_AUDIO_VOICES 128
46	#define SYSEX_BUFFER_SIZE 2048 // 2kB
47	#define VOICE_STEAL_ALGORITHM voice_steal_algo_oldestkey ///< @see voice_steal_algo_t for available voice stealing algorithms
48
49	namespace LinuxSampler { namespace gig {
50
51	using std::map;
52
53	// just symbol prototyping
54	class Voice;
55	class DiskThread;
56	class InstrumentResourceManager;
57
58	/**
59	* Sampler engine for the Gigasampler format.
60	*/
61	class gig::Engine : public LinuxSampler::Engine, public InstrumentConsumer {
62	public:
63	// types
64	enum voice_steal_algo_t {
65	voice_steal_algo_none,
66	voice_steal_algo_keymask,
67	voice_steal_algo_oldestkey
68	};
69
70	// methods
71	Engine();
72	~Engine();
73
74	// abstract methods derived from class 'LinuxSampler::Engine'
75	virtual void LoadInstrument(const char* FileName, uint Instrument);
76	virtual void Reset();
77	virtual void Enable();
78	virtual void Disable();
79	virtual void SendNoteOn(uint8_t Key, uint8_t Velocity);
80	virtual void SendNoteOff(uint8_t Key, uint8_t Velocity);
81	virtual void SendPitchbend(int Pitch);
82	virtual void SendControlChange(uint8_t Controller, uint8_t Value);
83	virtual void SendSysex(void* pData, uint Size);
84	virtual float Volume();
85	virtual void Volume(float f);
86	virtual uint Channels();
87	virtual void Connect(AudioOutputDevice* pAudioOut);
88	virtual void DisconnectAudioOutputDevice();
89	virtual void SetOutputChannel(uint EngineAudioChannel, uint AudioDeviceChannel);
90	virtual int OutputChannel(uint EngineAudioChannel);
91	virtual int RenderAudio(uint Samples);
92	virtual uint VoiceCount();
93	virtual uint VoiceCountMax();
94	virtual bool DiskStreamSupported();
95	virtual uint DiskStreamCount();
96	virtual uint DiskStreamCountMax();
97	virtual String DiskStreamBufferFillBytes();
98	virtual String DiskStreamBufferFillPercentage();
99	virtual String Description();
100	virtual String Version();
101	virtual String EngineName();
102	virtual String InstrumentFileName();
103	virtual int InstrumentIndex();
104	virtual int InstrumentStatus();
105
106	// abstract methods derived from interface class 'InstrumentConsumer'
107	virtual void ResourceToBeUpdated(::gig::Instrument* pResource, void*& pUpdateArg);
108	virtual void ResourceUpdated(::gig::Instrument* pOldResource, ::gig::Instrument* pNewResource, void* pUpdateArg);
109	protected:
110	struct midi_key_info_t {
111	RTEList<Voice>* pActiveVoices; ///< Contains the active voices associated with the MIDI key.
112	bool KeyPressed; ///< Is true if the respective MIDI key is currently pressed.
113	bool Active; ///< If the key contains active voices.
114	bool ReleaseTrigger; ///< If we have to launch release triggered voice(s) when the key is released
115	uint* pSelf; ///< hack to allow fast deallocation of the key from the list of active keys
116	RTEList<Event>* pEvents; ///< Key specific events (only Note-on, Note-off and sustain pedal currently)
117	};
118
119	static InstrumentResourceManager Instruments;
120
121	AudioOutputDevice* pAudioOutputDevice;
122	float* pOutputLeft; ///< Audio output channel buffer (left)
123	float* pOutputRight; ///< Audio output channel buffer (right)
124	int AudioDeviceChannelLeft; ///< audio device channel number to which the left channel is connected to
125	int AudioDeviceChannelRight; ///< audio device channel number to which the right channel is connected to
126	uint SampleRate; ///< Sample rate of the engines output audio signal (in Hz)
127	uint MaxSamplesPerCycle; ///< Size of each audio output buffer
128	DiskThread* pDiskThread;
129	uint8_t ControllerTable[128]; ///< Reflects the current values (0-127) of all MIDI controllers for this engine / sampler channel.
130	RingBuffer<Event>* pEventQueue; ///< Input event queue.
131	RingBuffer<uint8_t>* pSysexBuffer; ///< Input buffer for MIDI system exclusive messages.
132	midi_key_info_t pMIDIKeyInfo[128]; ///< Contains all active voices sorted by MIDI key number and other informations to the respective MIDI key
133	RTELMemoryPool<Voice>* pVoicePool; ///< Contains all voices that can be activated.
134	RTELMemoryPool<uint>* pActiveKeys; ///< Holds all keys in it's allocation list with active voices.
135	RTELMemoryPool<Event>* pEventPool; ///< Contains all Event objects that can be used.
136	EventGenerator* pEventGenerator;
137	RTEList<Event>* pVoiceStealingQueue; ///< All voice-launching events which had to be postponed due to free voice shortage.
138	RTEList<Event>* pEvents; ///< All events for the current audio fragment.
139	RTEList<Event>* pCCEvents; ///< All control change events for the current audio fragment.
140	RTEList<Event>* pSynthesisEvents[Event::destination_count]; ///< Events directly affecting synthesis parameter (like pitch, volume and filter).
141	float* pSynthesisParameters[Event::destination_count]; ///< Matrix with final synthesis parameters for the current audio fragment which will be used in the main synthesis loop.
142	biquad_param_t* pBasicFilterParameters; ///< Biquad parameters of the basic bandpass filter.
143	biquad_param_t* pMainFilterParameters; ///< Main biquad parameters of the individual filter (lowpass / bandpass / highpass).
144	map<uint,uint*> ActiveKeyGroups; ///< Contains active keys (in case they belong to a key group) ordered by key group ID.
145	RIFF::File* pRIFF;
146	::gig::File* pGig;
147	::gig::Instrument* pInstrument;
148	bool SustainPedal; ///< true if sustain pedal is down
149	double GlobalVolume; ///< overall volume (a value < 1.0 means attenuation, a value > 1.0 means amplification)
150	int Pitch; ///< Current (absolute) MIDI pitch value.
151	int ActiveVoiceCount; ///< number of currently active voices
152	int ActiveVoiceCountMax; ///< the maximum voice usage since application start
153	bool SuspensionRequested;
154	ConditionServer EngineDisabled;
155	String InstrumentFile;
156	int InstrumentIdx;
157	int InstrumentStat;
158	int8_t ScaleTuning[12]; ///< contains optional detune factors (-64..+63 cents) for all 12 semitones of an octave
159	Voice* pLastStolenVoice; ///< Only for voice stealing: points to the last voice which was theft in current audio fragment, NULL otherwise.
160	uint* puiLastStolenKey; ///< Only for voice stealing: key number of last key on which the last voice was theft in current audio fragment, NULL otherwise.
161
162	void ProcessNoteOn(Event* pNoteOnEvent);
163	void ProcessNoteOff(Event* pNoteOffEvent);
164	void ProcessPitchbend(Event* pPitchbendEvent);
165	void ProcessControlChange(Event* pControlChangeEvent);
166	void ProcessSysex(Event* pSysexEvent);
167	Voice* LaunchVoice(Event* pNoteOnEvent, int iLayer = 0, bool ReleaseTriggerVoice = false, bool VoiceStealing = true);
168	void StealVoice(Event* pNoteOnEvent, int iLayer, bool ReleaseTriggerVoice);
169	void KillVoiceImmediately(Voice* pVoice);
170	void ResetSynthesisParameters(Event::destination_t dst, float val);
171	void ResetInternal();
172
173	friend class Voice;
174	friend class EGADSR;
175	friend class EGDecay;
176	friend class VCAManipulator;
177	friend class VCFCManipulator;
178	friend class VCOManipulator;
179	friend class InstrumentResourceManager;
180	private:
181	void DisableAndLock();
182	uint8_t GSCheckSum(const RingBuffer<uint8_t>::NonVolatileReader AddrReader, uint DataSize);
183	void AdjustScale(int8_t ScaleTunes[12]);
184	};
185
186	}} // namespace LinuxSampler::gig
187
188	#endif // __LS_GIG_ENGINE_H__