/[svn]/linuxsampler/trunk/src/engines/gig/Engine.cpp

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

Parent Directory | Revision Log | View Patch Patch

-revision 123 by schoenebeck,
Mon Jun 14 19:33:16 2004 UTC
+revision 1764 by persson,
Sat Sep  6 14:55:18 2008 UTC
 Line 2
   *                                                                         *
   *   LinuxSampler - modular, streaming capable sampler                     *
   *                                                                         *
-  *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
+  *   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  *
-Line 23
+Line 24
  #include <sstream>
  #include "DiskThread.h"
  #include "Voice.h"
+ #include "EGADSR.h"
+ #include "../EngineFactory.h"
  #include "Engine.h"
+ #include "../../common/global_private.h"
  namespace LinuxSampler { namespace gig {
-     InstrumentResourceManager Engine::Instruments;
+     InstrumentResourceManager Engine::instruments;
+     std::map<AudioOutputDevice*,Engine*> Engine::engines;
+     /**
+      * Get a gig::Engine object for the given gig::EngineChannel and the
+      * given AudioOutputDevice. All engine channels which are connected to
+      * the same audio output device will use the same engine instance. This
+      * method will be called by a gig::EngineChannel whenever it's
+      * connecting to a audio output device.
+      *
+      * @param pChannel - engine channel which acquires an engine object
+      * @param pDevice  - the audio output device \a pChannel is connected to
+      */
+     Engine* Engine::AcquireEngine(LinuxSampler::gig::EngineChannel* pChannel, AudioOutputDevice* pDevice) {
+         Engine* pEngine = NULL;
+         // check if there's already an engine for the given audio output device
+         if (engines.count(pDevice)) {
+             dmsg(4,("Using existing gig::Engine.\n"));
+             pEngine = engines[pDevice];
+             // Disable the engine while the new engine channel is
+             // added and initialized. The engine will be enabled again
+             // in EngineChannel::Connect.
+             pEngine->DisableAndLock();
+         } else { // create a new engine (and disk thread) instance for the given audio output device
+             dmsg(4,("Creating new gig::Engine.\n"));
+             pEngine = (Engine*) EngineFactory::Create("gig");
+             pEngine->Connect(pDevice);
+             engines[pDevice] = pEngine;
+         }
+         // register engine channel to the engine instance
+         pEngine->engineChannels.add(pChannel);
+         // remember index in the ArrayList
+         pChannel->iEngineIndexSelf = pEngine->engineChannels.size() - 1;
+         dmsg(4,("This gig::Engine has now %d EngineChannels.\n",pEngine->engineChannels.size()));
+         return pEngine;
+     }
+     /**
+      * Once an engine channel is disconnected from an audio output device,
+      * it will immediately call this method to unregister itself from the
+      * engine instance and if that engine instance is not used by any other
+      * engine channel anymore, then that engine instance will be destroyed.
+      *
+      * @param pChannel - engine channel which wants to disconnect from it's
+      *                   engine instance
+      * @param pDevice  - audio output device \a pChannel was connected to
+      */
+     void Engine::FreeEngine(LinuxSampler::gig::EngineChannel* pChannel, AudioOutputDevice* pDevice) {
+         dmsg(4,("Disconnecting EngineChannel from gig::Engine.\n"));
+         Engine* pEngine = engines[pDevice];
+         // unregister EngineChannel from the Engine instance
+         pEngine->engineChannels.remove(pChannel);
+         // if the used Engine instance is not used anymore, then destroy it
+         if (pEngine->engineChannels.empty()) {
+             pDevice->Disconnect(pEngine);
+             engines.erase(pDevice);
+             delete pEngine;
+             dmsg(4,("Destroying gig::Engine.\n"));
+         }
+         else dmsg(4,("This gig::Engine has now %d EngineChannels.\n",pEngine->engineChannels.size()));
+     }
-     Engine::Engine() {
+     /**
-         pRIFF              = NULL;
+      * Constructor
-         pGig               = NULL;
+      */
-         pInstrument        = NULL;
+     Engine::Engine() : SuspendedRegions(128) {
          pAudioOutputDevice = NULL;
          pDiskThread        = NULL;
          pEventGenerator    = NULL;
-         pEventQueue        = new RingBuffer<Event>(MAX_EVENTS_PER_FRAGMENT);
+         pSysexBuffer       = new RingBuffer<uint8_t,false>(CONFIG_SYSEX_BUFFER_SIZE, 0);
-         pEventPool         = new RTELMemoryPool<Event>(MAX_EVENTS_PER_FRAGMENT);
+         pEventQueue        = new RingBuffer<Event,false>(CONFIG_MAX_EVENTS_PER_FRAGMENT, 0);
-         pVoicePool         = new RTELMemoryPool<Voice>(MAX_AUDIO_VOICES);
+         pEventPool         = new Pool<Event>(CONFIG_MAX_EVENTS_PER_FRAGMENT);
-         pActiveKeys        = new RTELMemoryPool<uint>(128);
+         pVoicePool         = new Pool<Voice>(CONFIG_MAX_VOICES);
-         pEvents            = new RTEList<Event>(pEventPool);
+         pDimRegionPool[0]  = new Pool< ::gig::DimensionRegion*>(CONFIG_MAX_VOICES);
-         pCCEvents          = new RTEList<Event>(pEventPool);
+         pDimRegionPool[1]  = new Pool< ::gig::DimensionRegion*>(CONFIG_MAX_VOICES);
-         for (uint i = 0; i < Event::destination_count; i++) {
+         pVoiceStealingQueue = new RTList<Event>(pEventPool);
-             pSynthesisEvents[i] = new RTEList<Event>(pEventPool);
+         pGlobalEvents      = new RTList<Event>(pEventPool);
-         }
-         for (uint i = 0; i < 128; i++) {
+         for (RTList<Voice>::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) {
-             pMIDIKeyInfo[i].pActiveVoices = new RTEList<Voice>(pVoicePool);
+             iterVoice->SetEngine(this);
-             pMIDIKeyInfo[i].KeyPressed    = false;
-             pMIDIKeyInfo[i].Active        = false;
-             pMIDIKeyInfo[i].pSelf         = NULL;
-             pMIDIKeyInfo[i].pEvents       = new RTEList<Event>(pEventPool);
-         }
-         for (Voice* pVoice = pVoicePool->alloc(); pVoice; pVoice = pVoicePool->alloc()) {
-             pVoice->SetEngine(this);
          }
          pVoicePool->clear();
-         pSynthesisParameters[0] = NULL; // we allocate when an audio device is connected
-         pBasicFilterParameters  = NULL;
-         pMainFilterParameters   = NULL;
-         InstrumentIdx = -1;
          ResetInternal();
+         ResetScaleTuning();
+         ResetSuspendedRegions();
      }
+     /**
+      * Destructor
+      */
      Engine::~Engine() {
+         MidiInputPort::RemoveSysexListener(this);
          if (pDiskThread) {
+             dmsg(1,("Stopping disk thread..."));
              pDiskThread->StopThread();
              delete pDiskThread;
+             dmsg(1,("OK\n"));
          }
-         if (pGig)  delete pGig;
-         if (pRIFF) delete pRIFF;
-         for (uint i = 0; i < 128; i++) {
-             if (pMIDIKeyInfo[i].pActiveVoices) delete pMIDIKeyInfo[i].pActiveVoices;
-             if (pMIDIKeyInfo[i].pEvents)       delete pMIDIKeyInfo[i].pEvents;
-         }
-         for (uint i = 0; i < Event::destination_count; i++) {
-             if (pSynthesisEvents[i]) delete pSynthesisEvents[i];
-         }
-         delete[] pSynthesisEvents;
-         if (pEvents)     delete pEvents;
-         if (pCCEvents)   delete pCCEvents;
          if (pEventQueue) delete pEventQueue;
          if (pEventPool)  delete pEventPool;
-         if (pVoicePool)  delete pVoicePool;
+         if (pVoicePool) {
-         if (pActiveKeys) delete pActiveKeys;
+             pVoicePool->clear();
+             delete pVoicePool;
+         }
          if (pEventGenerator) delete pEventGenerator;
-         if (pMainFilterParameters) delete[] pMainFilterParameters;
+         if (pVoiceStealingQueue) delete pVoiceStealingQueue;
-         if (pBasicFilterParameters) delete[] pBasicFilterParameters;
+         if (pSysexBuffer) delete pSysexBuffer;
-         if (pSynthesisParameters[0]) delete[] pSynthesisParameters[0];
+         if (pGlobalEvents) delete pGlobalEvents;
+         if (pDimRegionPool[0]) delete pDimRegionPool[0];
+         if (pDimRegionPool[1]) delete pDimRegionPool[1];
+         ResetSuspendedRegions();
+         Unregister();
      }
      void Engine::Enable() {
-Line 100 
 namespace LinuxSampler { namespace gig {
+Line 156 
 namespace LinuxSampler { namespace gig {
          dmsg(3,("gig::Engine: enabled (val=%d)\n", EngineDisabled.GetUnsafe()));
      }
+     /**
+      * Temporarily stop the engine to not do anything. The engine will just be
+      * frozen during that time, that means after enabling it again it will
+      * continue where it was, with all its voices and playback state it had at
+      * the point of disabling. Notice that the engine's (audio) thread will
+      * continue to run, it just remains in an inactive loop during that time.
+      *
+      * If you need to be sure that all voices and disk streams are killed as
+      * well, use @c SuspendAll() instead.
+      *
+      * @see Enable(), SuspendAll()
+      */
      void Engine::Disable() {
          dmsg(3,("gig::Engine: disabling\n"));
          bool* pWasDisabled = EngineDisabled.PushAndUnlock(true, 2); // wait max. 2s
-Line 113 
 namespace LinuxSampler { namespace gig {
+Line 181 
 namespace LinuxSampler { namespace gig {
      }
      /**
-      *  Reset all voices and disk thread and clear input event queue and all
+      * Similar to @c Disable() but this method additionally kills all voices
-      *  control and status variables.
+      * and disk streams and blocks until all voices and disk streams are actually
+      * killed / deleted.
+      *
+      * @e Note: only the original calling thread is able to re-enable the
+      * engine afterwards by calling @c ResumeAll() later on!
       */
-     void Engine::Reset() {
+     void Engine::SuspendAll() {
+         dmsg(2,("gig::Engine: Suspending all ...\n"));
+         // stop the engine, so we can safely modify the engine's
+         // data structures from this foreign thread
          DisableAndLock();
+         // we could also use the respective class member variable here,
+         // but this is probably safer and cleaner
+         int iPendingStreamDeletions = 0;
+         // kill all voices on all engine channels the *die hard* way
+         for (int iChannel = 0; iChannel < engineChannels.size(); iChannel++) {
+             EngineChannel* pEngineChannel = engineChannels[iChannel];
+             RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
+             RTList<uint>::Iterator end    = pEngineChannel->pActiveKeys->end();
+             for (; iuiKey != end; ++iuiKey) { // iterate through all active keys
+                 midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
+                 RTList<Voice>::Iterator itVoice = pKey->pActiveVoices->first();
+                 RTList<Voice>::Iterator itVoicesEnd = pKey->pActiveVoices->end();
+                 for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key
+                     // request a notification from disk thread side for stream deletion
+                     const Stream::Handle hStream = itVoice->KillImmediately(true);
+                     if (hStream != Stream::INVALID_HANDLE) { // voice actually used a stream
+                         iPendingStreamDeletions++;
+                     }
+                 }
+             }
+         }
+         // wait until all streams were actually deleted by the disk thread
+         while (iPendingStreamDeletions) {
+             while (
+                 iPendingStreamDeletions &&
+                 pDiskThread->AskForDeletedStream() != Stream::INVALID_HANDLE
+             ) iPendingStreamDeletions--;
+             if (!iPendingStreamDeletions) break;
+             usleep(10000); // sleep for 10ms
+         }
+         dmsg(2,("gig::Engine: Everything suspended.\n"));
+     }
-         //if (pAudioOutputDevice->IsPlaying()) { // if already running
+     /**
-             /*
+      * At the moment same as calling @c Enable() directly, but this might
-             // signal audio thread not to enter render part anymore
+      * change in future, so better call this method as counterpart to
-             SuspensionRequested = true;
+      * @c SuspendAll() instead of @c Enable() !
-             // sleep until wakened by audio thread
+      */
-             pthread_mutex_lock(&__render_state_mutex);
+     void Engine::ResumeAll() {
-             pthread_cond_wait(&__render_exit_condition, &__render_state_mutex);
+         Enable();
-             pthread_mutex_unlock(&__render_state_mutex);
+     }
-             */
-         //}
-         //if (wasplaying) pAudioOutputDevice->Stop();
+     /**
+      * Order the engine to stop rendering audio for the given region.
+      * Additionally this method will block until all voices and their disk
+      * streams associated with that region are actually killed / deleted, so
+      * one can i.e. safely modify the region with an instrument editor after
+      * returning from this method.
+      *
+      * @param pRegion - region the engine shall stop using
+      */
+     void Engine::Suspend(::gig::Region* pRegion) {
+         dmsg(2,("gig::Engine: Suspending Region %x ...\n",pRegion));
+         SuspendedRegionsMutex.Lock();
+         SuspensionChangeOngoing.Set(true);
+         pPendingRegionSuspension = pRegion;
+         SuspensionChangeOngoing.WaitAndUnlockIf(true);
+         SuspendedRegionsMutex.Unlock();
+         dmsg(2,("gig::Engine: Region %x suspended.",pRegion));
+     }
-         ResetInternal();
+     /**
+      * Orders the engine to resume playing back the given region, previously
+      * suspended with @c Suspend() .
+      *
+      * @param pRegion - region the engine shall be allowed to use again
+      */
+     void Engine::Resume(::gig::Region* pRegion) {
+         dmsg(2,("gig::Engine: Resuming Region %x ...\n",pRegion));
+         SuspendedRegionsMutex.Lock();
+         SuspensionChangeOngoing.Set(true);
+         pPendingRegionResumption = pRegion;
+         SuspensionChangeOngoing.WaitAndUnlockIf(true);
+         SuspendedRegionsMutex.Unlock();
+         dmsg(2,("gig::Engine: Region %x resumed.\n",pRegion));
+     }
-         // signal audio thread to continue with rendering
+     /**
-         //SuspensionRequested = false;
+      *  Reset all voices and disk thread and clear input event queue and all
+      *  control and status variables.
+      */
+     void Engine::Reset() {
+         DisableAndLock();
+         ResetInternal();
+         ResetScaleTuning();
          Enable();
      }
      /**
       *  Reset all voices and disk thread and clear input event queue and all
-      *  control and status variables. This method is not thread safe!
+      *  control and status variables. This method is protected by a mutex.
       */
      void Engine::ResetInternal() {
-         Pitch               = 0;
+         ResetInternalMutex.Lock();
-         SustainPedal        = false;
+         // make sure that the engine does not get any sysex messages
+         // while it's reseting
+         bool sysexDisabled = MidiInputPort::RemoveSysexListener(this);
          ActiveVoiceCount    = 0;
          ActiveVoiceCountMax = 0;
-         // set all MIDI controller values to zero
+         // reset voice stealing parameters
-         memset(ControllerTable, 0x00, 128);
+         pVoiceStealingQueue->clear();
+         itLastStolenVoice          = RTList<Voice>::Iterator();
-         // reset key info
+         itLastStolenVoiceGlobally  = RTList<Voice>::Iterator();
-         for (uint i = 0; i < 128; i++) {
+         iuiLastStolenKey           = RTList<uint>::Iterator();
-             pMIDIKeyInfo[i].pActiveVoices->clear();
+         iuiLastStolenKeyGlobally   = RTList<uint>::Iterator();
-             pMIDIKeyInfo[i].pEvents->clear();
+         pLastStolenChannel         = NULL;
-             pMIDIKeyInfo[i].KeyPressed = false;
-             pMIDIKeyInfo[i].Active     = false;
-             pMIDIKeyInfo[i].pSelf      = NULL;
-         }
          // reset all voices
-         for (Voice* pVoice = pVoicePool->alloc(); pVoice; pVoice = pVoicePool->alloc()) {
+         for (RTList<Voice>::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) {
-             pVoice->Reset();
+             iterVoice->Reset();
          }
          pVoicePool->clear();
-         // free all active keys
-         pActiveKeys->clear();
          // reset disk thread
          if (pDiskThread) pDiskThread->Reset();
          // delete all input events
          pEventQueue->init();
+         pSysexBuffer->init();
+         if (sysexDisabled) MidiInputPort::AddSysexListener(this);
+         ResetInternalMutex.Unlock();
      }
      /**
-      *  Load an instrument from a .gig file.
+      * Reset to normal, chromatic scale (means equal tempered).
-      *
-      *  @param FileName   - file name of the Gigasampler instrument file
-      *  @param Instrument - index of the instrument in the .gig file
-      *  @throws LinuxSamplerException  on error
-      *  @returns          detailed description of the method call result
       */
-     void Engine::LoadInstrument(const char* FileName, uint Instrument) {
+     void Engine::ResetScaleTuning() {
+         memset(&ScaleTuning[0], 0x00, 12);
-         DisableAndLock();
-         ResetInternal(); // reset engine
-         // free old instrument
-         if (pInstrument) {
-             // give old instrument back to instrument manager
-             Instruments.HandBack(pInstrument, this);
-         }
-         InstrumentIdx = -1;
-         // request gig instrument from instrument manager
-         try {
-             instrument_id_t instrid;
-             instrid.FileName    = FileName;
-             instrid.iInstrument = Instrument;
-             pInstrument = Instruments.Borrow(instrid, this);
-             if (!pInstrument) {
-                 dmsg(1,("no instrument loaded!!!\n"));
-                 exit(EXIT_FAILURE);
-             }
-         }
-         catch (RIFF::Exception e) {
-             String msg = "gig::Engine error: Failed to load instrument, cause: " + e.Message;
-             throw LinuxSamplerException(msg);
-         }
-         catch (InstrumentResourceManagerException e) {
-             String msg = "gig::Engine error: Failed to load instrument, cause: " + e.Message();
-             throw LinuxSamplerException(msg);
-         }
-         catch (...) {
-             throw LinuxSamplerException("gig::Engine error: Failed to load instrument, cause: Unknown exception while trying to parse gig file.");
-         }
-         InstrumentFile = FileName;
-         InstrumentIdx = Instrument;
-         // inform audio driver for the need of two channels
-         try {
-             if (pAudioOutputDevice) pAudioOutputDevice->AcquireChannels(2); // gig Engine only stereo
-         }
-         catch (AudioOutputException e) {
-             String msg = "Audio output device unable to provide 2 audio channels, cause: " + e.Message();
-             throw LinuxSamplerException(msg);
-         }
-         Enable();
      }
-     /**
+     void Engine::ResetSuspendedRegions() {
-      * Will be called by the InstrumentResourceManager when the instrument
+         SuspendedRegions.clear();
-      * we are currently using in this engine is going to be updated, so we
+         iPendingStreamDeletions = 0;
-      * can stop playback before that happens.
+         pPendingRegionSuspension = pPendingRegionResumption = NULL;
-      */
+         SuspensionChangeOngoing.Set(false);
-     void Engine::ResourceToBeUpdated(::gig::Instrument* pResource, void*& pUpdateArg) {
-         dmsg(3,("gig::Engine: Received instrument update message.\n"));
-         DisableAndLock();
-         ResetInternal();
-         this->pInstrument = NULL;
      }
      /**
-      * Will be called by the InstrumentResourceManager when the instrument
+      * Connect this engine instance with the given audio output device.
-      * update process was completed, so we can continue with playback.
+      * This method will be called when an Engine instance is created.
+      * All of the engine's data structures which are dependant to the used
+      * audio output device / driver will be (re)allocated and / or
+      * adjusted appropriately.
+      *
+      * @param pAudioOut - audio output device to connect to
       */
-     void Engine::ResourceUpdated(::gig::Instrument* pOldResource, ::gig::Instrument* pNewResource, void* pUpdateArg) {
-         this->pInstrument = pNewResource;
-         Enable();
-     }
      void Engine::Connect(AudioOutputDevice* pAudioOut) {
          pAudioOutputDevice = pAudioOut;
-Line 269 
 namespace LinuxSampler { namespace gig {
+Line 352 
 namespace LinuxSampler { namespace gig {
          }
          catch (AudioOutputException e) {
              String msg = "Audio output device unable to provide 2 audio channels, cause: " + e.Message();
-             throw LinuxSamplerException(msg);
+             throw Exception(msg);
+         }
+         this->MaxSamplesPerCycle = pAudioOutputDevice->MaxSamplesPerCycle();
+         this->SampleRate         = pAudioOutputDevice->SampleRate();
+         MinFadeOutSamples = int(double(SampleRate) * CONFIG_EG_MIN_RELEASE_TIME) - 1;
+         if (MaxSamplesPerCycle < MinFadeOutSamples) {
+             std::cerr << "gig::Engine: WARNING, CONFIG_EG_MIN_RELEASE_TIME "
+                       << "too big for current audio fragment size & sampling rate! "
+                       << "May lead to click sounds if voice stealing chimes in!\n" << std::flush;
+             // force volume ramp downs at the beginning of each fragment
+             MinFadeOutSamples = MaxSamplesPerCycle;
+             // lower minimum release time
+             const float minReleaseTime = (float) MaxSamplesPerCycle / (float) SampleRate;
+             for (RTList<Voice>::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) {
+                 iterVoice->EG1.CalculateFadeOutCoeff(minReleaseTime, SampleRate);
+             }
+             pVoicePool->clear();
          }
          // (re)create disk thread
          if (this->pDiskThread) {
+             dmsg(1,("Stopping disk thread..."));
              this->pDiskThread->StopThread();
              delete this->pDiskThread;
+             dmsg(1,("OK\n"));
          }
-         this->pDiskThread = new DiskThread(((pAudioOut->MaxSamplesPerCycle() << MAX_PITCH) << 1) + 6); //FIXME: assuming stereo
+         this->pDiskThread = new DiskThread(((pAudioOut->MaxSamplesPerCycle() << CONFIG_MAX_PITCH) << 1) + 6, //FIXME: assuming stereo
+                                            &instruments);
          if (!pDiskThread) {
              dmsg(0,("gig::Engine  new diskthread = NULL\n"));
              exit(EXIT_FAILURE);
          }
-         for (Voice* pVoice = pVoicePool->alloc(); pVoice; pVoice = pVoicePool->alloc()) {
+         for (RTList<Voice>::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) {
-             pVoice->pDiskThread = this->pDiskThread;
+             iterVoice->pDiskThread = this->pDiskThread;
-             pVoice->SetOutput(pAudioOut);
              dmsg(3,("d"));
          }
          pVoicePool->clear();
-Line 294 
 namespace LinuxSampler { namespace gig {
+Line 397 
 namespace LinuxSampler { namespace gig {
          if (pEventGenerator) delete pEventGenerator;
          pEventGenerator = new EventGenerator(pAudioOut->SampleRate());
-         // (re)allocate synthesis parameter matrix
-         if (pSynthesisParameters[0]) delete[] pSynthesisParameters[0];
-         pSynthesisParameters[0] = new float[Event::destination_count * pAudioOut->MaxSamplesPerCycle()];
-         for (int dst = 1; dst < Event::destination_count; dst++)
-             pSynthesisParameters[dst] = pSynthesisParameters[dst - 1] + pAudioOut->MaxSamplesPerCycle();
-         // (re)allocate biquad filter parameter sequence
-         if (pBasicFilterParameters) delete[] pBasicFilterParameters;
-         if (pMainFilterParameters)  delete[] pMainFilterParameters;
-         pBasicFilterParameters = new biquad_param_t[pAudioOut->MaxSamplesPerCycle()];
-         pMainFilterParameters  = new biquad_param_t[pAudioOut->MaxSamplesPerCycle()];
          dmsg(1,("Starting disk thread..."));
          pDiskThread->StartThread();
          dmsg(1,("OK\n"));
-         for (Voice* pVoice = pVoicePool->first(); pVoice; pVoice = pVoicePool->next()) {
+         for (RTList<Voice>::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) {
-             if (!pVoice->pDiskThread) {
+             if (!iterVoice->pDiskThread) {
                  dmsg(0,("Engine -> voice::trigger: !pDiskThread\n"));
                  exit(EXIT_FAILURE);
              }
          }
      }
-     void Engine::DisconnectAudioOutputDevice() {
+     /**
-         if (pAudioOutputDevice) { // if clause to prevent disconnect loops
+      * Called by the engine's (audio) thread once per cycle to process requests
-             AudioOutputDevice* olddevice = pAudioOutputDevice;
+      * from the outer world to suspend or resume a given @c gig::Region .
-             pAudioOutputDevice = NULL;
+      */
-             olddevice->Disconnect(this);
+     void Engine::ProcessSuspensionsChanges() {
+         // process request for suspending one region
+         if (pPendingRegionSuspension) {
+             // kill all voices on all engine channels that use this region
+             for (int iChannel = 0; iChannel < engineChannels.size(); iChannel++) {
+                 EngineChannel* pEngineChannel = engineChannels[iChannel];
+                 RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
+                 RTList<uint>::Iterator end    = pEngineChannel->pActiveKeys->end();
+                 for (; iuiKey != end; ++iuiKey) { // iterate through all active keys
+                     midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
+                     RTList<Voice>::Iterator itVoice = pKey->pActiveVoices->first();
+                     // if current key is not associated with this region, skip this key
+                     if (itVoice->pDimRgn->GetParent() != pPendingRegionSuspension) continue;
+                     RTList<Voice>::Iterator itVoicesEnd = pKey->pActiveVoices->end();
+                     for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key
+                         // request a notification from disk thread side for stream deletion
+                         const Stream::Handle hStream = itVoice->KillImmediately(true);
+                         if (hStream != Stream::INVALID_HANDLE) { // voice actually used a stream
+                             iPendingStreamDeletions++;
+                         }
+                     }
+                 }
+             }
+             // make sure the region is not yet on the list
+             bool bAlreadySuspended = false;
+             RTList< ::gig::Region*>::Iterator iter = SuspendedRegions.first();
+             RTList< ::gig::Region*>::Iterator end  = SuspendedRegions.end();
+             for (; iter != end; ++iter) { // iterate through all suspended regions
+                 if (*iter == pPendingRegionSuspension) { // found
+                     bAlreadySuspended = true;
+                     dmsg(1,("gig::Engine: attempt to suspend an already suspended region !!!\n"));
+                     break;
+                 }
+             }
+             if (!bAlreadySuspended) {
+                 // put the region on the list of suspended regions
+                 RTList< ::gig::Region*>::Iterator iter = SuspendedRegions.allocAppend();
+                 if (iter) {
+                     *iter = pPendingRegionSuspension;
+                 } else std::cerr << "gig::Engine: Could not suspend Region, list is full. This is a bug!!!\n" << std::flush;
+             }
+             // free request slot for next caller (and to make sure that
+             // we're not going to process the same request in the next cycle)
+             pPendingRegionSuspension = NULL;
+             // if no disk stream deletions are pending, awaken other side, as
+             // we're done in this case
+             if (!iPendingStreamDeletions) SuspensionChangeOngoing.Set(false);
+         }
+         // process request for resuming one region
+         if (pPendingRegionResumption) {
+             // remove region from the list of suspended regions
+             RTList< ::gig::Region*>::Iterator iter = SuspendedRegions.first();
+             RTList< ::gig::Region*>::Iterator end  = SuspendedRegions.end();
+             for (; iter != end; ++iter) { // iterate through all suspended regions
+                 if (*iter == pPendingRegionResumption) { // found
+                     SuspendedRegions.free(iter);
+                     break; // done
+                 }
+             }
+             // free request slot for next caller
+             pPendingRegionResumption = NULL;
+             // awake other side as we're done
+             SuspensionChangeOngoing.Set(false);
+         }
+     }
+     /**
+      * Called by the engine's (audio) thread once per cycle to check if
+      * streams of voices that were killed due to suspension request have
+      * finally really been deleted by the disk thread.
+      */
+     void Engine::ProcessPendingStreamDeletions() {
+         if (!iPendingStreamDeletions) return;
+         //TODO: or shall we better store a list with stream handles instead of a scalar amount of streams to be deleted? might be safer
+         while (
+             iPendingStreamDeletions &&
+             pDiskThread->AskForDeletedStream() != Stream::INVALID_HANDLE
+         ) iPendingStreamDeletions--;
+         // just for safety ...
+         while (pDiskThread->AskForDeletedStream() != Stream::INVALID_HANDLE);
+         // now that all disk streams are deleted, awake other side as
+         // we're finally done with suspending the requested region
+         if (!iPendingStreamDeletions) SuspensionChangeOngoing.Set(false);
+     }
+     /**
+      * Returns @c true if the given region is currently set to be suspended
+      * from being used, @c false otherwise.
+      */
+     bool Engine::RegionSuspended(::gig::Region* pRegion) {
+         if (SuspendedRegions.isEmpty()) return false;
+         //TODO: or shall we use a sorted container instead of the RTList? might be faster ... or trivial ;-)
+         RTList< ::gig::Region*>::Iterator iter = SuspendedRegions.first();
+         RTList< ::gig::Region*>::Iterator end  = SuspendedRegions.end();
+         for (; iter != end; ++iter)  // iterate through all suspended regions
+             if (*iter == pRegion) return true;
+         return false;
+     }
+     /**
+      * Clear all engine global event lists.
+      */
+     void Engine::ClearEventLists() {
+         pGlobalEvents->clear();
+     }
+     /**
+      * Copy all events from the engine's global input queue buffer to the
+      * engine's internal event list. This will be done at the beginning of
+      * each audio cycle (that is each RenderAudio() call) to distinguish
+      * all global events which have to be processed in the current audio
+      * cycle. These events are usually just SysEx messages. Every
+      * EngineChannel has it's own input event queue buffer and event list
+      * to handle common events like NoteOn, NoteOff and ControlChange
+      * events.
+      *
+      * @param Samples - number of sample points to be processed in the
+      *                  current audio cycle
+      */
+     void Engine::ImportEvents(uint Samples) {
+         RingBuffer<Event,false>::NonVolatileReader eventQueueReader = pEventQueue->get_non_volatile_reader();
+         Event* pEvent;
+         while (true) {
+             // get next event from input event queue
+             if (!(pEvent = eventQueueReader.pop())) break;
+             // if younger event reached, ignore that and all subsequent ones for now
+             if (pEvent->FragmentPos() >= Samples) {
+                 eventQueueReader--;
+                 dmsg(2,("Younger Event, pos=%d ,Samples=%d!\n",pEvent->FragmentPos(),Samples));
+                 pEvent->ResetFragmentPos();
+                 break;
+             }
+             // copy event to internal event list
+             if (pGlobalEvents->poolIsEmpty()) {
+                 dmsg(1,("Event pool emtpy!\n"));
+                 break;
+             }
+             *pGlobalEvents->allocAppend() = *pEvent;
          }
+         eventQueueReader.free(); // free all copied events from input queue
      }
      /**
-      *  Let this engine proceed to render the given amount of sample points. The
+      * Let this engine proceed to render the given amount of sample points.
-      *  calculated audio data of all voices of this engine will be placed into
+      * The engine will iterate through all engine channels and render audio
-      *  the engine's audio sum buffer which has to be copied and eventually be
+      * for each engine channel independently. The calculated audio data of
-      *  converted to the appropriate value range by the audio output class (e.g.
+      * all voices of each engine channel will be placed into the audio sum
-      *  AlsaIO or JackIO) right after.
+      * buffers of the respective audio output device, connected to the
+      * respective engine channel.
       *
       *  @param Samples - number of sample points to be rendered
       *  @returns       0 on success
       */
      int Engine::RenderAudio(uint Samples) {
-         dmsg(5,("RenderAudio(Samples=%d)\n", Samples));
+         dmsg(8,("RenderAudio(Samples=%d)\n", Samples));
-         // return if no instrument loaded or engine disabled
+         // return if engine disabled
          if (EngineDisabled.Pop()) {
              dmsg(5,("gig::Engine: engine disabled (val=%d)\n",EngineDisabled.GetUnsafe()));
+             EngineDisabled.RttDone();
              return 0;
          }
-         if (!pInstrument) {
-             dmsg(5,("gig::Engine: no instrument loaded\n"));
+         // process requests for suspending / resuming regions (i.e. to avoid
-             return 0;
+         // crashes while these regions are modified by an instrument editor)
+         ProcessSuspensionsChanges();
+         // update time of start and end of this audio fragment (as events' time stamps relate to this)
+         pEventGenerator->UpdateFragmentTime(Samples);
+         // We only allow a maximum of CONFIG_MAX_VOICES voices to be spawned
+         // in each audio fragment. All subsequent request for spawning new
+         // voices in the same audio fragment will be ignored.
+         VoiceSpawnsLeft = CONFIG_MAX_VOICES;
+         // get all events from the engine's global input event queue which belong to the current fragment
+         // (these are usually just SysEx messages)
+         ImportEvents(Samples);
+         // process engine global events (these are currently only MIDI System Exclusive messages)
+         {
+             RTList<Event>::Iterator itEvent = pGlobalEvents->first();
+             RTList<Event>::Iterator end     = pGlobalEvents->end();
+             for (; itEvent != end; ++itEvent) {
+                 switch (itEvent->Type) {
+                     case Event::type_sysex:
+                         dmsg(5,("Engine: Sysex received\n"));
+                         ProcessSysex(itEvent);
+                         break;
+                 }
+             }
          }
+         // reset internal voice counter (just for statistic of active voices)
+         ActiveVoiceCountTemp = 0;
-         // empty the event lists for the new fragment
+         // handle instrument change commands
-         pEvents->clear();
+         bool instrumentChanged = false;
-         pCCEvents->clear();
+         for (int i = 0; i < engineChannels.size(); i++) {
-         for (uint i = 0; i < Event::destination_count; i++) {
+             EngineChannel* pEngineChannel = engineChannels[i];
-             pSynthesisEvents[i]->clear();
+             // as we're going to (carefully) write some status to the
+             // synchronized struct, we cast away the const
+             EngineChannel::instrument_change_command_t& cmd =
+                 const_cast<EngineChannel::instrument_change_command_t&>(pEngineChannel->InstrumentChangeCommandReader.Lock());
+             pEngineChannel->pDimRegionsInUse = cmd.pDimRegionsInUse;
+             pEngineChannel->pDimRegionsInUse->clear();
+             if (cmd.bChangeInstrument) {
+                 // change instrument
+                 dmsg(5,("Engine: instrument change command received\n"));
+                 cmd.bChangeInstrument = false;
+                 pEngineChannel->pInstrument = cmd.pInstrument;
+                 instrumentChanged = true;
+                 // Iterate through all active voices and mark them as
+                 // "orphans", which means that the dimension regions
+                 // and samples they use should be released to the
+                 // instrument resource manager when the voices die.
+                 int i = 0;
+                 RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
+                 RTList<uint>::Iterator end    = pEngineChannel->pActiveKeys->end();
+                 while (iuiKey != end) { // iterate through all active keys
+                     midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
+                     ++iuiKey;
+                     RTList<Voice>::Iterator itVoice     = pKey->pActiveVoices->first();
+                     RTList<Voice>::Iterator itVoicesEnd = pKey->pActiveVoices->end();
+                     for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key
+                         itVoice->Orphan = true;
+                     }
+                 }
+             }
+         }
+         if (instrumentChanged) {
+             //TODO: this is a lazy solution ATM and not safe in case somebody is currently editing the instrument we're currently switching to (we should store all suspended regions on instrument manager side and when switching to another instrument copy that list to the engine's local list of suspensions
+             ResetSuspendedRegions();
          }
-         // read and copy events from input queue
+         // handle events on all engine channels
-         Event event = pEventGenerator->CreateEvent();
+         for (int i = 0; i < engineChannels.size(); i++) {
-         while (true) {
+             ProcessEvents(engineChannels[i], Samples);
-             if (!pEventQueue->pop(&event)) break;
-             pEvents->alloc_assign(event);
          }
+         // render all 'normal', active voices on all engine channels
+         for (int i = 0; i < engineChannels.size(); i++) {
+             RenderActiveVoices(engineChannels[i], Samples);
+         }
-         // update time of start and end of this audio fragment (as events' time stamps relate to this)
+         // now that all ordinary voices on ALL engine channels are rendered, render new stolen voices
-         pEventGenerator->UpdateFragmentTime(Samples);
+         RenderStolenVoices(Samples);
+         // handle audio routing for engine channels with FX sends
+         for (int i = 0; i < engineChannels.size(); i++) {
+             if (engineChannels[i]->fxSends.empty()) continue; // ignore if no FX sends
+             RouteAudio(engineChannels[i], Samples);
+         }
-         // process events
+         // handle cleanup on all engine channels for the next audio fragment
-         Event* pNextEvent = pEvents->first();
+         for (int i = 0; i < engineChannels.size(); i++) {
-         while (pNextEvent) {
+             PostProcess(engineChannels[i]);
-             Event* pEvent = pNextEvent;
-             pEvents->set_current(pEvent);
-             pNextEvent = pEvents->next();
-             switch (pEvent->Type) {
-                 case Event::type_note_on:
-                     dmsg(5,("Audio Thread: Note on received\n"));
-                     ProcessNoteOn(pEvent);
-                     break;
-                 case Event::type_note_off:
-                     dmsg(5,("Audio Thread: Note off received\n"));
-                     ProcessNoteOff(pEvent);
-                     break;
-                 case Event::type_control_change:
-                     dmsg(5,("Audio Thread: MIDI CC received\n"));
-                     ProcessControlChange(pEvent);
-                     break;
-                 case Event::type_pitchbend:
-                     dmsg(5,("Audio Thread: Pitchbend received\n"));
-                     ProcessPitchbend(pEvent);
-                     break;
-             }
          }
-         // render audio from all active voices
+         // empty the engine's event list for the next audio fragment
-         int active_voices = 0;
+         ClearEventLists();
-         uint* piKey = pActiveKeys->first();
-         while (piKey) { // iterate through all active keys
-             midi_key_info_t* pKey = &pMIDIKeyInfo[*piKey];
-             pActiveKeys->set_current(piKey);
-             piKey = pActiveKeys->next();
-             Voice* pVoiceNext = pKey->pActiveVoices->first();
-             while (pVoiceNext) { // iterate through all voices on this key
-                 // already get next voice on key
-                 Voice* pVoice = pVoiceNext;
-                 pKey->pActiveVoices->set_current(pVoice);
-                 pVoiceNext = pKey->pActiveVoices->next();
-                 // now render current voice
+         // reset voice stealing for the next audio fragment
-                 pVoice->Render(Samples);
+         pVoiceStealingQueue->clear();
-                 if (pVoice->IsActive()) active_voices++; // still active
-                 else { // voice reached end, is now inactive
+         // just some statistics about this engine instance
-                     KillVoice(pVoice); // remove voice from the list of active voices
+         ActiveVoiceCount = ActiveVoiceCountTemp;
+         if (ActiveVoiceCount > ActiveVoiceCountMax) ActiveVoiceCountMax = ActiveVoiceCount;
+         // in case regions were previously suspended and we killed voices
+         // with disk streams due to that, check if those streams have finally
+         // been deleted by the disk thread
+         if (iPendingStreamDeletions) ProcessPendingStreamDeletions();
+         for (int i = 0; i < engineChannels.size(); i++) {
+             engineChannels[i]->InstrumentChangeCommandReader.Unlock();
+         }
+         FrameTime += Samples;
+         EngineDisabled.RttDone();
+         return 0;
+     }
+     /**
+      * Dispatch and handle all events in this audio fragment for the given
+      * engine channel.
+      *
+      * @param pEngineChannel - engine channel on which events should be
+      *                         processed
+      * @param Samples        - amount of sample points to be processed in
+      *                         this audio fragment cycle
+      */
+     void Engine::ProcessEvents(EngineChannel* pEngineChannel, uint Samples) {
+         // get all events from the engine channels's input event queue which belong to the current fragment
+         // (these are the common events like NoteOn, NoteOff, ControlChange, etc.)
+         pEngineChannel->ImportEvents(Samples);
+         // process events
+         {
+             RTList<Event>::Iterator itEvent = pEngineChannel->pEvents->first();
+             RTList<Event>::Iterator end     = pEngineChannel->pEvents->end();
+             for (; itEvent != end; ++itEvent) {
+                 switch (itEvent->Type) {
+                     case Event::type_note_on:
+                         dmsg(5,("Engine: Note on received\n"));
+                         ProcessNoteOn((EngineChannel*)itEvent->pEngineChannel, itEvent);
+                         break;
+                     case Event::type_note_off:
+                         dmsg(5,("Engine: Note off received\n"));
+                         ProcessNoteOff((EngineChannel*)itEvent->pEngineChannel, itEvent);
+                         break;
+                     case Event::type_control_change:
+                         dmsg(5,("Engine: MIDI CC received\n"));
+                         ProcessControlChange((EngineChannel*)itEvent->pEngineChannel, itEvent);
+                         break;
+                     case Event::type_pitchbend:
+                         dmsg(5,("Engine: Pitchbend received\n"));
+                         ProcessPitchbend((EngineChannel*)itEvent->pEngineChannel, itEvent);
+                         break;
                  }
              }
-             pKey->pEvents->clear(); // free all events on the key
          }
+         // reset voice stealing for the next engine channel (or next audio fragment)
+         itLastStolenVoice         = RTList<Voice>::Iterator();
+         itLastStolenVoiceGlobally = RTList<Voice>::Iterator();
+         iuiLastStolenKey          = RTList<uint>::Iterator();
+         iuiLastStolenKeyGlobally  = RTList<uint>::Iterator();
+         pLastStolenChannel        = NULL;
+     }
-         // write that to the disk thread class so that it can print it
+     /**
-         // on the console for debugging purposes
+      * Render all 'normal' voices (that is voices which were not stolen in
-         ActiveVoiceCount = active_voices;
+      * this fragment) on the given engine channel.
-         if (ActiveVoiceCount > ActiveVoiceCountMax) ActiveVoiceCountMax = ActiveVoiceCount;
+      *
+      * @param pEngineChannel - engine channel on which audio should be
+      *                         rendered
+      * @param Samples        - amount of sample points to be rendered in
+      *                         this audio fragment cycle
+      */
+     void Engine::RenderActiveVoices(EngineChannel* pEngineChannel, uint Samples) {
+         #if !CONFIG_PROCESS_MUTED_CHANNELS
+         if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted
+         #endif
+         uint voiceCount = 0;
+         uint streamCount = 0;
+         RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
+         RTList<uint>::Iterator end    = pEngineChannel->pActiveKeys->end();
+         while (iuiKey != end) { // iterate through all active keys
+             midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
+             ++iuiKey;
+             RTList<Voice>::Iterator itVoice     = pKey->pActiveVoices->first();
+             RTList<Voice>::Iterator itVoicesEnd = pKey->pActiveVoices->end();
+             for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key
+                 // now render current voice
+                 itVoice->Render(Samples);
+                 if (itVoice->IsActive()) { // still active
+                     if (!itVoice->Orphan) {
+                         *(pEngineChannel->pDimRegionsInUse->allocAppend()) = itVoice->pDimRgn;
+                     }
+                     ActiveVoiceCountTemp++;
+                     voiceCount++;
+                     if (itVoice->PlaybackState == Voice::playback_state_disk) {
+                         if ((itVoice->DiskStreamRef).State == Stream::state_active) streamCount++;
+                     }
+                 }  else { // voice reached end, is now inactive
+                     FreeVoice(pEngineChannel, itVoice); // remove voice from the list of active voices
+                 }
+             }
+         }
-         return 0;
+         pEngineChannel->SetVoiceCount(voiceCount);
+         pEngineChannel->SetDiskStreamCount(streamCount);
      }
      /**
-      *  Will be called by the MIDIIn Thread to let the audio thread trigger a new
+      * Render all stolen voices (only voices which were stolen in this
-      *  voice for the given key.
+      * fragment) on the given engine channel. Stolen voices are rendered
+      * after all normal voices have been rendered; this is needed to render
+      * audio of those voices which were selected for voice stealing until
+      * the point were the stealing (that is the take over of the voice)
+      * actually happened.
       *
-      *  @param Key      - MIDI key number of the triggered key
+      * @param pEngineChannel - engine channel on which audio should be
-      *  @param Velocity - MIDI velocity value of the triggered key
+      *                         rendered
+      * @param Samples        - amount of sample points to be rendered in
+      *                         this audio fragment cycle
       */
-     void Engine::SendNoteOn(uint8_t Key, uint8_t Velocity) {
+     void Engine::RenderStolenVoices(uint Samples) {
-         Event event    = pEventGenerator->CreateEvent();
+         RTList<Event>::Iterator itVoiceStealEvent = pVoiceStealingQueue->first();
-         event.Type     = Event::type_note_on;
+         RTList<Event>::Iterator end               = pVoiceStealingQueue->end();
-         event.Key      = Key;
+         for (; itVoiceStealEvent != end; ++itVoiceStealEvent) {
-         event.Velocity = Velocity;
+             EngineChannel* pEngineChannel = (EngineChannel*) itVoiceStealEvent->pEngineChannel;
-         if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event);
+             if (!pEngineChannel->pInstrument) continue; // ignore if no instrument loaded
-         else dmsg(1,("Engine: Input event queue full!"));
+             Pool<Voice>::Iterator itNewVoice =
+                 LaunchVoice(pEngineChannel, itVoiceStealEvent, itVoiceStealEvent->Param.Note.Layer, itVoiceStealEvent->Param.Note.ReleaseTrigger, false, false);
+             if (itNewVoice) {
+                 itNewVoice->Render(Samples);
+                 if (itNewVoice->IsActive()) { // still active
+                     *(pEngineChannel->pDimRegionsInUse->allocAppend()) = itNewVoice->pDimRgn;
+                     ActiveVoiceCountTemp++;
+                     pEngineChannel->SetVoiceCount(pEngineChannel->GetVoiceCount() + 1);
+                     if (itNewVoice->PlaybackState == Voice::playback_state_disk) {
+                         if (itNewVoice->DiskStreamRef.State == Stream::state_active) {
+                             pEngineChannel->SetDiskStreamCount(pEngineChannel->GetDiskStreamCount() + 1);
+                         }
+                     }
+                 } else { // voice reached end, is now inactive
+                     FreeVoice(pEngineChannel, itNewVoice); // remove voice from the list of active voices
+                 }
+             }
+             else dmsg(1,("gig::Engine: ERROR, voice stealing didn't work out!\n"));
+             // we need to clear the key's event list explicitly here in case key was never active
+             midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[itVoiceStealEvent->Param.Note.Key];
+             pKey->VoiceTheftsQueued--;
+             if (!pKey->Active && !pKey->VoiceTheftsQueued) pKey->pEvents->clear();
+         }
      }
      /**
-      *  Will be called by the MIDIIn Thread to signal the audio thread to release
+      * Will be called in case the respective engine channel sports FX send
-      *  voice(s) on the given key.
+      * channels. In this particular case, engine channel local buffers are
+      * used to render and mix all voices to. This method is responsible for
+      * copying the audio data from those local buffers to the master audio
+      * output channels as well as to the FX send audio output channels with
+      * their respective FX send levels.
       *
-      *  @param Key      - MIDI key number of the released key
+      * @param pEngineChannel - engine channel from which audio should be
-      *  @param Velocity - MIDI release velocity value of the released key
+      *                         routed
+      * @param Samples        - amount of sample points to be routed in
+      *                         this audio fragment cycle
       */
-     void Engine::SendNoteOff(uint8_t Key, uint8_t Velocity) {
+     void Engine::RouteAudio(EngineChannel* pEngineChannel, uint Samples) {
-         Event event    = pEventGenerator->CreateEvent();
+         // route dry signal
-         event.Type     = Event::type_note_off;
+         {
-         event.Key      = Key;
+             AudioChannel* pDstL = pAudioOutputDevice->Channel(pEngineChannel->AudioDeviceChannelLeft);
-         event.Velocity = Velocity;
+             AudioChannel* pDstR = pAudioOutputDevice->Channel(pEngineChannel->AudioDeviceChannelRight);
-         if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event);
+             pEngineChannel->pChannelLeft->MixTo(pDstL, Samples);
-         else dmsg(1,("Engine: Input event queue full!"));
+             pEngineChannel->pChannelRight->MixTo(pDstR, Samples);
+         }
+         // route FX send signal
+         {
+             for (int iFxSend = 0; iFxSend < pEngineChannel->GetFxSendCount(); iFxSend++) {
+                 FxSend* pFxSend = pEngineChannel->GetFxSend(iFxSend);
+                 for (int iChan = 0; iChan < 2; ++iChan) {
+                     AudioChannel* pSource =
+                         (iChan)
+                             ? pEngineChannel->pChannelRight
+                             : pEngineChannel->pChannelLeft;
+                     const int iDstChan = pFxSend->DestinationChannel(iChan);
+                     if (iDstChan < 0) {
+                         dmsg(1,("Engine::RouteAudio() Error: invalid FX send (%s) destination channel (%d->%d)", ((iChan) ? "R" : "L"), iChan, iDstChan));
+                         goto channel_cleanup;
+                     }
+                     AudioChannel* pDstChan = NULL;
+                     if (pFxSend->DestinationMasterEffectChain() >= 0) { // fx send routed to an internal master effect
+                         EffectChain* pEffectChain =
+                             pAudioOutputDevice->MasterEffectChain(
+                                 pFxSend->DestinationMasterEffectChain()
+                             );
+                         if (!pEffectChain) {
+                             dmsg(1,("Engine::RouteAudio() Error: invalid FX send (%s) destination effect chain %d", ((iChan) ? "R" : "L"), pFxSend->DestinationMasterEffectChain()));
+                             goto channel_cleanup;
+                         }
+                         Effect* pEffect =
+                             pEffectChain->GetEffect(
+                                 pFxSend->DestinationMasterEffect()
+                             );
+                         if (!pEffect) {
+                             dmsg(1,("Engine::RouteAudio() Error: invalid FX send (%s) destination effect %d of effect chain %d", ((iChan) ? "R" : "L"), pFxSend->DestinationMasterEffect(), pFxSend->DestinationMasterEffectChain()));
+                             goto channel_cleanup;
+                         }
+                         pDstChan = pEffect->InputChannel(iDstChan);
+                     } else { // FX send routed directly to an audio output channel
+                         pDstChan = pAudioOutputDevice->Channel(iDstChan);
+                     }
+                     if (!pDstChan) {
+                         dmsg(1,("Engine::RouteAudio() Error: invalid FX send (%s) destination channel (%d->%d)", ((iChan) ? "R" : "L"), iChan, iDstChan));
+                         goto channel_cleanup;
+                     }
+                     pSource->MixTo(pDstChan, Samples, pFxSend->Level());
+                 }
+             }
+         }
+         channel_cleanup:
+         // reset buffers with silence (zero out) for the next audio cycle
+         pEngineChannel->pChannelLeft->Clear();
+         pEngineChannel->pChannelRight->Clear();
      }
      /**
-      *  Will be called by the MIDIIn Thread to signal the audio thread to change
+      * Free all keys which have turned inactive in this audio fragment, from
-      *  the pitch value for all voices.
+      * the list of active keys and clear all event lists on that engine
+      * channel.
       *
-      *  @param Pitch - MIDI pitch value (-8192 ... +8191)
+      * @param pEngineChannel - engine channel to cleanup
       */
-     void Engine::SendPitchbend(int Pitch) {
+     void Engine::PostProcess(EngineChannel* pEngineChannel) {
-         Event event = pEventGenerator->CreateEvent();
+         // free all keys which have no active voices left
-         event.Type  = Event::type_pitchbend;
+         {
-         event.Pitch = Pitch;
+             RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
-         if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event);
+             RTList<uint>::Iterator end    = pEngineChannel->pActiveKeys->end();
-         else dmsg(1,("Engine: Input event queue full!"));
+             while (iuiKey != end) { // iterate through all active keys
+                 midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
+                 ++iuiKey;
+                 if (pKey->pActiveVoices->isEmpty()) FreeKey(pEngineChannel, pKey);
+                 #if CONFIG_DEVMODE
+                 else { // just a sanity check for debugging
+                     RTList<Voice>::Iterator itVoice     = pKey->pActiveVoices->first();
+                     RTList<Voice>::Iterator itVoicesEnd = pKey->pActiveVoices->end();
+                     for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key
+                         if (itVoice->itKillEvent) {
+                             dmsg(1,("gig::Engine: ERROR, killed voice survived !!!\n"));
+                         }
+                     }
+                 }
+                 #endif // CONFIG_DEVMODE
+             }
+         }
+         // empty the engine channel's own event lists
+         pEngineChannel->ClearEventLists();
      }
      /**
-      *  Will be called by the MIDIIn Thread to signal the audio thread that a
+      *  Will be called by the MIDI input device whenever a MIDI system
-      *  continuous controller value has changed.
+      *  exclusive message has arrived.
       *
-      *  @param Controller - MIDI controller number of the occured control change
+      *  @param pData - pointer to sysex data
-      *  @param Value      - value of the control change
+      *  @param Size  - lenght of sysex data (in bytes)
+      *  @param pSender - the MIDI input port on which the SysEx message was
+      *                   received
       */
-     void Engine::SendControlChange(uint8_t Controller, uint8_t Value) {
+     void Engine::SendSysex(void* pData, uint Size, MidiInputPort* pSender) {
-         Event event      = pEventGenerator->CreateEvent();
+         Event event             = pEventGenerator->CreateEvent();
-         event.Type       = Event::type_control_change;
+         event.Type              = Event::type_sysex;
-         event.Controller = Controller;
+         event.Param.Sysex.Size  = Size;
-         event.Value      = Value;
+         event.pEngineChannel    = NULL; // as Engine global event
-         if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event);
+         event.pMidiInputPort    = pSender;
+         if (pEventQueue->write_space() > 0) {
+             if (pSysexBuffer->write_space() >= Size) {
+                 // copy sysex data to input buffer
+                 uint toWrite = Size;
+                 uint8_t* pPos = (uint8_t*) pData;
+                 while (toWrite) {
+                     const uint writeNow = RTMath::Min(toWrite, pSysexBuffer->write_space_to_end());
+                     pSysexBuffer->write(pPos, writeNow);
+                     toWrite -= writeNow;
+                     pPos    += writeNow;
+                 }
+                 // finally place sysex event into input event queue
+                 pEventQueue->push(&event);
+             }
+             else dmsg(1,("Engine: Sysex message too large (%d byte) for input buffer (%d byte)!",Size,CONFIG_SYSEX_BUFFER_SIZE));
+         }
          else dmsg(1,("Engine: Input event queue full!"));
      }
      /**
       *  Assigns and triggers a new voice for the respective MIDI key.
       *
-      *  @param pNoteOnEvent - key, velocity and time stamp of the event
+      *  @param pEngineChannel - engine channel on which this event occured on
+      *  @param itNoteOnEvent - key, velocity and time stamp of the event
       */
-     void Engine::ProcessNoteOn(Event* pNoteOnEvent) {
+     void Engine::ProcessNoteOn(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent) {
-         midi_key_info_t* pKey = &pMIDIKeyInfo[pNoteOnEvent->Key];
+         #if !CONFIG_PROCESS_MUTED_CHANNELS
+         if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted
+         #endif
+         if (!pEngineChannel->pInstrument) return; // ignore if no instrument loaded
+         //HACK: we should better add the transpose value only to the most mandatory places (like for retrieving the region and calculating the tuning), because otherwise voices will unintendedly survive when changing transpose while playing
+         itNoteOnEvent->Param.Note.Key += pEngineChannel->GlobalTranspose;
+         const int key = itNoteOnEvent->Param.Note.Key;
+         midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[key];
+         // move note on event to the key's own event list
+         RTList<Event>::Iterator itNoteOnEventOnKeyList = itNoteOnEvent.moveToEndOf(pKey->pEvents);
+         // if Solo Mode then kill all already active voices
+         if (pEngineChannel->SoloMode) {
+             Pool<uint>::Iterator itYoungestKey = pEngineChannel->pActiveKeys->last();
+             if (itYoungestKey) {
+                 const int iYoungestKey = *itYoungestKey;
+                 const midi_key_info_t* pOtherKey = &pEngineChannel->pMIDIKeyInfo[iYoungestKey];
+                 if (pOtherKey->Active) {
+                     // get final portamento position of currently active voice
+                     if (pEngineChannel->PortamentoMode) {
+                         RTList<Voice>::Iterator itVoice = pOtherKey->pActiveVoices->last();
+                         if (itVoice) itVoice->UpdatePortamentoPos(itNoteOnEventOnKeyList);
+                     }
+                     // kill all voices on the (other) key
+                     RTList<Voice>::Iterator itVoiceToBeKilled = pOtherKey->pActiveVoices->first();
+                     RTList<Voice>::Iterator end               = pOtherKey->pActiveVoices->end();
+                     for (; itVoiceToBeKilled != end; ++itVoiceToBeKilled) {
+                         if (itVoiceToBeKilled->Type != Voice::type_release_trigger)
+                             itVoiceToBeKilled->Kill(itNoteOnEventOnKeyList);
+                     }
+                 }
+             }
+             // set this key as 'currently active solo key'
+             pEngineChannel->SoloKey = key;
+         }
+         // Change key dimension value if key is in keyswitching area
+         {
+             const ::gig::Instrument* pInstrument = pEngineChannel->pInstrument;
+             if (key >= pInstrument->DimensionKeyRange.low && key <= pInstrument->DimensionKeyRange.high)
+                 pEngineChannel->CurrentKeyDimension = float(key - pInstrument->DimensionKeyRange.low) /
+                     (pInstrument->DimensionKeyRange.high - pInstrument->DimensionKeyRange.low + 1);
+         }
          pKey->KeyPressed = true; // the MIDI key was now pressed down
+         pKey->Velocity   = itNoteOnEventOnKeyList->Param.Note.Velocity;
+         pKey->NoteOnTime = FrameTime + itNoteOnEventOnKeyList->FragmentPos(); // will be used to calculate note length
          // cancel release process of voices on this key if needed
-         if (pKey->Active && !SustainPedal) {
+         if (pKey->Active && !pEngineChannel->SustainPedal) {
-             pNoteOnEvent->Type = Event::type_cancel_release; // transform event type
+             RTList<Event>::Iterator itCancelReleaseEvent = pKey->pEvents->allocAppend();
-             pEvents->move(pNoteOnEvent, pKey->pEvents); // move event to the key's own event list
+             if (itCancelReleaseEvent) {
+                 *itCancelReleaseEvent = *itNoteOnEventOnKeyList;         // copy event
+                 itCancelReleaseEvent->Type = Event::type_cancel_release; // transform event type
+             }
+             else dmsg(1,("Event pool emtpy!\n"));
          }
-         // allocate a new voice for the key
+         // allocate and trigger new voice(s) for the key
-         Voice* pNewVoice = pKey->pActiveVoices->alloc();
+         {
-         if (pNewVoice) {
+             // first, get total amount of required voices (dependant on amount of layers)
-             // launch the new voice
+             ::gig::Region* pRegion = pEngineChannel->pInstrument->GetRegion(itNoteOnEventOnKeyList->Param.Note.Key);
-             if (pNewVoice->Trigger(pNoteOnEvent, this->Pitch, this->pInstrument) < 0) {
+             if (pRegion && !RegionSuspended(pRegion)) {
-                 dmsg(1,("Triggering new voice failed!\n"));
+                 int voicesRequired = pRegion->Layers;
-                 pKey->pActiveVoices->free(pNewVoice);
+                 // now launch the required amount of voices
-             }
+                 for (int i = 0; i < voicesRequired; i++)
-             else if (!pKey->Active) { // mark as active key
+                     LaunchVoice(pEngineChannel, itNoteOnEventOnKeyList, i, false, true, true);
-                 pKey->Active = true;
-                 pKey->pSelf  = pActiveKeys->alloc();
-                 *pKey->pSelf = pNoteOnEvent->Key;
              }
          }
-         else std::cerr << "No free voice!" << std::endl << std::flush;
+         // if neither a voice was spawned or postponed then remove note on event from key again
+         if (!pKey->Active && !pKey->VoiceTheftsQueued)
+             pKey->pEvents->free(itNoteOnEventOnKeyList);
+         if (!pEngineChannel->SoloMode || pEngineChannel->PortamentoPos < 0.0f) pEngineChannel->PortamentoPos = (float) key;
+         pKey->RoundRobinIndex++;
      }
      /**
-Line 532 
 namespace LinuxSampler { namespace gig {
+Line 1079 
 namespace LinuxSampler { namespace gig {
       *  sustain pedal will be released or voice turned inactive by itself (e.g.
       *  due to completion of sample playback).
       *
-      *  @param pNoteOffEvent - key, velocity and time stamp of the event
+      *  @param pEngineChannel - engine channel on which this event occured on
+      *  @param itNoteOffEvent - key, velocity and time stamp of the event
       */
-     void Engine::ProcessNoteOff(Event* pNoteOffEvent) {
+     void Engine::ProcessNoteOff(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOffEvent) {
-         midi_key_info_t* pKey = &pMIDIKeyInfo[pNoteOffEvent->Key];
+         #if !CONFIG_PROCESS_MUTED_CHANNELS
+         if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted
+         #endif
+         //HACK: we should better add the transpose value only to the most mandatory places (like for retrieving the region and calculating the tuning), because otherwise voices will unintendedly survive when changing transpose while playing
+         itNoteOffEvent->Param.Note.Key += pEngineChannel->GlobalTranspose;
+         const int iKey = itNoteOffEvent->Param.Note.Key;
+         midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[iKey];
          pKey->KeyPressed = false; // the MIDI key was now released
-         // release voices on this key if needed
+         // move event to the key's own event list
-         if (pKey->Active && !SustainPedal) {
+         RTList<Event>::Iterator itNoteOffEventOnKeyList = itNoteOffEvent.moveToEndOf(pKey->pEvents);
-             pNoteOffEvent->Type = Event::type_release; // transform event type
-             pEvents->move(pNoteOffEvent, pKey->pEvents); // move event to the key's own event list
+         bool bShouldRelease = pKey->Active && ShouldReleaseVoice(pEngineChannel, itNoteOffEventOnKeyList->Param.Note.Key);
+         // in case Solo Mode is enabled, kill all voices on this key and respawn a voice on the highest pressed key (if any)
+         if (pEngineChannel->SoloMode && pEngineChannel->pInstrument) { //TODO: this feels like too much code just for handling solo mode :P
+             bool bOtherKeysPressed = false;
+             if (iKey == pEngineChannel->SoloKey) {
+                 pEngineChannel->SoloKey = -1;
+                 // if there's still a key pressed down, respawn a voice (group) on the highest key
+                 for (int i = 127; i > 0; i--) {
+                     midi_key_info_t* pOtherKey = &pEngineChannel->pMIDIKeyInfo[i];
+                     if (pOtherKey->KeyPressed) {
+                         bOtherKeysPressed = true;
+                         // make the other key the new 'currently active solo key'
+                         pEngineChannel->SoloKey = i;
+                         // get final portamento position of currently active voice
+                         if (pEngineChannel->PortamentoMode) {
+                             RTList<Voice>::Iterator itVoice = pKey->pActiveVoices->first();
+                             if (itVoice) itVoice->UpdatePortamentoPos(itNoteOffEventOnKeyList);
+                         }
+                         // create a pseudo note on event
+                         RTList<Event>::Iterator itPseudoNoteOnEvent = pOtherKey->pEvents->allocAppend();
+                         if (itPseudoNoteOnEvent) {
+                             // copy event
+                             *itPseudoNoteOnEvent = *itNoteOffEventOnKeyList;
+                             // transform event to a note on event
+                             itPseudoNoteOnEvent->Type                = Event::type_note_on;
+                             itPseudoNoteOnEvent->Param.Note.Key      = i;
+                             itPseudoNoteOnEvent->Param.Note.Velocity = pOtherKey->Velocity;
+                             // allocate and trigger new voice(s) for the other key
+                             {
+                                 // first, get total amount of required voices (dependant on amount of layers)
+                                 ::gig::Region* pRegion = pEngineChannel->pInstrument->GetRegion(i);
+                                 if (pRegion) {
+                                     int voicesRequired = pRegion->Layers;
+                                     // now launch the required amount of voices
+                                     for (int iLayer = 0; iLayer < voicesRequired; iLayer++)
+                                         LaunchVoice(pEngineChannel, itPseudoNoteOnEvent, iLayer, false, true, false);
+                                 }
+                             }
+                             // if neither a voice was spawned or postponed then remove note on event from key again
+                             if (!pOtherKey->Active && !pOtherKey->VoiceTheftsQueued)
+                                 pOtherKey->pEvents->free(itPseudoNoteOnEvent);
+                         } else dmsg(1,("Could not respawn voice, no free event left\n"));
+                         break; // done
+                     }
+                 }
+             }
+             if (bOtherKeysPressed) {
+                 if (pKey->Active) { // kill all voices on this key
+                     bShouldRelease = false; // no need to release, as we kill it here
+                     RTList<Voice>::Iterator itVoiceToBeKilled = pKey->pActiveVoices->first();
+                     RTList<Voice>::Iterator end               = pKey->pActiveVoices->end();
+                     for (; itVoiceToBeKilled != end; ++itVoiceToBeKilled) {
+                         if (itVoiceToBeKilled->Type != Voice::type_release_trigger)
+                             itVoiceToBeKilled->Kill(itNoteOffEventOnKeyList);
+                     }
+                 }
+             } else pEngineChannel->PortamentoPos = -1.0f;
+         }
+         // if no solo mode (the usual case) or if solo mode and no other key pressed, then release voices on this key if needed
+         if (bShouldRelease) {
+             itNoteOffEventOnKeyList->Type = Event::type_release; // transform event type
+             // spawn release triggered voice(s) if needed
+             if (pKey->ReleaseTrigger && pEngineChannel->pInstrument) {
+                 // first, get total amount of required voices (dependant on amount of layers)
+                 ::gig::Region* pRegion = pEngineChannel->pInstrument->GetRegion(itNoteOffEventOnKeyList->Param.Note.Key);
+                 if (pRegion) {
+                     int voicesRequired = pRegion->Layers;
+                     // MIDI note-on velocity is used instead of note-off velocity
+                     itNoteOffEventOnKeyList->Param.Note.Velocity = pKey->Velocity;
+                     // now launch the required amount of voices
+                     for (int i = 0; i < voicesRequired; i++)
+                         LaunchVoice(pEngineChannel, itNoteOffEventOnKeyList, i, true, false, false); //FIXME: for the moment we don't perform voice stealing for release triggered samples
+                 }
+                 pKey->ReleaseTrigger = false;
+             }
          }
+         // if neither a voice was spawned or postponed on this key then remove note off event from key again
+         if (!pKey->Active && !pKey->VoiceTheftsQueued)
+             pKey->pEvents->free(itNoteOffEventOnKeyList);
+     }
+     /**
+      *  Moves pitchbend event from the general (input) event list to the engine
+      *  channel's event list. It will actually processed later by the
+      *  respective voice.
+      *
+      *  @param pEngineChannel - engine channel on which this event occured on
+      *  @param itPitchbendEvent - absolute pitch value and time stamp of the event
+      */
+     void Engine::ProcessPitchbend(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itPitchbendEvent) {
+         pEngineChannel->Pitch = itPitchbendEvent->Param.Pitch.Pitch; // store current pitch value
      }
      /**
-      *  Moves pitchbend event from the general (input) event list to the pitch
+      *  Allocates and triggers a new voice. This method will usually be
-      *  event list.
+      *  called by the ProcessNoteOn() method and by the voices itself
+      *  (e.g. to spawn further voices on the same key for layered sounds).
       *
-      *  @param pPitchbendEvent - absolute pitch value and time stamp of the event
+      *  @param pEngineChannel      - engine channel on which this event occured on
+      *  @param itNoteOnEvent       - key, velocity and time stamp of the event
+      *  @param iLayer              - layer index for the new voice (optional - only
+      *                               in case of layered sounds of course)
+      *  @param ReleaseTriggerVoice - if new voice is a release triggered voice
+      *                               (optional, default = false)
+      *  @param VoiceStealing       - if voice stealing should be performed
+      *                               when there is no free voice
+      *                               (optional, default = true)
+      *  @param HandleKeyGroupConflicts - if voices should be killed due to a
+      *                                   key group conflict
+      *  @returns pointer to new voice or NULL if there was no free voice or
+      *           if the voice wasn't triggered (for example when no region is
+      *           defined for the given key).
       */
-     void Engine::ProcessPitchbend(Event* pPitchbendEvent) {
+     Pool<Voice>::Iterator Engine::LaunchVoice(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing, bool HandleKeyGroupConflicts) {
-         this->Pitch = pPitchbendEvent->Pitch; // store current pitch value
+         int MIDIKey            = itNoteOnEvent->Param.Note.Key;
-         pEvents->move(pPitchbendEvent, pSynthesisEvents[Event::destination_vco]);
+         midi_key_info_t* pKey  = &pEngineChannel->pMIDIKeyInfo[MIDIKey];
+         ::gig::Region* pRegion = pEngineChannel->pInstrument->GetRegion(MIDIKey);
+         // if nothing defined for this key
+         if (!pRegion) return Pool<Voice>::Iterator(); // nothing to do
+         // only mark the first voice of a layered voice (group) to be in a
+         // key group, so the layered voices won't kill each other
+         int iKeyGroup = (iLayer == 0 && !ReleaseTriggerVoice) ? pRegion->KeyGroup : 0;
+         // handle key group (a.k.a. exclusive group) conflicts
+         if (HandleKeyGroupConflicts) {
+             if (iKeyGroup) { // if this voice / key belongs to a key group
+                 uint** ppKeyGroup = &pEngineChannel->ActiveKeyGroups[iKeyGroup];
+                 if (*ppKeyGroup) { // if there's already an active key in that key group
+                     midi_key_info_t* pOtherKey = &pEngineChannel->pMIDIKeyInfo[**ppKeyGroup];
+                     // kill all voices on the (other) key
+                     RTList<Voice>::Iterator itVoiceToBeKilled = pOtherKey->pActiveVoices->first();
+                     RTList<Voice>::Iterator end               = pOtherKey->pActiveVoices->end();
+                     for (; itVoiceToBeKilled != end; ++itVoiceToBeKilled) {
+                         if (itVoiceToBeKilled->Type != Voice::type_release_trigger) {
+                             itVoiceToBeKilled->Kill(itNoteOnEvent);
+                             --VoiceSpawnsLeft; //FIXME: just a hack, we should better check in StealVoice() if the voice was killed due to key conflict
+                         }
+                     }
+                 }
+             }
+         }
+         Voice::type_t VoiceType = Voice::type_normal;
+         // get current dimension values to select the right dimension region
+         //TODO: for stolen voices this dimension region selection block is processed twice, this should be changed
+         //FIXME: controller values for selecting the dimension region here are currently not sample accurate
+         uint DimValues[8] = { 0 };
+         for (int i = pRegion->Dimensions - 1; i >= 0; i--) {
+             switch (pRegion->pDimensionDefinitions[i].dimension) {
+                 case ::gig::dimension_samplechannel:
+                     DimValues[i] = 0; //TODO: we currently ignore this dimension
+                     break;
+                 case ::gig::dimension_layer:
+                     DimValues[i] = iLayer;
+                     break;
+                 case ::gig::dimension_velocity:
+                     DimValues[i] = itNoteOnEvent->Param.Note.Velocity;
+                     break;
+                 case ::gig::dimension_channelaftertouch:
+                     DimValues[i] = pEngineChannel->ControllerTable[128];
+                     break;
+                 case ::gig::dimension_releasetrigger:
+                     VoiceType = (ReleaseTriggerVoice) ? Voice::type_release_trigger : (!iLayer) ? Voice::type_release_trigger_required : Voice::type_normal;
+                     DimValues[i] = (uint) ReleaseTriggerVoice;
+                     break;
+                 case ::gig::dimension_keyboard:
+                     DimValues[i] = (uint) (pEngineChannel->CurrentKeyDimension * pRegion->pDimensionDefinitions[i].zones);
+                     break;
+                 case ::gig::dimension_roundrobin:
+                     DimValues[i] = (uint) pEngineChannel->pMIDIKeyInfo[MIDIKey].RoundRobinIndex; // incremented for each note on
+                     break;
+                 case ::gig::dimension_random:
+                     RandomSeed   = RandomSeed * 1103515245 + 12345; // classic pseudo random number generator
+                     DimValues[i] = (uint) RandomSeed >> (32 - pRegion->pDimensionDefinitions[i].bits); // highest bits are most random
+                     break;
+                 case ::gig::dimension_modwheel:
+                     DimValues[i] = pEngineChannel->ControllerTable[1];
+                     break;
+                 case ::gig::dimension_breath:
+                     DimValues[i] = pEngineChannel->ControllerTable[2];
+                     break;
+                 case ::gig::dimension_foot:
+                     DimValues[i] = pEngineChannel->ControllerTable[4];
+                     break;
+                 case ::gig::dimension_portamentotime:
+                     DimValues[i] = pEngineChannel->ControllerTable[5];
+                     break;
+                 case ::gig::dimension_effect1:
+                     DimValues[i] = pEngineChannel->ControllerTable[12];
+                     break;
+                 case ::gig::dimension_effect2:
+                     DimValues[i] = pEngineChannel->ControllerTable[13];
+                     break;
+                 case ::gig::dimension_genpurpose1:
+                     DimValues[i] = pEngineChannel->ControllerTable[16];
+                     break;
+                 case ::gig::dimension_genpurpose2:
+                     DimValues[i] = pEngineChannel->ControllerTable[17];
+                     break;
+                 case ::gig::dimension_genpurpose3:
+                     DimValues[i] = pEngineChannel->ControllerTable[18];
+                     break;
+                 case ::gig::dimension_genpurpose4:
+                     DimValues[i] = pEngineChannel->ControllerTable[19];
+                     break;
+                 case ::gig::dimension_sustainpedal:
+                     DimValues[i] = pEngineChannel->ControllerTable[64];
+                     break;
+                 case ::gig::dimension_portamento:
+                     DimValues[i] = pEngineChannel->ControllerTable[65];
+                     break;
+                 case ::gig::dimension_sostenutopedal:
+                     DimValues[i] = pEngineChannel->ControllerTable[66];
+                     break;
+                 case ::gig::dimension_softpedal:
+                     DimValues[i] = pEngineChannel->ControllerTable[67];
+                     break;
+                 case ::gig::dimension_genpurpose5:
+                     DimValues[i] = pEngineChannel->ControllerTable[80];
+                     break;
+                 case ::gig::dimension_genpurpose6:
+                     DimValues[i] = pEngineChannel->ControllerTable[81];
+                     break;
+                 case ::gig::dimension_genpurpose7:
+                     DimValues[i] = pEngineChannel->ControllerTable[82];
+                     break;
+                 case ::gig::dimension_genpurpose8:
+                     DimValues[i] = pEngineChannel->ControllerTable[83];
+                     break;
+                 case ::gig::dimension_effect1depth:
+                     DimValues[i] = pEngineChannel->ControllerTable[91];
+                     break;
+                 case ::gig::dimension_effect2depth:
+                     DimValues[i] = pEngineChannel->ControllerTable[92];
+                     break;
+                 case ::gig::dimension_effect3depth:
+                     DimValues[i] = pEngineChannel->ControllerTable[93];
+                     break;
+                 case ::gig::dimension_effect4depth:
+                     DimValues[i] = pEngineChannel->ControllerTable[94];
+                     break;
+                 case ::gig::dimension_effect5depth:
+                     DimValues[i] = pEngineChannel->ControllerTable[95];
+                     break;
+                 case ::gig::dimension_none:
+                     std::cerr << "gig::Engine::LaunchVoice() Error: dimension=none\n" << std::flush;
+                     break;
+                 default:
+                     std::cerr << "gig::Engine::LaunchVoice() Error: Unknown dimension\n" << std::flush;
+             }
+         }
+         // return if this is a release triggered voice and there is no
+         // releasetrigger dimension (could happen if an instrument
+         // change has occured between note on and off)
+         if (ReleaseTriggerVoice && VoiceType != Voice::type_release_trigger) return Pool<Voice>::Iterator();
+         ::gig::DimensionRegion* pDimRgn = pRegion->GetDimensionRegionByValue(DimValues);
+         // no need to continue if sample is silent
+         if (!pDimRgn->pSample || !pDimRgn->pSample->SamplesTotal) return Pool<Voice>::Iterator();
+         // allocate a new voice for the key
+         Pool<Voice>::Iterator itNewVoice = pKey->pActiveVoices->allocAppend();
+         if (itNewVoice) {
+             // launch the new voice
+             if (itNewVoice->Trigger(pEngineChannel, itNoteOnEvent, pEngineChannel->Pitch, pDimRgn, VoiceType, iKeyGroup) < 0) {
+                 dmsg(4,("Voice not triggered\n"));
+                 pKey->pActiveVoices->free(itNewVoice);
+             }
+             else { // on success
+                 --VoiceSpawnsLeft;
+                 if (!pKey->Active) { // mark as active key
+                     pKey->Active = true;
+                     pKey->itSelf = pEngineChannel->pActiveKeys->allocAppend();
+                     *pKey->itSelf = itNoteOnEvent->Param.Note.Key;
+                 }
+                 if (itNewVoice->KeyGroup) {
+                     uint** ppKeyGroup = &pEngineChannel->ActiveKeyGroups[itNewVoice->KeyGroup];
+                     *ppKeyGroup = &*pKey->itSelf; // put key as the (new) active key to its key group
+                 }
+                 if (itNewVoice->Type == Voice::type_release_trigger_required) pKey->ReleaseTrigger = true; // mark key for the need of release triggered voice(s)
+                 return itNewVoice; // success
+             }
+         }
+         else if (VoiceStealing) {
+             // try to steal one voice
+             int result = StealVoice(pEngineChannel, itNoteOnEvent);
+             if (!result) { // voice stolen successfully
+                 // put note-on event into voice-stealing queue, so it will be reprocessed after killed voice died
+                 RTList<Event>::Iterator itStealEvent = pVoiceStealingQueue->allocAppend();
+                 if (itStealEvent) {
+                     *itStealEvent = *itNoteOnEvent; // copy event
+                     itStealEvent->Param.Note.Layer = iLayer;
+                     itStealEvent->Param.Note.ReleaseTrigger = ReleaseTriggerVoice;
+                     pKey->VoiceTheftsQueued++;
+                 }
+                 else dmsg(1,("Voice stealing queue full!\n"));
+             }
+         }
+         return Pool<Voice>::Iterator(); // no free voice or error
      }
      /**
-      *  Immediately kills the voice given with pVoice (no matter if sustain is
+      *  Will be called by LaunchVoice() method in case there are no free
-      *  pressed or not) and removes it from the MIDI key's list of active voice.
+      *  voices left. This method will select and kill one old voice for
-      *  This method will e.g. be called if a voice went inactive by itself.
+      *  voice stealing and postpone the note-on event until the selected
+      *  voice actually died.
       *
-      *  @param pVoice - points to the voice to be killed
+      *  @param pEngineChannel - engine channel on which this event occured on
+      *  @param itNoteOnEvent - key, velocity and time stamp of the event
+      *  @returns 0 on success, a value < 0 if no active voice could be picked for voice stealing
       */
-     void Engine::KillVoice(Voice* pVoice) {
+     int Engine::StealVoice(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent) {
-         if (pVoice) {
+         if (VoiceSpawnsLeft <= 0) {
-             if (pVoice->IsActive()) pVoice->Kill();
+             dmsg(1,("Max. voice thefts per audio fragment reached (you may raise CONFIG_MAX_VOICES).\n"));
+             return -1;
+         }
+         if (!pEventPool->poolIsEmpty()) {
+             RTList<Voice>::Iterator itSelectedVoice;
+             // Select one voice for voice stealing
+             switch (CONFIG_VOICE_STEAL_ALGO) {
+                 // try to pick the oldest voice on the key where the new
+                 // voice should be spawned, if there is no voice on that
+                 // key, or no voice left to kill, then procceed with
+                 // 'oldestkey' algorithm
+                 case voice_steal_algo_oldestvoiceonkey: {
+                     midi_key_info_t* pSelectedKey = &pEngineChannel->pMIDIKeyInfo[itNoteOnEvent->Param.Note.Key];
+                     itSelectedVoice = pSelectedKey->pActiveVoices->first();
+                     // proceed iterating if voice was created in this fragment cycle
+                     while (itSelectedVoice && !itSelectedVoice->IsStealable()) ++itSelectedVoice;
+                     // if we haven't found a voice then proceed with algorithm 'oldestkey'
+                     if (itSelectedVoice && itSelectedVoice->IsStealable()) break;
+                 } // no break - intentional !
+                 // try to pick the oldest voice on the oldest active key
+                 // from the same engine channel
+                 // (caution: must stay after 'oldestvoiceonkey' algorithm !)
+                 case voice_steal_algo_oldestkey: {
+                     // if we already stole in this fragment, try to proceed on same key
+                     if (this->itLastStolenVoice) {
+                         itSelectedVoice = this->itLastStolenVoice;
+                         do {
+                             ++itSelectedVoice;
+                         } while (itSelectedVoice && !itSelectedVoice->IsStealable()); // proceed iterating if voice was created in this fragment cycle
+                         // found a "stealable" voice ?
+                         if (itSelectedVoice && itSelectedVoice->IsStealable()) {
+                             // remember which voice we stole, so we can simply proceed on next voice stealing
+                             this->itLastStolenVoice = itSelectedVoice;
+                             break; // selection succeeded
+                         }
+                     }
+                     // get (next) oldest key
+                     RTList<uint>::Iterator iuiSelectedKey = (this->iuiLastStolenKey) ? ++this->iuiLastStolenKey : pEngineChannel->pActiveKeys->first();
+                     while (iuiSelectedKey) {
+                         midi_key_info_t* pSelectedKey = &pEngineChannel->pMIDIKeyInfo[*iuiSelectedKey];
+                         itSelectedVoice = pSelectedKey->pActiveVoices->first();
+                         // proceed iterating if voice was created in this fragment cycle
+                         while (itSelectedVoice && !itSelectedVoice->IsStealable()) ++itSelectedVoice;
+                         // found a "stealable" voice ?
+                         if (itSelectedVoice && itSelectedVoice->IsStealable()) {
+                             // remember which voice on which key we stole, so we can simply proceed on next voice stealing
+                             this->iuiLastStolenKey  = iuiSelectedKey;
+                             this->itLastStolenVoice = itSelectedVoice;
+                             break; // selection succeeded
+                         }
+                         ++iuiSelectedKey; // get next oldest key
+                     }
+                     break;
+                 }
-             midi_key_info_t* pKey = &pMIDIKeyInfo[pVoice->MIDIKey];
+                 // don't steal anything
+                 case voice_steal_algo_none:
+                 default: {
+                     dmsg(1,("No free voice (voice stealing disabled)!\n"));
+                     return -1;
+                 }
+             }
+             // if we couldn't steal a voice from the same engine channel then
+             // steal oldest voice on the oldest key from any other engine channel
+             // (the smaller engine channel number, the higher priority)
+             if (!itSelectedVoice || !itSelectedVoice->IsStealable()) {
+                 EngineChannel* pSelectedChannel;
+                 int            iChannelIndex;
+                 // select engine channel
+                 if (pLastStolenChannel) {
+                     pSelectedChannel = pLastStolenChannel;
+                     iChannelIndex    = pSelectedChannel->iEngineIndexSelf;
+                 } else { // pick the engine channel followed by this engine channel
+                     iChannelIndex    = (pEngineChannel->iEngineIndexSelf + 1) % engineChannels.size();
+                     pSelectedChannel = engineChannels[iChannelIndex];
+                 }
+                 // if we already stole in this fragment, try to proceed on same key
+                 if (this->itLastStolenVoiceGlobally) {
+                     itSelectedVoice = this->itLastStolenVoiceGlobally;
+                     do {
+                         ++itSelectedVoice;
+                     } while (itSelectedVoice && !itSelectedVoice->IsStealable()); // proceed iterating if voice was created in this fragment cycle
+                 }
+                 #if CONFIG_DEVMODE
+                 EngineChannel* pBegin = pSelectedChannel; // to detect endless loop
+                 #endif // CONFIG_DEVMODE
+                 // did we find a 'stealable' voice?
+                 if (itSelectedVoice && itSelectedVoice->IsStealable()) {
+                     // remember which voice we stole, so we can simply proceed on next voice stealing
+                     this->itLastStolenVoiceGlobally = itSelectedVoice;
+                 } else while (true) { // iterate through engine channels
+                     // get (next) oldest key
+                     RTList<uint>::Iterator iuiSelectedKey = (this->iuiLastStolenKeyGlobally) ? ++this->iuiLastStolenKeyGlobally : pSelectedChannel->pActiveKeys->first();
+                     this->iuiLastStolenKeyGlobally = RTList<uint>::Iterator(); // to prevent endless loop (see line above)
+                     while (iuiSelectedKey) {
+                         midi_key_info_t* pSelectedKey = &pSelectedChannel->pMIDIKeyInfo[*iuiSelectedKey];
+                         itSelectedVoice = pSelectedKey->pActiveVoices->first();
+                         // proceed iterating if voice was created in this fragment cycle
+                         while (itSelectedVoice && !itSelectedVoice->IsStealable()) ++itSelectedVoice;
+                         // found a "stealable" voice ?
+                         if (itSelectedVoice && itSelectedVoice->IsStealable()) {
+                             // remember which voice on which key on which engine channel we stole, so we can simply proceed on next voice stealing
+                             this->iuiLastStolenKeyGlobally  = iuiSelectedKey;
+                             this->itLastStolenVoiceGlobally = itSelectedVoice;
+                             this->pLastStolenChannel        = pSelectedChannel;
+                             goto stealable_voice_found; // selection succeeded
+                         }
+                         ++iuiSelectedKey; // get next key on current engine channel
+                     }
+                     // get next engine channel
+                     iChannelIndex    = (iChannelIndex + 1) % engineChannels.size();
+                     pSelectedChannel = engineChannels[iChannelIndex];
+                     #if CONFIG_DEVMODE
+                     if (pSelectedChannel == pBegin) {
+                         dmsg(1,("FATAL ERROR: voice stealing endless loop!\n"));
+                         dmsg(1,("VoiceSpawnsLeft=%d.\n", VoiceSpawnsLeft));
+                         dmsg(1,("Exiting.\n"));
+                         exit(-1);
+                     }
+                     #endif // CONFIG_DEVMODE
+                 }
+             }
+             // jump point if a 'stealable' voice was found
+             stealable_voice_found:
+             #if CONFIG_DEVMODE
+             if (!itSelectedVoice->IsActive()) {
+                 dmsg(1,("gig::Engine: ERROR, tried to steal a voice which was not active !!!\n"));
+                 return -1;
+             }
+             #endif // CONFIG_DEVMODE
+             // now kill the selected voice
+             itSelectedVoice->Kill(itNoteOnEvent);
+             --VoiceSpawnsLeft;
+             return 0; // success
+         }
+         else {
+             dmsg(1,("Event pool emtpy!\n"));
+             return -1;
+         }
+     }
+     /**
+      *  Removes the given voice from the MIDI key's list of active voices.
+      *  This method will be called when a voice went inactive, e.g. because
+      *  it finished to playback its sample, finished its release stage or
+      *  just was killed.
+      *
+      *  @param pEngineChannel - engine channel on which this event occured on
+      *  @param itVoice - points to the voice to be freed
+      */
+     void Engine::FreeVoice(EngineChannel* pEngineChannel, Pool<Voice>::Iterator& itVoice) {
+         if (itVoice) {
+             midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[itVoice->MIDIKey];
+             uint keygroup = itVoice->KeyGroup;
+             // if the sample and dimension region belong to an
+             // instrument that is unloaded, tell the disk thread to
+             // release them
+             if (itVoice->Orphan) {
+                 pDiskThread->OrderDeletionOfDimreg(itVoice->pDimRgn);
+             }
              // free the voice object
-             pVoicePool->free(pVoice);
+             pVoicePool->free(itVoice);
-             // check if there are no voices left on the MIDI key and update the key info if so
+             // if no other voices left and member of a key group, remove from key group
-             if (pKey->pActiveVoices->is_empty()) {
+             if (pKey->pActiveVoices->isEmpty() && keygroup) {
-                 pKey->Active = false;
+                 uint** ppKeyGroup = &pEngineChannel->ActiveKeyGroups[keygroup];
-                 pActiveKeys->free(pKey->pSelf); // remove key from list of active keys
+                 if (*ppKeyGroup == &*pKey->itSelf) *ppKeyGroup = NULL; // remove key from key group
-                 pKey->pSelf = NULL;
-                 dmsg(3,("Key has no more voices now\n"));
              }
          }
-         else std::cerr << "Couldn't release voice! (pVoice == NULL)\n" << std::flush;
+         else std::cerr << "Couldn't release voice! (!itVoice)\n" << std::flush;
+     }
+     /**
+      *  Called when there's no more voice left on a key, this call will
+      *  update the key info respectively.
+      *
+      *  @param pEngineChannel - engine channel on which this event occured on
+      *  @param pKey - key which is now inactive
+      */
+     void Engine::FreeKey(EngineChannel* pEngineChannel, midi_key_info_t* pKey) {
+         if (pKey->pActiveVoices->isEmpty()) {
+             pKey->Active = false;
+             pEngineChannel->pActiveKeys->free(pKey->itSelf); // remove key from list of active keys
+             pKey->itSelf = RTList<uint>::Iterator();
+             pKey->ReleaseTrigger = false;
+             pKey->pEvents->clear();
+             dmsg(3,("Key has no more voices now\n"));
+         }
+         else dmsg(1,("gig::Engine: Oops, tried to free a key which contains voices.\n"));
      }
      /**
       *  Reacts on supported control change commands (e.g. pitch bend wheel,
       *  modulation wheel, aftertouch).
       *
-      *  @param pControlChangeEvent - controller, value and time stamp of the event
+      *  @param pEngineChannel - engine channel on which this event occured on
+      *  @param itControlChangeEvent - controller, value and time stamp of the event
       */
-     void Engine::ProcessControlChange(Event* pControlChangeEvent) {
+     void Engine::ProcessControlChange(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itControlChangeEvent) {
-         dmsg(4,("Engine::ContinuousController cc=%d v=%d\n", pControlChangeEvent->Controller, pControlChangeEvent->Value));
+         dmsg(4,("Engine::ContinuousController cc=%d v=%d\n", itControlChangeEvent->Param.CC.Controller, itControlChangeEvent->Param.CC.Value));
+         // handle the "control triggered" MIDI rule: a control change
+         // event can trigger a new note on or note off event
+         if (pEngineChannel->pInstrument) {
+             ::gig::MidiRule* rule;
+             for (int i = 0 ; (rule = pEngineChannel->pInstrument->GetMidiRule(i)) ; i++) {
+                 if (::gig::MidiRuleCtrlTrigger* ctrlTrigger =
+                     dynamic_cast< ::gig::MidiRuleCtrlTrigger*>(rule)) {
+                     if (itControlChangeEvent->Param.CC.Controller ==
+                         ctrlTrigger->ControllerNumber) {
+                         uint8_t oldCCValue = pEngineChannel->ControllerTable[
+                             itControlChangeEvent->Param.CC.Controller];
+                         uint8_t newCCValue = itControlChangeEvent->Param.CC.Value;
+                         for (int i = 0 ; i < ctrlTrigger->Triggers ; i++) {
+                             ::gig::MidiRuleCtrlTrigger::trigger_t* pTrigger =
+                                   &ctrlTrigger->pTriggers[i];
+                             // check if the controller has passed the
+                             // trigger point in the right direction
+                             if ((pTrigger->Descending &&
+                                  oldCCValue > pTrigger->TriggerPoint &&
+                                  newCCValue <= pTrigger->TriggerPoint) ||
+                                 (!pTrigger->Descending &&
+                                  oldCCValue < pTrigger->TriggerPoint &&
+                                  newCCValue >= pTrigger->TriggerPoint)) {
+                                 RTList<Event>::Iterator itNewEvent = pGlobalEvents->allocAppend();
+                                 if (itNewEvent) {
+                                     *itNewEvent = *itControlChangeEvent;
+                                     itNewEvent->Param.Note.Key = pTrigger->Key;
+                                     if (pTrigger->NoteOff || pTrigger->Velocity == 0) {
+                                         itNewEvent->Type = Event::type_note_off;
+                                         itNewEvent->Param.Note.Velocity = 100;
+                                         ProcessNoteOff(pEngineChannel, itNewEvent);
+                                     } else {
+                                         itNewEvent->Type = Event::type_note_on;
+                                         //TODO: if Velocity is 255, the triggered velocity should
+                                         // depend on how fast the controller is moving
+                                         itNewEvent->Param.Note.Velocity =
+                                             pTrigger->Velocity == 255 ? 100 :
+                                             pTrigger->Velocity;
+                                         ProcessNoteOn(pEngineChannel, itNewEvent);
+                                     }
+                                 }
+                                 else dmsg(1,("Event pool emtpy!\n"));
+                             }
+                         }
+                     }
+                 }
+             }
+         }
+         // update controller value in the engine channel's controller table
+         pEngineChannel->ControllerTable[itControlChangeEvent->Param.CC.Controller] = itControlChangeEvent->Param.CC.Value;
-         switch (pControlChangeEvent->Controller) {
+         // handle hard coded MIDI controllers
-             case 64: {
+         switch (itControlChangeEvent->Param.CC.Controller) {
-                 if (pControlChangeEvent->Value >= 64 && !SustainPedal) {
+             case 5: { // portamento time
-                     dmsg(4,("PEDAL DOWN\n"));
+                 pEngineChannel->PortamentoTime = (float) itControlChangeEvent->Param.CC.Value / 127.0f * (float) CONFIG_PORTAMENTO_TIME_MAX + (float) CONFIG_PORTAMENTO_TIME_MIN;
-                     SustainPedal = true;
+                 break;
+             }
+             case 6: { // data entry (currently only used for RPN controllers)
+                 if (pEngineChannel->GetMidiRpnController() == 2) { // coarse tuning in half tones
+                     int transpose = (int) itControlChangeEvent->Param.CC.Value - 64;
+                     // limit to +- two octaves for now
+                     transpose = RTMath::Min(transpose,  24);
+                     transpose = RTMath::Max(transpose, -24);
+                     pEngineChannel->GlobalTranspose = transpose;
+                     // workaround, so we won't have hanging notes
+                     ReleaseAllVoices(pEngineChannel, itControlChangeEvent);
+                 }
+                 // to avoid other MIDI CC #6 messages to be misenterpreted as RPN controller data
+                 pEngineChannel->ResetMidiRpnController();
+                 break;
+             }
+             case 7: { // volume
+                 //TODO: not sample accurate yet
+                 pEngineChannel->MidiVolume = VolumeCurve[itControlChangeEvent->Param.CC.Value];
+                 pEngineChannel->bStatusChanged = true; // engine channel status has changed, so set notify flag
+                 break;
+             }
+             case 10: { // panpot
+                 //TODO: not sample accurate yet
+                 pEngineChannel->GlobalPanLeft  = PanCurve[128 - itControlChangeEvent->Param.CC.Value];
+                 pEngineChannel->GlobalPanRight = PanCurve[itControlChangeEvent->Param.CC.Value];
+                 pEngineChannel->iLastPanRequest = itControlChangeEvent->Param.CC.Value;
+                 break;
+             }
+             case 64: { // sustain
+                 if (itControlChangeEvent->Param.CC.Value >= 64 && !pEngineChannel->SustainPedal) {
+                     dmsg(4,("DAMPER (RIGHT) PEDAL DOWN\n"));
+                     pEngineChannel->SustainPedal = true;
+                     #if !CONFIG_PROCESS_MUTED_CHANNELS
+                     if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted
+                     #endif
                      // cancel release process of voices if necessary
-                     uint* piKey = pActiveKeys->first();
+                     RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
-                     if (piKey) {
+                     for (; iuiKey; ++iuiKey) {
-                         pControlChangeEvent->Type = Event::type_cancel_release; // transform event type
+                         midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
-                         while (piKey) {
+                         if (!pKey->KeyPressed) {
-                             midi_key_info_t* pKey = &pMIDIKeyInfo[*piKey];
+                             RTList<Event>::Iterator itNewEvent = pKey->pEvents->allocAppend();
-                             pActiveKeys->set_current(piKey);
+                             if (itNewEvent) {
-                             piKey = pActiveKeys->next();
+                                 *itNewEvent = *itControlChangeEvent; // copy event to the key's own event list
-                             if (!pKey->KeyPressed) {
+                                 itNewEvent->Type = Event::type_cancel_release; // transform event type
-                                 Event* pNewEvent = pKey->pEvents->alloc();
-                                 if (pNewEvent) *pNewEvent = *pControlChangeEvent; // copy event to the key's own event list
-                                 else dmsg(1,("Event pool emtpy!\n"));
                              }
+                             else dmsg(1,("Event pool emtpy!\n"));
                          }
                      }
                  }
-                 if (pControlChangeEvent->Value < 64 && SustainPedal) {
+                 if (itControlChangeEvent->Param.CC.Value < 64 && pEngineChannel->SustainPedal) {
-                     dmsg(4,("PEDAL UP\n"));
+                     dmsg(4,("DAMPER (RIGHT) PEDAL UP\n"));
-                     SustainPedal = false;
+                     pEngineChannel->SustainPedal = false;
+                     #if !CONFIG_PROCESS_MUTED_CHANNELS
+                     if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted
+                     #endif
                      // release voices if their respective key is not pressed
-                     uint* piKey = pActiveKeys->first();
+                     RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
-                     if (piKey) {
+                     for (; iuiKey; ++iuiKey) {
-                         pControlChangeEvent->Type = Event::type_release; // transform event type
+                         midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
-                         while (piKey) {
+                         if (!pKey->KeyPressed && ShouldReleaseVoice(pEngineChannel, *iuiKey)) {
-                             midi_key_info_t* pKey = &pMIDIKeyInfo[*piKey];
+                             RTList<Event>::Iterator itNewEvent = pKey->pEvents->allocAppend();
-                             pActiveKeys->set_current(piKey);
+                             if (itNewEvent) {
-                             piKey = pActiveKeys->next();
+                                 *itNewEvent = *itControlChangeEvent; // copy event to the key's own event list
-                             if (!pKey->KeyPressed) {
+                                 itNewEvent->Type = Event::type_release; // transform event type
-                                 Event* pNewEvent = pKey->pEvents->alloc();
-                                 if (pNewEvent) *pNewEvent = *pControlChangeEvent; // copy event to the key's own event list
-                                 else dmsg(1,("Event pool emtpy!\n"));
                              }
+                             else dmsg(1,("Event pool emtpy!\n"));
                          }
                      }
                  }
                  break;
              }
+             case 65: { // portamento on / off
+                 const bool bPortamento = itControlChangeEvent->Param.CC.Value >= 64;
+                 if (bPortamento != pEngineChannel->PortamentoMode)
+                     KillAllVoices(pEngineChannel, itControlChangeEvent);
+                 pEngineChannel->PortamentoMode = bPortamento;
+                 break;
+             }
+             case 66: { // sostenuto
+                 if (itControlChangeEvent->Param.CC.Value >= 64 && !pEngineChannel->SostenutoPedal) {
+                     dmsg(4,("SOSTENUTO (CENTER) PEDAL DOWN\n"));
+                     pEngineChannel->SostenutoPedal = true;
+                     #if !CONFIG_PROCESS_MUTED_CHANNELS
+                     if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted
+                     #endif
+                     SostenutoKeyCount = 0;
+                     // Remeber the pressed keys
+                     RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
+                     for (; iuiKey; ++iuiKey) {
+                         midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
+                         if (pKey->KeyPressed && SostenutoKeyCount < 128) SostenutoKeys[SostenutoKeyCount++] = *iuiKey;
+                     }
+                 }
+                 if (itControlChangeEvent->Param.CC.Value < 64 && pEngineChannel->SostenutoPedal) {
+                     dmsg(4,("SOSTENUTO (CENTER) PEDAL UP\n"));
+                     pEngineChannel->SostenutoPedal = false;
+                     #if !CONFIG_PROCESS_MUTED_CHANNELS
+                     if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted
+                     #endif
+                     // release voices if the damper pedal is up and their respective key is not pressed
+                     for (int i = 0; i < SostenutoKeyCount; i++) {
+                         midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[SostenutoKeys[i]];
+                         if (!pKey->KeyPressed && !pEngineChannel->SustainPedal) {
+                             RTList<Event>::Iterator itNewEvent = pKey->pEvents->allocAppend();
+                             if (itNewEvent) {
+                                 *itNewEvent = *itControlChangeEvent; // copy event to the key's own event list
+                                 itNewEvent->Type = Event::type_release; // transform event type
+                             }
+                             else dmsg(1,("Event pool emtpy!\n"));
+                         }
+                     }
+                 }
+                 break;
+             }
+             case 100: { // RPN controller LSB
+                 pEngineChannel->SetMidiRpnControllerLsb(itControlChangeEvent->Param.CC.Value);
+                 break;
+             }
+             case 101: { // RPN controller MSB
+                 pEngineChannel->SetMidiRpnControllerMsb(itControlChangeEvent->Param.CC.Value);
+                 break;
+             }
+             // Channel Mode Messages
+             case 120: { // all sound off
+                 KillAllVoices(pEngineChannel, itControlChangeEvent);
+                 break;
+             }
+             case 121: { // reset all controllers
+                 pEngineChannel->ResetControllers();
+                 break;
+             }
+             case 123: { // all notes off
+                 #if CONFIG_PROCESS_ALL_NOTES_OFF
+                 ReleaseAllVoices(pEngineChannel, itControlChangeEvent);
+                 #endif // CONFIG_PROCESS_ALL_NOTES_OFF
+                 break;
+             }
+             case 126: { // mono mode on
+                 if (!pEngineChannel->SoloMode)
+                     KillAllVoices(pEngineChannel, itControlChangeEvent);
+                 pEngineChannel->SoloMode = true;
+                 break;
+             }
+             case 127: { // poly mode on
+                 if (pEngineChannel->SoloMode)
+                     KillAllVoices(pEngineChannel, itControlChangeEvent);
+                 pEngineChannel->SoloMode = false;
+                 break;
+             }
          }
-         // update controller value in the engine's controller table
+         // handle FX send controllers
-         ControllerTable[pControlChangeEvent->Controller] = pControlChangeEvent->Value;
+         if (!pEngineChannel->fxSends.empty()) {
+             for (int iFxSend = 0; iFxSend < pEngineChannel->GetFxSendCount(); iFxSend++) {
+                 FxSend* pFxSend = pEngineChannel->GetFxSend(iFxSend);
+                 if (pFxSend->MidiController() == itControlChangeEvent->Param.CC.Controller) {
+                     pFxSend->SetLevel(itControlChangeEvent->Param.CC.Value);
+                     pFxSend->SetInfoChanged(true);
+                 }
+             }
+         }
+     }
+     /**
+      *  Reacts on MIDI system exclusive messages.
+      *
+      *  @param itSysexEvent - sysex data size and time stamp of the sysex event
+      */
+     void Engine::ProcessSysex(Pool<Event>::Iterator& itSysexEvent) {
+         RingBuffer<uint8_t,false>::NonVolatileReader reader = pSysexBuffer->get_non_volatile_reader();
+         uint8_t exclusive_status, id;
+         if (!reader.pop(&exclusive_status)) goto free_sysex_data;
+         if (!reader.pop(&id))               goto free_sysex_data;
+         if (exclusive_status != 0xF0)       goto free_sysex_data;
+         switch (id) {
+             case 0x7f: { // (Realtime) Universal Sysex (GM Standard)
+                 uint8_t sysex_channel, sub_id1, sub_id2, val_msb, val_lsb;;
+                 if (!reader.pop(&sysex_channel)) goto free_sysex_data;
+                 if (!reader.pop(&sub_id1)) goto free_sysex_data;
+                 if (!reader.pop(&sub_id2)) goto free_sysex_data;
+                 if (!reader.pop(&val_lsb)) goto free_sysex_data;
+                 if (!reader.pop(&val_msb)) goto free_sysex_data;
+                 //TODO: for now we simply ignore the sysex channel, seldom used anyway
+                 switch (sub_id1) {
+                     case 0x04: // Device Control
+                         switch (sub_id2) {
+                             case 0x01: { // Master Volume
+                                 const double volume =
+                                     double((uint(val_msb)<<7) | uint(val_lsb)) / 16383.0;
+                                 #if CONFIG_MASTER_VOLUME_SYSEX_BY_PORT
+                                 // apply volume to all sampler channels that
+                                 // are connected to the same MIDI input port
+                                 // this sysex message arrived on
+                                 for (int i = 0; i < engineChannels.size(); ++i) {
+                                     EngineChannel* pEngineChannel = engineChannels[i];
+                                     if (pEngineChannel->GetMidiInputPort() ==
+                                         itSysexEvent->pMidiInputPort)
+                                     {
+                                         pEngineChannel->Volume(volume);
+                                     }
+                                 }
+                                 #else
+                                 // apply volume globally to the whole sampler
+                                 GLOBAL_VOLUME = volume;
+                                 #endif // CONFIG_MASTER_VOLUME_SYSEX_BY_PORT
+                                 break;
+                             }
+                         }
+                         break;
+                 }
+                 break;
+             }
+             case 0x41: { // Roland
+                 dmsg(3,("Roland Sysex\n"));
+                 uint8_t device_id, model_id, cmd_id;
+                 if (!reader.pop(&device_id)) goto free_sysex_data;
+                 if (!reader.pop(&model_id))  goto free_sysex_data;
+                 if (!reader.pop(&cmd_id))    goto free_sysex_data;
+                 if (model_id != 0x42 /*GS*/) goto free_sysex_data;
+                 if (cmd_id != 0x12 /*DT1*/)  goto free_sysex_data;
+                 // command address
+                 uint8_t addr[3]; // 2 byte addr MSB, followed by 1 byte addr LSB)
+                 const RingBuffer<uint8_t,false>::NonVolatileReader checksum_reader = reader; // so we can calculate the check sum later
+                 if (reader.read(&addr[0], 3) != 3) goto free_sysex_data;
+                 if (addr[0] == 0x40 && addr[1] == 0x00) { // System Parameters
+                     dmsg(3,("\tSystem Parameter\n"));
+                 }
+                 else if (addr[0] == 0x40 && addr[1] == 0x01) { // Common Parameters
+                     dmsg(3,("\tCommon Parameter\n"));
+                 }
+                 else if (addr[0] == 0x40 && (addr[1] & 0xf0) == 0x10) { // Part Parameters (1)
+                     dmsg(3,("\tPart Parameter\n"));
+                     switch (addr[2]) {
+                         case 0x40: { // scale tuning
+                             dmsg(3,("\t\tScale Tuning\n"));
+                             uint8_t scale_tunes[12]; // detuning of all 12 semitones of an octave
+                             if (reader.read(&scale_tunes[0], 12) != 12) goto free_sysex_data;
+                             uint8_t checksum;
+                             if (!reader.pop(&checksum)) goto free_sysex_data;
+                             #if CONFIG_ASSERT_GS_SYSEX_CHECKSUM
+                             if (GSCheckSum(checksum_reader, 12)) goto free_sysex_data;
+                             #endif // CONFIG_ASSERT_GS_SYSEX_CHECKSUM
+                             for (int i = 0; i < 12; i++) scale_tunes[i] -= 64;
+                             AdjustScale((int8_t*) scale_tunes);
+                             dmsg(3,("\t\t\tNew scale applied.\n"));
+                             break;
+                         }
+                         case 0x15: { // chromatic / drumkit mode
+                             dmsg(3,("\t\tMIDI Instrument Map Switch\n"));
+                             uint8_t part = addr[1] & 0x0f;
+                             uint8_t map;
+                             if (!reader.pop(&map)) goto free_sysex_data;
+                             for (int i = 0; i < engineChannels.size(); ++i) {
+                                 EngineChannel* pEngineChannel = engineChannels[i];
+                                 if (
+                                     (pEngineChannel->midiChannel == part ||
+                                      pEngineChannel->midiChannel == midi_chan_all) &&
+                                      pEngineChannel->GetMidiInputPort() == itSysexEvent->pMidiInputPort
+                                 ) {
+                                     try {
+                                         pEngineChannel->SetMidiInstrumentMap(map);
+                                     } catch (Exception e) {
+                                         dmsg(2,("\t\t\tCould not apply MIDI instrument map %d to part %d: %s\n", map, part, e.Message().c_str()));
+                                         goto free_sysex_data;
+                                     } catch (...) {
+                                         dmsg(2,("\t\t\tCould not apply MIDI instrument map %d to part %d (unknown exception)\n", map, part));
+                                         goto free_sysex_data;
+                                     }
+                                 }
+                             }
+                             dmsg(3,("\t\t\tApplied MIDI instrument map %d to part %d.\n", map, part));
+                             break;
+                         }
+                     }
+                 }
+                 else if (addr[0] == 0x40 && (addr[1] & 0xf0) == 0x20) { // Part Parameters (2)
+                 }
+                 else if (addr[0] == 0x41) { // Drum Setup Parameters
+                 }
+                 break;
+             }
+         }
+         free_sysex_data: // finally free sysex data
+         pSysexBuffer->increment_read_ptr(itSysexEvent->Param.Sysex.Size);
+     }
+     /**
+      * Calculates the Roland GS sysex check sum.
+      *
+      * @param AddrReader - reader which currently points to the first GS
+      *                     command address byte of the GS sysex message in
+      *                     question
+      * @param DataSize   - size of the GS message data (in bytes)
+      */
+     uint8_t Engine::GSCheckSum(const RingBuffer<uint8_t,false>::NonVolatileReader AddrReader, uint DataSize) {
+         RingBuffer<uint8_t,false>::NonVolatileReader reader = AddrReader;
+         uint bytes = 3 /*addr*/ + DataSize;
+         uint8_t addr_and_data[bytes];
+         reader.read(&addr_and_data[0], bytes);
+         uint8_t sum = 0;
+         for (uint i = 0; i < bytes; i++) sum += addr_and_data[i];
+         return 128 - sum % 128;
+     }
-         // move event from the unsorted event list to the control change event list
+     /**
-         pEvents->move(pControlChangeEvent, pCCEvents);
+      * Allows to tune each of the twelve semitones of an octave.
+      *
+      * @param ScaleTunes - detuning of all twelve semitones (in cents)
+      */
+     void Engine::AdjustScale(int8_t ScaleTunes[12]) {
+         memcpy(&this->ScaleTuning[0], &ScaleTunes[0], 12); //TODO: currently not sample accurate
      }
      /**
-      * Initialize the parameter sequence for the modulation destination given by
+      * Releases all voices on an engine channel. All voices will go into
-      * by 'dst' with the constant value given by val.
+      * the release stage and thus it might take some time (e.g. dependant to
+      * their envelope release time) until they actually die.
+      *
+      * @param pEngineChannel - engine channel on which all voices should be released
+      * @param itReleaseEvent - event which caused this releasing of all voices
       */
-     void Engine::ResetSynthesisParameters(Event::destination_t dst, float val) {
+     void Engine::ReleaseAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itReleaseEvent) {
-         int maxsamples = pAudioOutputDevice->MaxSamplesPerCycle();
+         RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
-         float* m = &pSynthesisParameters[dst][0];
+         while (iuiKey) {
-         for (int i = 0; i < maxsamples; i += 4) {
+             midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
-            m[i]   = val;
+             ++iuiKey;
-            m[i+1] = val;
+             // append a 'release' event to the key's own event list
-            m[i+2] = val;
+             RTList<Event>::Iterator itNewEvent = pKey->pEvents->allocAppend();
-            m[i+3] = val;
+             if (itNewEvent) {
+                 *itNewEvent = *itReleaseEvent; // copy original event (to the key's event list)
+                 itNewEvent->Type = Event::type_release; // transform event type
+             }
+             else dmsg(1,("Event pool emtpy!\n"));
          }
      }
-     float Engine::Volume() {
+     /**
-         return GlobalVolume;
+      * Kills all voices on an engine channel as soon as possible. Voices
+      * won't get into release state, their volume level will be ramped down
+      * as fast as possible.
+      *
+      * @param pEngineChannel - engine channel on which all voices should be killed
+      * @param itKillEvent    - event which caused this killing of all voices
+      */
+     void Engine::KillAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itKillEvent) {
+         RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
+         RTList<uint>::Iterator end    = pEngineChannel->pActiveKeys->end();
+         while (iuiKey != end) { // iterate through all active keys
+             midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
+             ++iuiKey;
+             RTList<Voice>::Iterator itVoice     = pKey->pActiveVoices->first();
+             RTList<Voice>::Iterator itVoicesEnd = pKey->pActiveVoices->end();
+             for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key
+                 itVoice->Kill(itKillEvent);
+                 --VoiceSpawnsLeft; //FIXME: just a temporary workaround, we should check the cause in StealVoice() instead
+             }
+         }
      }
-     void Engine::Volume(float f) {
+     /**
-         GlobalVolume = f;
+      * Determines whether the specified voice should be released.
+      *
+      * @param pEngineChannel - The engine channel on which the voice should be checked
+      * @param Key - The key number
+      * @returns true if the specified should be released, false otherwise.
+      */
+     bool Engine::ShouldReleaseVoice(EngineChannel* pEngineChannel, int Key) {
+         if (pEngineChannel->SustainPedal) return false;
+         if (pEngineChannel->SostenutoPedal) {
+             for (int i = 0; i < SostenutoKeyCount; i++)
+                 if (Key == SostenutoKeys[i]) return false;
+         }
+         return true;
      }
      uint Engine::VoiceCount() {
-Line 698 
 namespace LinuxSampler { namespace gig {
+Line 2128 
 namespace LinuxSampler { namespace gig {
      }
      String Engine::EngineName() {
-         return "GigEngine";
+         return LS_GIG_ENGINE_NAME;
      }
-     String Engine::InstrumentFileName() {
+     String Engine::Description() {
-         return InstrumentFile;
+         return "Gigasampler Format Engine";
      }
-     int Engine::InstrumentIndex() {
+     String Engine::Version() {
-         return InstrumentIdx;
+         String s = "$Revision: 1.97 $";
+         return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword
      }
-     String Engine::Description() {
+     InstrumentManager* Engine::GetInstrumentManager() {
-         return "Gigasampler Engine";
+         return &instruments;
      }
-     String Engine::Version() {
+     // static constant initializers
-         String s = "$Revision: 1.6 $";
+     const Engine::FloatTable Engine::VolumeCurve(InitVolumeCurve());
-         return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword
+     const Engine::FloatTable Engine::PanCurve(InitPanCurve());
+     const Engine::FloatTable Engine::CrossfadeCurve(InitCrossfadeCurve());
+     float* Engine::InitVolumeCurve() {
+         // line-segment approximation
+         const float segments[] = {
+, 0, 2, 0.0046, 16, 0.016, 31, 0.051, 45, 0.115, 54.5, 0.2,
+.5, 0.39, 74, 0.74, 92, 1.03, 114, 1.94, 119.2, 2.2, 127, 2.2
+         };
+         return InitCurve(segments);
+     }
+     float* Engine::InitPanCurve() {
+         // line-segment approximation
+         const float segments[] = {
+, 0, 1, 0,
+, 0.05, 31.5, 0.7, 51, 0.851, 74.5, 1.12,
+, 1.41, 128, 1.41
+         };
+         return InitCurve(segments, 129);
+     }
+     float* Engine::InitCrossfadeCurve() {
+         // line-segment approximation
+         const float segments[] = {
+, 0, 1, 0.03, 10, 0.1, 51, 0.58, 127, 1
+         };
+         return InitCurve(segments);
+     }
+     float* Engine::InitCurve(const float* segments, int size) {
+         float* y = new float[size];
+         for (int x = 0 ; x < size ; x++) {
+             if (x > segments[2]) segments += 2;
+             y[x] = segments[1] + (x - segments[0]) *
+                 (segments[3] - segments[1]) / (segments[2] - segments[0]);
+         }
+         return y;
      }
  }} // namespace LinuxSampler::gig

 Legend:



Removed from v.123
 


changed lines


 
Added in v.1764
 Legend:



Removed from v.123
 


changed lines


 
Added in v.1764
-Removed from v.123
+Added in v.1764

	ViewVC Help
Powered by ViewVC