--- linuxsampler/trunk/src/engines/gig/Engine.cpp 2005/06/06 16:54:20 614 +++ linuxsampler/trunk/src/engines/gig/Engine.cpp 2005/06/21 13:33:19 669 @@ -119,6 +119,7 @@ pMainFilterParameters = NULL; ResetInternal(); + ResetScaleTuning(); } /** @@ -171,6 +172,7 @@ void Engine::Reset() { DisableAndLock(); ResetInternal(); + ResetScaleTuning(); Enable(); } @@ -184,12 +186,11 @@ // reset voice stealing parameters pVoiceStealingQueue->clear(); - itLastStolenVoice = RTList::Iterator(); - iuiLastStolenKey = RTList::Iterator(); - pLastStolenChannel = NULL; - - // reset to normal chromatic scale (means equal temper) - memset(&ScaleTuning[0], 0x00, 12); + itLastStolenVoice = RTList::Iterator(); + itLastStolenVoiceGlobally = RTList::Iterator(); + iuiLastStolenKey = RTList::Iterator(); + iuiLastStolenKeyGlobally = RTList::Iterator(); + pLastStolenChannel = NULL; // reset all voices for (RTList::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) { @@ -205,6 +206,13 @@ } /** + * Reset to normal, chromatic scale (means equal tempered). + */ + void Engine::ResetScaleTuning() { + memset(&ScaleTuning[0], 0x00, 12); + } + + /** * 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 @@ -352,6 +360,11 @@ // update time of start and end of this audio fragment (as events' time stamps relate to this) pEventGenerator->UpdateFragmentTime(Samples); + // We only allow a maximum of CONFIG_MAX_VOICES voices to be spawned + // in each audio fragment. All subsequent request for spawning new + // voices in the same audio fragment will be ignored. + VoiceSpawnsLeft = CONFIG_MAX_VOICES; + // get all events from the engine's global input event queue which belong to the current fragment // (these are usually just SysEx messages) ImportEvents(Samples); @@ -370,15 +383,9 @@ } } - // 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; - // reset internal voice counter (just for statistic of active voices) ActiveVoiceCountTemp = 0; - // handle events on all engine channels for (int i = 0; i < engineChannels.size(); i++) { if (!engineChannels[i]->pInstrument) continue; // ignore if no instrument loaded @@ -406,14 +413,13 @@ // reset voice stealing for the next audio fragment pVoiceStealingQueue->clear(); - itLastStolenVoice = RTList::Iterator(); - iuiLastStolenKey = RTList::Iterator(); - pLastStolenChannel = NULL; // just some statistics about this engine instance ActiveVoiceCount = ActiveVoiceCountTemp; if (ActiveVoiceCount > ActiveVoiceCountMax) ActiveVoiceCountMax = ActiveVoiceCount; + FrameTime += Samples; + return 0; } @@ -456,6 +462,13 @@ } } } + + // 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; } /** @@ -506,7 +519,7 @@ for (; itVoiceStealEvent != end; ++itVoiceStealEvent) { EngineChannel* pEngineChannel = (EngineChannel*) itVoiceStealEvent->pEngineChannel; Pool::Iterator itNewVoice = - LaunchVoice(pEngineChannel, itVoiceStealEvent, itVoiceStealEvent->Param.Note.Layer, itVoiceStealEvent->Param.Note.ReleaseTrigger, false); + LaunchVoice(pEngineChannel, itVoiceStealEvent, itVoiceStealEvent->Param.Note.Layer, itVoiceStealEvent->Param.Note.ReleaseTrigger, false, false); if (itNewVoice) { itNewVoice->Render(Samples); if (itNewVoice->IsActive()) ActiveVoiceCountTemp++; // still active @@ -610,6 +623,8 @@ 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 && !pEngineChannel->SustainPedal) { @@ -632,7 +647,7 @@ int voicesRequired = pRegion->Layers; // now launch the required amount of voices for (int i = 0; i < voicesRequired; i++) - LaunchVoice(pEngineChannel, itNoteOnEventOnKeyList, i, false, true); + LaunchVoice(pEngineChannel, itNoteOnEventOnKeyList, i, false, true, true); } } @@ -665,14 +680,18 @@ RTList::Iterator itNoteOffEventOnKeyList = itNoteOffEvent.moveToEndOf(pKey->pEvents); // spawn release triggered voice(s) if needed - if (pKey->ReleaseTrigger && itNoteOffEventOnKeyList->Param.Note.Velocity) { + 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 + LaunchVoice(pEngineChannel, itNoteOffEventOnKeyList, i, true, false, false); //FIXME: for the moment we don't perform voice stealing for release triggered samples } pKey->ReleaseTrigger = false; } @@ -709,41 +728,175 @@ * @param VoiceStealing - if voice stealing should be performed * when there is no free voice * (optional, default = true) + * @param HandleKeyGroupConflicts - if voices should be killed due to a + * key group conflict * @returns pointer to new voice or NULL if there was no free voice or * if the voice wasn't triggered (for example when no region is * defined for the given key). */ - Pool::Iterator Engine::LaunchVoice(EngineChannel* pEngineChannel, Pool::Iterator& itNoteOnEvent, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing) { - midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[itNoteOnEvent->Param.Note.Key]; + Pool::Iterator Engine::LaunchVoice(EngineChannel* pEngineChannel, Pool::Iterator& itNoteOnEvent, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing, bool HandleKeyGroupConflicts) { + int MIDIKey = itNoteOnEvent->Param.Note.Key; + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[MIDIKey]; + ::gig::Region* pRegion = pEngineChannel->pInstrument->GetRegion(MIDIKey); + + // if nothing defined for this key + if (!pRegion) return Pool::Iterator(); // nothing to do + + // only mark the first voice of a layered voice (group) to be in a + // key group, so the layered voices won't kill each other + int iKeyGroup = (iLayer == 0 && !ReleaseTriggerVoice) ? pRegion->KeyGroup : 0; + + // handle key group (a.k.a. exclusive group) conflicts + if (HandleKeyGroupConflicts) { + if (iKeyGroup) { // if this voice / key belongs to a key group + uint** ppKeyGroup = &pEngineChannel->ActiveKeyGroups[iKeyGroup]; + if (*ppKeyGroup) { // if there's already an active key in that key group + midi_key_info_t* pOtherKey = &pEngineChannel->pMIDIKeyInfo[**ppKeyGroup]; + // kill all voices on the (other) key + RTList::Iterator itVoiceToBeKilled = pOtherKey->pActiveVoices->first(); + RTList::Iterator end = pOtherKey->pActiveVoices->end(); + for (; itVoiceToBeKilled != end; ++itVoiceToBeKilled) { + if (itVoiceToBeKilled->Type != Voice::type_release_trigger) { + itVoiceToBeKilled->Kill(itNoteOnEvent); + --VoiceSpawnsLeft; //FIXME: just a hack, we should better check in StealVoice() if the voice was killed due to key conflict + } + } + } + } + } + + Voice::type_t VoiceType = Voice::type_normal; + + // get current dimension values to select the right dimension region + //TODO: for stolen voices this dimension region selection block is processed twice, this should be changed + //FIXME: controller values for selecting the dimension region here are currently not sample accurate + uint DimValues[8] = { 0 }; + for (int i = pRegion->Dimensions - 1; i >= 0; i--) { + switch (pRegion->pDimensionDefinitions[i].dimension) { + case ::gig::dimension_samplechannel: + DimValues[i] = 0; //TODO: we currently ignore this dimension + break; + case ::gig::dimension_layer: + DimValues[i] = iLayer; + break; + case ::gig::dimension_velocity: + DimValues[i] = itNoteOnEvent->Param.Note.Velocity; + break; + case ::gig::dimension_channelaftertouch: + DimValues[i] = 0; //TODO: we currently ignore this dimension + break; + case ::gig::dimension_releasetrigger: + VoiceType = (ReleaseTriggerVoice) ? Voice::type_release_trigger : (!iLayer) ? Voice::type_release_trigger_required : Voice::type_normal; + DimValues[i] = (uint) ReleaseTriggerVoice; + break; + case ::gig::dimension_keyboard: + DimValues[i] = (uint) pEngineChannel->CurrentKeyDimension; + break; + case ::gig::dimension_roundrobin: + DimValues[i] = (uint) pEngineChannel->pMIDIKeyInfo[MIDIKey].RoundRobinIndex; // incremented for each note on + break; + case ::gig::dimension_random: + RandomSeed = RandomSeed * 1103515245 + 12345; // classic pseudo random number generator + DimValues[i] = (uint) RandomSeed >> (32 - pRegion->pDimensionDefinitions[i].bits); // highest bits are most random + break; + case ::gig::dimension_modwheel: + DimValues[i] = pEngineChannel->ControllerTable[1]; + break; + case ::gig::dimension_breath: + DimValues[i] = pEngineChannel->ControllerTable[2]; + break; + case ::gig::dimension_foot: + DimValues[i] = pEngineChannel->ControllerTable[4]; + break; + case ::gig::dimension_portamentotime: + DimValues[i] = pEngineChannel->ControllerTable[5]; + break; + case ::gig::dimension_effect1: + DimValues[i] = pEngineChannel->ControllerTable[12]; + break; + case ::gig::dimension_effect2: + DimValues[i] = pEngineChannel->ControllerTable[13]; + break; + case ::gig::dimension_genpurpose1: + DimValues[i] = pEngineChannel->ControllerTable[16]; + break; + case ::gig::dimension_genpurpose2: + DimValues[i] = pEngineChannel->ControllerTable[17]; + break; + case ::gig::dimension_genpurpose3: + DimValues[i] = pEngineChannel->ControllerTable[18]; + break; + case ::gig::dimension_genpurpose4: + DimValues[i] = pEngineChannel->ControllerTable[19]; + break; + case ::gig::dimension_sustainpedal: + DimValues[i] = pEngineChannel->ControllerTable[64]; + break; + case ::gig::dimension_portamento: + DimValues[i] = pEngineChannel->ControllerTable[65]; + break; + case ::gig::dimension_sostenutopedal: + DimValues[i] = pEngineChannel->ControllerTable[66]; + break; + case ::gig::dimension_softpedal: + DimValues[i] = pEngineChannel->ControllerTable[67]; + break; + case ::gig::dimension_genpurpose5: + DimValues[i] = pEngineChannel->ControllerTable[80]; + break; + case ::gig::dimension_genpurpose6: + DimValues[i] = pEngineChannel->ControllerTable[81]; + break; + case ::gig::dimension_genpurpose7: + DimValues[i] = pEngineChannel->ControllerTable[82]; + break; + case ::gig::dimension_genpurpose8: + DimValues[i] = pEngineChannel->ControllerTable[83]; + break; + case ::gig::dimension_effect1depth: + DimValues[i] = pEngineChannel->ControllerTable[91]; + break; + case ::gig::dimension_effect2depth: + DimValues[i] = pEngineChannel->ControllerTable[92]; + break; + case ::gig::dimension_effect3depth: + DimValues[i] = pEngineChannel->ControllerTable[93]; + break; + case ::gig::dimension_effect4depth: + DimValues[i] = pEngineChannel->ControllerTable[94]; + break; + case ::gig::dimension_effect5depth: + DimValues[i] = pEngineChannel->ControllerTable[95]; + break; + case ::gig::dimension_none: + std::cerr << "gig::Engine::LaunchVoice() Error: dimension=none\n" << std::flush; + break; + default: + std::cerr << "gig::Engine::LaunchVoice() Error: Unknown dimension\n" << std::flush; + } + } + ::gig::DimensionRegion* pDimRgn = pRegion->GetDimensionRegionByValue(DimValues); + + // no need to continue if sample is silent + if (!pDimRgn->pSample || !pDimRgn->pSample->SamplesTotal) return Pool::Iterator(); // allocate a new voice for the key Pool::Iterator itNewVoice = pKey->pActiveVoices->allocAppend(); if (itNewVoice) { // launch the new voice - if (itNewVoice->Trigger(pEngineChannel, itNoteOnEvent, pEngineChannel->Pitch, pEngineChannel->pInstrument, iLayer, ReleaseTriggerVoice, VoiceStealing) < 0) { + if (itNewVoice->Trigger(pEngineChannel, itNoteOnEvent, pEngineChannel->Pitch, pDimRgn, VoiceType, iKeyGroup) < 0) { dmsg(4,("Voice not triggered\n")); pKey->pActiveVoices->free(itNewVoice); } else { // on success - uint** ppKeyGroup = NULL; - if (itNewVoice->KeyGroup) { // if this voice / key belongs to a key group - ppKeyGroup = &pEngineChannel->ActiveKeyGroups[itNewVoice->KeyGroup]; - if (*ppKeyGroup) { // if there's already an active key in that key group - midi_key_info_t* pOtherKey = &pEngineChannel->pMIDIKeyInfo[**ppKeyGroup]; - // kill all voices on the (other) key - RTList::Iterator itVoiceToBeKilled = pOtherKey->pActiveVoices->first(); - RTList::Iterator end = pOtherKey->pActiveVoices->end(); - for (; itVoiceToBeKilled != end; ++itVoiceToBeKilled) { - if (itVoiceToBeKilled->Type != Voice::type_release_trigger) itVoiceToBeKilled->Kill(itNoteOnEvent); - } - } - } + --VoiceSpawnsLeft; if (!pKey->Active) { // mark as active key pKey->Active = true; pKey->itSelf = pEngineChannel->pActiveKeys->allocAppend(); *pKey->itSelf = itNoteOnEvent->Param.Note.Key; } if (itNewVoice->KeyGroup) { + uint** ppKeyGroup = &pEngineChannel->ActiveKeyGroups[itNewVoice->KeyGroup]; *ppKeyGroup = &*pKey->itSelf; // put key as the (new) active key to its key group } if (itNewVoice->Type == Voice::type_release_trigger_required) pKey->ReleaseTrigger = true; // mark key for the need of release triggered voice(s) @@ -780,7 +933,7 @@ * @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) { + if (VoiceSpawnsLeft <= 0) { dmsg(1,("Max. voice thefts per audio fragment reached (you may raise CONFIG_MAX_VOICES).\n")); return -1; } @@ -799,28 +952,44 @@ 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; + while (itSelectedVoice && !itSelectedVoice->IsStealable()) ++itSelectedVoice; // if we haven't found a voice then proceed with algorithm 'oldestkey' - if (itSelectedVoice && itSelectedVoice->hasRendered()) break; + if (itSelectedVoice && itSelectedVoice->IsStealable()) break; } // no break - intentional ! // try to pick the oldest voice on the oldest active key // from the same engine channel // (caution: must stay after 'oldestvoiceonkey' algorithm !) case voice_steal_algo_oldestkey: { + // if we already stole in this fragment, try to proceed on same key if (this->itLastStolenVoice) { itSelectedVoice = this->itLastStolenVoice; - ++itSelectedVoice; - if (itSelectedVoice) break; // selection succeeded - RTList::Iterator iuiSelectedKey = this->iuiLastStolenKey; - ++iuiSelectedKey; - if (iuiSelectedKey) { - this->iuiLastStolenKey = iuiSelectedKey; - midi_key_info_t* pSelectedKey = &pEngineChannel->pMIDIKeyInfo[*iuiSelectedKey]; - itSelectedVoice = pSelectedKey->pActiveVoices->first(); + do { + ++itSelectedVoice; + } while (itSelectedVoice && !itSelectedVoice->IsStealable()); // proceed iterating if voice was created in this fragment cycle + // found a "stealable" voice ? + if (itSelectedVoice && itSelectedVoice->IsStealable()) { + // remember which voice we stole, so we can simply proceed on next voice stealing + this->itLastStolenVoice = itSelectedVoice; break; // selection succeeded } } + // get (next) oldest key + RTList::Iterator iuiSelectedKey = (this->iuiLastStolenKey) ? ++this->iuiLastStolenKey : pEngineChannel->pActiveKeys->first(); + while (iuiSelectedKey) { + midi_key_info_t* pSelectedKey = &pEngineChannel->pMIDIKeyInfo[*iuiSelectedKey]; + itSelectedVoice = pSelectedKey->pActiveVoices->first(); + // proceed iterating if voice was created in this fragment cycle + while (itSelectedVoice && !itSelectedVoice->IsStealable()) ++itSelectedVoice; + // found a "stealable" voice ? + if (itSelectedVoice && itSelectedVoice->IsStealable()) { + // remember which voice on which key we stole, so we can simply proceed on next voice stealing + this->iuiLastStolenKey = iuiSelectedKey; + this->itLastStolenVoice = itSelectedVoice; + break; // selection succeeded + } + ++iuiSelectedKey; // get next oldest key + } break; } @@ -834,23 +1003,72 @@ // 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 - if (!itSelectedVoice) { - EngineChannel* pSelectedChannel = (pLastStolenChannel) ? pLastStolenChannel : pEngineChannel; - int iChannelIndex = pSelectedChannel->iEngineIndexSelf; - while (true) { - RTList::Iterator iuiSelectedKey = pSelectedChannel->pActiveKeys->first(); - if (iuiSelectedKey) { + // (the smaller engine channel number, the higher priority) + if (!itSelectedVoice || !itSelectedVoice->IsStealable()) { + EngineChannel* pSelectedChannel; + int iChannelIndex; + // select engine channel + if (pLastStolenChannel) { + pSelectedChannel = pLastStolenChannel; + iChannelIndex = pSelectedChannel->iEngineIndexSelf; + } else { // pick the engine channel followed by this engine channel + iChannelIndex = (pEngineChannel->iEngineIndexSelf + 1) % engineChannels.size(); + pSelectedChannel = engineChannels[iChannelIndex]; + } + + // if we already stole in this fragment, try to proceed on same key + if (this->itLastStolenVoiceGlobally) { + itSelectedVoice = this->itLastStolenVoiceGlobally; + do { + ++itSelectedVoice; + } while (itSelectedVoice && !itSelectedVoice->IsStealable()); // proceed iterating if voice was created in this fragment cycle + } + + #if CONFIG_DEVMODE + EngineChannel* pBegin = pSelectedChannel; // to detect endless loop + #endif // CONFIG_DEVMODE + + // did we find a 'stealable' voice? + if (itSelectedVoice && itSelectedVoice->IsStealable()) { + // remember which voice we stole, so we can simply proceed on next voice stealing + this->itLastStolenVoiceGlobally = itSelectedVoice; + } else while (true) { // iterate through engine channels + // get (next) oldest key + RTList::Iterator iuiSelectedKey = (this->iuiLastStolenKeyGlobally) ? ++this->iuiLastStolenKeyGlobally : pSelectedChannel->pActiveKeys->first(); + this->iuiLastStolenKeyGlobally = RTList::Iterator(); // to prevent endless loop (see line above) + while (iuiSelectedKey) { midi_key_info_t* pSelectedKey = &pSelectedChannel->pMIDIKeyInfo[*iuiSelectedKey]; - itSelectedVoice = pSelectedKey->pActiveVoices->first(); - iuiLastStolenKey = iuiSelectedKey; - pLastStolenChannel = pSelectedChannel; - break; // selection succeeded + itSelectedVoice = pSelectedKey->pActiveVoices->first(); + // proceed iterating if voice was created in this fragment cycle + while (itSelectedVoice && !itSelectedVoice->IsStealable()) ++itSelectedVoice; + // found a "stealable" voice ? + if (itSelectedVoice && itSelectedVoice->IsStealable()) { + // remember which voice on which key on which engine channel we stole, so we can simply proceed on next voice stealing + this->iuiLastStolenKeyGlobally = iuiSelectedKey; + this->itLastStolenVoiceGlobally = itSelectedVoice; + this->pLastStolenChannel = pSelectedChannel; + goto stealable_voice_found; // selection succeeded + } + ++iuiSelectedKey; // get next key on current engine channel } + // get next engine channel iChannelIndex = (iChannelIndex + 1) % engineChannels.size(); - pSelectedChannel = engineChannels[iChannelIndex]; + pSelectedChannel = engineChannels[iChannelIndex]; + + #if CONFIG_DEVMODE + if (pSelectedChannel == pBegin) { + dmsg(1,("FATAL ERROR: voice stealing endless loop!\n")); + dmsg(1,("VoiceSpawnsLeft=%d.\n", VoiceSpawnsLeft)); + dmsg(1,("Exiting.\n")); + exit(-1); + } + #endif // CONFIG_DEVMODE } } + // jump point if a 'stealable' voice was found + stealable_voice_found: + #if CONFIG_DEVMODE if (!itSelectedVoice->IsActive()) { dmsg(1,("gig::Engine: ERROR, tried to steal a voice which was not active !!!\n")); @@ -861,10 +1079,7 @@ // now kill the selected voice itSelectedVoice->Kill(itNoteOnEvent); - // remember which voice we stole, so we can simply proceed for the next voice stealing - itLastStolenVoice = itSelectedVoice; - - --VoiceTheftsLeft; + --VoiceSpawnsLeft; return 0; // success } @@ -940,6 +1155,7 @@ case 7: { // volume //TODO: not sample accurate yet pEngineChannel->GlobalVolume = (float) itControlChangeEventOnCCList->Param.CC.Value / 127.0f; + pEngineChannel->bStatusChanged = true; // engine channel status has changed, so set notify flag break; } case 10: { // panpot @@ -1139,6 +1355,7 @@ RTList::Iterator itVoicesEnd = pKey->pActiveVoices->end(); for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key itVoice->Kill(itKillEvent); + --VoiceSpawnsLeft; //FIXME: just a temporary workaround, we should check the cause in StealVoice() instead } } } @@ -1195,7 +1412,7 @@ } String Engine::Version() { - String s = "$Revision: 1.39 $"; + String s = "$Revision: 1.47 $"; return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword }