--- linuxsampler/trunk/src/engines/gig/Engine.cpp 2004/09/20 00:31:13 250 +++ linuxsampler/trunk/src/engines/gig/Engine.cpp 2005/06/16 21:35:30 659 @@ -3,6 +3,7 @@ * LinuxSampler - modular, streaming capable sampler * * * * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck * + * Copyright (C) 2005 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 * @@ -23,41 +24,93 @@ #include #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 RTELMemoryPool(MAX_EVENTS_PER_FRAGMENT); - pVoicePool = new RTELMemoryPool(MAX_AUDIO_VOICES); - pActiveKeys = new RTELMemoryPool(128); - pVoiceStealingQueue = new RTEList(pEventPool); - pEvents = new RTEList(pEventPool); - pCCEvents = new RTEList(pEventPool); - for (uint i = 0; i < Event::destination_count; i++) { - pSynthesisEvents[i] = new RTEList(pEventPool); - } - for (uint i = 0; i < 128; i++) { - pMIDIKeyInfo[i].pActiveVoices = new RTEList(pVoicePool); - pMIDIKeyInfo[i].KeyPressed = false; - pMIDIKeyInfo[i].Active = false; - pMIDIKeyInfo[i].ReleaseTrigger = false; - pMIDIKeyInfo[i].pSelf = NULL; - pMIDIKeyInfo[i].pEvents = new RTEList(pEventPool); - } - for (Voice* pVoice = pVoicePool->alloc(); pVoice; pVoice = pVoicePool->alloc()) { - pVoice->SetEngine(this); + 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); + pGlobalEvents = new RTList(pEventPool); + for (RTList::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) { + iterVoice->SetEngine(this); } pVoicePool->clear(); @@ -65,42 +118,33 @@ pBasicFilterParameters = NULL; pMainFilterParameters = NULL; - InstrumentIdx = -1; - InstrumentStat = -1; - - AudioDeviceChannelLeft = -1; - AudioDeviceChannelRight = -1; - ResetInternal(); + ResetScaleTuning(); } + /** + * Destructor + */ Engine::~Engine() { 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 (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]) delete[] pSynthesisParameters[0]; + if (pSynthesisParameters[0]) free(pSynthesisParameters[0]); if (pVoiceStealingQueue) delete pVoiceStealingQueue; + if (pSysexBuffer) delete pSysexBuffer; + EngineFactory::Destroy(this); } void Engine::Enable() { @@ -127,24 +171,8 @@ */ 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(); } @@ -153,46 +181,23 @@ * control and status variables. This method is not thread safe! */ void Engine::ResetInternal() { - Pitch = 0; - SustainPedal = false; ActiveVoiceCount = 0; ActiveVoiceCountMax = 0; - GlobalVolume = 1.0; // reset voice stealing parameters - pLastStolenVoice = NULL; - puiLastStolenKey = NULL; 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].pSelf = NULL; - } - - // 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 (Voice* pVoice = pVoicePool->alloc(); pVoice; pVoice = pVoicePool->alloc()) { - pVoice->Reset(); + for (RTList::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) { + iterVoice->Reset(); } pVoicePool->clear(); - // free all active keys - pActiveKeys->clear(); - // reset disk thread if (pDiskThread) pDiskThread->Reset(); @@ -201,98 +206,21 @@ } /** - * 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 + * Reset to normal, chromatic scale (means equal tempered). */ - 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. - */ - 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; @@ -307,26 +235,29 @@ throw LinuxSamplerException(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) * CONFIG_EG_MIN_RELEASE_TIME) - 1; + if (MaxFadeOutPos < 0) + throw LinuxSamplerException("CONFIG_EG_MIN_RELEASE_TIME too big for current audio fragment size / sampling rate!"); // (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 if (!pDiskThread) { dmsg(0,("gig::Engine new diskthread = NULL\n")); exit(EXIT_FAILURE); } - for (Voice* pVoice = pVoicePool->alloc(); pVoice; pVoice = pVoicePool->alloc()) { - pVoice->pDiskThread = this->pDiskThread; + for (RTList::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) { + iterVoice->pDiskThread = this->pDiskThread; dmsg(3,("d")); } pVoicePool->clear(); @@ -336,8 +267,13 @@ 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()]; + 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(); @@ -351,22 +287,55 @@ pDiskThread->StartThread(); dmsg(1,("OK\n")); - for (Voice* pVoice = pVoicePool->first(); pVoice; pVoice = pVoicePool->next()) { - if (!pVoice->pDiskThread) { + for (RTList::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) { + if (!iterVoice->pDiskThread) { dmsg(0,("Engine -> voice::trigger: !pDiskThread\n")); exit(EXIT_FAILURE); } } } - 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 } /** @@ -382,185 +351,224 @@ int Engine::RenderAudio(uint Samples) { dmsg(5,("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); - // empty the event lists for the new fragment - pEvents->clear(); - pCCEvents->clear(); - for (uint i = 0; i < Event::destination_count; i++) { - pSynthesisEvents[i]->clear(); - } - for (uint* puiKey = pActiveKeys->first(); puiKey; puiKey = pActiveKeys->next()) { - midi_key_info_t* pKey = &pMIDIKeyInfo[*puiKey]; - pKey->pEvents->clear(); // free all events on the key - } - - // read and copy events from input queue - Event event = pEventGenerator->CreateEvent(); - while (true) { - if (!pEventQueue->pop(&event)) break; - pEvents->alloc_assign(event); + // 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::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; + } + } } + // We only allow a maximum of CONFIG_MAX_VOICES voices to be stolen + // in each audio fragment. All subsequent request for spawning new + // voices in the same audio fragment will be ignored. + VoiceTheftsLeft = CONFIG_MAX_VOICES; - // update time of start and end of this audio fragment (as events' time stamps relate to this) - pEventGenerator->UpdateFragmentTime(Samples); + // reset internal voice counter (just for statistic of active voices) + ActiveVoiceCountTemp = 0; - // process events - Event* pNextEvent = pEvents->first(); - while (pNextEvent) { - Event* pEvent = pNextEvent; - pEvents->set_current(pEvent); - pNextEvent = pEvents->next(); - switch (pEvent->Type) { - case Event::type_note_on: - dmsg(5,("Engine: Note on received\n")); - ProcessNoteOn(pEvent); - break; - case Event::type_note_off: - dmsg(5,("Engine: Note off received\n")); - ProcessNoteOff(pEvent); - break; - case Event::type_control_change: - dmsg(5,("Engine: MIDI CC received\n")); - ProcessControlChange(pEvent); - break; - case Event::type_pitchbend: - dmsg(5,("Engine: Pitchbend received\n")); - ProcessPitchbend(pEvent); - break; - case Event::type_sysex: - dmsg(5,("Engine: Sysex received\n")); - ProcessSysex(pEvent); - break; - } + // 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); + } - // render audio from all active voices - int active_voices = 0; - 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 that all ordinary voices on ALL engine channels are rendered, render new stolen voices + RenderStolenVoices(Samples); - // now render current voice - pVoice->Render(Samples); - if (pVoice->IsActive()) active_voices++; // still active - else { // voice reached end, is now inactive - KillVoiceImmediately(pVoice); // remove voice from the list of active voices - } - } + // 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]); } - // now render all postponed voices from voice stealing - Event* pVoiceStealEvent = pVoiceStealingQueue->first(); - while (pVoiceStealEvent) { - Voice* pNewVoice = LaunchVoice(pVoiceStealEvent, pVoiceStealEvent->Param.Note.Layer, pVoiceStealEvent->Param.Note.ReleaseTrigger, false); - if (pNewVoice) { - pNewVoice->Render(Samples); - if (pNewVoice->IsActive()) active_voices++; // still active - else { // voice reached end, is now inactive - KillVoiceImmediately(pNewVoice); // remove voice from the list of active voices - } - } - else dmsg(1,("Ouch, voice stealing didn't work out!\n")); - pVoiceStealEvent = pVoiceStealingQueue->next(); - } - // reset voice stealing for the new fragment - pVoiceStealingQueue->clear(); - pLastStolenVoice = NULL; - puiLastStolenKey = NULL; + // empty the engine's event list for the next audio fragment + ClearEventLists(); + // reset voice stealing for the next audio fragment + pVoiceStealingQueue->clear(); - // write that to the disk thread class so that it can print it - // on the console for debugging purposes - ActiveVoiceCount = active_voices; + // just some statistics about this engine instance + ActiveVoiceCount = ActiveVoiceCountTemp; if (ActiveVoiceCount > ActiveVoiceCountMax) ActiveVoiceCountMax = ActiveVoiceCount; + FrameTime += Samples; return 0; } /** - * Will be called by the MIDIIn Thread to let the audio thread trigger a new - * voice for the given key. + * Dispatch and handle all events in this audio fragment for the given + * engine channel. * - * @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!")); + * @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 = 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((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; + } + } + } + + // 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; } /** - * Will be called by the MIDIIn Thread to signal the audio thread to release - * voice(s) on the given key. + * Render all 'normal' voices (that is voices which were not stolen in + * this fragment) on the given engine channel. * - * @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!")); + * @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) { + 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 + } + } + } } /** - * Will be called by the MIDIIn Thread to signal the audio thread to change - * the pitch value for all 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 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!")); + * @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); + 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")); + + // 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 that a - * continuous controller value has changed. + * 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 Controller - MIDI controller number of the occured control change - * @param Value - value of the control change + * @param pEngineChannel - engine channel to cleanup */ - 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!")); + void Engine::PostProcess(EngineChannel* pEngineChannel) { + // free all keys which have no active voices left + { + 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; + 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 + 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(); } /** @@ -574,6 +582,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 @@ -589,7 +598,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!")); } @@ -597,28 +606,57 @@ /** * 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) { - midi_key_info_t* pKey = &pMIDIKeyInfo[pNoteOnEvent->Param.Note.Key]; + void Engine::ProcessNoteOn(EngineChannel* pEngineChannel, Pool::Iterator& itNoteOnEvent) { + + const int key = itNoteOnEvent->Param.Note.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 = ((key - pInstrument->DimensionKeyRange.low) * 128) / + (pInstrument->DimensionKeyRange.high - pInstrument->DimensionKeyRange.low + 1); + } + + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[key]; pKey->KeyPressed = true; // the MIDI key was now pressed down + pKey->Velocity = itNoteOnEvent->Param.Note.Velocity; + pKey->NoteOnTime = FrameTime + itNoteOnEvent->FragmentPos(); // will be used to calculate note length // cancel release process of voices on this key if needed - if (pKey->Active && !SustainPedal) { - Event* pCancelReleaseEvent = pKey->pEvents->alloc(); - if (pCancelReleaseEvent) { - *pCancelReleaseEvent = *pNoteOnEvent; - pCancelReleaseEvent->Type = Event::type_cancel_release; // transform event type + if (pKey->Active && !pEngineChannel->SustainPedal) { + RTList::Iterator itCancelReleaseEvent = pKey->pEvents->allocAppend(); + if (itCancelReleaseEvent) { + *itCancelReleaseEvent = *itNoteOnEvent; // copy event + itCancelReleaseEvent->Type = Event::type_cancel_release; // transform event type } else dmsg(1,("Event pool emtpy!\n")); } - // allocate and trigger a new voice for the key - LaunchVoice(pNoteOnEvent); + // move note on event to the key's own event list + RTList::Iterator itNoteOnEventOnKeyList = itNoteOnEvent.moveToEndOf(pKey->pEvents); - // finally move note on event to the key's own event list - pEvents->move(pNoteOnEvent, 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); + } + } + + // 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); + + pKey->RoundRobinIndex++; } /** @@ -627,37 +665,54 @@ * 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) { - midi_key_info_t* pKey = &pMIDIKeyInfo[pNoteOffEvent->Param.Note.Key]; + void Engine::ProcessNoteOff(EngineChannel* pEngineChannel, Pool::Iterator& itNoteOffEvent) { + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[itNoteOffEvent->Param.Note.Key]; pKey->KeyPressed = false; // the MIDI key was now released // release voices on this key if needed - if (pKey->Active && !SustainPedal) { - pNoteOffEvent->Type = Event::type_release; // transform event type - } + if (pKey->Active && !pEngineChannel->SustainPedal) { + itNoteOffEvent->Type = Event::type_release; // transform event type - // spawn release triggered voice(s) if needed - if (pKey->ReleaseTrigger) { - LaunchVoice(pNoteOffEvent, 0, true); - pKey->ReleaseTrigger = false; - } + // 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) { + // 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); //FIXME: for the moment we don't perform voice stealing for release triggered samples + } + pKey->ReleaseTrigger = false; + } - // move event to the key's own event list - pEvents->move(pNoteOffEvent, pKey->pEvents); + // if neither a voice was spawned or postponed 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. * - * @param pPitchbendEvent - absolute pitch value and time stamp of the event + * @param pEngineChannel - engine channel on which this event occured on + * @param itPitchbendEvent - absolute pitch value and time stamp of the event */ - void Engine::ProcessPitchbend(Event* pPitchbendEvent) { - this->Pitch = pPitchbendEvent->Param.Pitch.Pitch; // store current pitch value - pEvents->move(pPitchbendEvent, pSynthesisEvents[Event::destination_vco]); + void Engine::ProcessPitchbend(EngineChannel* pEngineChannel, Pool::Iterator& itPitchbendEvent) { + pEngineChannel->Pitch = itPitchbendEvent->Param.Pitch.Pitch; // store current pitch value + itPitchbendEvent.moveToEndOf(pEngineChannel->pSynthesisEvents[Event::destination_vco]); } /** @@ -665,7 +720,8 @@ * called by the ProcessNoteOn() method and by the voices itself * (e.g. to spawn further voices on the same key for layered sounds). * - * @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 * @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 @@ -674,50 +730,63 @@ * when there is no free voice * (optional, default = true) * @returns pointer to new voice or NULL if there was no free voice or - * if an error occured while trying to trigger the new voice + * if the voice wasn't triggered (for example when no region is + * defined for the given key). */ - Voice* Engine::LaunchVoice(Event* pNoteOnEvent, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing) { - midi_key_info_t* pKey = &pMIDIKeyInfo[pNoteOnEvent->Param.Note.Key]; + Pool::Iterator Engine::LaunchVoice(EngineChannel* pEngineChannel, Pool::Iterator& itNoteOnEvent, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing) { + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[itNoteOnEvent->Param.Note.Key]; // allocate a new voice for the key - Voice* pNewVoice = pKey->pActiveVoices->alloc(); - if (pNewVoice) { + Pool::Iterator itNewVoice = pKey->pActiveVoices->allocAppend(); + if (itNewVoice) { // launch the new voice - if (pNewVoice->Trigger(pNoteOnEvent, this->Pitch, this->pInstrument, iLayer, ReleaseTriggerVoice) < 0) { - dmsg(1,("Triggering new voice failed!\n")); - pKey->pActiveVoices->free(pNewVoice); + if (itNewVoice->Trigger(pEngineChannel, itNoteOnEvent, pEngineChannel->Pitch, pEngineChannel->pInstrument, iLayer, ReleaseTriggerVoice, VoiceStealing) < 0) { + dmsg(4,("Voice not triggered\n")); + pKey->pActiveVoices->free(itNewVoice); } else { // on success uint** ppKeyGroup = NULL; - if (pNewVoice->KeyGroup) { // if this voice / key belongs to a key group - ppKeyGroup = &ActiveKeyGroups[pNewVoice->KeyGroup]; + if (itNewVoice->KeyGroup) { // if this voice / key belongs to a key group + ppKeyGroup = &pEngineChannel->ActiveKeyGroups[itNewVoice->KeyGroup]; if (*ppKeyGroup) { // if there's already an active key in that key group - midi_key_info_t* pOtherKey = &pMIDIKeyInfo[**ppKeyGroup]; + midi_key_info_t* pOtherKey = &pEngineChannel->pMIDIKeyInfo[**ppKeyGroup]; // kill all voices on the (other) key - Voice* pVoiceToBeKilled = pOtherKey->pActiveVoices->first(); - while (pVoiceToBeKilled) { - Voice* pVoiceToBeKilledNext = pOtherKey->pActiveVoices->next(); - if (pVoiceToBeKilled->Type != Voice::type_release_trigger) pVoiceToBeKilled->Kill(pNoteOnEvent); - pOtherKey->pActiveVoices->set_current(pVoiceToBeKilled); - pVoiceToBeKilled = pVoiceToBeKilledNext; + 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); } } } if (!pKey->Active) { // mark as active key pKey->Active = true; - pKey->pSelf = pActiveKeys->alloc(); - *pKey->pSelf = pNoteOnEvent->Param.Note.Key; + pKey->itSelf = pEngineChannel->pActiveKeys->allocAppend(); + *pKey->itSelf = itNoteOnEvent->Param.Note.Key; + } + if (itNewVoice->KeyGroup) { + *ppKeyGroup = &*pKey->itSelf; // put key as the (new) active key to its key group } - if (pNewVoice->KeyGroup) { - *ppKeyGroup = pKey->pSelf; // 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::Iterator itStealEvent = pVoiceStealingQueue->allocAppend(); + if (itStealEvent) { + *itStealEvent = *itNoteOnEvent; // copy event + itStealEvent->Param.Note.Layer = iLayer; + itStealEvent->Param.Note.ReleaseTrigger = ReleaseTriggerVoice; + pKey->VoiceTheftsQueued++; } - if (pNewVoice->Type == Voice::type_release_trigger_required) pKey->ReleaseTrigger = true; // mark key for the need of release triggered voice(s) - return pNewVoice; // success + else dmsg(1,("Voice stealing queue full!\n")); } } - else if (VoiceStealing) StealVoice(pNoteOnEvent, iLayer, ReleaseTriggerVoice); // no free voice left, so steal one - return NULL; // no free voice or error + return Pool::Iterator(); // no free voice or error } /** @@ -726,63 +795,67 @@ * voice stealing and postpone the note-on event until the selected * voice actually died. * - * @param pNoteOnEvent - key, velocity and time stamp of the event - * @param iLayer - layer index for the new voice - * @param ReleaseTriggerVoice - if new voice is a release triggered voice - */ - void Engine::StealVoice(Event* pNoteOnEvent, int iLayer, bool ReleaseTriggerVoice) { - if (!pEventPool->pool_is_empty()) { + * @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 + */ + int Engine::StealVoice(EngineChannel* pEngineChannel, Pool::Iterator& itNoteOnEvent) { + if (!VoiceTheftsLeft) { + dmsg(1,("Max. voice thefts per audio fragment reached (you may raise CONFIG_MAX_VOICES).\n")); + return -1; + } + if (!pEventPool->poolIsEmpty()) { - uint* puiOldestKey; - Voice* pOldestVoice; + 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[pNoteOnEvent->Param.Note.Key]; - if (pLastStolenVoice) { - pOldestKey->pActiveVoices->set_current(pLastStolenVoice); - pOldestVoice = pOldestKey->pActiveVoices->next(); - } - else { // no voice stolen in this audio fragment cycle yet - pOldestVoice = pOldestKey->pActiveVoices->first(); - } - if (pOldestVoice) { - puiOldestKey = pOldestKey->pSelf; - 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->hasRendered()) ++itSelectedVoice; + // if we haven't found a voice then proceed with algorithm 'oldestkey' + if (itSelectedVoice && itSelectedVoice->hasRendered()) 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 (pLastStolenVoice) { - midi_key_info_t* pOldestKey = &pMIDIKeyInfo[*puiLastStolenKey]; - pOldestKey->pActiveVoices->set_current(pLastStolenVoice); - pOldestVoice = pOldestKey->pActiveVoices->next(); - if (!pOldestVoice) { - pActiveKeys->set_current(puiLastStolenKey); - puiOldestKey = pActiveKeys->next(); - if (puiOldestKey) { - midi_key_info_t* pOldestKey = &pMIDIKeyInfo[*puiOldestKey]; - pOldestVoice = pOldestKey->pActiveVoices->first(); - } - else { // too less voices, even for voice stealing - dmsg(1,("Voice overflow! - You might 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->hasRendered()); // proceed iterating if voice was created in this fragment cycle + // found a "stealable" voice ? + if (itSelectedVoice && itSelectedVoice->hasRendered()) { + // remember which voice we stole, so we can simply proceed on next voice stealing + this->itLastStolenVoice = itSelectedVoice; + break; // selection succeeded } - else puiOldestKey = puiLastStolenKey; } - else { // no voice stolen in this audio fragment cycle yet - puiOldestKey = pActiveKeys->first(); - midi_key_info_t* pOldestKey = &pMIDIKeyInfo[*puiOldestKey]; - pOldestVoice = 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->hasRendered()) ++itSelectedVoice; + // found a "stealable" voice ? + if (itSelectedVoice && itSelectedVoice->hasRendered()) { + // 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; } @@ -791,125 +864,221 @@ case voice_steal_algo_none: default: { dmsg(1,("No free voice (voice stealing disabled)!\n")); - return; + 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->hasRendered()) { + 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]; + } + // iterate through engine channels + while (true) { + // if we already stole in this fragment, try to proceed on same key + if (this->itLastStolenVoiceGlobally) { + itSelectedVoice = this->itLastStolenVoiceGlobally; + do { + ++itSelectedVoice; + } while (itSelectedVoice && !itSelectedVoice->hasRendered()); // proceed iterating if voice was created in this fragment cycle + // break if selection succeeded + if (itSelectedVoice && itSelectedVoice->hasRendered()) { + // remember which voice we stole, so we can simply proceed on next voice stealing + this->itLastStolenVoiceGlobally = itSelectedVoice; + break; // selection succeeded + } + } + // get (next) oldest key + RTList::Iterator iuiSelectedKey = (this->iuiLastStolenKey) ? ++this->iuiLastStolenKey : pSelectedChannel->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->hasRendered()) ++itSelectedVoice; + // found a "stealable" voice ? + if (itSelectedVoice && itSelectedVoice->hasRendered()) { + // 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; + break; // 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 (!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 - pOldestVoice->Kill(pNoteOnEvent); - // remember which voice on which key we stole, so we can simply proceed for the next voice stealing - this->pLastStolenVoice = pOldestVoice; - this->puiLastStolenKey = puiOldestKey; - // put note-on event into voice-stealing queue, so it will be reprocessed after killed voice died - Event* pStealEvent = pVoiceStealingQueue->alloc(); - *pStealEvent = *pNoteOnEvent; - pStealEvent->Param.Note.Layer = iLayer; - pStealEvent->Param.Note.ReleaseTrigger = ReleaseTriggerVoice; + itSelectedVoice->Kill(itNoteOnEvent); + + --VoiceTheftsLeft; + + return 0; // success + } + else { + dmsg(1,("Event pool emtpy!\n")); + return -1; } - else dmsg(1,("Event pool emtpy!\n")); } /** - * Immediately kills the voice given with pVoice (no matter if sustain is - * pressed or not) and removes it from the MIDI key's list of active voice. - * This method will e.g. be called if a voice went inactive by itself. + * 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 pVoice - points to the voice to be killed + * @param pEngineChannel - engine channel on which this event occured on + * @param itVoice - points to the voice to be freed */ - void Engine::KillVoiceImmediately(Voice* pVoice) { - if (pVoice) { - if (pVoice->IsActive()) pVoice->KillImmediately(); + void Engine::FreeVoice(EngineChannel* pEngineChannel, Pool::Iterator& itVoice) { + if (itVoice) { + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[itVoice->MIDIKey]; - midi_key_info_t* pKey = &pMIDIKeyInfo[pVoice->MIDIKey]; + uint keygroup = itVoice->KeyGroup; // 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 (pKey->pActiveVoices->is_empty()) { - if (pVoice->KeyGroup) { // if voice / key belongs to a key group - uint** ppKeyGroup = &ActiveKeyGroups[pVoice->KeyGroup]; - if (*ppKeyGroup == pKey->pSelf) *ppKeyGroup = NULL; // remove key from key group - } - pKey->Active = false; - pActiveKeys->free(pKey->pSelf); // remove key from list of active keys - pKey->pSelf = NULL; - pKey->ReleaseTrigger = false; - pKey->pEvents->clear(); - dmsg(3,("Key has no more voices now\n")); + // if no other voices left and member of a key group, remove from key group + if (pKey->pActiveVoices->isEmpty() && keygroup) { + uint** ppKeyGroup = &pEngineChannel->ActiveKeyGroups[keygroup]; + if (*ppKeyGroup == &*pKey->itSelf) *ppKeyGroup = NULL; // remove key from key group } } - 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::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) { - dmsg(4,("Engine::ContinuousController cc=%d v=%d\n", pControlChangeEvent->Param.CC.Controller, pControlChangeEvent->Param.CC.Value)); + 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; + + // move event from the unsorted event list to the control change event list + Pool::Iterator itControlChangeEventOnCCList = itControlChangeEvent.moveToEndOf(pEngineChannel->pCCEvents); - switch (pControlChangeEvent->Param.CC.Controller) { - case 64: { - if (pControlChangeEvent->Param.CC.Value >= 64 && !SustainPedal) { + switch (itControlChangeEventOnCCList->Param.CC.Controller) { + case 7: { // volume + //TODO: not sample accurate yet + pEngineChannel->GlobalVolume = (float) itControlChangeEventOnCCList->Param.CC.Value / 127.0f; + break; + } + case 10: { // panpot + //TODO: not sample accurate yet + const int pan = (int) itControlChangeEventOnCCList->Param.CC.Value - 64; + pEngineChannel->GlobalPanLeft = 1.0f - float(RTMath::Max(pan, 0)) / 63.0f; + pEngineChannel->GlobalPanRight = 1.0f - float(RTMath::Min(pan, 0)) / -64.0f; + break; + } + case 64: { // sustain + if (itControlChangeEventOnCCList->Param.CC.Value >= 64 && !pEngineChannel->SustainPedal) { dmsg(4,("PEDAL DOWN\n")); - SustainPedal = true; + pEngineChannel->SustainPedal = true; // cancel release process of voices if necessary - uint* piKey = pActiveKeys->first(); - if (piKey) { - pControlChangeEvent->Type = Event::type_cancel_release; // transform event type - while (piKey) { - midi_key_info_t* pKey = &pMIDIKeyInfo[*piKey]; - pActiveKeys->set_current(piKey); - piKey = pActiveKeys->next(); - if (!pKey->KeyPressed) { - 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")); + 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 = *itControlChangeEventOnCCList; // 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 (pControlChangeEvent->Param.CC.Value < 64 && SustainPedal) { + if (itControlChangeEventOnCCList->Param.CC.Value < 64 && pEngineChannel->SustainPedal) { dmsg(4,("PEDAL UP\n")); - SustainPedal = false; + pEngineChannel->SustainPedal = false; // release voices if their respective key is not pressed - uint* piKey = pActiveKeys->first(); - if (piKey) { - pControlChangeEvent->Type = Event::type_release; // transform event type - while (piKey) { - midi_key_info_t* pKey = &pMIDIKeyInfo[*piKey]; - pActiveKeys->set_current(piKey); - piKey = pActiveKeys->next(); - if (!pKey->KeyPressed) { - 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")); + 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 = *itControlChangeEventOnCCList; // 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[pControlChangeEvent->Param.CC.Controller] = pControlChangeEvent->Param.CC.Value; - // move event from the unsorted event list to the control change event list - pEvents->move(pControlChangeEvent, pCCEvents); + // Channel Mode Messages + + case 120: { // all sound off + KillAllVoices(pEngineChannel, itControlChangeEventOnCCList); + break; + } + case 121: { // reset all controllers + pEngineChannel->ResetControllers(); + break; + } + case 123: { // all notes off + ReleaseAllVoices(pEngineChannel, itControlChangeEventOnCCList); + break; + } + } } /** * Reacts on MIDI system exclusive messages. * - * @param pSysexEvent - sysex data size and time stamp of the sysex event + * @param itSysexEvent - sysex data size and time stamp of the sysex event */ - void Engine::ProcessSysex(Event* pSysexEvent) { + void Engine::ProcessSysex(Pool::Iterator& itSysexEvent) { RingBuffer::NonVolatileReader reader = pSysexBuffer->get_non_volatile_reader(); uint8_t exclusive_status, id; @@ -919,6 +1088,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; @@ -931,19 +1101,26 @@ 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; } } @@ -957,7 +1134,7 @@ } free_sysex_data: // finally free sysex data - pSysexBuffer->increment_read_ptr(pSysexEvent->Param.Sysex.Size); + pSysexBuffer->increment_read_ptr(itSysexEvent->Param.Sysex.Size); } /** @@ -988,6 +1165,51 @@ } /** + * 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::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")); + } + } + + /** + * 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); + } + } + } + + /** * Initialize the parameter sequence for the modulation destination given by * by 'dst' with the constant value given by val. */ @@ -1002,46 +1224,6 @@ } } - 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)); - } - } - - 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)); - } - } - uint Engine::VoiceCount() { return ActiveVoiceCount; } @@ -1071,19 +1253,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() { @@ -1091,7 +1261,7 @@ } String Engine::Version() { - String s = "$Revision: 1.14 $"; + String s = "$Revision: 1.42 $"; return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword }