/[svn]/linuxsampler/trunk/src/engines/gig/Engine.h
ViewVC logotype

Diff of /linuxsampler/trunk/src/engines/gig/Engine.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 250 by schoenebeck, Mon Sep 20 00:31:13 2004 UTC revision 1789 by iliev, Sat Nov 1 19:01:27 2008 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   LinuxSampler - modular, streaming capable sampler                     *   *   LinuxSampler - modular, streaming capable sampler                     *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *   *   Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck    *
6     *   Copyright (C) 2005-2008 Christian Schoenebeck                         *
7   *                                                                         *   *                                                                         *
8   *   This program is free software; you can redistribute it and/or modify  *   *   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  *   *   it under the terms of the GNU General Public License as published by  *
# Line 25  Line 26 
26    
27  #include "../../common/global.h"  #include "../../common/global.h"
28    
 #if DEBUG_HEADERS  
 # warning Engine.h included  
 #endif // DEBUG_HEADERS  
   
29  #include <map>  #include <map>
30    #include <gig.h>
31    
32    #include "EngineGlobals.h"
33  #include "../../common/RingBuffer.h"  #include "../../common/RingBuffer.h"
34  #include "../../common/RTELMemoryPool.h"  #include "../../common/Pool.h"
35    #include "../../common/ArrayList.h"
36    #include "../../common/Condition.h"
37  #include "../../common/ConditionServer.h"  #include "../../common/ConditionServer.h"
38  #include "../common/Engine.h"  #include "../Engine.h"
39  #include "../common/Event.h"  #include "../common/Event.h"
 #include "../common/BiquadFilter.h"  
 #include "../../lib/fileloader/libgig/gig.h"  
 #include "InstrumentResourceManager.h"  
40  #include "../../network/lscp.h"  #include "../../network/lscp.h"
41    #include "EngineChannel.h"
42    
43  #define PITCHBEND_SEMITONES             12  // identifier of this sampler engine
44  #define MAX_AUDIO_VOICES                128  #define LS_GIG_ENGINE_NAME "GIG"
 #define SYSEX_BUFFER_SIZE               2048  // 2kB  
 #define VOICE_STEAL_ALGORITHM           voice_steal_algo_oldestkey  ///< @see voice_steal_algo_t for available voice stealing algorithms  
