--- linuxsampler/trunk/src/engines/gig/Engine.cpp 2004/04/26 17:15:51 53 +++ linuxsampler/trunk/src/engines/gig/Engine.cpp 2005/02/19 02:40:24 392 @@ -2,7 +2,7 @@ * * * LinuxSampler - modular, streaming capable sampler * * * - * Copyright (C) 2003 by Benno Senoner and Christian Schoenebeck * + * Copyright (C) 2003, 2004 by Benno Senoner and 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,9 +23,16 @@ #include #include "DiskThread.h" #include "Voice.h" +#include "EGADSR.h" #include "Engine.h" +#if defined(__APPLE__) +# include +#else +# include +#endif + namespace LinuxSampler { namespace gig { InstrumentResourceManager Engine::Instruments; @@ -37,37 +44,52 @@ pAudioOutputDevice = NULL; pDiskThread = NULL; pEventGenerator = NULL; - pEventQueue = new RingBuffer(MAX_EVENTS_PER_FRAGMENT); - pEventPool = new RTELMemoryPool(MAX_EVENTS_PER_FRAGMENT); - pVoicePool = new RTELMemoryPool(MAX_AUDIO_VOICES); - pActiveKeys = new RTELMemoryPool(128); - pEvents = new RTEList(pEventPool); - pCCEvents = new RTEList(pEventPool); + 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); + pVoiceStealingQueue = new RTList(pEventPool); + pEvents = new RTList(pEventPool); + pCCEvents = new RTList(pEventPool); for (uint i = 0; i < Event::destination_count; i++) { - pSynthesisEvents[i] = new RTEList(pEventPool); + pSynthesisEvents[i] = new RTList(pEventPool); } for (uint i = 0; i < 128; i++) { - pMIDIKeyInfo[i].pActiveVoices = new RTEList(pVoicePool); - pMIDIKeyInfo[i].KeyPressed = false; - pMIDIKeyInfo[i].Active = false; - pMIDIKeyInfo[i].pSelf = NULL; - pMIDIKeyInfo[i].pEvents = new RTEList(pEventPool); + 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 (Voice* pVoice = pVoicePool->alloc(); pVoice; pVoice = pVoicePool->alloc()) { - pVoice->SetEngine(this); + for (RTList::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) { + iterVoice->SetEngine(this); } pVoicePool->clear(); pSynthesisParameters[0] = NULL; // we allocate when an audio device is connected + pBasicFilterParameters = NULL; + pMainFilterParameters = NULL; + + InstrumentIdx = -1; + InstrumentStat = -1; + + AudioDeviceChannelLeft = -1; + AudioDeviceChannelRight = -1; ResetInternal(); } Engine::~Engine() { if (pDiskThread) { + dmsg(1,("Stopping disk thread...")); pDiskThread->StopThread(); delete pDiskThread; + dmsg(1,("OK\n")); } + + if (pInstrument) Instruments.HandBack(pInstrument, this); + if (pGig) delete pGig; if (pRIFF) delete pRIFF; for (uint i = 0; i < 128; i++) { @@ -77,21 +99,27 @@ for (uint i = 0; i < Event::destination_count; i++) { if (pSynthesisEvents[i]) delete pSynthesisEvents[i]; } - delete[] pSynthesisEvents; if (pEvents) delete pEvents; if (pCCEvents) delete pCCEvents; if (pEventQueue) delete pEventQueue; if (pEventPool) delete pEventPool; - if (pVoicePool) delete pVoicePool; + if (pVoicePool) { + pVoicePool->clear(); + delete pVoicePool; + } if (pActiveKeys) delete pActiveKeys; + if (pSysexBuffer) delete pSysexBuffer; if (pEventGenerator) delete pEventGenerator; - if (pSynthesisParameters[0]) delete[] pSynthesisParameters[0]; + if (pMainFilterParameters) delete[] pMainFilterParameters; + if (pBasicFilterParameters) delete[] pBasicFilterParameters; + if (pSynthesisParameters[0]) free(pSynthesisParameters[0]); + if (pVoiceStealingQueue) delete pVoiceStealingQueue; } void Engine::Enable() { dmsg(3,("gig::Engine: enabling\n")); EngineDisabled.PushAndUnlock(false, 2); // set condition object 'EngineDisabled' to false (wait max. 2s) - dmsg(1,("gig::Engine: enabled (val=%d)\n", EngineDisabled.GetUnsafe())); + dmsg(3,("gig::Engine: enabled (val=%d)\n", EngineDisabled.GetUnsafe())); } void Engine::Disable() { @@ -142,6 +170,16 @@ SustainPedal = false; ActiveVoiceCount = 0; ActiveVoiceCountMax = 0; + GlobalVolume = 1.0; + CurrentKeyDimension = 0; + + // reset voice stealing parameters + itLastStolenVoice = RTList::Iterator(); + iuiLastStolenKey = RTList::Iterator(); + pVoiceStealingQueue->clear(); + + // reset to normal chromatic scale (means equal temper) + memset(&ScaleTuning[0], 0x00, 12); // set all MIDI controller values to zero memset(ControllerTable, 0x00, 128); @@ -150,14 +188,19 @@ 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].pSelf = NULL; + 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 (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(); @@ -172,14 +215,31 @@ } /** - * Load an instrument from a .gig file. + * More or less a workaround to set the instrument name, index and load + * status variable to zero percent immediately, that is without blocking + * the calling thread. It might be used in future for other preparations + * as well though. + * + * @param FileName - file name of the Gigasampler instrument file + * @param Instrument - index of the instrument in the .gig file + * @see LoadInstrument() + */ + void Engine::PrepareLoadInstrument(const char* FileName, uint Instrument) { + InstrumentFile = FileName; + InstrumentIdx = Instrument; + InstrumentStat = 0; + } + + /** + * Load an instrument from a .gig file. PrepareLoadInstrument() has to + * be called first to provide the information which instrument to load. + * This method will then actually start to load the instrument and block + * the calling thread until loading was completed. * - * @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 + * @returns detailed description of the method call result + * @see PrepareLoadInstrument() */ - void Engine::LoadInstrument(const char* FileName, uint Instrument) { + void Engine::LoadInstrument() { DisableAndLock(); @@ -191,29 +251,43 @@ Instruments.HandBack(pInstrument, this); } + // delete all key groups + ActiveKeyGroups.clear(); + // request gig instrument from instrument manager try { instrument_id_t instrid; - instrid.FileName = FileName; - instrid.iInstrument = Instrument; + instrid.FileName = InstrumentFile; + instrid.iInstrument = InstrumentIdx; 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; + + InstrumentIdxName = pInstrument->pInfo->Name; + InstrumentStat = 100; + // inform audio driver for the need of two channels try { if (pAudioOutputDevice) pAudioOutputDevice->AcquireChannels(2); // gig Engine only stereo @@ -243,7 +317,7 @@ * update process was completed, so we can continue with playback. */ void Engine::ResourceUpdated(::gig::Instrument* pOldResource, ::gig::Instrument* pNewResource, void* pUpdateArg) { - this->pInstrument = pNewResource; + this->pInstrument = pNewResource; //TODO: there are couple of engine parameters we should update here as well if the instrument was updated (see LoadInstrument()) Enable(); } @@ -261,10 +335,24 @@ 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 to 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) { @@ -272,9 +360,8 @@ exit(EXIT_FAILURE); } - for (Voice* pVoice = pVoicePool->alloc(); pVoice; pVoice = pVoicePool->alloc()) { - pVoice->pDiskThread = this->pDiskThread; - pVoice->SetOutput(pAudioOut); + for (RTList::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) { + iterVoice->pDiskThread = this->pDiskThread; dmsg(3,("d")); } pVoicePool->clear(); @@ -284,17 +371,28 @@ 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(); + // (re)allocate biquad filter parameter sequence + if (pBasicFilterParameters) delete[] pBasicFilterParameters; + if (pMainFilterParameters) delete[] pMainFilterParameters; + pBasicFilterParameters = new biquad_param_t[pAudioOut->MaxSamplesPerCycle()]; + pMainFilterParameters = new biquad_param_t[pAudioOut->MaxSamplesPerCycle()]; + dmsg(1,("Starting disk thread...")); pDiskThread->StartThread(); dmsg(1,("OK\n")); - for (Voice* pVoice = pVoicePool->first(); pVoice; pVoice = pVoicePool->next()) { - 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); } @@ -306,6 +404,8 @@ AudioOutputDevice* olddevice = pAudioOutputDevice; pAudioOutputDevice = NULL; olddevice->Disconnect(this); + AudioDeviceChannelLeft = -1; + AudioDeviceChannelRight = -1; } } @@ -333,75 +433,149 @@ } + // 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(); } - - // read and copy events from input queue - Event event = pEventGenerator->CreateEvent(); - while (true) { - if (!pEventQueue->pop(&event)) break; - pEvents->alloc_assign(event); + { + RTList::Iterator iuiKey = pActiveKeys->first(); + RTList::Iterator end = pActiveKeys->end(); + for(; iuiKey != end; ++iuiKey) { + 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 input event queue which belong to the current fragment + { + RingBuffer::NonVolatileReader eventQueueReader = pEventQueue->get_non_volatile_reader(); + Event* pEvent; + while (true) { + // get next event from input event queue + if (!(pEvent = eventQueueReader.pop())) break; + // if younger event reached, ignore that and all subsequent ones for now + if (pEvent->FragmentPos() >= Samples) { + eventQueueReader--; + dmsg(2,("Younger Event, pos=%d ,Samples=%d!\n",pEvent->FragmentPos(),Samples)); + pEvent->ResetFragmentPos(); + break; + } + // copy event to internal event list + if (pEvents->poolIsEmpty()) { + dmsg(1,("Event pool emtpy!\n")); + break; + } + *pEvents->allocAppend() = *pEvent; + } + eventQueueReader.free(); // free all copied events from input queue + } // 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,("Audio Thread: Note on received\n")); - ProcessNoteOn(pEvent); - break; - case Event::type_note_off: - dmsg(5,("Audio Thread: Note off received\n")); - ProcessNoteOff(pEvent); - break; - case Event::type_control_change: - dmsg(5,("Audio Thread: MIDI CC received\n")); - ProcessControlChange(pEvent); - break; - case Event::type_pitchbend: - dmsg(5,("Audio Thread: Pitchbend received\n")); - ProcessPitchbend(pEvent); - break; + { + RTList::Iterator itEvent = pEvents->first(); + RTList::Iterator end = pEvents->end(); + for (; itEvent != end; ++itEvent) { + switch (itEvent->Type) { + case Event::type_note_on: + dmsg(5,("Engine: Note on received\n")); + ProcessNoteOn(itEvent); + break; + case Event::type_note_off: + dmsg(5,("Engine: Note off received\n")); + ProcessNoteOff(itEvent); + break; + case Event::type_control_change: + dmsg(5,("Engine: MIDI CC received\n")); + ProcessControlChange(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); + break; + } } } - // 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 render current voice - pVoice->Render(Samples); - if (pVoice->IsActive()) active_voices++; // still active - else { // voice reached end, is now inactive - KillVoice(pVoice); // remove voice from the list of active voices + + // render audio from all active voices + { + RTList::Iterator iuiKey = pActiveKeys->first(); + RTList::Iterator end = pActiveKeys->end(); + while (iuiKey != end) { // iterate through all active keys + midi_key_info_t* pKey = &pMIDIKeyInfo[*iuiKey]; + ++iuiKey; + + RTList::Iterator itVoice = pKey->pActiveVoices->first(); + RTList::Iterator itVoicesEnd = pKey->pActiveVoices->end(); + for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key + // now render current voice + itVoice->Render(Samples); + if (itVoice->IsActive()) active_voices++; // still active + else { // voice reached end, is now inactive + FreeVoice(itVoice); // remove voice from the list of active voices + } + } + } + } + + + // 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); + if (itNewVoice) { + for (; itNewVoice; itNewVoice = itNewVoice->itChildVoice) { + itNewVoice->Render(Samples); + if (itNewVoice->IsActive()) active_voices++; // still active + else { // voice reached end, is now inactive + FreeVoice(itNewVoice); // remove voice from the list of active voices + } + } } + 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(); + + + // free all keys which have no active voices left + { + RTList::Iterator iuiKey = pActiveKeys->first(); + RTList::Iterator end = pActiveKeys->end(); + while (iuiKey != end) { // iterate through all active keys + midi_key_info_t* pKey = &pMIDIKeyInfo[*iuiKey]; + ++iuiKey; + if (pKey->pActiveVoices->isEmpty()) FreeKey(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 } - pKey->pEvents->clear(); // free all events on the key } @@ -422,10 +596,10 @@ * @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.Key = Key; - event.Velocity = 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!")); } @@ -438,10 +612,10 @@ * @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.Key = Key; - event.Velocity = 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!")); } @@ -453,9 +627,9 @@ * @param Pitch - MIDI pitch value (-8192 ... +8191) */ void Engine::SendPitchbend(int Pitch) { - Event event = pEventGenerator->CreateEvent(); - event.Type = Event::type_pitchbend; - event.Pitch = 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!")); } @@ -468,45 +642,78 @@ * @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.Controller = Controller; - event.Value = 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!")); } /** + * Will be called by the MIDI input device whenever a MIDI system + * exclusive message has arrived. + * + * @param pData - pointer to sysex data + * @param Size - lenght of sysex data (in bytes) + */ + void Engine::SendSysex(void* pData, uint Size) { + Event event = pEventGenerator->CreateEvent(); + event.Type = Event::type_sysex; + event.Param.Sysex.Size = Size; + if (pEventQueue->write_space() > 0) { + if (pSysexBuffer->write_space() >= Size) { + // copy sysex data to input buffer + uint toWrite = Size; + uint8_t* pPos = (uint8_t*) pData; + while (toWrite) { + const uint writeNow = RTMath::Min(toWrite, pSysexBuffer->write_space_to_end()); + pSysexBuffer->write(pPos, writeNow); + toWrite -= writeNow; + pPos += writeNow; + + } + // finally place sysex event into input event queue + pEventQueue->push(&event); + } + else dmsg(1,("Engine: Sysex message too large (%d byte) for input buffer (%d byte)!",Size,SYSEX_BUFFER_SIZE)); + } + else dmsg(1,("Engine: Input event queue full!")); + } + + /** * Assigns and triggers a new voice for the respective MIDI key. * - * @param pNoteOnEvent - key, velocity and time stamp of the event + * @param itNoteOnEvent - key, velocity and time stamp of the event */ - void Engine::ProcessNoteOn(Event* pNoteOnEvent) { - midi_key_info_t* pKey = &pMIDIKeyInfo[pNoteOnEvent->Key]; + void Engine::ProcessNoteOn(Pool::Iterator& itNoteOnEvent) { + + const int key = itNoteOnEvent->Param.Note.Key; + + // Change key dimension value if key is in keyswitching area + if (key >= pInstrument->DimensionKeyRange.low && key <= pInstrument->DimensionKeyRange.high) + CurrentKeyDimension = ((key - pInstrument->DimensionKeyRange.low) * 128) / + (pInstrument->DimensionKeyRange.high - pInstrument->DimensionKeyRange.low + 1); + + midi_key_info_t* pKey = &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) { - pNoteOnEvent->Type = Event::type_cancel_release; // transform event type - pEvents->move(pNoteOnEvent, pKey->pEvents); // move event to the key's own event list - } - - // allocate a new voice for the key - Voice* pNewVoice = pKey->pActiveVoices->alloc(); - if (pNewVoice) { - // launch the new voice - if (pNewVoice->Trigger(pNoteOnEvent, this->Pitch, this->pInstrument) < 0) { - dmsg(1,("Triggering new voice failed!\n")); - pKey->pActiveVoices->free(pNewVoice); - } - else if (!pKey->Active) { // mark as active key - pKey->Active = true; - pKey->pSelf = pActiveKeys->alloc(); - *pKey->pSelf = pNoteOnEvent->Key; + 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")); } - else std::cerr << "No free voice!" << std::endl << std::flush; + + // move note on event to the key's own event list + RTList::Iterator itNoteOnEventOnKeyList = itNoteOnEvent.moveToEndOf(pKey->pEvents); + + // allocate and trigger a new voice for the key + LaunchVoice(itNoteOnEventOnKeyList, 0, false, true); } /** @@ -515,17 +722,25 @@ * 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 itNoteOffEvent - key, velocity and time stamp of the event */ - void Engine::ProcessNoteOff(Event* pNoteOffEvent) { - midi_key_info_t* pKey = &pMIDIKeyInfo[pNoteOffEvent->Key]; + void Engine::ProcessNoteOff(Pool::Iterator& itNoteOffEvent) { + midi_key_info_t* pKey = &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 - pEvents->move(pNoteOffEvent, pKey->pEvents); // move event to the key's own event list + itNoteOffEvent->Type = Event::type_release; // transform event type + } + + // move event to the key's own event list + RTList::Iterator itNoteOffEventOnKeyList = itNoteOffEvent.moveToEndOf(pKey->pEvents); + + // spawn release triggered voice(s) if needed + if (pKey->ReleaseTrigger) { + LaunchVoice(itNoteOffEventOnKeyList, 0, true, false); //FIXME: for the moment we don't perform voice stealing for release triggered samples + pKey->ReleaseTrigger = false; } } @@ -533,86 +748,263 @@ * 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 itPitchbendEvent - absolute pitch value and time stamp of the event */ - void Engine::ProcessPitchbend(Event* pPitchbendEvent) { - this->Pitch = pPitchbendEvent->Pitch; // store current pitch value - pEvents->move(pPitchbendEvent, pSynthesisEvents[Event::destination_vco]); + void Engine::ProcessPitchbend(Pool::Iterator& itPitchbendEvent) { + this->Pitch = itPitchbendEvent->Param.Pitch.Pitch; // store current pitch value + itPitchbendEvent.moveToEndOf(pSynthesisEvents[Event::destination_vco]); } /** - * 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. + * Allocates and triggers a new voice. This method will usually be + * called by the ProcessNoteOn() method and by the voices itself + * (e.g. to spawn further voices on the same key for layered sounds). * - * @param pVoice - points to the voice to be killed + * @param itNoteOnEvent - key, velocity and time stamp of the event + * @param iLayer - layer index for the new voice (optional - only + * in case of layered sounds of course) + * @param ReleaseTriggerVoice - if new voice is a release triggered voice + * (optional, default = false) + * @param VoiceStealing - if voice stealing should be performed + * when there is no free voice + * (optional, default = true) + * @returns pointer to new voice or NULL if there was no free voice or + * if the voice wasn't triggered (for example when no region is + * defined for the given key). */ - void Engine::KillVoice(Voice* pVoice) { - if (pVoice) { - if (pVoice->IsActive()) pVoice->Kill(); + Pool::Iterator Engine::LaunchVoice(Pool::Iterator& itNoteOnEvent, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing) { + midi_key_info_t* pKey = &pMIDIKeyInfo[itNoteOnEvent->Param.Note.Key]; - midi_key_info_t* pKey = &pMIDIKeyInfo[pVoice->MIDIKey]; + // allocate a new voice for the key + Pool::Iterator itNewVoice = pKey->pActiveVoices->allocAppend(); + if (itNewVoice) { + // launch the new voice + if (itNewVoice->Trigger(itNoteOnEvent, this->Pitch, this->pInstrument, iLayer, ReleaseTriggerVoice, VoiceStealing) < 0) { + dmsg(4,("Voice not triggered\n")); + pKey->pActiveVoices->free(itNewVoice); + } + else { // on success + uint** ppKeyGroup = NULL; + if (itNewVoice->KeyGroup) { // if this voice / key belongs to a key group + ppKeyGroup = &ActiveKeyGroups[itNewVoice->KeyGroup]; + if (*ppKeyGroup) { // if there's already an active key in that key group + midi_key_info_t* pOtherKey = &pMIDIKeyInfo[**ppKeyGroup]; + // kill all voices on the (other) key + RTList::Iterator itVoiceToBeKilled = pOtherKey->pActiveVoices->first(); + RTList::Iterator end = pOtherKey->pActiveVoices->end(); + for (; itVoiceToBeKilled != end; ++itVoiceToBeKilled) { + if (itVoiceToBeKilled->Type != Voice::type_release_trigger) itVoiceToBeKilled->Kill(itNoteOnEvent); + } + } + } + if (!pKey->Active) { // mark as active key + pKey->Active = true; + pKey->itSelf = 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 (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) { + // first, get total amount of required voices (dependant on amount of layers) + ::gig::Region* pRegion = pInstrument->GetRegion(itNoteOnEvent->Param.Note.Key); + if (!pRegion) return Pool::Iterator(); // nothing defined for this MIDI key, so no voice needed + int voicesRequired = pRegion->Layers; + + // now steal the (remaining) amount of voices + for (int i = iLayer; i < voicesRequired; i++) + StealVoice(itNoteOnEvent); + + // put note-on event into voice-stealing queue, so it will be reprocessed after killed voice died + RTList::Iterator itStealEvent = pVoiceStealingQueue->allocAppend(); + if (itStealEvent) { + *itStealEvent = *itNoteOnEvent; // copy event + itStealEvent->Param.Note.Layer = iLayer; + itStealEvent->Param.Note.ReleaseTrigger = ReleaseTriggerVoice; + } + else dmsg(1,("Voice stealing queue full!\n")); + } + + return Pool::Iterator(); // no free voice or error + } + + /** + * Will be called by LaunchVoice() method in case there are no free + * voices left. This method will select and kill one old voice for + * voice stealing and postpone the note-on event until the selected + * voice actually died. + * + * @param itNoteOnEvent - key, velocity and time stamp of the event + */ + void Engine::StealVoice(Pool::Iterator& itNoteOnEvent) { + if (!pEventPool->poolIsEmpty()) { + + RTList::Iterator iuiOldestKey; + RTList::Iterator itOldestVoice; + + // Select one voice for voice stealing + switch (VOICE_STEAL_ALGORITHM) { + + // 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 + // 'oldestkey' algorithm + case voice_steal_algo_keymask: { + midi_key_info_t* pOldestKey = &pMIDIKeyInfo[itNoteOnEvent->Param.Note.Key]; + if (itLastStolenVoice) { + itOldestVoice = itLastStolenVoice; + ++itOldestVoice; + } + else { // no voice stolen in this audio fragment cycle yet + itOldestVoice = pOldestKey->pActiveVoices->first(); + } + if (itOldestVoice) { + iuiOldestKey = pOldestKey->itSelf; + break; // selection succeeded + } + } // no break - intentional ! + + // 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; + ++itOldestVoice; + if (!itOldestVoice) { + iuiOldestKey = iuiLastStolenKey; + ++iuiOldestKey; + if (iuiOldestKey) { + midi_key_info_t* pOldestKey = &pMIDIKeyInfo[*iuiOldestKey]; + itOldestVoice = pOldestKey->pActiveVoices->first(); + } + else { + dmsg(1,("gig::Engine: Warning, too less voices, even for voice stealing! - Better recompile with higher MAX_AUDIO_VOICES.\n")); + return; + } + } + else iuiOldestKey = iuiLastStolenKey; + } + else { // no voice stolen in this audio fragment cycle yet + iuiOldestKey = pActiveKeys->first(); + midi_key_info_t* pOldestKey = &pMIDIKeyInfo[*iuiOldestKey]; + itOldestVoice = pOldestKey->pActiveVoices->first(); + } + break; + } + + // don't steal anything + case voice_steal_algo_none: + default: { + dmsg(1,("No free voice (voice stealing disabled)!\n")); + return; + } + } + + //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; + } + else dmsg(1,("Event pool emtpy!\n")); + } + + /** + * 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 freed + */ + void Engine::FreeVoice(Pool::Iterator& itVoice) { + if (itVoice) { + midi_key_info_t* pKey = &pMIDIKeyInfo[itVoice->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()) { - pKey->Active = false; - pActiveKeys->free(pKey->pSelf); // remove key from list of active keys - pKey->pSelf = NULL; - 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 = &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 pKey - key which is now inactive + */ + void Engine::FreeKey(midi_key_info_t* pKey) { + if (pKey->pActiveVoices->isEmpty()) { + 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")); + } + 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 itControlChangeEvent - controller, value and time stamp of the event */ - void Engine::ProcessControlChange(Event* pControlChangeEvent) { - dmsg(4,("Engine::ContinuousController cc=%d v=%d\n", pControlChangeEvent->Controller, pControlChangeEvent->Value)); + void Engine::ProcessControlChange(Pool::Iterator& itControlChangeEvent) { + dmsg(4,("Engine::ContinuousController cc=%d v=%d\n", itControlChangeEvent->Param.CC.Controller, itControlChangeEvent->Param.CC.Value)); - switch (pControlChangeEvent->Controller) { + switch (itControlChangeEvent->Param.CC.Controller) { case 64: { - if (pControlChangeEvent->Value >= 64 && !SustainPedal) { + if (itControlChangeEvent->Param.CC.Value >= 64 && !SustainPedal) { dmsg(4,("PEDAL DOWN\n")); 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(); + RTList::Iterator iuiKey = pActiveKeys->first(); + if (iuiKey) { + itControlChangeEvent->Type = Event::type_cancel_release; // transform event type + while (iuiKey) { + midi_key_info_t* pKey = &pMIDIKeyInfo[*iuiKey]; + ++iuiKey; if (!pKey->KeyPressed) { - Event* pNewEvent = pKey->pEvents->alloc(); - if (pNewEvent) *pNewEvent = *pControlChangeEvent; // copy event to the key's own event list + RTList::Iterator itNewEvent = pKey->pEvents->allocAppend(); + if (itNewEvent) *itNewEvent = *itControlChangeEvent; // copy event to the key's own event list else dmsg(1,("Event pool emtpy!\n")); } } } } - if (pControlChangeEvent->Value < 64 && SustainPedal) { + if (itControlChangeEvent->Param.CC.Value < 64 && SustainPedal) { dmsg(4,("PEDAL UP\n")); 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(); + RTList::Iterator iuiKey = pActiveKeys->first(); + if (iuiKey) { + itControlChangeEvent->Type = Event::type_release; // transform event type + while (iuiKey) { + midi_key_info_t* pKey = &pMIDIKeyInfo[*iuiKey]; + ++iuiKey; if (!pKey->KeyPressed) { - Event* pNewEvent = pKey->pEvents->alloc(); - if (pNewEvent) *pNewEvent = *pControlChangeEvent; // copy event to the key's own event list + RTList::Iterator itNewEvent = pKey->pEvents->allocAppend(); + if (itNewEvent) *itNewEvent = *itControlChangeEvent; // copy event to the key's own event list else dmsg(1,("Event pool emtpy!\n")); } } @@ -623,10 +1015,93 @@ } // update controller value in the engine's controller table - ControllerTable[pControlChangeEvent->Controller] = pControlChangeEvent->Value; + ControllerTable[itControlChangeEvent->Param.CC.Controller] = itControlChangeEvent->Param.CC.Value; // move event from the unsorted event list to the control change event list - pEvents->move(pControlChangeEvent, pCCEvents); + itControlChangeEvent.moveToEndOf(pCCEvents); + } + + /** + * Reacts on MIDI system exclusive messages. + * + * @param itSysexEvent - sysex data size and time stamp of the sysex event + */ + void Engine::ProcessSysex(Pool::Iterator& itSysexEvent) { + RingBuffer::NonVolatileReader reader = pSysexBuffer->get_non_volatile_reader(); + + uint8_t exclusive_status, id; + if (!reader.pop(&exclusive_status)) goto free_sysex_data; + if (!reader.pop(&id)) goto free_sysex_data; + if (exclusive_status != 0xF0) goto free_sysex_data; + + switch (id) { + case 0x41: { // Roland + uint8_t device_id, model_id, cmd_id; + if (!reader.pop(&device_id)) goto free_sysex_data; + if (!reader.pop(&model_id)) goto free_sysex_data; + if (!reader.pop(&cmd_id)) goto free_sysex_data; + if (model_id != 0x42 /*GS*/) goto free_sysex_data; + if (cmd_id != 0x12 /*DT1*/) goto free_sysex_data; + + // command address + uint8_t addr[3]; // 2 byte addr MSB, followed by 1 byte addr LSB) + const RingBuffer::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 + } + else if (addr[0] == 0x40 && addr[1] == 0x01) { // Common Parameters + } + else if (addr[0] == 0x40 && (addr[1] & 0xf0) == 0x10) { // Part Parameters (1) + switch (addr[3]) { + case 0x40: { // scale tuning + 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; + for (int i = 0; i < 12; i++) scale_tunes[i] -= 64; + AdjustScale((int8_t*) scale_tunes); + break; + } + } + } + else if (addr[0] == 0x40 && (addr[1] & 0xf0) == 0x20) { // Part Parameters (2) + } + else if (addr[0] == 0x41) { // Drum Setup Parameters + } + break; + } + } + + free_sysex_data: // finally free sysex data + pSysexBuffer->increment_read_ptr(itSysexEvent->Param.Sysex.Size); + } + + /** + * Calculates the Roland GS sysex check sum. + * + * @param AddrReader - reader which currently points to the first GS + * command address byte of the GS sysex message in + * question + * @param DataSize - size of the GS message data (in bytes) + */ + uint8_t Engine::GSCheckSum(const RingBuffer::NonVolatileReader AddrReader, uint DataSize) { + RingBuffer::NonVolatileReader reader = AddrReader; + uint bytes = 3 /*addr*/ + DataSize; + uint8_t addr_and_data[bytes]; + reader.read(&addr_and_data[0], bytes); + uint8_t sum = 0; + for (uint i = 0; i < bytes; i++) sum += addr_and_data[i]; + return 128 - sum % 128; + } + + /** + * Allows to tune each of the twelve semitones of an octave. + * + * @param ScaleTunes - detuning of all twelve semitones (in cents) + */ + void Engine::AdjustScale(int8_t ScaleTunes[12]) { + memcpy(&this->ScaleTuning[0], &ScaleTunes[0], 12); //TODO: currently not sample accurate } /** @@ -635,7 +1110,13 @@ */ void Engine::ResetSynthesisParameters(Event::destination_t dst, float val) { int maxsamples = pAudioOutputDevice->MaxSamplesPerCycle(); - for (int i = 0; i < maxsamples; i++) pSynthesisParameters[dst][i] = val; + float* m = &pSynthesisParameters[dst][0]; + for (int i = 0; i < maxsamples; i += 4) { + m[i] = val; + m[i+1] = val; + m[i+2] = val; + m[i+3] = val; + } } float Engine::Volume() { @@ -646,6 +1127,38 @@ 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; } @@ -674,12 +1187,33 @@ return pDiskThread->GetBufferFillPercentage(); } + String Engine::EngineName() { + return "GigEngine"; + } + + String Engine::InstrumentFileName() { + return InstrumentFile; + } + + String Engine::InstrumentName() { + return InstrumentIdxName; + } + + int Engine::InstrumentIndex() { + return InstrumentIdx; + } + + int Engine::InstrumentStatus() { + return InstrumentStat; + } + String Engine::Description() { return "Gigasampler Engine"; } String Engine::Version() { - return "0.0.1-0cvs20040423"; + String s = "$Revision: 1.25 $"; + return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword } }} // namespace LinuxSampler::gig