--- linuxsampler/trunk/src/engines/gig/Engine.cpp 2004/10/08 20:51:39 271 +++ linuxsampler/trunk/src/engines/gig/Engine.cpp 2005/03/03 03:25:17 420 @@ -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,38 +24,91 @@ #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.push_back(pChannel); + 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())); + } 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); + pVoicePool = new Pool(MAX_AUDIO_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); - } for (RTList::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) { iterVoice->SetEngine(this); } @@ -64,42 +118,34 @@ pBasicFilterParameters = NULL; pMainFilterParameters = NULL; - InstrumentIdx = -1; - InstrumentStat = -1; - - AudioDeviceChannelLeft = -1; - AudioDeviceChannelRight = -1; - ResetInternal(); } Engine::~Engine() { if (pDiskThread) { + dmsg(1,("Stopping disk thread...")); pDiskThread->StopThread(); delete pDiskThread; - } - 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; + dmsg(1,("OK\n")); } 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() { @@ -126,24 +172,7 @@ */ 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; Enable(); } @@ -152,145 +181,27 @@ * 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 - 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; - // reset all voices 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(); // delete all input events pEventQueue->init(); - } - - /** - * 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. - */ - void Engine::ResourceToBeUpdated(::gig::Instrument* pResource, void*& pUpdateArg) { - dmsg(3,("gig::Engine: Received instrument update message.\n")); - DisableAndLock(); - ResetInternal(); - this->pInstrument = NULL; - } - - /** - * Will be called by the InstrumentResourceManager when the instrument - * update process was completed, so we can continue with playback. - */ - 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; @@ -305,18 +216,21 @@ String msg = "Audio output device unable to provide 2 audio channels, cause: " + e.Message(); 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(); + // 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 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 if (!pDiskThread) { @@ -335,8 +249,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(); @@ -358,17 +277,52 @@ } } - void Engine::DisconnectAudioOutputDevice() { - if (pAudioOutputDevice) { // if clause to prevent disconnect loops - AudioOutputDevice* olddevice = pAudioOutputDevice; - pAudioOutputDevice = NULL; - olddevice->Disconnect(this); - AudioDeviceChannelLeft = -1; - AudioDeviceChannelRight = -1; + void Engine::ClearEventLists() { + pEvents->clear(); + pCCEvents->clear(); + for (uint i = 0; i < Event::destination_count; i++) { + pSynthesisEvents[i]->clear(); } } /** + * Copy all events from the given 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 get all events which have + * to be processed in the current audio cycle. Each EngineChannel has + * it's own input event queue for the common channel specific events + * (like NoteOn, NoteOff and ControlChange events). Beside that, the + * engine also has a input event queue for global events (usually SysEx + * message). + * + * @param pEventQueue - input event buffer to read from + * @param Samples - number of sample points to be processed in the + * current audio cycle + */ + void Engine::ImportEvents(RingBuffer* pEventQueue, 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 (pEvents->poolIsEmpty()) { + dmsg(1,("Event pool emtpy!\n")); + break; + } + *pEvents->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 @@ -381,41 +335,73 @@ 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(); + // empty the engine's event lists for the new fragment + ClearEventLists(); + + // get all events from the engine's global input event queue which belong to the current fragment + // (these are usually just SysEx messages) + ImportEvents(this->pEventQueue, Samples); + + // process engine global events (these are currently only MIDI System Exclusive messages) + { + RTList::Iterator itEvent = pEvents->first(); + RTList::Iterator end = pEvents->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; + + // render audio for all engine channels + // TODO: should we make voice stealing engine globally? unfortunately this would mean other disadvantages so I left voice stealing in the engine channel space for now { - RTList::Iterator iuiKey = pActiveKeys->first(); - RTList::Iterator end = pActiveKeys->end(); - for(; iuiKey != end; ++iuiKey) { - pMIDIKeyInfo[*iuiKey].pEvents->clear(); // free all events on the key + std::list::iterator itChannel = engineChannels.begin(); + std::list::iterator end = engineChannels.end(); + for (; itChannel != end; itChannel++) { + if (!(*itChannel)->pInstrument) continue; // ignore if no instrument loaded + RenderAudio(*itChannel, Samples); } } - // read and copy events from input queue - Event event = pEventGenerator->CreateEvent(); - while (true) { - if (!pEventQueue->pop(&event) || pEvents->poolIsEmpty()) break; - *pEvents->allocAppend() = event; + // just some statistics about this engine instance + ActiveVoiceCount = ActiveVoiceCountTemp; + if (ActiveVoiceCount > ActiveVoiceCountMax) ActiveVoiceCountMax = ActiveVoiceCount; + + return 0; + } + + void Engine::RenderAudio(EngineChannel* pEngineChannel, uint Samples) { + // empty the engine's event lists for the new fragment + ClearEventLists(); + // empty the engine channel's, MIDI key specific event lists + { + RTList::Iterator iuiKey = pEngineChannel->pActiveKeys->first(); + RTList::Iterator end = pEngineChannel->pActiveKeys->end(); + for(; iuiKey != end; ++iuiKey) { + pEngineChannel->pMIDIKeyInfo[*iuiKey].pEvents->clear(); // free all events on the key + } } - // update time of start and end of this audio fragment (as events' time stamps relate to this) - pEventGenerator->UpdateFragmentTime(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.) + ImportEvents(pEngineChannel->pEventQueue, Samples); // process events @@ -426,37 +412,31 @@ 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; } } } - int active_voices = 0; - // render audio from all active voices { - 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; RTList::Iterator itVoice = pKey->pActiveVoices->first(); @@ -464,106 +444,61 @@ 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 + if (itVoice->IsActive()) ActiveVoiceCountTemp++; // still active else { // voice reached end, is now inactive - KillVoiceImmediately(itVoice); // remove voice from the list of active voices + FreeVoice(pEngineChannel, itVoice); // remove voice from the list of active voices } } } } - + // now render all postponed voices from voice stealing { 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); + Pool::Iterator itNewVoice = + LaunchVoice(pEngineChannel, itVoiceStealEvent, itVoiceStealEvent->Param.Note.Layer, itVoiceStealEvent->Param.Note.ReleaseTrigger, false); if (itNewVoice) { - itNewVoice->Render(Samples); - if (itNewVoice->IsActive()) active_voices++; // still active - else { // voice reached end, is now inactive - KillVoiceImmediately(itNewVoice); // remove voice from the list of active voices + for (; itNewVoice; itNewVoice = itNewVoice->itChildVoice) { + 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,("Ouch, voice stealing didn't work out!\n")); + 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(); - - - // 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; - } + pEngineChannel->itLastStolenVoice = RTList::Iterator(); + pEngineChannel->iuiLastStolenKey = RTList::Iterator(); + - /** - * 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!")); + // 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 DEVMODE + else { // FIXME: should be removed before the final release (purpose: 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 // DEVMODE + } + } } /** @@ -577,6 +512,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 @@ -600,15 +536,27 @@ /** * 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) { - midi_key_info_t* pKey = &pMIDIKeyInfo[itNoteOnEvent->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 // 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 @@ -621,7 +569,7 @@ RTList::Iterator itNoteOnEventOnKeyList = itNoteOnEvent.moveToEndOf(pKey->pEvents); // allocate and trigger a new voice for the key - LaunchVoice(itNoteOnEventOnKeyList); + LaunchVoice(pEngineChannel, itNoteOnEventOnKeyList, 0, false, true); } /** @@ -630,15 +578,16 @@ * 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) { + 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) { + if (pKey->Active && !pEngineChannel->SustainPedal) { itNoteOffEvent->Type = Event::type_release; // transform event type } @@ -647,7 +596,7 @@ // spawn release triggered voice(s) if needed if (pKey->ReleaseTrigger) { - LaunchVoice(itNoteOffEventOnKeyList, 0, true); + LaunchVoice(pEngineChannel, itNoteOffEventOnKeyList, 0, true, false); //FIXME: for the moment we don't perform voice stealing for release triggered samples pKey->ReleaseTrigger = false; } } @@ -656,10 +605,11 @@ * Moves pitchbend event from the general (input) event list to the pitch * event list. * + * @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 + void Engine::ProcessPitchbend(EngineChannel* pEngineChannel, Pool::Iterator& itPitchbendEvent) { + pEngineChannel->Pitch = itPitchbendEvent->Param.Pitch.Pitch; // store current pitch value itPitchbendEvent.moveToEndOf(pSynthesisEvents[Event::destination_vco]); } @@ -668,6 +618,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) @@ -677,25 +628,26 @@ * 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). */ - 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) { + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[itNoteOnEvent->Param.Note.Key]; // 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) < 0) { - dmsg(1,("Triggering new voice failed!\n")); + 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 (itNewVoice->KeyGroup) { // if this voice / key belongs to a key group - ppKeyGroup = &ActiveKeyGroups[itNewVoice->KeyGroup]; + 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 RTList::Iterator itVoiceToBeKilled = pOtherKey->pActiveVoices->first(); RTList::Iterator end = pOtherKey->pActiveVoices->end(); @@ -706,7 +658,7 @@ } 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) { @@ -716,7 +668,25 @@ return itNewVoice; // success } } - else if (VoiceStealing) StealVoice(itNoteOnEvent, iLayer, ReleaseTriggerVoice); // no free voice left, so steal one + else if (VoiceStealing) { + // first, get total amount of required voices (dependant on amount of layers) + ::gig::Region* pRegion = pEngineChannel->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(pEngineChannel, 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; + } + else dmsg(1,("Voice stealing queue full!\n")); + } return Pool::Iterator(); // no free voice or error } @@ -727,11 +697,10 @@ * voice stealing and postpone the note-on event until the selected * voice actually died. * - * @param itNoteOnEvent - 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 + * @param pEngineChannel - engine channel on which this event occured on + * @param itNoteOnEvent - key, velocity and time stamp of the event */ - void Engine::StealVoice(Pool::Iterator& itNoteOnEvent, int iLayer, bool ReleaseTriggerVoice) { + void Engine::StealVoice(EngineChannel* pEngineChannel, Pool::Iterator& itNoteOnEvent) { if (!pEventPool->poolIsEmpty()) { RTList::Iterator iuiOldestKey; @@ -745,9 +714,9 @@ // key, or no voice left to kill there, then procceed with // 'oldestkey' algorithm case voice_steal_algo_keymask: { - midi_key_info_t* pOldestKey = &pMIDIKeyInfo[itNoteOnEvent->Param.Note.Key]; - if (itLastStolenVoice) { - itOldestVoice = itLastStolenVoice; + midi_key_info_t* pOldestKey = &pEngineChannel->pMIDIKeyInfo[itNoteOnEvent->Param.Note.Key]; + if (pEngineChannel->itLastStolenVoice) { + itOldestVoice = pEngineChannel->itLastStolenVoice; ++itOldestVoice; } else { // no voice stolen in this audio fragment cycle yet @@ -762,27 +731,27 @@ // try to pick the oldest voice on the oldest active key // (caution: must stay after 'keymask' algorithm !) case voice_steal_algo_oldestkey: { - if (itLastStolenVoice) { - midi_key_info_t* pOldestKey = &pMIDIKeyInfo[*iuiLastStolenKey]; - itOldestVoice = itLastStolenVoice; + if (pEngineChannel->itLastStolenVoice) { + midi_key_info_t* pOldestKey = &pEngineChannel->pMIDIKeyInfo[*pEngineChannel->iuiLastStolenKey]; + itOldestVoice = pEngineChannel->itLastStolenVoice; ++itOldestVoice; if (!itOldestVoice) { - iuiOldestKey = iuiLastStolenKey; + iuiOldestKey = pEngineChannel->iuiLastStolenKey; ++iuiOldestKey; if (iuiOldestKey) { - midi_key_info_t* pOldestKey = &pMIDIKeyInfo[*iuiOldestKey]; + midi_key_info_t* pOldestKey = &pEngineChannel->pMIDIKeyInfo[*iuiOldestKey]; itOldestVoice = pOldestKey->pActiveVoices->first(); } - else { // too less voices, even for voice stealing - dmsg(1,("Voice overflow! - You might recompile with higher MAX_AUDIO_VOICES!\n")); + else { + dmsg(1,("gig::Engine: Warning, too less voices, even for voice stealing! - Better recompile with higher MAX_AUDIO_VOICES.\n")); return; } } - else iuiOldestKey = iuiLastStolenKey; + else iuiOldestKey = pEngineChannel->iuiLastStolenKey; } else { // no voice stolen in this audio fragment cycle yet - iuiOldestKey = pActiveKeys->first(); - midi_key_info_t* pOldestKey = &pMIDIKeyInfo[*iuiOldestKey]; + iuiOldestKey = pEngineChannel->pActiveKeys->first(); + midi_key_info_t* pOldestKey = &pEngineChannel->pMIDIKeyInfo[*iuiOldestKey]; itOldestVoice = pOldestKey->pActiveVoices->first(); } break; @@ -796,79 +765,86 @@ } } + //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")); + // 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; - // 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; - } - else dmsg(1,("Voice stealing queue full!\n")); + pEngineChannel->itLastStolenVoice = itOldestVoice; + pEngineChannel->iuiLastStolenKey = iuiOldestKey; } 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 itVoice - 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(Pool::Iterator& itVoice) { + void Engine::FreeVoice(EngineChannel* pEngineChannel, Pool::Iterator& itVoice) { if (itVoice) { - if (itVoice->IsActive()) itVoice->KillImmediately(); - - midi_key_info_t* pKey = &pMIDIKeyInfo[itVoice->MIDIKey]; + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[itVoice->MIDIKey]; uint keygroup = itVoice->KeyGroup; // free the voice object pVoicePool->free(itVoice); - // check if there are no voices left on the MIDI key and update the key info if so - if (pKey->pActiveVoices->isEmpty()) { - if (keygroup) { // if voice / key belongs to a key group - uint** ppKeyGroup = &ActiveKeyGroups[keygroup]; - if (*ppKeyGroup == &*pKey->itSelf) *ppKeyGroup = NULL; // remove key from key group - } - pKey->Active = false; - 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")); + // 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 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)); switch (itControlChangeEvent->Param.CC.Controller) { case 64: { - if (itControlChangeEvent->Param.CC.Value >= 64 && !SustainPedal) { + if (itControlChangeEvent->Param.CC.Value >= 64 && !pEngineChannel->SustainPedal) { dmsg(4,("PEDAL DOWN\n")); - SustainPedal = true; + pEngineChannel->SustainPedal = true; // cancel release process of voices if necessary - RTList::Iterator iuiKey = pActiveKeys->first(); + RTList::Iterator iuiKey = pEngineChannel->pActiveKeys->first(); if (iuiKey) { itControlChangeEvent->Type = Event::type_cancel_release; // transform event type while (iuiKey) { - midi_key_info_t* pKey = &pMIDIKeyInfo[*iuiKey]; + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey]; ++iuiKey; if (!pKey->KeyPressed) { RTList::Iterator itNewEvent = pKey->pEvents->allocAppend(); @@ -878,16 +854,16 @@ } } } - if (itControlChangeEvent->Param.CC.Value < 64 && SustainPedal) { + if (itControlChangeEvent->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 - RTList::Iterator iuiKey = pActiveKeys->first(); + RTList::Iterator iuiKey = pEngineChannel->pActiveKeys->first(); if (iuiKey) { itControlChangeEvent->Type = Event::type_release; // transform event type while (iuiKey) { - midi_key_info_t* pKey = &pMIDIKeyInfo[*iuiKey]; + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey]; ++iuiKey; if (!pKey->KeyPressed) { RTList::Iterator itNewEvent = pKey->pEvents->allocAppend(); @@ -902,7 +878,7 @@ } // update controller value in the engine's controller table - ControllerTable[itControlChangeEvent->Param.CC.Controller] = itControlChangeEvent->Param.CC.Value; + pEngineChannel->ControllerTable[itControlChangeEvent->Param.CC.Controller] = itControlChangeEvent->Param.CC.Value; // move event from the unsorted event list to the control change event list itControlChangeEvent.moveToEndOf(pCCEvents); @@ -1004,47 +980,7 @@ m[i+2] = val; m[i+3] = val; } - } - - 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; @@ -1078,24 +1014,12 @@ return "GigEngine"; } - String Engine::InstrumentFileName() { - return InstrumentFile; - } - - int Engine::InstrumentIndex() { - return InstrumentIdx; - } - - int Engine::InstrumentStatus() { - return InstrumentStat; - } - String Engine::Description() { return "Gigasampler Engine"; } String Engine::Version() { - String s = "$Revision: 1.15 $"; + String s = "$Revision: 1.28 $"; return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword }