--- linuxsampler/trunk/src/engines/gig/Engine.cpp 2006/12/27 16:17:08 1001 +++ linuxsampler/trunk/src/engines/gig/Engine.cpp 2009/02/21 17:08:18 1843 @@ -2,8 +2,8 @@ * * * LinuxSampler - modular, streaming capable sampler * * * - * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck * - * Copyright (C) 2005, 2006 Christian Schoenebeck * + * Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck * + * Copyright (C) 2005-2008 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 * @@ -29,6 +29,8 @@ #include "Engine.h" +#include "../../common/global_private.h" + namespace LinuxSampler { namespace gig { InstrumentResourceManager Engine::instruments; @@ -51,6 +53,11 @@ if (engines.count(pDevice)) { dmsg(4,("Using existing gig::Engine.\n")); pEngine = engines[pDevice]; + + // Disable the engine while the new engine channel is + // added and initialized. The engine will be enabled again + // in EngineChannel::Connect. + pEngine->DisableAndLock(); } 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"); @@ -67,7 +74,7 @@ /** * Once an engine channel is disconnected from an audio output device, - * it wil immediately call this method to unregister itself from the + * it will 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. * @@ -93,16 +100,20 @@ /** * Constructor */ - Engine::Engine() { + Engine::Engine() : SuspendedRegions(128) { pAudioOutputDevice = NULL; pDiskThread = NULL; pEventGenerator = NULL; pSysexBuffer = new RingBuffer(CONFIG_SYSEX_BUFFER_SIZE, 0); pEventQueue = new RingBuffer(CONFIG_MAX_EVENTS_PER_FRAGMENT, 0); pEventPool = new Pool(CONFIG_MAX_EVENTS_PER_FRAGMENT); - pVoicePool = new Pool(CONFIG_MAX_VOICES); + pVoicePool = new Pool(GLOBAL_MAX_VOICES); + pDimRegionPool[0] = new Pool< ::gig::DimensionRegion*>(GLOBAL_MAX_VOICES); + pDimRegionPool[1] = new Pool< ::gig::DimensionRegion*>(GLOBAL_MAX_VOICES); pVoiceStealingQueue = new RTList(pEventPool); pGlobalEvents = new RTList(pEventPool); + iMaxDiskStreams = GLOBAL_MAX_STREAMS; + for (RTList::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) { iterVoice->SetEngine(this); } @@ -110,6 +121,7 @@ ResetInternal(); ResetScaleTuning(); + ResetSuspendedRegions(); } /** @@ -132,7 +144,11 @@ if (pEventGenerator) delete pEventGenerator; if (pVoiceStealingQueue) delete pVoiceStealingQueue; if (pSysexBuffer) delete pSysexBuffer; - EngineFactory::Destroy(this); + if (pGlobalEvents) delete pGlobalEvents; + if (pDimRegionPool[0]) delete pDimRegionPool[0]; + if (pDimRegionPool[1]) delete pDimRegionPool[1]; + ResetSuspendedRegions(); + Unregister(); } void Engine::Enable() { @@ -141,6 +157,18 @@ dmsg(3,("gig::Engine: enabled (val=%d)\n", EngineDisabled.GetUnsafe())); } + /** + * Temporarily stop the engine to not do anything. The engine will just be + * frozen during that time, that means after enabling it again it will + * continue where it was, with all its voices and playback state it had at + * the point of disabling. Notice that the engine's (audio) thread will + * continue to run, it just remains in an inactive loop during that time. + * + * If you need to be sure that all voices and disk streams are killed as + * well, use @c SuspendAll() instead. + * + * @see Enable(), SuspendAll() + */ void Engine::Disable() { dmsg(3,("gig::Engine: disabling\n")); bool* pWasDisabled = EngineDisabled.PushAndUnlock(true, 2); // wait max. 2s @@ -154,6 +182,96 @@ } /** + * Similar to @c Disable() but this method additionally kills all voices + * and disk streams and blocks until all voices and disk streams are actually + * killed / deleted. + * + * @e Note: only the original calling thread is able to re-enable the + * engine afterwards by calling @c ResumeAll() later on! + */ + void Engine::SuspendAll() { + dmsg(2,("gig::Engine: Suspending all ...\n")); + // stop the engine, so we can safely modify the engine's + // data structures from this foreign thread + DisableAndLock(); + // we could also use the respective class member variable here, + // but this is probably safer and cleaner + int iPendingStreamDeletions = 0; + // kill all voices on all engine channels the *die hard* way + for (int iChannel = 0; iChannel < engineChannels.size(); iChannel++) { + EngineChannel* pEngineChannel = engineChannels[iChannel]; + RTList::Iterator iuiKey = pEngineChannel->pActiveKeys->first(); + RTList::Iterator end = pEngineChannel->pActiveKeys->end(); + for (; iuiKey != end; ++iuiKey) { // iterate through all active keys + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey]; + RTList::Iterator itVoice = pKey->pActiveVoices->first(); + RTList::Iterator itVoicesEnd = pKey->pActiveVoices->end(); + for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key + // request a notification from disk thread side for stream deletion + const Stream::Handle hStream = itVoice->KillImmediately(true); + if (hStream != Stream::INVALID_HANDLE) { // voice actually used a stream + iPendingStreamDeletions++; + } + } + } + } + // wait until all streams were actually deleted by the disk thread + while (iPendingStreamDeletions) { + while ( + iPendingStreamDeletions && + pDiskThread->AskForDeletedStream() != Stream::INVALID_HANDLE + ) iPendingStreamDeletions--; + if (!iPendingStreamDeletions) break; + usleep(10000); // sleep for 10ms + } + dmsg(2,("gig::Engine: Everything suspended.\n")); + } + + /** + * At the moment same as calling @c Enable() directly, but this might + * change in future, so better call this method as counterpart to + * @c SuspendAll() instead of @c Enable() ! + */ + void Engine::ResumeAll() { + Enable(); + } + + /** + * Order the engine to stop rendering audio for the given region. + * Additionally this method will block until all voices and their disk + * streams associated with that region are actually killed / deleted, so + * one can i.e. safely modify the region with an instrument editor after + * returning from this method. + * + * @param pRegion - region the engine shall stop using + */ + void Engine::Suspend(::gig::Region* pRegion) { + dmsg(2,("gig::Engine: Suspending Region %x ...\n",pRegion)); + SuspendedRegionsMutex.Lock(); + SuspensionChangeOngoing.Set(true); + pPendingRegionSuspension = pRegion; + SuspensionChangeOngoing.WaitAndUnlockIf(true); + SuspendedRegionsMutex.Unlock(); + dmsg(2,("gig::Engine: Region %x suspended.",pRegion)); + } + + /** + * Orders the engine to resume playing back the given region, previously + * suspended with @c Suspend() . + * + * @param pRegion - region the engine shall be allowed to use again + */ + void Engine::Resume(::gig::Region* pRegion) { + dmsg(2,("gig::Engine: Resuming Region %x ...\n",pRegion)); + SuspendedRegionsMutex.Lock(); + SuspensionChangeOngoing.Set(true); + pPendingRegionResumption = pRegion; + SuspensionChangeOngoing.WaitAndUnlockIf(true); + SuspendedRegionsMutex.Unlock(); + dmsg(2,("gig::Engine: Region %x resumed.\n",pRegion)); + } + + /** * Reset all voices and disk thread and clear input event queue and all * control and status variables. */ @@ -174,7 +292,7 @@ // make sure that the engine does not get any sysex messages // while it's reseting bool sysexDisabled = MidiInputPort::RemoveSysexListener(this); - ActiveVoiceCount = 0; + SetVoiceCount(0); ActiveVoiceCountMax = 0; // reset voice stealing parameters @@ -208,6 +326,13 @@ memset(&ScaleTuning[0], 0x00, 12); } + void Engine::ResetSuspendedRegions() { + SuspendedRegions.clear(); + iPendingStreamDeletions = 0; + pPendingRegionSuspension = pPendingRegionResumption = NULL; + SuspensionChangeOngoing.Set(false); + } + /** * Connect this engine instance with the given audio output device. * This method will be called when an Engine instance is created. @@ -218,6 +343,9 @@ * @param pAudioOut - audio output device to connect to */ void Engine::Connect(AudioOutputDevice* pAudioOut) { + // caution: don't ignore if connecting to the same device here, + // because otherwise SetMaxDiskStreams() implementation won't work anymore! + pAudioOutputDevice = pAudioOut; ResetInternal(); @@ -234,14 +362,13 @@ this->MaxSamplesPerCycle = pAudioOutputDevice->MaxSamplesPerCycle(); this->SampleRate = pAudioOutputDevice->SampleRate(); - // FIXME: audio drivers with varying fragment sizes might be a problem here - MaxFadeOutPos = MaxSamplesPerCycle - int(double(SampleRate) * CONFIG_EG_MIN_RELEASE_TIME) - 1; - if (MaxFadeOutPos < 0) { + MinFadeOutSamples = int(double(SampleRate) * CONFIG_EG_MIN_RELEASE_TIME) - 1; + if (MaxSamplesPerCycle < MinFadeOutSamples) { std::cerr << "gig::Engine: WARNING, CONFIG_EG_MIN_RELEASE_TIME " << "too big for current audio fragment size & sampling rate! " << "May lead to click sounds if voice stealing chimes in!\n" << std::flush; // force volume ramp downs at the beginning of each fragment - MaxFadeOutPos = 0; + MinFadeOutSamples = MaxSamplesPerCycle; // lower minimum release time const float minReleaseTime = (float) MaxSamplesPerCycle / (float) SampleRate; for (RTList::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) { @@ -257,7 +384,13 @@ delete this->pDiskThread; dmsg(1,("OK\n")); } - this->pDiskThread = new DiskThread(((pAudioOut->MaxSamplesPerCycle() << CONFIG_MAX_PITCH) << 1) + 6); //FIXME: assuming stereo + this->pDiskThread = + new DiskThread( + iMaxDiskStreams, + ((pAudioOut->MaxSamplesPerCycle() << CONFIG_MAX_PITCH) << 1) + 6, //FIXME: assuming stereo + &instruments + ); + if (!pDiskThread) { dmsg(0,("gig::Engine new diskthread = NULL\n")); exit(EXIT_FAILURE); @@ -283,6 +416,111 @@ exit(EXIT_FAILURE); } } + pVoicePool->clear(); + } + + /** + * Called by the engine's (audio) thread once per cycle to process requests + * from the outer world to suspend or resume a given @c gig::Region . + */ + void Engine::ProcessSuspensionsChanges() { + // process request for suspending one region + if (pPendingRegionSuspension) { + // kill all voices on all engine channels that use this region + for (int iChannel = 0; iChannel < engineChannels.size(); iChannel++) { + EngineChannel* pEngineChannel = engineChannels[iChannel]; + RTList::Iterator iuiKey = pEngineChannel->pActiveKeys->first(); + RTList::Iterator end = pEngineChannel->pActiveKeys->end(); + for (; iuiKey != end; ++iuiKey) { // iterate through all active keys + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey]; + RTList::Iterator itVoice = pKey->pActiveVoices->first(); + // if current key is not associated with this region, skip this key + if (itVoice->pDimRgn->GetParent() != pPendingRegionSuspension) continue; + RTList::Iterator itVoicesEnd = pKey->pActiveVoices->end(); + for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key + // request a notification from disk thread side for stream deletion + const Stream::Handle hStream = itVoice->KillImmediately(true); + if (hStream != Stream::INVALID_HANDLE) { // voice actually used a stream + iPendingStreamDeletions++; + } + } + } + } + // make sure the region is not yet on the list + bool bAlreadySuspended = false; + RTList< ::gig::Region*>::Iterator iter = SuspendedRegions.first(); + RTList< ::gig::Region*>::Iterator end = SuspendedRegions.end(); + for (; iter != end; ++iter) { // iterate through all suspended regions + if (*iter == pPendingRegionSuspension) { // found + bAlreadySuspended = true; + dmsg(1,("gig::Engine: attempt to suspend an already suspended region !!!\n")); + break; + } + } + if (!bAlreadySuspended) { + // put the region on the list of suspended regions + RTList< ::gig::Region*>::Iterator iter = SuspendedRegions.allocAppend(); + if (iter) { + *iter = pPendingRegionSuspension; + } else std::cerr << "gig::Engine: Could not suspend Region, list is full. This is a bug!!!\n" << std::flush; + } + // free request slot for next caller (and to make sure that + // we're not going to process the same request in the next cycle) + pPendingRegionSuspension = NULL; + // if no disk stream deletions are pending, awaken other side, as + // we're done in this case + if (!iPendingStreamDeletions) SuspensionChangeOngoing.Set(false); + } + + // process request for resuming one region + if (pPendingRegionResumption) { + // remove region from the list of suspended regions + RTList< ::gig::Region*>::Iterator iter = SuspendedRegions.first(); + RTList< ::gig::Region*>::Iterator end = SuspendedRegions.end(); + for (; iter != end; ++iter) { // iterate through all suspended regions + if (*iter == pPendingRegionResumption) { // found + SuspendedRegions.free(iter); + break; // done + } + } + // free request slot for next caller + pPendingRegionResumption = NULL; + // awake other side as we're done + SuspensionChangeOngoing.Set(false); + } + } + + /** + * Called by the engine's (audio) thread once per cycle to check if + * streams of voices that were killed due to suspension request have + * finally really been deleted by the disk thread. + */ + void Engine::ProcessPendingStreamDeletions() { + if (!iPendingStreamDeletions) return; + //TODO: or shall we better store a list with stream handles instead of a scalar amount of streams to be deleted? might be safer + while ( + iPendingStreamDeletions && + pDiskThread->AskForDeletedStream() != Stream::INVALID_HANDLE + ) iPendingStreamDeletions--; + // just for safety ... + while (pDiskThread->AskForDeletedStream() != Stream::INVALID_HANDLE); + // now that all disk streams are deleted, awake other side as + // we're finally done with suspending the requested region + if (!iPendingStreamDeletions) SuspensionChangeOngoing.Set(false); + } + + /** + * Returns @c true if the given region is currently set to be suspended + * from being used, @c false otherwise. + */ + bool Engine::RegionSuspended(::gig::Region* pRegion) { + if (SuspendedRegions.isEmpty()) return false; + //TODO: or shall we use a sorted container instead of the RTList? might be faster ... or trivial ;-) + RTList< ::gig::Region*>::Iterator iter = SuspendedRegions.first(); + RTList< ::gig::Region*>::Iterator end = SuspendedRegions.end(); + for (; iter != end; ++iter) // iterate through all suspended regions + if (*iter == pRegion) return true; + return false; } /** @@ -340,21 +578,26 @@ * @returns 0 on success */ int Engine::RenderAudio(uint Samples) { - dmsg(7,("RenderAudio(Samples=%d)\n", Samples)); + dmsg(8,("RenderAudio(Samples=%d)\n", Samples)); // return if engine disabled if (EngineDisabled.Pop()) { dmsg(5,("gig::Engine: engine disabled (val=%d)\n",EngineDisabled.GetUnsafe())); + EngineDisabled.RttDone(); return 0; } + // process requests for suspending / resuming regions (i.e. to avoid + // crashes while these regions are modified by an instrument editor) + ProcessSuspensionsChanges(); + // 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 + // We only allow the given maximum number of 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; + VoiceSpawnsLeft = MaxVoices(); // get all events from the engine's global input event queue which belong to the current fragment // (these are usually just SysEx messages) @@ -377,15 +620,57 @@ // reset internal voice counter (just for statistic of active voices) ActiveVoiceCountTemp = 0; + // handle instrument change commands + bool instrumentChanged = false; + for (int i = 0; i < engineChannels.size(); i++) { + EngineChannel* pEngineChannel = engineChannels[i]; + + // as we're going to (carefully) write some status to the + // synchronized struct, we cast away the const + EngineChannel::instrument_change_command_t& cmd = + const_cast(pEngineChannel->InstrumentChangeCommandReader.Lock()); + + pEngineChannel->pDimRegionsInUse = cmd.pDimRegionsInUse; + pEngineChannel->pDimRegionsInUse->clear(); + + if (cmd.bChangeInstrument) { + // change instrument + dmsg(5,("Engine: instrument change command received\n")); + cmd.bChangeInstrument = false; + pEngineChannel->pInstrument = cmd.pInstrument; + instrumentChanged = true; + + // Iterate through all active voices and mark them as + // "orphans", which means that the dimension regions + // and samples they use should be released to the + // instrument resource manager when the voices die. + int i = 0; + RTList::Iterator iuiKey = pEngineChannel->pActiveKeys->first(); + RTList::Iterator end = pEngineChannel->pActiveKeys->end(); + while (iuiKey != end) { // iterate through all active keys + midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey]; + ++iuiKey; + + RTList::Iterator itVoice = pKey->pActiveVoices->first(); + RTList::Iterator itVoicesEnd = pKey->pActiveVoices->end(); + for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key + itVoice->Orphan = true; + } + } + } + } + if (instrumentChanged) { + //TODO: this is a lazy solution ATM and not safe in case somebody is currently editing the instrument we're currently switching to (we should store all suspended regions on instrument manager side and when switching to another instrument copy that list to the engine's local list of suspensions + ResetSuspendedRegions(); + } + // handle events on all engine channels for (int i = 0; i < engineChannels.size(); i++) { - if (!engineChannels[i]->pInstrument) continue; // ignore if no instrument loaded ProcessEvents(engineChannels[i], Samples); } // render all 'normal', active voices on all engine channels for (int i = 0; i < engineChannels.size(); i++) { - if (!engineChannels[i]->pInstrument) continue; // ignore if no instrument loaded RenderActiveVoices(engineChannels[i], Samples); } @@ -400,7 +685,6 @@ // handle cleanup on all engine channels for the next audio fragment for (int i = 0; i < engineChannels.size(); i++) { - if (!engineChannels[i]->pInstrument) continue; // ignore if no instrument loaded PostProcess(engineChannels[i]); } @@ -412,11 +696,20 @@ pVoiceStealingQueue->clear(); // just some statistics about this engine instance - ActiveVoiceCount = ActiveVoiceCountTemp; - if (ActiveVoiceCount > ActiveVoiceCountMax) ActiveVoiceCountMax = ActiveVoiceCount; + SetVoiceCount(ActiveVoiceCountTemp); + if (VoiceCount() > ActiveVoiceCountMax) ActiveVoiceCountMax = VoiceCount(); + + // in case regions were previously suspended and we killed voices + // with disk streams due to that, check if those streams have finally + // been deleted by the disk thread + if (iPendingStreamDeletions) ProcessPendingStreamDeletions(); + for (int i = 0; i < engineChannels.size(); i++) { + engineChannels[i]->InstrumentChangeCommandReader.Unlock(); + } FrameTime += Samples; + EngineDisabled.RttDone(); return 0; } @@ -482,6 +775,8 @@ if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted #endif + uint voiceCount = 0; + uint streamCount = 0; RTList::Iterator iuiKey = pEngineChannel->pActiveKeys->first(); RTList::Iterator end = pEngineChannel->pActiveKeys->end(); while (iuiKey != end) { // iterate through all active keys @@ -493,12 +788,24 @@ for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key // now render current voice itVoice->Render(Samples); - if (itVoice->IsActive()) ActiveVoiceCountTemp++; // still active - else { // voice reached end, is now inactive + if (itVoice->IsActive()) { // still active + if (!itVoice->Orphan) { + *(pEngineChannel->pDimRegionsInUse->allocAppend()) = itVoice->pDimRgn; + } + ActiveVoiceCountTemp++; + voiceCount++; + + if (itVoice->PlaybackState == Voice::playback_state_disk) { + if ((itVoice->DiskStreamRef).State != Stream::state_unused) streamCount++; + } + } else { // voice reached end, is now inactive FreeVoice(pEngineChannel, itVoice); // remove voice from the list of active voices } } } + + pEngineChannel->SetVoiceCount(voiceCount); + pEngineChannel->SetDiskStreamCount(streamCount); } /** @@ -519,12 +826,22 @@ RTList::Iterator end = pVoiceStealingQueue->end(); for (; itVoiceStealEvent != end; ++itVoiceStealEvent) { EngineChannel* pEngineChannel = (EngineChannel*) itVoiceStealEvent->pEngineChannel; + if (!pEngineChannel->pInstrument) continue; // ignore if no instrument loaded Pool::Iterator itNewVoice = LaunchVoice(pEngineChannel, itVoiceStealEvent, itVoiceStealEvent->Param.Note.Layer, itVoiceStealEvent->Param.Note.ReleaseTrigger, false, false); if (itNewVoice) { itNewVoice->Render(Samples); - if (itNewVoice->IsActive()) ActiveVoiceCountTemp++; // still active - else { // voice reached end, is now inactive + if (itNewVoice->IsActive()) { // still active + *(pEngineChannel->pDimRegionsInUse->allocAppend()) = itNewVoice->pDimRgn; + ActiveVoiceCountTemp++; + pEngineChannel->SetVoiceCount(pEngineChannel->GetVoiceCount() + 1); + + if (itNewVoice->PlaybackState == Voice::playback_state_disk) { + if (itNewVoice->DiskStreamRef.State != Stream::state_unused) { + pEngineChannel->SetDiskStreamCount(pEngineChannel->GetDiskStreamCount() + 1); + } + } + } else { // voice reached end, is now inactive FreeVoice(pEngineChannel, itNewVoice); // remove voice from the list of active voices } } @@ -551,39 +868,58 @@ * this audio fragment cycle */ void Engine::RouteAudio(EngineChannel* pEngineChannel, uint Samples) { - // route master signal + // route dry signal { AudioChannel* pDstL = pAudioOutputDevice->Channel(pEngineChannel->AudioDeviceChannelLeft); AudioChannel* pDstR = pAudioOutputDevice->Channel(pEngineChannel->AudioDeviceChannelRight); - pEngineChannel->pChannelLeft->CopyTo(pDstL, Samples); - pEngineChannel->pChannelRight->CopyTo(pDstR, Samples); + pEngineChannel->pChannelLeft->MixTo(pDstL, Samples); + pEngineChannel->pChannelRight->MixTo(pDstR, Samples); } // route FX send signal { for (int iFxSend = 0; iFxSend < pEngineChannel->GetFxSendCount(); iFxSend++) { FxSend* pFxSend = pEngineChannel->GetFxSend(iFxSend); - // left channel - const int iDstL = pFxSend->DestinationChannel(0); - if (iDstL < 0) { - dmsg(1,("Engine::RouteAudio() Error: invalid FX send (L) destination channel")); - } else { - AudioChannel* pDstL = pAudioOutputDevice->Channel(iDstL); - if (!pDstL) { - dmsg(1,("Engine::RouteAudio() Error: invalid FX send (L) destination channel")); - } else pEngineChannel->pChannelLeft->CopyTo(pDstL, Samples, pFxSend->Level()); - } - // right channel - const int iDstR = pFxSend->DestinationChannel(1); - if (iDstR < 0) { - dmsg(1,("Engine::RouteAudio() Error: invalid FX send (R) destination channel")); - } else { - AudioChannel* pDstR = pAudioOutputDevice->Channel(iDstR); - if (!pDstR) { - dmsg(1,("Engine::RouteAudio() Error: invalid FX send (R) destination channel")); - } else pEngineChannel->pChannelRight->CopyTo(pDstR, Samples, pFxSend->Level()); + for (int iChan = 0; iChan < 2; ++iChan) { + AudioChannel* pSource = + (iChan) + ? pEngineChannel->pChannelRight + : pEngineChannel->pChannelLeft; + const int iDstChan = pFxSend->DestinationChannel(iChan); + if (iDstChan < 0) { + dmsg(1,("Engine::RouteAudio() Error: invalid FX send (%s) destination channel (%d->%d)", ((iChan) ? "R" : "L"), iChan, iDstChan)); + goto channel_cleanup; + } + AudioChannel* pDstChan = NULL; + if (pFxSend->DestinationMasterEffectChain() >= 0) { // fx send routed to an internal master effect + EffectChain* pEffectChain = + pAudioOutputDevice->MasterEffectChain( + pFxSend->DestinationMasterEffectChain() + ); + if (!pEffectChain) { + dmsg(1,("Engine::RouteAudio() Error: invalid FX send (%s) destination effect chain %d", ((iChan) ? "R" : "L"), pFxSend->DestinationMasterEffectChain())); + goto channel_cleanup; + } + Effect* pEffect = + pEffectChain->GetEffect( + pFxSend->DestinationMasterEffect() + ); + if (!pEffect) { + dmsg(1,("Engine::RouteAudio() Error: invalid FX send (%s) destination effect %d of effect chain %d", ((iChan) ? "R" : "L"), pFxSend->DestinationMasterEffect(), pFxSend->DestinationMasterEffectChain())); + goto channel_cleanup; + } + pDstChan = pEffect->InputChannel(iDstChan); + } else { // FX send routed directly to an audio output channel + pDstChan = pAudioOutputDevice->Channel(iDstChan); + } + if (!pDstChan) { + dmsg(1,("Engine::RouteAudio() Error: invalid FX send (%s) destination channel (%d->%d)", ((iChan) ? "R" : "L"), iChan, iDstChan)); + goto channel_cleanup; + } + pSource->MixTo(pDstChan, Samples, pFxSend->Level()); } } } + channel_cleanup: // reset buffers with silence (zero out) for the next audio cycle pEngineChannel->pChannelLeft->Clear(); pEngineChannel->pChannelRight->Clear(); @@ -629,12 +965,15 @@ * * @param pData - pointer to sysex data * @param Size - lenght of sysex data (in bytes) + * @param pSender - the MIDI input port on which the SysEx message was + * received */ - void Engine::SendSysex(void* pData, uint Size) { + void Engine::SendSysex(void* pData, uint Size, MidiInputPort* pSender) { Event event = pEventGenerator->CreateEvent(); event.Type = Event::type_sysex; event.Param.Sysex.Size = Size; event.pEngineChannel = NULL; // as Engine global event + event.pMidiInputPort = pSender; if (pEventQueue->write_space() > 0) { if (pSysexBuffer->write_space() >= Size) { // copy sysex data to input buffer @@ -666,6 +1005,11 @@ if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted #endif + if (!pEngineChannel->pInstrument) return; // ignore if no instrument loaded + + //HACK: we should better add the transpose value only to the most mandatory places (like for retrieving the region and calculating the tuning), because otherwise voices will unintendedly survive when changing transpose while playing + itNoteOnEvent->Param.Note.Key += pEngineChannel->GlobalTranspose; + const int key = itNoteOnEvent->Param.Note.Key; midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[key]; @@ -723,7 +1067,7 @@ { // first, get total amount of required voices (dependant on amount of layers) ::gig::Region* pRegion = pEngineChannel->pInstrument->GetRegion(itNoteOnEventOnKeyList->Param.Note.Key); - if (pRegion) { + if (pRegion && !RegionSuspended(pRegion)) { int voicesRequired = pRegion->Layers; // now launch the required amount of voices for (int i = 0; i < voicesRequired; i++) @@ -753,6 +1097,9 @@ if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted #endif + //HACK: we should better add the transpose value only to the most mandatory places (like for retrieving the region and calculating the tuning), because otherwise voices will unintendedly survive when changing transpose while playing + itNoteOffEvent->Param.Note.Key += pEngineChannel->GlobalTranspose; + const int iKey = itNoteOffEvent->Param.Note.Key; midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[iKey]; pKey->KeyPressed = false; // the MIDI key was now released @@ -763,7 +1110,7 @@ bool bShouldRelease = pKey->Active && ShouldReleaseVoice(pEngineChannel, itNoteOffEventOnKeyList->Param.Note.Key); // in case Solo Mode is enabled, kill all voices on this key and respawn a voice on the highest pressed key (if any) - if (pEngineChannel->SoloMode) { //TODO: this feels like too much code just for handling solo mode :P + if (pEngineChannel->SoloMode && pEngineChannel->pInstrument) { //TODO: this feels like too much code just for handling solo mode :P bool bOtherKeysPressed = false; if (iKey == pEngineChannel->SoloKey) { pEngineChannel->SoloKey = -1; @@ -826,7 +1173,7 @@ itNoteOffEventOnKeyList->Type = Event::type_release; // transform event type // spawn release triggered voice(s) if needed - if (pKey->ReleaseTrigger) { + if (pKey->ReleaseTrigger && pEngineChannel->pInstrument) { // first, get total amount of required voices (dependant on amount of layers) ::gig::Region* pRegion = pEngineChannel->pInstrument->GetRegion(itNoteOffEventOnKeyList->Param.Note.Key); if (pRegion) { @@ -1021,6 +1368,12 @@ std::cerr << "gig::Engine::LaunchVoice() Error: Unknown dimension\n" << std::flush; } } + + // return if this is a release triggered voice and there is no + // releasetrigger dimension (could happen if an instrument + // change has occured between note on and off) + if (ReleaseTriggerVoice && VoiceType != Voice::type_release_trigger) return Pool::Iterator(); + ::gig::DimensionRegion* pDimRgn = pRegion->GetDimensionRegionByValue(DimValues); // no need to continue if sample is silent @@ -1250,6 +1603,13 @@ uint keygroup = itVoice->KeyGroup; + // if the sample and dimension region belong to an + // instrument that is unloaded, tell the disk thread to + // release them + if (itVoice->Orphan) { + pDiskThread->OrderDeletionOfDimreg(itVoice->pDimRgn); + } + // free the voice object pVoicePool->free(itVoice); @@ -1291,6 +1651,64 @@ 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)); + // handle the "control triggered" MIDI rule: a control change + // event can trigger a new note on or note off event + if (pEngineChannel->pInstrument) { + + ::gig::MidiRule* rule; + for (int i = 0 ; (rule = pEngineChannel->pInstrument->GetMidiRule(i)) ; i++) { + + if (::gig::MidiRuleCtrlTrigger* ctrlTrigger = + dynamic_cast< ::gig::MidiRuleCtrlTrigger*>(rule)) { + if (itControlChangeEvent->Param.CC.Controller == + ctrlTrigger->ControllerNumber) { + + uint8_t oldCCValue = pEngineChannel->ControllerTable[ + itControlChangeEvent->Param.CC.Controller]; + uint8_t newCCValue = itControlChangeEvent->Param.CC.Value; + + for (int i = 0 ; i < ctrlTrigger->Triggers ; i++) { + ::gig::MidiRuleCtrlTrigger::trigger_t* pTrigger = + &ctrlTrigger->pTriggers[i]; + + // check if the controller has passed the + // trigger point in the right direction + if ((pTrigger->Descending && + oldCCValue > pTrigger->TriggerPoint && + newCCValue <= pTrigger->TriggerPoint) || + (!pTrigger->Descending && + oldCCValue < pTrigger->TriggerPoint && + newCCValue >= pTrigger->TriggerPoint)) { + + RTList::Iterator itNewEvent = pGlobalEvents->allocAppend(); + if (itNewEvent) { + *itNewEvent = *itControlChangeEvent; + itNewEvent->Param.Note.Key = pTrigger->Key; + + if (pTrigger->NoteOff || pTrigger->Velocity == 0) { + itNewEvent->Type = Event::type_note_off; + itNewEvent->Param.Note.Velocity = 100; + + ProcessNoteOff(pEngineChannel, itNewEvent); + } else { + itNewEvent->Type = Event::type_note_on; + //TODO: if Velocity is 255, the triggered velocity should + // depend on how fast the controller is moving + itNewEvent->Param.Note.Velocity = + pTrigger->Velocity == 255 ? 100 : + pTrigger->Velocity; + + ProcessNoteOn(pEngineChannel, itNewEvent); + } + } + else dmsg(1,("Event pool emtpy!\n")); + } + } + } + } + } + } + // update controller value in the engine channel's controller table pEngineChannel->ControllerTable[itControlChangeEvent->Param.CC.Controller] = itControlChangeEvent->Param.CC.Value; @@ -1300,6 +1718,20 @@ pEngineChannel->PortamentoTime = (float) itControlChangeEvent->Param.CC.Value / 127.0f * (float) CONFIG_PORTAMENTO_TIME_MAX + (float) CONFIG_PORTAMENTO_TIME_MIN; break; } + case 6: { // data entry (currently only used for RPN controllers) + if (pEngineChannel->GetMidiRpnController() == 2) { // coarse tuning in half tones + int transpose = (int) itControlChangeEvent->Param.CC.Value - 64; + // limit to +- two octaves for now + transpose = RTMath::Min(transpose, 24); + transpose = RTMath::Max(transpose, -24); + pEngineChannel->GlobalTranspose = transpose; + // workaround, so we won't have hanging notes + ReleaseAllVoices(pEngineChannel, itControlChangeEvent); + } + // to avoid other MIDI CC #6 messages to be misenterpreted as RPN controller data + pEngineChannel->ResetMidiRpnController(); + break; + } case 7: { // volume //TODO: not sample accurate yet pEngineChannel->MidiVolume = VolumeCurve[itControlChangeEvent->Param.CC.Value]; @@ -1310,6 +1742,7 @@ //TODO: not sample accurate yet pEngineChannel->GlobalPanLeft = PanCurve[128 - itControlChangeEvent->Param.CC.Value]; pEngineChannel->GlobalPanRight = PanCurve[itControlChangeEvent->Param.CC.Value]; + pEngineChannel->iLastPanRequest = itControlChangeEvent->Param.CC.Value; break; } case 64: { // sustain @@ -1360,8 +1793,10 @@ break; } case 65: { // portamento on / off - KillAllVoices(pEngineChannel, itControlChangeEvent); - pEngineChannel->PortamentoMode = itControlChangeEvent->Param.CC.Value >= 64; + const bool bPortamento = itControlChangeEvent->Param.CC.Value >= 64; + if (bPortamento != pEngineChannel->PortamentoMode) + KillAllVoices(pEngineChannel, itControlChangeEvent); + pEngineChannel->PortamentoMode = bPortamento; break; } case 66: { // sostenuto @@ -1404,6 +1839,14 @@ } break; } + case 100: { // RPN controller LSB + pEngineChannel->SetMidiRpnControllerLsb(itControlChangeEvent->Param.CC.Value); + break; + } + case 101: { // RPN controller MSB + pEngineChannel->SetMidiRpnControllerMsb(itControlChangeEvent->Param.CC.Value); + break; + } // Channel Mode Messages @@ -1423,12 +1866,14 @@ break; } case 126: { // mono mode on - KillAllVoices(pEngineChannel, itControlChangeEvent); + if (!pEngineChannel->SoloMode) + KillAllVoices(pEngineChannel, itControlChangeEvent); pEngineChannel->SoloMode = true; break; } case 127: { // poly mode on - KillAllVoices(pEngineChannel, itControlChangeEvent); + if (pEngineChannel->SoloMode) + KillAllVoices(pEngineChannel, itControlChangeEvent); pEngineChannel->SoloMode = false; break; } @@ -1438,8 +1883,10 @@ if (!pEngineChannel->fxSends.empty()) { for (int iFxSend = 0; iFxSend < pEngineChannel->GetFxSendCount(); iFxSend++) { FxSend* pFxSend = pEngineChannel->GetFxSend(iFxSend); - if (pFxSend->MidiController() == itControlChangeEvent->Param.CC.Controller) + if (pFxSend->MidiController() == itControlChangeEvent->Param.CC.Controller) { pFxSend->SetLevel(itControlChangeEvent->Param.CC.Value); + pFxSend->SetInfoChanged(true); + } } } } @@ -1458,6 +1905,43 @@ if (exclusive_status != 0xF0) goto free_sysex_data; switch (id) { + case 0x7f: { // (Realtime) Universal Sysex (GM Standard) + uint8_t sysex_channel, sub_id1, sub_id2, val_msb, val_lsb;; + if (!reader.pop(&sysex_channel)) goto free_sysex_data; + if (!reader.pop(&sub_id1)) goto free_sysex_data; + if (!reader.pop(&sub_id2)) goto free_sysex_data; + if (!reader.pop(&val_lsb)) goto free_sysex_data; + if (!reader.pop(&val_msb)) goto free_sysex_data; + //TODO: for now we simply ignore the sysex channel, seldom used anyway + switch (sub_id1) { + case 0x04: // Device Control + switch (sub_id2) { + case 0x01: { // Master Volume + const double volume = + double((uint(val_msb)<<7) | uint(val_lsb)) / 16383.0; + #if CONFIG_MASTER_VOLUME_SYSEX_BY_PORT + // apply volume to all sampler channels that + // are connected to the same MIDI input port + // this sysex message arrived on + for (int i = 0; i < engineChannels.size(); ++i) { + EngineChannel* pEngineChannel = engineChannels[i]; + if (pEngineChannel->GetMidiInputPort() == + itSysexEvent->pMidiInputPort) + { + pEngineChannel->Volume(volume); + } + } + #else + // apply volume globally to the whole sampler + GLOBAL_VOLUME = volume; + #endif // CONFIG_MASTER_VOLUME_SYSEX_BY_PORT + break; + } + } + break; + } + break; + } case 0x41: { // Roland dmsg(3,("Roland Sysex\n")); uint8_t device_id, model_id, cmd_id; @@ -1494,6 +1978,32 @@ dmsg(3,("\t\t\tNew scale applied.\n")); break; } + case 0x15: { // chromatic / drumkit mode + dmsg(3,("\t\tMIDI Instrument Map Switch\n")); + uint8_t part = addr[1] & 0x0f; + uint8_t map; + if (!reader.pop(&map)) goto free_sysex_data; + for (int i = 0; i < engineChannels.size(); ++i) { + EngineChannel* pEngineChannel = engineChannels[i]; + if ( + (pEngineChannel->midiChannel == part || + pEngineChannel->midiChannel == midi_chan_all) && + pEngineChannel->GetMidiInputPort() == itSysexEvent->pMidiInputPort + ) { + try { + pEngineChannel->SetMidiInstrumentMap(map); + } catch (Exception e) { + dmsg(2,("\t\t\tCould not apply MIDI instrument map %d to part %d: %s\n", map, part, e.Message().c_str())); + goto free_sysex_data; + } catch (...) { + dmsg(2,("\t\t\tCould not apply MIDI instrument map %d to part %d (unknown exception)\n", map, part)); + goto free_sysex_data; + } + } + } + dmsg(3,("\t\t\tApplied MIDI instrument map %d to part %d.\n", map, part)); + break; + } } } else if (addr[0] == 0x40 && (addr[1] & 0xf0) == 0x20) { // Part Parameters (2) @@ -1600,25 +2110,89 @@ } uint Engine::VoiceCount() { - return ActiveVoiceCount; + return atomic_read(&ActiveVoiceCount); + } + + void Engine::SetVoiceCount(uint Count) { + atomic_set(&ActiveVoiceCount, Count); } uint Engine::VoiceCountMax() { return ActiveVoiceCountMax; } + int Engine::MaxVoices() { + return pVoicePool->poolSize(); + } + + void Engine::SetMaxVoices(int iVoices) throw (Exception) { + if (iVoices < 1) + throw Exception("Maximum voices for an engine cannot be set lower than 1"); + + SuspendAll(); + + // NOTE: we need to clear pDimRegionsInUse before deleting pDimRegionPool, + // otherwise memory corruption will occur if there are active voices (see bug #118) + for (int iChannel = 0; iChannel < engineChannels.size(); iChannel++) { + engineChannels[iChannel]->ClearDimRegionsInUse(); + } + + if (pDimRegionPool[0]) delete pDimRegionPool[0]; + if (pDimRegionPool[1]) delete pDimRegionPool[1]; + + pDimRegionPool[0] = new Pool< ::gig::DimensionRegion*>(iVoices); + pDimRegionPool[1] = new Pool< ::gig::DimensionRegion*>(iVoices); + + for (int iChannel = 0; iChannel < engineChannels.size(); iChannel++) { + engineChannels[iChannel]->ResetDimRegionsInUse(); + } + + try { + pVoicePool->resizePool(iVoices); + } catch (...) { + throw Exception("FATAL: Could not resize voice pool!"); + } + + for (RTList::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) { + iterVoice->SetEngine(this); + iterVoice->pDiskThread = this->pDiskThread; + } + pVoicePool->clear(); + + ResumeAll(); + } + bool Engine::DiskStreamSupported() { return true; } uint Engine::DiskStreamCount() { - return (pDiskThread) ? pDiskThread->ActiveStreamCount : 0; + return (pDiskThread) ? pDiskThread->GetActiveStreamCount() : 0; } uint Engine::DiskStreamCountMax() { return (pDiskThread) ? pDiskThread->ActiveStreamCountMax : 0; } + int Engine::MaxDiskStreams() { + return iMaxDiskStreams; + } + + void Engine::SetMaxDiskStreams(int iStreams) throw (Exception) { + if (iStreams < 0) + throw Exception("Maximum disk streams for an engine cannot be set lower than 0"); + + SuspendAll(); + + iMaxDiskStreams = iStreams; + + // reconnect to audio output device, because that will automatically + // recreate the disk thread with the required amount of streams + if (pAudioOutputDevice) Connect(pAudioOutputDevice); + + ResumeAll(); + } + String Engine::DiskStreamBufferFillBytes() { return pDiskThread->GetBufferFillBytes(); } @@ -1632,11 +2206,11 @@ } String Engine::Description() { - return "Gigasampler Engine"; + return "Gigasampler Format Engine"; } String Engine::Version() { - String s = "$Revision: 1.68 $"; + String s = "$Revision: 1.100 $"; return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword } @@ -1645,9 +2219,9 @@ } // static constant initializers - const float* Engine::VolumeCurve(InitVolumeCurve()); - const float* Engine::PanCurve(InitPanCurve()); - const float* Engine::CrossfadeCurve(InitCrossfadeCurve()); + const Engine::FloatTable Engine::VolumeCurve(InitVolumeCurve()); + const Engine::FloatTable Engine::PanCurve(InitPanCurve()); + const Engine::FloatTable Engine::CrossfadeCurve(InitCrossfadeCurve()); float* Engine::InitVolumeCurve() { // line-segment approximation