/[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 268 by capela, Thu Oct 7 22:20:20 2004 UTC revision 947 by schoenebeck, Mon Nov 27 21:34:55 2006 UTC
# Line 3  Line 3 
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, 2006 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/ConditionServer.h"  #include "../../common/ConditionServer.h"
37  #include "../common/Engine.h"  #include "../Engine.h"
38  #include "../common/Event.h"  #include "../common/Event.h"
 #include "../common/BiquadFilter.h"  
 #include "../../lib/fileloader/libgig/gig.h"  
 #include "InstrumentResourceManager.h"  
39  #include "../../network/lscp.h"  #include "../../network/lscp.h"
40    #include "EngineChannel.h"
41    
42  #define PITCHBEND_SEMITONES             12  // identifier of this sampler engine
43  #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  
44    
45  namespace LinuxSampler { namespace gig {  namespace LinuxSampler { namespace gig {
46    
     using std::map;  
   
47      // just symbol prototyping      // just symbol prototyping
48      class Voice;      class Voice;
49      class DiskThread;      class DiskThread;
50      class InstrumentResourceManager;      class InstrumentResourceManager;
51        class midi_key_info_t;
52        class EngineChannel;
53    
54      /**      /**
55       * Sampler engine for the Gigasampler format.       * Sampler engine for the Gigasampler format.
56       */       */
57      class Engine : public LinuxSampler::Engine, public InstrumentConsumer {      class Engine : public LinuxSampler::Engine {
58          public:          public:
             // types  
             enum voice_steal_algo_t {  
                 voice_steal_algo_none,  
                 voice_steal_algo_keymask,  
                 voice_steal_algo_oldestkey  
             };  
   
59              // methods              // methods
60              Engine();              Engine();
61             ~Engine();              virtual ~Engine();
62                void Connect(AudioOutputDevice* pAudioOut);
63    
64              // abstract methods derived from class 'LinuxSampler::Engine'              // implementation of abstract methods derived from class 'LinuxSampler::Engine'
65              virtual void   LoadInstrument(const char* FileName, uint Instrument);              virtual int    RenderAudio(uint Samples);
66                virtual void   SendSysex(void* pData, uint Size);
67              virtual void   Reset();              virtual void   Reset();
68              virtual void   Enable();              virtual void   Enable();
69              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);  
70              virtual uint   VoiceCount();              virtual uint   VoiceCount();
71              virtual uint   VoiceCountMax();              virtual uint   VoiceCountMax();
72              virtual bool   DiskStreamSupported();              virtual bool   DiskStreamSupported();
# Line 99  namespace LinuxSampler { namespace gig { Line 77  namespace LinuxSampler { namespace gig {
77              virtual String Description();              virtual String Description();
78              virtual String Version();              virtual String Version();
79              virtual String EngineName();              virtual String EngineName();
80              virtual String InstrumentFileName();              virtual InstrumentManager* GetInstrumentManager();
             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)  
             };  
81    
82              static InstrumentResourceManager Instruments;              static const float* VolumeCurve;    ///< Table that maps volume control change values 0..127 to amplitude. Unity gain is at 90.
83                static const float* PanCurve;       ///< Table that maps pan control change values 0..128 to right channel amplitude. Unity gain is at 64 (center).
84                static const float* CrossfadeCurve; ///< Table that maps crossfade control change values 0..127 to amplitude. Unity gain is at 127.
85    
86            //protected:
87                static InstrumentResourceManager instruments;
88    
89              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  
90              uint                    SampleRate;            ///< Sample rate of the engines output audio signal (in Hz)              uint                    SampleRate;            ///< Sample rate of the engines output audio signal (in Hz)
91              uint                    MaxSamplesPerCycle;    ///< Size of each audio output buffer              uint                    MaxSamplesPerCycle;    ///< Size of each audio output buffer
92              DiskThread*             pDiskThread;              DiskThread*             pDiskThread;
93              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 for engine global events (e.g. SysEx messages).
94              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.  
95              EventGenerator*         pEventGenerator;              EventGenerator*         pEventGenerator;
96              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.
97              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).
98              RTEList<Event>*         pCCEvents;             ///< All control change events for the current audio fragment.              Pool<Event>*            pEventPool;            ///< Contains all Event objects that can be used.
99              RTEList<Event>*         pSynthesisEvents[Event::destination_count];     ///< Events directly affecting synthesis parameter (like pitch, volume and filter).              RingBuffer<uint8_t>*    pSysexBuffer;          ///< Input buffer for MIDI system exclusive messages.
100              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                     ActiveVoiceCount;      ///< number of currently active voices (this value will be returned for public calls)
101              biquad_param_t*         pBasicFilterParameters; ///< Biquad parameters of the basic bandpass filter.              int                     ActiveVoiceCountTemp;  ///< number of currently active voices (for internal usage, will be used for incrementation)
             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  
102              int                     ActiveVoiceCountMax;   ///< the maximum voice usage since application start              int                     ActiveVoiceCountMax;   ///< the maximum voice usage since application start
103                int                     VoiceSpawnsLeft;       ///< We only allow CONFIG_MAX_VOICES voices to be spawned per audio fragment, we use this variable to ensure this limit.
104                RTList<Voice>::Iterator itLastStolenVoice;     ///< Only for voice stealing: points to the last voice which was theft in current audio fragment, NULL otherwise.
105                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.
106                EngineChannel*          pLastStolenChannel;    ///< Only for voice stealing: points to the engine channel on which the previous voice was stolen in this audio fragment.
107                RTList<Voice>::Iterator itLastStolenVoiceGlobally; ///< Same as itLastStolenVoice, but engine globally
108                RTList<uint>::Iterator  iuiLastStolenKeyGlobally;  ///< Same as iuiLastStolenKey, but engine globally
109              bool                    SuspensionRequested;              bool                    SuspensionRequested;
110              ConditionServer         EngineDisabled;              ConditionServer         EngineDisabled;
             String                  InstrumentFile;  
             int                     InstrumentIdx;  
             int                     InstrumentStat;  
111              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
112              Voice*                  pLastStolenVoice;      ///< Only for voice stealing: points to the last voice which was theft in current audio fragment, NULL otherwise.              int                     MaxFadeOutPos;         ///< The last position in an audio fragment to allow an instant fade out (e.g. for voice stealing) without leading to clicks.
113              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.
114                Mutex                   ResetInternalMutex;    ///< Mutex to protect the ResetInternal function for concurrent usage (e.g. by the lscp and instrument loader threads).
115              void ProcessNoteOn(Event* pNoteOnEvent);  
116              void ProcessNoteOff(Event* pNoteOffEvent);              void ProcessEvents(EngineChannel* pEngineChannel, uint Samples);
117              void ProcessPitchbend(Event* pPitchbendEvent);              void RenderActiveVoices(EngineChannel* pEngineChannel, uint Samples);
118              void ProcessControlChange(Event* pControlChangeEvent);              void RenderStolenVoices(uint Samples);
119              void ProcessSysex(Event* pSysexEvent);              void PostProcess(EngineChannel* pEngineChannel);
120              Voice* LaunchVoice(Event* pNoteOnEvent, int iLayer = 0, bool ReleaseTriggerVoice = false, bool VoiceStealing = true);              void ClearEventLists();
121              void StealVoice(Event* pNoteOnEvent, int iLayer, bool ReleaseTriggerVoice);              void ImportEvents(uint Samples);
122              void KillVoiceImmediately(Voice* pVoice);              void ProcessNoteOn(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent);
123              void ResetSynthesisParameters(Event::destination_t dst, float val);              void ProcessNoteOff(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOffEvent);
124                void ProcessPitchbend(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itPitchbendEvent);
125                void ProcessControlChange(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itControlChangeEvent);
126                void ProcessSysex(Pool<Event>::Iterator& itSysexEvent);
127                Pool<Voice>::Iterator LaunchVoice(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing, bool HandleKeyGroupConflicts);
128                int  StealVoice(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent);
129                void FreeVoice(EngineChannel* pEngineChannel, Pool<Voice>::Iterator& itVoice);
130                void FreeKey(EngineChannel* pEngineChannel, midi_key_info_t* pKey);
131              void ResetInternal();              void ResetInternal();
132                void ResetScaleTuning();
133    
134                static Engine* AcquireEngine(LinuxSampler::gig::EngineChannel* pChannel, AudioOutputDevice* pDevice);
135                static void    FreeEngine(LinuxSampler::gig::EngineChannel* pChannel, AudioOutputDevice* pDevice);
136    
137                void DisableAndLock(); // FIXME: should at least be protected
138    
139              friend class Voice;              friend class Voice;
             friend class EGADSR;  
             friend class EGDecay;  
             friend class VCAManipulator;  
             friend class VCFCManipulator;  
             friend class VCOManipulator;  
             friend class InstrumentResourceManager;  
140          private:          private:
141              void    DisableAndLock();              ArrayList<EngineChannel*> engineChannels; ///< All engine channels of a gig::Engine instance.
142    
143                static std::map<AudioOutputDevice*,Engine*> engines; ///< All instances of gig::Engine.
144    
145                int SostenutoKeys[128];
146                int SostenutoKeyCount;
147    
148              uint8_t GSCheckSum(const RingBuffer<uint8_t>::NonVolatileReader AddrReader, uint DataSize);              uint8_t GSCheckSum(const RingBuffer<uint8_t>::NonVolatileReader AddrReader, uint DataSize);
149              void    AdjustScale(int8_t ScaleTunes[12]);              void    AdjustScale(int8_t ScaleTunes[12]);
150                void    ReleaseAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itReleaseEvent);
151                void    KillAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itKillEvent);
152                bool    ShouldReleaseVoice(EngineChannel* pEngineChannel, int Key);
153                static float* InitVolumeCurve();
154                static float* InitPanCurve();
155                static float* InitCrossfadeCurve();
156                static float* InitCurve(const float* segments, int size = 128);
157    
158                unsigned long FrameTime; ///< Time in frames of the start of the current audio fragment
159      };      };
160    
161  }} // namespace LinuxSampler::gig  }} // namespace LinuxSampler::gig
Legend:
Removed from v.268  
changed lines
  Added in v.947
  ViewVC Help
Powered by ViewVC