--- linuxsampler/trunk/src/engines/gig/Engine.cpp 2005/02/09 01:22:18 361 +++ linuxsampler/trunk/src/engines/gig/Engine.cpp 2007/01/23 20:03:22 1037 @@ -2,7 +2,8 @@ * * * 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-2007 Christian Schoenebeck * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * @@ -24,96 +25,114 @@ #include "DiskThread.h" #include "Voice.h" #include "EGADSR.h" +#include "../EngineFactory.h" #include "Engine.h" -#if defined(__APPLE__) -# include -#else -# include -#endif - namespace LinuxSampler { namespace gig { - InstrumentResourceManager Engine::Instruments; + InstrumentResourceManager Engine::instruments; + + std::map 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]; + } 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 wil 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())); + } + /** + * Constructor + */ Engine::Engine() { - pRIFF = NULL; - pGig = NULL; - pInstrument = NULL; pAudioOutputDevice = NULL; pDiskThread = NULL; pEventGenerator = NULL; - pSysexBuffer = new RingBuffer(SYSEX_BUFFER_SIZE, 0); - pEventQueue = new RingBuffer(MAX_EVENTS_PER_FRAGMENT, 0); - pEventPool = new Pool(MAX_EVENTS_PER_FRAGMENT); - pVoicePool = new Pool(MAX_AUDIO_VOICES); - pActiveKeys = new Pool(128); + pSysexBuffer = new RingBuffer(CONFIG_SYSEX_BUFFER_SIZE, 0); + pEventQueue = new RingBuffer(CONFIG_MAX_EVENTS_PER_FRAGMENT, 0); + pEventPool = new Pool(CONFIG_MAX_EVENTS_PER_FRAGMENT); + pVoicePool = new Pool(CONFIG_MAX_VOICES); pVoiceStealingQueue = new RTList(pEventPool); - pEvents = new RTList(pEventPool); - pCCEvents = new RTList(pEventPool); - for (uint i = 0; i < Event::destination_count; i++) { - pSynthesisEvents[i] = new RTList(pEventPool); - } - for (uint i = 0; i < 128; i++) { - pMIDIKeyInfo[i].pActiveVoices = new RTList(pVoicePool); - pMIDIKeyInfo[i].KeyPressed = false; - pMIDIKeyInfo[i].Active = false; - pMIDIKeyInfo[i].ReleaseTrigger = false; - pMIDIKeyInfo[i].pEvents = new RTList(pEventPool); - } + pGlobalEvents = new RTList(pEventPool); for (RTList::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) { iterVoice->SetEngine(this); } pVoicePool->clear(); - pSynthesisParameters[0] = NULL; // we allocate when an audio device is connected - pBasicFilterParameters = NULL; - pMainFilterParameters = NULL; - - InstrumentIdx = -1; - InstrumentStat = -1; - - AudioDeviceChannelLeft = -1; - AudioDeviceChannelRight = -1; - ResetInternal(); + ResetScaleTuning(); } + /** + * Destructor + */ Engine::~Engine() { + MidiInputPort::RemoveSysexListener(this); if (pDiskThread) { dmsg(1,("Stopping disk thread...")); pDiskThread->StopThread(); delete pDiskThread; dmsg(1,("OK\n")); } - - if (pInstrument) Instruments.HandBack(pInstrument, this); - - 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]; - } - if (pEvents) delete pEvents; - if (pCCEvents) delete pCCEvents; if (pEventQueue) delete pEventQueue; if (pEventPool) delete pEventPool; - if (pVoicePool) { - pVoicePool->clear(); - delete pVoicePool; - } - if (pActiveKeys) delete pActiveKeys; - if (pSysexBuffer) delete pSysexBuffer; + if (pVoicePool) { + pVoicePool->clear(); + delete pVoicePool; + } if (pEventGenerator) delete pEventGenerator; - if (pMainFilterParameters) delete[] pMainFilterParameters; - if (pBasicFilterParameters) delete[] pBasicFilterParameters; - if (pSynthesisParameters[0]) free(pSynthesisParameters[0]); if (pVoiceStealingQueue) delete pVoiceStealingQueue; + if (pSysexBuffer) delete pSysexBuffer; + Unregister(); } void Engine::Enable() { @@ -140,63 +159,31 @@ */ void Engine::Reset() { DisableAndLock(); - - //if (pAudioOutputDevice->IsPlaying()) { // if already running - /* - // signal audio thread not to enter render part anymore - SuspensionRequested = true; - // sleep until wakened by audio thread - pthread_mutex_lock(&__render_state_mutex); - pthread_cond_wait(&__render_exit_condition, &__render_state_mutex); - pthread_mutex_unlock(&__render_state_mutex); - */ - //} - - //if (wasplaying) pAudioOutputDevice->Stop(); - ResetInternal(); - - // signal audio thread to continue with rendering - //SuspensionRequested = false; + 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; - SustainPedal = false; + ResetInternalMutex.Lock(); + + // make sure that the engine does not get any sysex messages + // while it's reseting + bool sysexDisabled = MidiInputPort::RemoveSysexListener(this); ActiveVoiceCount = 0; ActiveVoiceCountMax = 0; - GlobalVolume = 1.0; - CurrentKeyDimension = 0; // reset voice stealing parameters - itLastStolenVoice = RTList::Iterator(); - iuiLastStolenKey = RTList::Iterator(); pVoiceStealingQueue->clear(); - - // reset to normal chromatic scale (means equal temper) - memset(&ScaleTuning[0], 0x00, 12); - - // set all MIDI controller values to zero - memset(ControllerTable, 0x00, 128); - - // reset key info - for (uint i = 0; i < 128; i++) { - pMIDIKeyInfo[i].pActiveVoices->clear(); - pMIDIKeyInfo[i].pEvents->clear(); - pMIDIKeyInfo[i].KeyPressed = false; - pMIDIKeyInfo[i].Active = false; - pMIDIKeyInfo[i].ReleaseTrigger = false; - pMIDIKeyInfo[i].itSelf = Pool::Iterator(); - } - - // reset all key groups - map::iterator iter = ActiveKeyGroups.begin(); - for (; iter != ActiveKeyGroups.end(); iter++) iter->second = NULL; + itLastStolenVoice = RTList::Iterator(); + itLastStolenVoiceGlobally = RTList::Iterator(); + iuiLastStolenKey = RTList::Iterator(); + iuiLastStolenKeyGlobally = RTList::Iterator(); + pLastStolenChannel = NULL; // reset all voices for (RTList::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) { @@ -204,109 +191,32 @@ } 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. - * - * @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) { - - DisableAndLock(); - - ResetInternal(); // reset engine - - // free old instrument - if (pInstrument) { - // give old instrument back to instrument manager - Instruments.HandBack(pInstrument, this); - } - - InstrumentFile = FileName; - InstrumentIdx = Instrument; - InstrumentStat = 0; - - // delete all key groups - ActiveKeyGroups.clear(); - - // request gig instrument from instrument manager - try { - instrument_id_t instrid; - instrid.FileName = FileName; - instrid.iInstrument = Instrument; - pInstrument = Instruments.Borrow(instrid, this); - if (!pInstrument) { - InstrumentStat = -1; - dmsg(1,("no instrument loaded!!!\n")); - exit(EXIT_FAILURE); - } - } - catch (RIFF::Exception e) { - InstrumentStat = -2; - String msg = "gig::Engine error: Failed to load instrument, cause: " + e.Message; - throw LinuxSamplerException(msg); - } - catch (InstrumentResourceManagerException e) { - InstrumentStat = -3; - String msg = "gig::Engine error: Failed to load instrument, cause: " + e.Message(); - throw LinuxSamplerException(msg); - } - catch (...) { - InstrumentStat = -4; - throw LinuxSamplerException("gig::Engine error: Failed to load instrument, cause: Unknown exception while trying to parse gig file."); - } - - // rebuild ActiveKeyGroups map with key groups of current instrument - for (::gig::Region* pRegion = pInstrument->GetFirstRegion(); pRegion; pRegion = pInstrument->GetNextRegion()) - if (pRegion->KeyGroup) ActiveKeyGroups[pRegion->KeyGroup] = NULL; - - InstrumentStat = 100; - - // 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(); - } - - /** - * Will be called by the InstrumentResourceManager when the instrument - * we are currently using in this engine is going to be updated, so we - * can stop playback before that happens. + * Reset to normal, chromatic scale (means equal tempered). */ - void Engine::ResourceToBeUpdated(::gig::Instrument* pResource, void*& pUpdateArg) { - dmsg(3,("gig::Engine: Received instrument update message.\n")); - DisableAndLock(); - ResetInternal(); - this->pInstrument = NULL; + void Engine::ResetScaleTuning() { + memset(&ScaleTuning[0], 0x00, 12); } /** - * Will be called by the InstrumentResourceManager when the instrument - * update process was completed, so we can continue with playback. + * Connect this engine instance with the given audio output device. + * 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; //TODO: there are couple of engine parameters we should update here as well if the instrument was updated (see LoadInstrument()) - Enable(); - } - void Engine::Connect(AudioOutputDevice* pAudioOut) { pAudioOutputDevice = pAudioOut; @@ -318,20 +228,27 @@ } catch (AudioOutputException e) { String msg = "Audio output device unable to provide 2 audio channels, cause: " + e.Message(); - throw LinuxSamplerException(msg); + throw Exception(msg); } - this->AudioDeviceChannelLeft = 0; - this->AudioDeviceChannelRight = 1; - this->pOutputLeft = pAudioOutputDevice->Channel(0)->Buffer(); - this->pOutputRight = pAudioOutputDevice->Channel(1)->Buffer(); - this->MaxSamplesPerCycle = pAudioOutputDevice->MaxSamplesPerCycle(); - this->SampleRate = pAudioOutputDevice->SampleRate(); + this->MaxSamplesPerCycle = pAudioOutputDevice->MaxSamplesPerCycle(); + this->SampleRate = pAudioOutputDevice->SampleRate(); // FIXME: audio drivers with varying fragment sizes might be a problem here - MaxFadeOutPos = MaxSamplesPerCycle - int(double(SampleRate) * EG_MIN_RELEASE_TIME) - 1; - if (MaxFadeOutPos < 0) - throw LinuxSamplerException("EG_MIN_RELEASE_TIME in EGADSR.h to big for current audio fragment size / sampling rate!"); + MaxFadeOutPos = MaxSamplesPerCycle - int(double(SampleRate) * CONFIG_EG_MIN_RELEASE_TIME) - 1; + if (MaxFadeOutPos < 0) { + 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 + MaxFadeOutPos = 0; + // lower minimum release time + const float minReleaseTime = (float) MaxSamplesPerCycle / (float) SampleRate; + for (RTList::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) { + iterVoice->EG1.CalculateFadeOutCoeff(minReleaseTime, SampleRate); + } + pVoicePool->clear(); + } // (re)create disk thread if (this->pDiskThread) { @@ -340,7 +257,7 @@ 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 if (!pDiskThread) { dmsg(0,("gig::Engine new diskthread = NULL\n")); exit(EXIT_FAILURE); @@ -356,23 +273,6 @@ if (pEventGenerator) delete pEventGenerator; pEventGenerator = new EventGenerator(pAudioOut->SampleRate()); - // (re)allocate synthesis parameter matrix - if (pSynthesisParameters[0]) free(pSynthesisParameters[0]); - - #if defined(__APPLE__) - pSynthesisParameters[0] = (float *) malloc(Event::destination_count * sizeof(float) * pAudioOut->MaxSamplesPerCycle()); - #else - pSynthesisParameters[0] = (float *) memalign(16,(Event::destination_count * sizeof(float) * pAudioOut->MaxSamplesPerCycle())); - #endif - 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")); @@ -385,173 +285,328 @@ } } - void Engine::DisconnectAudioOutputDevice() { - if (pAudioOutputDevice) { // if clause to prevent disconnect loops - AudioOutputDevice* olddevice = pAudioOutputDevice; - pAudioOutputDevice = NULL; - olddevice->Disconnect(this); - AudioDeviceChannelLeft = -1; - AudioDeviceChannelRight = -1; + /** + * 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::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 - * calculated audio data of all voices of this engine will be placed into - * the engine's audio sum buffer which has to be copied and eventually be - * converted to the appropriate value range by the audio output class (e.g. - * AlsaIO or JackIO) right after. + * Let this engine proceed to render the given amount of sample points. + * The engine will iterate through all engine channels and render audio + * for each engine channel independently. The calculated audio data of + * all voices of each engine channel will be placed into the audio sum + * 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(7,("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())); return 0; } - if (!pInstrument) { - dmsg(5,("gig::Engine: no instrument loaded\n")); - return 0; - } - // 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); - // empty the event lists for the new fragment - pEvents->clear(); - pCCEvents->clear(); - for (uint i = 0; i < Event::destination_count; i++) { - pSynthesisEvents[i]->clear(); - } + // process engine global events (these are currently only MIDI System Exclusive messages) { - RTList::Iterator iuiKey = pActiveKeys->first(); - RTList::Iterator end = pActiveKeys->end(); - for(; iuiKey != end; ++iuiKey) { - pMIDIKeyInfo[*iuiKey].pEvents->clear(); // free all events on the key + RTList::Iterator itEvent = pGlobalEvents->first(); + RTList::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; - // get all events from the input event queue which belong to the current fragment - { - RingBuffer::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 (pEvents->poolIsEmpty()) { - dmsg(1,("Event pool emtpy!\n")); - break; - } - *pEvents->allocAppend() = *pEvent; - } - eventQueueReader.free(); // free all copied events from input queue + // handle events on all engine channels + for (int i = 0; i < engineChannels.size(); i++) { + if (!engineChannels[i]->pInstrument) continue; // ignore if no instrument loaded + ProcessEvents(engineChannels[i], Samples); + } + + // render all 'normal', active voices on all engine channels + for (int i = 0; i < engineChannels.size(); i++) { + if (!engineChannels[i]->pInstrument) continue; // ignore if no instrument loaded + RenderActiveVoices(engineChannels[i], Samples); + } + + // now that all ordinary voices on ALL engine channels are rendered, render new stolen voices + 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); } + // handle cleanup on all engine channels for the next audio fragment + for (int i = 0; i < engineChannels.size(); i++) { + if (!engineChannels[i]->pInstrument) continue; // ignore if no instrument loaded + PostProcess(engineChannels[i]); + } + + + // empty the engine's event list for the next audio fragment + ClearEventLists(); + + // reset voice stealing for the next audio fragment + pVoiceStealingQueue->clear(); + + // just some statistics about this engine instance + ActiveVoiceCount = ActiveVoiceCountTemp; + if (ActiveVoiceCount > ActiveVoiceCountMax) ActiveVoiceCountMax = ActiveVoiceCount; + + FrameTime += Samples; + + 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::Iterator itEvent = pEvents->first(); - RTList::Iterator end = pEvents->end(); + RTList::Iterator itEvent = pEngineChannel->pEvents->first(); + RTList::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(itEvent); + ProcessNoteOn((EngineChannel*)itEvent->pEngineChannel, itEvent); break; case Event::type_note_off: dmsg(5,("Engine: Note off received\n")); - ProcessNoteOff(itEvent); + ProcessNoteOff((EngineChannel*)itEvent->pEngineChannel, itEvent); break; case Event::type_control_change: dmsg(5,("Engine: MIDI CC received\n")); - ProcessControlChange(itEvent); + ProcessControlChange((EngineChannel*)itEvent->pEngineChannel, itEvent); break; case Event::type_pitchbend: dmsg(5,("Engine: Pitchbend received\n")); - ProcessPitchbend(itEvent); - break; - case Event::type_sysex: - dmsg(5,("Engine: Sysex received\n")); - ProcessSysex(itEvent); + ProcessPitchbend((EngineChannel*)itEvent->pEngineChannel, itEvent); break; } } } + // reset voice stealing for the next engine channel (or next audio fragment) + itLastStolenVoice = RTList::Iterator(); + itLastStolenVoiceGlobally = RTList::Iterator(); + iuiLastStolenKey = RTList::Iterator(); + iuiLastStolenKeyGlobally = RTList::Iterator(); + pLastStolenChannel = NULL; + } - int active_voices = 0; - - // render audio from all active voices - { - RTList::Iterator iuiKey = pActiveKeys->first(); - RTList::Iterator end = pActiveKeys->end(); - while (iuiKey != end) { // iterate through all active keys - midi_key_info_t* pKey = &pMIDIKeyInfo[*iuiKey]; - ++iuiKey; + /** + * Render all 'normal' voices (that is voices which were not stolen in + * this fragment) on the given engine channel. + * + * @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 - RTList::Iterator itVoice = pKey->pActiveVoices->first(); - RTList::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()) active_voices++; // still active - else { // voice reached end, is now inactive - FreeVoice(itVoice); // remove voice from the list of active voices - } + RTList::Iterator iuiKey = pEngineChannel->pActiveKeys->first(); + RTList::Iterator end = pEngineChannel->pActiveKeys->end(); + while (iuiKey != end) { // iterate through all active keys + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey]; + ++iuiKey; + + RTList::Iterator itVoice = pKey->pActiveVoices->first(); + RTList::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()) ActiveVoiceCountTemp++; // still active + else { // voice reached end, is now inactive + FreeVoice(pEngineChannel, itVoice); // remove voice from the list of active voices } } } + } + /** + * Render all stolen voices (only voices which were stolen in this + * 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 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::RenderStolenVoices(uint Samples) { + RTList::Iterator itVoiceStealEvent = pVoiceStealingQueue->first(); + RTList::Iterator end = pVoiceStealingQueue->end(); + for (; itVoiceStealEvent != end; ++itVoiceStealEvent) { + EngineChannel* pEngineChannel = (EngineChannel*) itVoiceStealEvent->pEngineChannel; + Pool::Iterator itNewVoice = + LaunchVoice(pEngineChannel, itVoiceStealEvent, itVoiceStealEvent->Param.Note.Layer, itVoiceStealEvent->Param.Note.ReleaseTrigger, false, false); + if (itNewVoice) { + itNewVoice->Render(Samples); + if (itNewVoice->IsActive()) ActiveVoiceCountTemp++; // still active + 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")); - // now render all postponed voices from voice stealing + // 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 in case the respective engine channel sports FX send + * 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 pEngineChannel - engine channel from which audio should be + * routed + * @param Samples - amount of sample points to be routed in + * this audio fragment cycle + */ + void Engine::RouteAudio(EngineChannel* pEngineChannel, uint Samples) { + // route master signal { - RTList::Iterator itVoiceStealEvent = pVoiceStealingQueue->first(); - RTList::Iterator end = pVoiceStealingQueue->end(); - for (; itVoiceStealEvent != end; ++itVoiceStealEvent) { - Pool::Iterator itNewVoice = LaunchVoice(itVoiceStealEvent, itVoiceStealEvent->Param.Note.Layer, itVoiceStealEvent->Param.Note.ReleaseTrigger, false); - if (itNewVoice) { - for (; itNewVoice; itNewVoice = itNewVoice->itChildVoice) { - itNewVoice->Render(Samples); - if (itNewVoice->IsActive()) active_voices++; // still active - else { // voice reached end, is now inactive - FreeVoice(itNewVoice); // remove voice from the list of active voices - } - } + AudioChannel* pDstL = pAudioOutputDevice->Channel(pEngineChannel->AudioDeviceChannelLeft); + AudioChannel* pDstR = pAudioOutputDevice->Channel(pEngineChannel->AudioDeviceChannelRight); + pEngineChannel->pChannelLeft->MixTo(pDstL, Samples); + pEngineChannel->pChannelRight->MixTo(pDstR, Samples); + } + // route FX send signal + { + for (int iFxSend = 0; iFxSend < pEngineChannel->GetFxSendCount(); iFxSend++) { + FxSend* pFxSend = pEngineChannel->GetFxSend(iFxSend); + // left channel + const int iDstL = pFxSend->DestinationChannel(0); + if (iDstL < 0) { + dmsg(1,("Engine::RouteAudio() Error: invalid FX send (L) destination channel")); + } else { + AudioChannel* pDstL = pAudioOutputDevice->Channel(iDstL); + if (!pDstL) { + dmsg(1,("Engine::RouteAudio() Error: invalid FX send (L) destination channel")); + } else pEngineChannel->pChannelLeft->MixTo(pDstL, Samples, pFxSend->Level()); + } + // right channel + const int iDstR = pFxSend->DestinationChannel(1); + if (iDstR < 0) { + dmsg(1,("Engine::RouteAudio() Error: invalid FX send (R) destination channel")); + } else { + AudioChannel* pDstR = pAudioOutputDevice->Channel(iDstR); + if (!pDstR) { + dmsg(1,("Engine::RouteAudio() Error: invalid FX send (R) destination channel")); + } else pEngineChannel->pChannelRight->MixTo(pDstR, Samples, pFxSend->Level()); } - else dmsg(1,("gig::Engine: ERROR, voice stealing didn't work out!\n")); } } - // reset voice stealing for the new fragment - pVoiceStealingQueue->clear(); - itLastStolenVoice = RTList::Iterator(); - iuiLastStolenKey = RTList::Iterator(); - + // reset buffers with silence (zero out) for the next audio cycle + pEngineChannel->pChannelLeft->Clear(); + pEngineChannel->pChannelRight->Clear(); + } + /** + * Free all keys which have turned inactive in this audio fragment, from + * the list of active keys and clear all event lists on that engine + * channel. + * + * @param pEngineChannel - engine channel to cleanup + */ + void Engine::PostProcess(EngineChannel* pEngineChannel) { // free all keys which have no active voices left { - RTList::Iterator iuiKey = pActiveKeys->first(); - RTList::Iterator end = pActiveKeys->end(); + RTList::Iterator iuiKey = pEngineChannel->pActiveKeys->first(); + RTList::Iterator end = pEngineChannel->pActiveKeys->end(); while (iuiKey != end) { // iterate through all active keys - midi_key_info_t* pKey = &pMIDIKeyInfo[*iuiKey]; + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey]; ++iuiKey; - if (pKey->pActiveVoices->isEmpty()) FreeKey(pKey); - #if DEVMODE - else { // FIXME: should be removed before the final release (purpose: just a sanity check for debugging) + if (pKey->pActiveVoices->isEmpty()) FreeKey(pEngineChannel, pKey); + #if CONFIG_DEVMODE + else { // just a sanity check for debugging RTList::Iterator itVoice = pKey->pActiveVoices->first(); RTList::Iterator itVoicesEnd = pKey->pActiveVoices->end(); for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key @@ -560,80 +615,12 @@ } } } - #endif // DEVMODE + #endif // CONFIG_DEVMODE } } - - // write that to the disk thread class so that it can print it - // on the console for debugging purposes - ActiveVoiceCount = active_voices; - if (ActiveVoiceCount > ActiveVoiceCountMax) ActiveVoiceCountMax = ActiveVoiceCount; - - - return 0; - } - - /** - * Will be called by the MIDIIn Thread to let the audio thread trigger a new - * voice for the given key. - * - * @param Key - MIDI key number of the triggered key - * @param Velocity - MIDI velocity value of the triggered key - */ - void Engine::SendNoteOn(uint8_t Key, uint8_t Velocity) { - Event event = pEventGenerator->CreateEvent(); - event.Type = Event::type_note_on; - event.Param.Note.Key = Key; - event.Param.Note.Velocity = Velocity; - if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event); - else dmsg(1,("Engine: Input event queue full!")); - } - - /** - * Will be called by the MIDIIn Thread to signal the audio thread to release - * voice(s) on the given key. - * - * @param Key - MIDI key number of the released key - * @param Velocity - MIDI release velocity value of the released key - */ - void Engine::SendNoteOff(uint8_t Key, uint8_t Velocity) { - Event event = pEventGenerator->CreateEvent(); - event.Type = Event::type_note_off; - event.Param.Note.Key = Key; - event.Param.Note.Velocity = Velocity; - if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event); - else dmsg(1,("Engine: Input event queue full!")); - } - - /** - * Will be called by the MIDIIn Thread to signal the audio thread to change - * the pitch value for all voices. - * - * @param Pitch - MIDI pitch value (-8192 ... +8191) - */ - void Engine::SendPitchbend(int Pitch) { - Event event = pEventGenerator->CreateEvent(); - event.Type = Event::type_pitchbend; - event.Param.Pitch.Pitch = Pitch; - if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event); - else dmsg(1,("Engine: Input event queue full!")); - } - - /** - * Will be called by the MIDIIn Thread to signal the audio thread that a - * continuous controller value has changed. - * - * @param Controller - MIDI controller number of the occured control change - * @param Value - value of the control change - */ - void Engine::SendControlChange(uint8_t Controller, uint8_t Value) { - Event event = pEventGenerator->CreateEvent(); - event.Type = Event::type_control_change; - event.Param.CC.Controller = Controller; - event.Param.CC.Value = Value; - if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event); - else dmsg(1,("Engine: Input event queue full!")); + // empty the engine channel's own event lists + pEngineChannel->ClearEventLists(); } /** @@ -647,6 +634,7 @@ Event event = pEventGenerator->CreateEvent(); event.Type = Event::type_sysex; event.Param.Sysex.Size = Size; + event.pEngineChannel = NULL; // as Engine global event if (pEventQueue->write_space() > 0) { if (pSysexBuffer->write_space() >= Size) { // copy sysex data to input buffer @@ -662,7 +650,7 @@ // 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,SYSEX_BUFFER_SIZE)); + 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!")); } @@ -670,36 +658,85 @@ /** * Assigns and triggers a new voice for the respective MIDI key. * + * @param pEngineChannel - engine channel on which this event occured on * @param itNoteOnEvent - key, velocity and time stamp of the event */ - void Engine::ProcessNoteOn(Pool::Iterator& itNoteOnEvent) { + void Engine::ProcessNoteOn(EngineChannel* pEngineChannel, Pool::Iterator& itNoteOnEvent) { + #if !CONFIG_PROCESS_MUTED_CHANNELS + if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted + #endif const int key = itNoteOnEvent->Param.Note.Key; + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[key]; - // Change key dimension value if key is in keyswitching area - if (key >= pInstrument->DimensionKeyRange.low && key <= pInstrument->DimensionKeyRange.high) - CurrentKeyDimension = ((key - pInstrument->DimensionKeyRange.low) * 128) / - (pInstrument->DimensionKeyRange.high - pInstrument->DimensionKeyRange.low + 1); + // move note on event to the key's own event list + RTList::Iterator itNoteOnEventOnKeyList = itNoteOnEvent.moveToEndOf(pKey->pEvents); - midi_key_info_t* pKey = &pMIDIKeyInfo[key]; + // if Solo Mode then kill all already active voices + if (pEngineChannel->SoloMode) { + Pool::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::Iterator itVoice = pOtherKey->pActiveVoices->last(); + if (itVoice) itVoice->UpdatePortamentoPos(itNoteOnEventOnKeyList); + } + // kill all voices on the (other) key + RTList::Iterator itVoiceToBeKilled = pOtherKey->pActiveVoices->first(); + RTList::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) { RTList::Iterator itCancelReleaseEvent = pKey->pEvents->allocAppend(); if (itCancelReleaseEvent) { - *itCancelReleaseEvent = *itNoteOnEvent; // copy event + *itCancelReleaseEvent = *itNoteOnEventOnKeyList; // copy event itCancelReleaseEvent->Type = Event::type_cancel_release; // transform event type } else dmsg(1,("Event pool emtpy!\n")); } - // move note on event to the key's own event list - RTList::Iterator itNoteOnEventOnKeyList = itNoteOnEvent.moveToEndOf(pKey->pEvents); + // allocate and trigger new voice(s) for the key + { + // first, get total amount of required voices (dependant on amount of layers) + ::gig::Region* pRegion = pEngineChannel->pInstrument->GetRegion(itNoteOnEventOnKeyList->Param.Note.Key); + if (pRegion) { + int voicesRequired = pRegion->Layers; + // now launch the required amount of voices + for (int i = 0; i < voicesRequired; i++) + LaunchVoice(pEngineChannel, itNoteOnEventOnKeyList, i, false, true, true); + } + } + + // 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); - // allocate and trigger a new voice for the key - LaunchVoice(itNoteOnEventOnKeyList, 0, false, true); + if (!pEngineChannel->SoloMode || pEngineChannel->PortamentoPos < 0.0f) pEngineChannel->PortamentoPos = (float) key; + pKey->RoundRobinIndex++; } /** @@ -708,37 +745,119 @@ * sustain pedal will be released or voice turned inactive by itself (e.g. * due to completion of sample playback). * + * @param pEngineChannel - engine channel on which this event occured on * @param itNoteOffEvent - key, velocity and time stamp of the event */ - void Engine::ProcessNoteOff(Pool::Iterator& itNoteOffEvent) { - midi_key_info_t* pKey = &pMIDIKeyInfo[itNoteOffEvent->Param.Note.Key]; + void Engine::ProcessNoteOff(EngineChannel* pEngineChannel, Pool::Iterator& itNoteOffEvent) { + #if !CONFIG_PROCESS_MUTED_CHANNELS + if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted + #endif + 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 - if (pKey->Active && !SustainPedal) { - itNoteOffEvent->Type = Event::type_release; // transform event type - } - // move event to the key's own event list RTList::Iterator itNoteOffEventOnKeyList = itNoteOffEvent.moveToEndOf(pKey->pEvents); - // spawn release triggered voice(s) if needed - if (pKey->ReleaseTrigger) { - LaunchVoice(itNoteOffEventOnKeyList, 0, true, false); //FIXME: for the moment we don't perform voice stealing for release triggered samples - pKey->ReleaseTrigger = false; + 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) { //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::Iterator itVoice = pKey->pActiveVoices->first(); + if (itVoice) itVoice->UpdatePortamentoPos(itNoteOffEventOnKeyList); + } + // create a pseudo note on event + RTList::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::Iterator itVoiceToBeKilled = pKey->pActiveVoices->first(); + RTList::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) { + // 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 pitch - * event list. + * 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(Pool::Iterator& itPitchbendEvent) { - this->Pitch = itPitchbendEvent->Param.Pitch.Pitch; // store current pitch value - itPitchbendEvent.moveToEndOf(pSynthesisEvents[Event::destination_vco]); + void Engine::ProcessPitchbend(EngineChannel* pEngineChannel, Pool::Iterator& itPitchbendEvent) { + pEngineChannel->Pitch = itPitchbendEvent->Param.Pitch.Pitch; // store current pitch value } /** @@ -746,6 +865,7 @@ * called by the ProcessNoteOn() method and by the voices itself * (e.g. to spawn further voices on the same key for layered sounds). * + * @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) @@ -754,41 +874,175 @@ * @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). */ - Pool::Iterator Engine::LaunchVoice(Pool::Iterator& itNoteOnEvent, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing) { - midi_key_info_t* pKey = &pMIDIKeyInfo[itNoteOnEvent->Param.Note.Key]; + Pool::Iterator Engine::LaunchVoice(EngineChannel* pEngineChannel, Pool::Iterator& itNoteOnEvent, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing, bool HandleKeyGroupConflicts) { + int MIDIKey = itNoteOnEvent->Param.Note.Key; + 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::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::Iterator itVoiceToBeKilled = pOtherKey->pActiveVoices->first(); + RTList::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; + } + } + ::gig::DimensionRegion* pDimRgn = pRegion->GetDimensionRegionByValue(DimValues); + + // no need to continue if sample is silent + if (!pDimRgn->pSample || !pDimRgn->pSample->SamplesTotal) return Pool::Iterator(); // allocate a new voice for the key Pool::Iterator itNewVoice = pKey->pActiveVoices->allocAppend(); if (itNewVoice) { // launch the new voice - if (itNewVoice->Trigger(itNoteOnEvent, this->Pitch, this->pInstrument, iLayer, ReleaseTriggerVoice, VoiceStealing) < 0) { + if (itNewVoice->Trigger(pEngineChannel, itNoteOnEvent, pEngineChannel->Pitch, pDimRgn, VoiceType, iKeyGroup) < 0) { dmsg(4,("Voice not triggered\n")); pKey->pActiveVoices->free(itNewVoice); } else { // on success - uint** ppKeyGroup = NULL; - if (itNewVoice->KeyGroup) { // if this voice / key belongs to a key group - ppKeyGroup = &ActiveKeyGroups[itNewVoice->KeyGroup]; - if (*ppKeyGroup) { // if there's already an active key in that key group - midi_key_info_t* pOtherKey = &pMIDIKeyInfo[**ppKeyGroup]; - // kill all voices on the (other) key - RTList::Iterator itVoiceToBeKilled = pOtherKey->pActiveVoices->first(); - RTList::Iterator end = pOtherKey->pActiveVoices->end(); - for (; itVoiceToBeKilled != end; ++itVoiceToBeKilled) { - if (itVoiceToBeKilled->Type != Voice::type_release_trigger) itVoiceToBeKilled->Kill(itNoteOnEvent); - } - } - } + --VoiceSpawnsLeft; if (!pKey->Active) { // mark as active key pKey->Active = true; - pKey->itSelf = pActiveKeys->allocAppend(); + 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) @@ -796,23 +1050,19 @@ } } else if (VoiceStealing) { - // first, get total amount of required voices (dependant on amount of layers) - ::gig::Region* pRegion = pInstrument->GetRegion(itNoteOnEvent->Param.Note.Key); - if (!pRegion) return Pool::Iterator(); // nothing defined for this MIDI key, so no voice needed - int voicesRequired = pRegion->Layers; - - // now steal the (remaining) amount of voices - for (int i = iLayer; i < voicesRequired; i++) - StealVoice(itNoteOnEvent); - - // put note-on event into voice-stealing queue, so it will be reprocessed after killed voice died - RTList::Iterator itStealEvent = pVoiceStealingQueue->allocAppend(); - if (itStealEvent) { - *itStealEvent = *itNoteOnEvent; // copy event - itStealEvent->Param.Note.Layer = iLayer; - itStealEvent->Param.Note.ReleaseTrigger = ReleaseTriggerVoice; + // 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::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")); } - else dmsg(1,("Voice stealing queue full!\n")); } return Pool::Iterator(); // no free voice or error @@ -824,61 +1074,67 @@ * voice stealing and postpone the note-on event until the selected * voice actually died. * + * @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::StealVoice(Pool::Iterator& itNoteOnEvent) { + int Engine::StealVoice(EngineChannel* pEngineChannel, Pool::Iterator& itNoteOnEvent) { + if (VoiceSpawnsLeft <= 0) { + dmsg(1,("Max. voice thefts per audio fragment reached (you may raise CONFIG_MAX_VOICES).\n")); + return -1; + } if (!pEventPool->poolIsEmpty()) { - RTList::Iterator iuiOldestKey; - RTList::Iterator itOldestVoice; + RTList::Iterator itSelectedVoice; // Select one voice for voice stealing - switch (VOICE_STEAL_ALGORITHM) { + 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 there, then procceed with + // key, or no voice left to kill, then procceed with // 'oldestkey' algorithm - case voice_steal_algo_keymask: { - midi_key_info_t* pOldestKey = &pMIDIKeyInfo[itNoteOnEvent->Param.Note.Key]; - if (itLastStolenVoice) { - itOldestVoice = itLastStolenVoice; - ++itOldestVoice; - } - else { // no voice stolen in this audio fragment cycle yet - itOldestVoice = pOldestKey->pActiveVoices->first(); - } - if (itOldestVoice) { - iuiOldestKey = pOldestKey->itSelf; - break; // selection succeeded - } + 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 - // (caution: must stay after 'keymask' algorithm !) + // from the same engine channel + // (caution: must stay after 'oldestvoiceonkey' algorithm !) case voice_steal_algo_oldestkey: { - if (itLastStolenVoice) { - midi_key_info_t* pOldestKey = &pMIDIKeyInfo[*iuiLastStolenKey]; - itOldestVoice = itLastStolenVoice; - ++itOldestVoice; - if (!itOldestVoice) { - iuiOldestKey = iuiLastStolenKey; - ++iuiOldestKey; - if (iuiOldestKey) { - midi_key_info_t* pOldestKey = &pMIDIKeyInfo[*iuiOldestKey]; - itOldestVoice = pOldestKey->pActiveVoices->first(); - } - else { - dmsg(1,("gig::Engine: Warning, too less voices, even for voice stealing! - Better recompile with higher MAX_AUDIO_VOICES.\n")); - return; - } + // 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 } - else iuiOldestKey = iuiLastStolenKey; } - else { // no voice stolen in this audio fragment cycle yet - iuiOldestKey = pActiveKeys->first(); - midi_key_info_t* pOldestKey = &pMIDIKeyInfo[*iuiOldestKey]; - itOldestVoice = pOldestKey->pActiveVoices->first(); + // get (next) oldest key + RTList::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; } @@ -887,20 +1143,96 @@ case voice_steal_algo_none: default: { dmsg(1,("No free voice (voice stealing disabled)!\n")); - return; + return -1; } } - //FIXME: can be removed, just a sanity check for debugging - if (!itOldestVoice->IsActive()) dmsg(1,("gig::Engine: ERROR, tried to steal a voice which was not active !!!\n")); + // 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::Iterator iuiSelectedKey = (this->iuiLastStolenKeyGlobally) ? ++this->iuiLastStolenKeyGlobally : pSelectedChannel->pActiveKeys->first(); + this->iuiLastStolenKeyGlobally = RTList::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 - itOldestVoice->Kill(itNoteOnEvent); - // remember which voice on which key we stole, so we can simply proceed for the next voice stealing - this->itLastStolenVoice = itOldestVoice; - this->iuiLastStolenKey = iuiOldestKey; + itSelectedVoice->Kill(itNoteOnEvent); + + --VoiceSpawnsLeft; + + return 0; // success + } + else { + dmsg(1,("Event pool emtpy!\n")); + return -1; } - else dmsg(1,("Event pool emtpy!\n")); } /** @@ -909,11 +1241,12 @@ * 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(Pool::Iterator& itVoice) { + void Engine::FreeVoice(EngineChannel* pEngineChannel, Pool::Iterator& itVoice) { if (itVoice) { - midi_key_info_t* pKey = &pMIDIKeyInfo[itVoice->MIDIKey]; + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[itVoice->MIDIKey]; uint keygroup = itVoice->KeyGroup; @@ -922,7 +1255,7 @@ // if no other voices left and member of a key group, remove from key group if (pKey->pActiveVoices->isEmpty() && keygroup) { - uint** ppKeyGroup = &ActiveKeyGroups[keygroup]; + uint** ppKeyGroup = &pEngineChannel->ActiveKeyGroups[keygroup]; if (*ppKeyGroup == &*pKey->itSelf) *ppKeyGroup = NULL; // remove key from key group } } @@ -933,12 +1266,13 @@ * 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(midi_key_info_t* pKey) { + void Engine::FreeKey(EngineChannel* pEngineChannel, midi_key_info_t* pKey) { if (pKey->pActiveVoices->isEmpty()) { pKey->Active = false; - pActiveKeys->free(pKey->itSelf); // remove key from list of active keys + pEngineChannel->pActiveKeys->free(pKey->itSelf); // remove key from list of active keys pKey->itSelf = RTList::Iterator(); pKey->ReleaseTrigger = false; pKey->pEvents->clear(); @@ -951,60 +1285,163 @@ * Reacts on supported control change commands (e.g. pitch bend wheel, * modulation wheel, aftertouch). * + * @param pEngineChannel - engine channel on which this event occured on * @param itControlChangeEvent - controller, value and time stamp of the event */ - void Engine::ProcessControlChange(Pool::Iterator& itControlChangeEvent) { + void Engine::ProcessControlChange(EngineChannel* pEngineChannel, Pool::Iterator& itControlChangeEvent) { dmsg(4,("Engine::ContinuousController cc=%d v=%d\n", itControlChangeEvent->Param.CC.Controller, itControlChangeEvent->Param.CC.Value)); + // update controller value in the engine channel's controller table + pEngineChannel->ControllerTable[itControlChangeEvent->Param.CC.Controller] = itControlChangeEvent->Param.CC.Value; + + // handle hard coded MIDI controllers switch (itControlChangeEvent->Param.CC.Controller) { - case 64: { - if (itControlChangeEvent->Param.CC.Value >= 64 && !SustainPedal) { - dmsg(4,("PEDAL DOWN\n")); - SustainPedal = true; + case 5: { // portamento time + pEngineChannel->PortamentoTime = (float) itControlChangeEvent->Param.CC.Value / 127.0f * (float) CONFIG_PORTAMENTO_TIME_MAX + (float) CONFIG_PORTAMENTO_TIME_MIN; + 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]; + 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 - RTList::Iterator iuiKey = pActiveKeys->first(); - if (iuiKey) { - itControlChangeEvent->Type = Event::type_cancel_release; // transform event type - while (iuiKey) { - midi_key_info_t* pKey = &pMIDIKeyInfo[*iuiKey]; - ++iuiKey; - if (!pKey->KeyPressed) { - RTList::Iterator itNewEvent = pKey->pEvents->allocAppend(); - if (itNewEvent) *itNewEvent = *itControlChangeEvent; // copy event to the key's own event list - else dmsg(1,("Event pool emtpy!\n")); + RTList::Iterator iuiKey = pEngineChannel->pActiveKeys->first(); + for (; iuiKey; ++iuiKey) { + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey]; + if (!pKey->KeyPressed) { + RTList::Iterator itNewEvent = pKey->pEvents->allocAppend(); + if (itNewEvent) { + *itNewEvent = *itControlChangeEvent; // copy event to the key's own event list + itNewEvent->Type = Event::type_cancel_release; // transform event type } + else dmsg(1,("Event pool emtpy!\n")); } } } - if (itControlChangeEvent->Param.CC.Value < 64 && SustainPedal) { - dmsg(4,("PEDAL UP\n")); - SustainPedal = false; + if (itControlChangeEvent->Param.CC.Value < 64 && pEngineChannel->SustainPedal) { + dmsg(4,("DAMPER (RIGHT) PEDAL UP\n")); + 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 - RTList::Iterator iuiKey = pActiveKeys->first(); - if (iuiKey) { - itControlChangeEvent->Type = Event::type_release; // transform event type - while (iuiKey) { - midi_key_info_t* pKey = &pMIDIKeyInfo[*iuiKey]; - ++iuiKey; - if (!pKey->KeyPressed) { - RTList::Iterator itNewEvent = pKey->pEvents->allocAppend(); - if (itNewEvent) *itNewEvent = *itControlChangeEvent; // copy event to the key's own event list - else dmsg(1,("Event pool emtpy!\n")); + RTList::Iterator iuiKey = pEngineChannel->pActiveKeys->first(); + for (; iuiKey; ++iuiKey) { + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey]; + if (!pKey->KeyPressed && ShouldReleaseVoice(pEngineChannel, *iuiKey)) { + RTList::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 65: { // portamento on / off + KillAllVoices(pEngineChannel, itControlChangeEvent); + pEngineChannel->PortamentoMode = itControlChangeEvent->Param.CC.Value >= 64; + 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::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::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; + } + - // update controller value in the engine's controller table - ControllerTable[itControlChangeEvent->Param.CC.Controller] = itControlChangeEvent->Param.CC.Value; + // Channel Mode Messages - // move event from the unsorted event list to the control change event list - itControlChangeEvent.moveToEndOf(pCCEvents); + 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 + KillAllVoices(pEngineChannel, itControlChangeEvent); + pEngineChannel->SoloMode = true; + break; + } + case 127: { // poly mode on + KillAllVoices(pEngineChannel, itControlChangeEvent); + pEngineChannel->SoloMode = false; + break; + } + } + + // handle FX send controllers + 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); + } + } } /** @@ -1013,7 +1450,7 @@ * @param itSysexEvent - sysex data size and time stamp of the sysex event */ void Engine::ProcessSysex(Pool::Iterator& itSysexEvent) { - RingBuffer::NonVolatileReader reader = pSysexBuffer->get_non_volatile_reader(); + RingBuffer::NonVolatileReader reader = pSysexBuffer->get_non_volatile_reader(); uint8_t exclusive_status, id; if (!reader.pop(&exclusive_status)) goto free_sysex_data; @@ -1022,6 +1459,7 @@ switch (id) { 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; @@ -1031,22 +1469,29 @@ // command address uint8_t addr[3]; // 2 byte addr MSB, followed by 1 byte addr LSB) - const RingBuffer::NonVolatileReader checksum_reader = reader; // so we can calculate the check sum later + const RingBuffer::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) - switch (addr[3]) { + 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 (GSCheckSum(checksum_reader, 12) != checksum) goto free_sysex_data; + 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; } } @@ -1071,8 +1516,8 @@ * question * @param DataSize - size of the GS message data (in bytes) */ - uint8_t Engine::GSCheckSum(const RingBuffer::NonVolatileReader AddrReader, uint DataSize) { - RingBuffer::NonVolatileReader reader = AddrReader; + uint8_t Engine::GSCheckSum(const RingBuffer::NonVolatileReader AddrReader, uint DataSize) { + RingBuffer::NonVolatileReader reader = AddrReader; uint bytes = 3 /*addr*/ + DataSize; uint8_t addr_and_data[bytes]; reader.read(&addr_and_data[0], bytes); @@ -1091,58 +1536,67 @@ } /** - * Initialize the parameter sequence for the modulation destination given by - * by 'dst' with the constant value given by val. + * Releases all voices on an engine channel. All voices will go into + * 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) { - int maxsamples = pAudioOutputDevice->MaxSamplesPerCycle(); - float* m = &pSynthesisParameters[dst][0]; - for (int i = 0; i < maxsamples; i += 4) { - m[i] = val; - m[i+1] = val; - m[i+2] = val; - m[i+3] = val; + void Engine::ReleaseAllVoices(EngineChannel* pEngineChannel, Pool::Iterator& itReleaseEvent) { + RTList::Iterator iuiKey = pEngineChannel->pActiveKeys->first(); + while (iuiKey) { + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey]; + ++iuiKey; + // append a 'release' event to the key's own event list + RTList::Iterator itNewEvent = pKey->pEvents->allocAppend(); + 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; - } - - void Engine::Volume(float f) { - GlobalVolume = f; - } - - uint Engine::Channels() { - return 2; - } - - void Engine::SetOutputChannel(uint EngineAudioChannel, uint AudioDeviceChannel) { - AudioChannel* pChannel = pAudioOutputDevice->Channel(AudioDeviceChannel); - if (!pChannel) throw AudioOutputException("Invalid audio output device channel " + ToString(AudioDeviceChannel)); - switch (EngineAudioChannel) { - case 0: // left output channel - pOutputLeft = pChannel->Buffer(); - AudioDeviceChannelLeft = AudioDeviceChannel; - break; - case 1: // right output channel - pOutputRight = pChannel->Buffer(); - AudioDeviceChannelRight = AudioDeviceChannel; - break; - default: - throw AudioOutputException("Invalid engine audio channel " + ToString(EngineAudioChannel)); + /** + * 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::Iterator& itKillEvent) { + RTList::Iterator iuiKey = pEngineChannel->pActiveKeys->first(); + RTList::Iterator end = pEngineChannel->pActiveKeys->end(); + while (iuiKey != end) { // iterate through all active keys + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey]; + ++iuiKey; + RTList::Iterator itVoice = pKey->pActiveVoices->first(); + RTList::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 + } } } - int Engine::OutputChannel(uint EngineAudioChannel) { - switch (EngineAudioChannel) { - case 0: // left channel - return AudioDeviceChannelLeft; - case 1: // right channel - return AudioDeviceChannelRight; - default: - throw AudioOutputException("Invalid engine audio channel " + ToString(EngineAudioChannel)); + /** + * 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() { @@ -1174,19 +1628,7 @@ } String Engine::EngineName() { - return "GigEngine"; - } - - String Engine::InstrumentFileName() { - return InstrumentFile; - } - - int Engine::InstrumentIndex() { - return InstrumentIdx; - } - - int Engine::InstrumentStatus() { - return InstrumentStat; + return LS_GIG_ENGINE_NAME; } String Engine::Description() { @@ -1194,8 +1636,54 @@ } String Engine::Version() { - String s = "$Revision: 1.23 $"; + String s = "$Revision: 1.70 $"; return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword } + InstrumentManager* Engine::GetInstrumentManager() { + return &instruments; + } + + // static constant initializers + const float* Engine::VolumeCurve(InitVolumeCurve()); + const float* Engine::PanCurve(InitPanCurve()); + const float* Engine::CrossfadeCurve(InitCrossfadeCurve()); + + float* Engine::InitVolumeCurve() { + // line-segment approximation + const float segments[] = { + 0, 0, 2, 0.0046, 16, 0.016, 31, 0.051, 45, 0.115, 54.5, 0.2, + 64.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, 0, 1, 0, + 2, 0.05, 31.5, 0.7, 51, 0.851, 74.5, 1.12, + 127, 1.41, 128, 1.41 + }; + return InitCurve(segments, 129); + } + + float* Engine::InitCrossfadeCurve() { + // line-segment approximation + const float segments[] = { + 0, 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