45    
46  namespace LinuxSampler { namespace gig {  namespace LinuxSampler { namespace gig {
47    
     using std::map;  
   
48      // just symbol prototyping      // just symbol prototyping
49      class Voice;      class Voice;
50      class DiskThread;      class DiskThread;
51      class InstrumentResourceManager;      class InstrumentResourceManager;
52        class midi_key_info_t;
53        class EngineChannel;
54    
55      /**      /**
56       * Sampler engine for the Gigasampler format.       * Sampler engine for the Gigasampler format.
57       */       */
58      class gig::Engine : public LinuxSampler::Engine, public InstrumentConsumer {      class Engine : public LinuxSampler::Engine {
59          public:          public:
             // types  
             enum voice_steal_algo_t {  
                 voice_steal_algo_none,  
                 voice_steal_algo_keymask,  
                 voice_steal_algo_oldestkey  
             };  
   
60              // methods              // methods
61              Engine();              Engine();
62             ~Engine();              virtual ~Engine();
63                void Connect(AudioOutputDevice* pAudioOut);
64                void SuspendAll();
65                void ResumeAll();
66                void Suspend(::gig::Region* pRegion);
67                void Resume(::gig::Region* pRegion);
68    
69              // abstract methods derived from class 'LinuxSampler::Engine'              // implementation of abstract methods derived from class 'LinuxSampler::Engine'
70              virtual void   LoadInstrument(const char* FileName, uint Instrument);              virtual int    RenderAudio(uint Samples);
71                virtual void   SendSysex(void* pData, uint Size, MidiInputPort* pSender);
72              virtual void   Reset();              virtual void   Reset();
73              virtual void   Enable();              virtual void   Enable();
74              virtual void   Disable();              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);  
75              virtual uint   VoiceCount();              virtual uint   VoiceCount();
76              virtual uint   VoiceCountMax();              virtual uint   VoiceCountMax();
77              virtual bool   DiskStreamSupported();              virtual bool   DiskStreamSupported();
# Line 99  namespace LinuxSampler { namespace gig { Line 82  namespace LinuxSampler { namespace gig {
82              virtual String Description();              virtual String Description();
83              virtual String Version();              virtual String Version();
84              virtual String EngineName();              virtual String EngineName();
85              virtual String InstrumentFileName();              virtual InstrumentManager* GetInstrumentManager();
86              virtual int    InstrumentIndex();  
87              virtual int    InstrumentStatus();              void SetVoiceCount(uint Count);
88    
89              // abstract methods derived from interface class 'InstrumentConsumer'              // Simple array wrapper just to make sure memory is freed
90              virtual void ResourceToBeUpdated(::gig::Instrument* pResource, void*& pUpdateArg);              // when liblinuxsampler is unloaded
91              virtual void ResourceUpdated(::gig::Instrument* pOldResource, ::gig::Instrument* pNewResource, void* pUpdateArg);              class FloatTable {
92          protected:              private:
93              struct midi_key_info_t {                  const float* array;
94                  RTEList<Voice>* pActiveVoices;  ///< Contains the active voices associated with the MIDI key.              public:
95                  bool            KeyPressed;     ///< Is true if the respective MIDI key is currently pressed.                  FloatTable(const float* array) : array(array) { }
96                  bool            Active;         ///< If the key contains active voices.                  ~FloatTable() { delete[] array; }
97                  bool            ReleaseTrigger; ///< If we have to launch release triggered voice(s) when the key is released                  const float& operator[](int i) const { return array[i]; }
                 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)  
98              };              };
99    
100              static InstrumentResourceManager Instruments;              static const FloatTable VolumeCurve;    ///< Table that maps volume control change values 0..127 to amplitude. Unity gain is at 90.
101                static const FloatTable PanCurve;       ///< Table that maps pan control change values 0..128 to right channel amplitude. Unity gain is at 64 (center).
102                static const FloatTable CrossfadeCurve; ///< Table that maps crossfade control change values 0..127 to amplitude. Unity gain is at 127.
103    
104            //protected:
105                static InstrumentResourceManager instruments;
106    
107              AudioOutputDevice*      pAudioOutputDevice;              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  
108              uint                    SampleRate;            ///< Sample rate of the engines output audio signal (in Hz)              uint                    SampleRate;            ///< Sample rate of the engines output audio signal (in Hz)
109              uint                    MaxSamplesPerCycle;    ///< Size of each audio output buffer              uint                    MaxSamplesPerCycle;    ///< Size of each audio output buffer
110              DiskThread*             pDiskThread;              DiskThread*             pDiskThread;
111              uint8_t                 ControllerTable[128];  ///< Reflects the current values (0-127) of all MIDI controllers for this engine / sampler channel.              RingBuffer<Event,false>* pEventQueue;          ///< Input event queue for engine global events (e.g. SysEx messages).
112              RingBuffer<Event>*      pEventQueue;           ///< Input event queue.              Pool<Voice>*            pVoicePool;            ///< Contains all voices that can be activated.
             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.  
113              EventGenerator*         pEventGenerator;              EventGenerator*         pEventGenerator;
114              RTEList<Event>*         pVoiceStealingQueue;   ///< All voice-launching events which had to be postponed due to free voice shortage.              RTList<Event>*          pVoiceStealingQueue;   ///< All voice-launching events which had to be postponed due to free voice shortage.
115              RTEList<Event>*         pEvents;               ///< All events for the current audio fragment.              RTList<Event>*          pGlobalEvents;         ///< All engine global events for the current audio fragment (usually only SysEx messages).
116              RTEList<Event>*         pCCEvents;             ///< All control change events for the current audio fragment.              Pool<Event>*            pEventPool;            ///< Contains all Event objects that can be used.
117              RTEList<Event>*         pSynthesisEvents[Event::destination_count];     ///< Events directly affecting synthesis parameter (like pitch, volume and filter).              RingBuffer<uint8_t,false>* pSysexBuffer;       ///< Input buffer for MIDI system exclusive messages.
118              float*                  pSynthesisParameters[Event::destination_count]; ///< Matrix with final synthesis parameters for the current audio fragment which will be used in the main synthesis loop.              int                     ActiveVoiceCountTemp;  ///< number of currently active voices (for internal usage, will be used for incrementation)
             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  
119              int                     ActiveVoiceCountMax;   ///< the maximum voice usage since application start              int                     ActiveVoiceCountMax;   ///< the maximum voice usage since application start
120                int                     VoiceSpawnsLeft;       ///< We only allow CONFIG_MAX_VOICES voices to be spawned per audio fragment, we use this variable to ensure this limit.
121                RTList<Voice>::Iterator itLastStolenVoice;     ///< Only for voice stealing: points to the last voice which was theft in current audio fragment, NULL otherwise.
122                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.
123                EngineChannel*          pLastStolenChannel;    ///< Only for voice stealing: points to the engine channel on which the previous voice was stolen in this audio fragment.
124                RTList<Voice>::Iterator itLastStolenVoiceGlobally; ///< Same as itLastStolenVoice, but engine globally
125                RTList<uint>::Iterator  iuiLastStolenKeyGlobally;  ///< Same as iuiLastStolenKey, but engine globally
126              bool                    SuspensionRequested;              bool                    SuspensionRequested;
127              ConditionServer         EngineDisabled;              ConditionServer         EngineDisabled;
             String                  InstrumentFile;  
             int                     InstrumentIdx;  
             int                     InstrumentStat;  
128              int8_t                  ScaleTuning[12];       ///< contains optional detune factors (-64..+63 cents) for all 12 semitones of an octave              int8_t                  ScaleTuning[12];       ///< contains optional detune factors (-64..+63 cents) for all 12 semitones of an octave
129              Voice*                  pLastStolenVoice;      ///< Only for voice stealing: points to the last voice which was theft in current audio fragment, NULL otherwise.              int                     MinFadeOutSamples;     ///< The number of samples needed to make an instant fade out (e.g. for voice stealing) without leading to clicks.
130              uint*                   puiLastStolenKey;      ///< Only for voice stealing: key number of last key on which the last voice was theft in current audio fragment, NULL otherwise.              uint32_t                RandomSeed;            ///< State of the random number generator used by the random dimension.
131                Mutex                   ResetInternalMutex;    ///< Mutex to protect the ResetInternal function for concurrent usage (e.g. by the lscp and instrument loader threads).
132              void ProcessNoteOn(Event* pNoteOnEvent);              Pool< ::gig::DimensionRegion*>* pDimRegionPool[2]; ///< Double buffered pool, used by the engine channels to keep track of dimension regions in use.
133              void ProcessNoteOff(Event* pNoteOffEvent);  
134              void ProcessPitchbend(Event* pPitchbendEvent);              void ProcessEvents(EngineChannel* pEngineChannel, uint Samples);
135              void ProcessControlChange(Event* pControlChangeEvent);              void RenderActiveVoices(EngineChannel* pEngineChannel, uint Samples);
136              void ProcessSysex(Event* pSysexEvent);              void RenderStolenVoices(uint Samples);
137              Voice* LaunchVoice(Event* pNoteOnEvent, int iLayer = 0, bool ReleaseTriggerVoice = false, bool VoiceStealing = true);              void RouteAudio(EngineChannel* pEngineChannel, uint Samples);
138              void StealVoice(Event* pNoteOnEvent, int iLayer, bool ReleaseTriggerVoice);              void PostProcess(EngineChannel* pEngineChannel);
139              void KillVoiceImmediately(Voice* pVoice);              void ClearEventLists();
140              void ResetSynthesisParameters(Event::destination_t dst, float val);              void ImportEvents(uint Samples);
141                void ProcessNoteOn(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent);
142                void ProcessNoteOff(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOffEvent);
143                void ProcessPitchbend(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itPitchbendEvent);
144                void ProcessControlChange(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itControlChangeEvent);
145                void ProcessSysex(Pool<Event>::Iterator& itSysexEvent);
146                void ProcessSuspensionsChanges();
147                void ProcessPendingStreamDeletions();
148                Pool<Voice>::Iterator LaunchVoice(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing, bool HandleKeyGroupConflicts);
149                int  StealVoice(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent);
150                void FreeVoice(EngineChannel* pEngineChannel, Pool<Voice>::Iterator& itVoice);
151                void FreeKey(EngineChannel* pEngineChannel, midi_key_info_t* pKey);
152              void ResetInternal();              void ResetInternal();
153                void ResetScaleTuning();
154                void ResetSuspendedRegions();
155    
156                static Engine* AcquireEngine(LinuxSampler::gig::EngineChannel* pChannel, AudioOutputDevice* pDevice);
157                static void    FreeEngine(LinuxSampler::gig::EngineChannel* pChannel, AudioOutputDevice* pDevice);
158    
159                void DisableAndLock(); // FIXME: should at least be protected
160    
161              friend class Voice;              friend class Voice;
             friend class EGADSR;  
             friend class EGDecay;  
             friend class VCAManipulator;  
             friend class VCFCManipulator;  
             friend class VCOManipulator;  
             friend class InstrumentResourceManager;  
162          private:          private:
163              void    DisableAndLock();              Pool< ::gig::Region*> SuspendedRegions;
164              uint8_t GSCheckSum(const RingBuffer<uint8_t>::NonVolatileReader AddrReader, uint DataSize);              Mutex                 SuspendedRegionsMutex;
165                Condition             SuspensionChangeOngoing;
166                ::gig::Region*        pPendingRegionSuspension;
167                ::gig::Region*        pPendingRegionResumption;
168                int                   iPendingStreamDeletions;
169    
170                ArrayList<EngineChannel*> engineChannels; ///< All engine channels of a gig::Engine instance.
171    
172                static std::map<AudioOutputDevice*,Engine*> engines; ///< All instances of gig::Engine.
173    
174                int SostenutoKeys[128];
175                int SostenutoKeyCount;
176    
177                uint8_t GSCheckSum(const RingBuffer<uint8_t,false>::NonVolatileReader AddrReader, uint DataSize);
178              void    AdjustScale(int8_t ScaleTunes[12]);              void    AdjustScale(int8_t ScaleTunes[12]);
179                void    ReleaseAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itReleaseEvent);
180                void    KillAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itKillEvent);
181                bool    ShouldReleaseVoice(EngineChannel* pEngineChannel, int Key);
182                bool    RegionSuspended(::gig::Region* pRegion);
183                static float* InitVolumeCurve();
184                static float* InitPanCurve();
185                static float* InitCrossfadeCurve();
186                static float* InitCurve(const float* segments, int size = 128);
187    
188                unsigned long FrameTime; ///< Time in frames of the start of the current audio fragment
189    
190                atomic_t ActiveVoiceCount; ///< number of currently active voices
191                
192      };      };
193    
194  }} // namespace LinuxSampler::gig  }} // namespace LinuxSampler::gig
Legend:
Removed from v.250  
changed lines
  Added in v.1789
  ViewVC Help
Powered by ViewVC