--- linuxsampler/trunk/src/engines/gig/InstrumentResourceManager.cpp 2005/05/08 00:26:21 517 +++ linuxsampler/trunk/src/engines/gig/InstrumentResourceManager.cpp 2008/01/20 15:04:51 1646 @@ -3,7 +3,7 @@ * LinuxSampler - modular, streaming capable sampler * * * * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck * - * Copyright (C) 2005 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 * @@ -25,6 +25,9 @@ #include "InstrumentResourceManager.h" +#include "../../common/global_private.h" +#include "../../plugins/InstrumentEditorFactory.h" + // We need to know the maximum number of sample points which are going to // be processed for each render cycle of the audio output driver, to know // how much initial sample points we need to cache into RAM. If the given @@ -34,10 +37,36 @@ namespace LinuxSampler { namespace gig { + // data stored as long as an instrument resource exists + struct instr_entry_t { + InstrumentManager::instrument_id_t ID; + ::gig::File* pGig; + uint MaxSamplesPerCycle; ///< if some engine requests an already allocated instrument with a higher value, we have to reallocate the instrument + }; + // some data needed for the libgig callback function struct progress_callback_arg_t { - InstrumentResourceManager* pManager; - instrument_id_t* pInstrumentKey; + InstrumentResourceManager* pManager; + InstrumentManager::instrument_id_t* pInstrumentKey; + }; + + // we use this to react on events concerning an instrument on behalf of an instrument editor + class InstrumentEditorProxy : public InstrumentConsumer { + public: + virtual void ResourceToBeUpdated(::gig::Instrument* pResource, void*& pUpdateArg) { + //TODO: inform the instrument editor about the pending update + } + + virtual void ResourceUpdated(::gig::Instrument* pOldResource, ::gig::Instrument* pNewResource, void* pUpdateArg) { + //TODO:: inform the instrument editor about finished update + } + + virtual void OnResourceProgress(float fProgress) { + //TODO: inform the instrument editor about the progress of an update + } + + // the instrument we borrowed on behalf of the editor + ::gig::Instrument* pInstrument; }; /** @@ -57,9 +86,300 @@ pArg->pManager->DispatchResourceProgressEvent(*pArg->pInstrumentKey, localProgress); } + std::vector InstrumentResourceManager::Instruments() { + return Entries(); + } + + InstrumentManager::mode_t InstrumentResourceManager::GetMode(const instrument_id_t& ID) { + return static_cast(AvailabilityMode(ID)); + } + + void InstrumentResourceManager::SetMode(const instrument_id_t& ID, InstrumentManager::mode_t Mode) { + dmsg(2,("gig::InstrumentResourceManager: setting mode for %s (Index=%d) to %d\n",ID.FileName.c_str(),ID.Index,Mode)); + SetAvailabilityMode(ID, static_cast::mode_t>(Mode)); + } + + String InstrumentResourceManager::GetInstrumentName(instrument_id_t ID) { + Lock(); + ::gig::Instrument* pInstrument = Resource(ID, false); + String res = (pInstrument) ? pInstrument->pInfo->Name : ""; + Unlock(); + return res; + } + + String InstrumentResourceManager::GetInstrumentDataStructureName(instrument_id_t ID) { + return ::gig::libraryName(); + } + + String InstrumentResourceManager::GetInstrumentDataStructureVersion(instrument_id_t ID) { + return ::gig::libraryVersion(); + } + + std::vector InstrumentResourceManager::GetInstrumentFileContent(String File) throw (InstrumentManagerException) { + ::RIFF::File* riff = NULL; + ::gig::File* gig = NULL; + try { + std::vector result; + riff = new ::RIFF::File(File); + gig = new ::gig::File(riff); + gig->SetAutoLoad(false); // avoid time consuming samples scanning + for (int i = 0; gig->GetInstrument(i); i++) { + instrument_id_t id; + id.FileName = File; + id.Index = i; + result.push_back(id); + } + if (gig) delete gig; + if (riff) delete riff; + return result; + } catch (::RIFF::Exception e) { + if (gig) delete gig; + if (riff) delete riff; + throw InstrumentManagerException(e.Message); + } catch (...) { + if (gig) delete gig; + if (riff) delete riff; + throw InstrumentManagerException("Unknown exception while trying to parse '" + File + "'"); + } + } + + InstrumentResourceManager::instrument_info_t InstrumentResourceManager::GetInstrumentInfo(instrument_id_t ID) throw (InstrumentManagerException) { + std::vector result; + ::RIFF::File* riff = NULL; + ::gig::File* gig = NULL; + try { + riff = new ::RIFF::File(ID.FileName); + gig = new ::gig::File(riff); + gig->SetAutoLoad(false); // avoid time consuming samples scanning + ::gig::Instrument* pInstrument = gig->GetInstrument(ID.Index); + if (!pInstrument) throw InstrumentManagerException("There is no instrument " + ToString(ID.Index) + " in " + ID.FileName); + instrument_info_t info; + if (gig->pVersion) { + info.FormatVersion = ToString(gig->pVersion->major); + info.Product = gig->pInfo->Product; + info.Artists = gig->pInfo->Artists; + } + info.InstrumentName = pInstrument->pInfo->Name; + if (gig) delete gig; + if (riff) delete riff; + return info; + } catch (::RIFF::Exception e) { + if (gig) delete gig; + if (riff) delete riff; + throw InstrumentManagerException(e.Message); + } catch (...) { + if (gig) delete gig; + if (riff) delete riff; + throw InstrumentManagerException("Unknown exception while trying to parse '" + ID.FileName + "'"); + } + } + + void InstrumentResourceManager::LaunchInstrumentEditor(instrument_id_t ID) throw (InstrumentManagerException) { + const String sDataType = GetInstrumentDataStructureName(ID); + const String sDataVersion = GetInstrumentDataStructureVersion(ID); + // find instrument editors capable to handle given instrument + std::vector vEditors = + InstrumentEditorFactory::MatchingEditors(sDataType, sDataVersion); + if (!vEditors.size()) + throw InstrumentManagerException( + "There is no instrument editor capable to handle this instrument" + ); + // simply use the first editor in the result set + dmsg(1,("Found matching editor '%s' for instrument ('%s', %d) having data structure ('%s','%s')\n", + vEditors[0].c_str(), ID.FileName.c_str(), ID.Index, sDataType.c_str(), sDataVersion.c_str())); + InstrumentEditor* pEditor = InstrumentEditorFactory::Create(vEditors[0]); + // register for receiving notifications from the instrument editor + pEditor->AddListener(this); + // create a proxy that reacts on notification on behalf of the editor + InstrumentEditorProxy* pProxy = new InstrumentEditorProxy; + // borrow the instrument on behalf of the instrument editor + ::gig::Instrument* pInstrument = Borrow(ID, pProxy); + // remember the proxy and instrument for this instrument editor + pProxy->pInstrument = pInstrument; + InstrumentEditorProxiesMutex.Lock(); + InstrumentEditorProxies[pEditor] = pProxy; + InstrumentEditorProxiesMutex.Unlock(); + // launch the instrument editor for the given instrument + pEditor->Launch(pInstrument, sDataType, sDataVersion); + } + + /** + * Will be called by the respective instrument editor once it left its + * Main() loop. That way we can handle cleanup before its thread finally + * dies. + * + * @param pSender - instrument editor that stops execution + */ + void InstrumentResourceManager::OnInstrumentEditorQuit(InstrumentEditor* pSender) { + dmsg(1,("InstrumentResourceManager: instrument editor quit, doing cleanup\n")); + // hand back instrument and free proxy + InstrumentEditorProxiesMutex.Lock(); + if (InstrumentEditorProxies.count(pSender)) { + InstrumentEditorProxy* pProxy = + dynamic_cast( + InstrumentEditorProxies[pSender] + ); + InstrumentEditorProxies.erase(pSender); + InstrumentEditorProxiesMutex.Unlock(); + HandBack(pProxy->pInstrument, pProxy); + if (pProxy) delete pProxy; + } else { + InstrumentEditorProxiesMutex.Unlock(); + std::cerr << "Eeeek, could not find instrument editor proxy, this is a bug!\n" << std::flush; + } + + // Note that we don't need to free the editor here. As it + // derives from Thread, it will delete itself when the thread + // dies. + } + + void InstrumentResourceManager::OnSamplesToBeRemoved(std::set Samples, InstrumentEditor* pSender) { + if (Samples.empty()) { + std::cerr << "gig::InstrumentResourceManager: WARNING, " + "OnSamplesToBeRemoved() called with empty list, this " + "is a bug!\n" << std::flush; + return; + } + // TODO: ATM we assume here that all samples are from the same file + ::gig::Sample* pFirstSample = (::gig::Sample*) *Samples.begin(); + ::gig::File* pCriticalFile = dynamic_cast< ::gig::File*>(pFirstSample->GetParent()); + // completely suspend all engines that use that same file + SuspendEnginesUsing(pCriticalFile); + } + + void InstrumentResourceManager::OnSamplesRemoved(InstrumentEditor* pSender) { + // resume all previously, completely suspended engines + // (we don't have to un-cache the removed samples here, since that is + // automatically done by the gig::Sample destructor) + ResumeAllEngines(); + } + + void InstrumentResourceManager::OnDataStructureToBeChanged(void* pStruct, String sStructType, InstrumentEditor* pSender) { + //TODO: remove code duplication + if (sStructType == "gig::File") { + // completely suspend all engines that use that file + ::gig::File* pFile = (::gig::File*) pStruct; + SuspendEnginesUsing(pFile); + } else if (sStructType == "gig::Instrument") { + // completely suspend all engines that use that instrument + ::gig::Instrument* pInstrument = (::gig::Instrument*) pStruct; + SuspendEnginesUsing(pInstrument); + } else if (sStructType == "gig::Region") { + // only advice the engines to suspend the given region, so they'll + // only ignore that region (and probably already other suspended + // ones), but beside that continue normal playback + ::gig::Region* pRegion = (::gig::Region*) pStruct; + ::gig::Instrument* pInstrument = + (::gig::Instrument*) pRegion->GetParent(); + Lock(); + std::set engines = + GetEnginesUsing(pInstrument, false/*don't lock again*/); + std::set::iterator iter = engines.begin(); + std::set::iterator end = engines.end(); + for (; iter != end; ++iter) (*iter)->Suspend(pRegion); + Unlock(); + } else if (sStructType == "gig::DimensionRegion") { + // only advice the engines to suspend the given DimensionRegions's + // parent region, so they'll only ignore that region (and probably + // already other suspended ones), but beside that continue normal + // playback + ::gig::DimensionRegion* pDimReg = + (::gig::DimensionRegion*) pStruct; + ::gig::Region* pRegion = pDimReg->GetParent(); + ::gig::Instrument* pInstrument = + (::gig::Instrument*) pRegion->GetParent(); + Lock(); + std::set engines = + GetEnginesUsing(pInstrument, false/*don't lock again*/); + std::set::iterator iter = engines.begin(); + std::set::iterator end = engines.end(); + for (; iter != end; ++iter) (*iter)->Suspend(pRegion); + Unlock(); + } else { + std::cerr << "gig::InstrumentResourceManager: ERROR, unknown data " + "structure '" << sStructType << "' requested to be " + "suspended by instrument editor. This is a bug!\n" + << std::flush; + //TODO: we should inform the instrument editor that something seriously went wrong + } + } + + void InstrumentResourceManager::OnDataStructureChanged(void* pStruct, String sStructType, InstrumentEditor* pSender) { + //TODO: remove code duplication + if (sStructType == "gig::File") { + // resume all previously suspended engines + ResumeAllEngines(); + } else if (sStructType == "gig::Instrument") { + // resume all previously suspended engines + ResumeAllEngines(); + } else if (sStructType == "gig::Region") { + // advice the engines to resume the given region, that is to + // using it for playback again + ::gig::Region* pRegion = (::gig::Region*) pStruct; + ::gig::Instrument* pInstrument = + (::gig::Instrument*) pRegion->GetParent(); + Lock(); + std::set engines = + GetEnginesUsing(pInstrument, false/*don't lock again*/); + std::set::iterator iter = engines.begin(); + std::set::iterator end = engines.end(); + for (; iter != end; ++iter) (*iter)->Resume(pRegion); + Unlock(); + } else if (sStructType == "gig::DimensionRegion") { + // advice the engines to resume the given DimensionRegion's parent + // region, that is to using it for playback again + ::gig::DimensionRegion* pDimReg = + (::gig::DimensionRegion*) pStruct; + ::gig::Region* pRegion = pDimReg->GetParent(); + ::gig::Instrument* pInstrument = + (::gig::Instrument*) pRegion->GetParent(); + Lock(); + std::set engines = + GetEnginesUsing(pInstrument, false/*don't lock again*/); + std::set::iterator iter = engines.begin(); + std::set::iterator end = engines.end(); + for (; iter != end; ++iter) (*iter)->Resume(pRegion); + Unlock(); + } else { + std::cerr << "gig::InstrumentResourceManager: ERROR, unknown data " + "structure '" << sStructType << "' requested to be " + "resumed by instrument editor. This is a bug!\n" + << std::flush; + //TODO: we should inform the instrument editor that something seriously went wrong + } + } + + void InstrumentResourceManager::OnSampleReferenceChanged(void* pOldSample, void* pNewSample, InstrumentEditor* pSender) { + // uncache old sample in case it's not used by anybody anymore + if (pOldSample) { + Lock(); + ::gig::Sample* pSample = (::gig::Sample*) pOldSample; + ::gig::File* pFile = (::gig::File*) pSample->GetParent(); + std::vector< ::gig::Instrument*> instruments = + GetInstrumentsCurrentlyUsedOf(pFile, false/*don't lock again*/); + for (int i = 0; i < instruments.size(); i++) + if (!SampleReferencedByInstrument(pSample, instruments[i])) + UncacheInitialSamples(pSample); + Unlock(); + } + // make sure new sample reference is cached + if (pNewSample) { + Lock(); + ::gig::Sample* pSample = (::gig::Sample*) pNewSample; + ::gig::File* pFile = (::gig::File*) pSample->GetParent(); + // get all engines that use that same gig::File + std::set engines = GetEnginesUsing(pFile, false/*don't lock again*/); + std::set::iterator iter = engines.begin(); + std::set::iterator end = engines.end(); + for (; iter != end; ++iter) + CacheInitialSamples(pSample, *iter); + Unlock(); + } + } + ::gig::Instrument* InstrumentResourceManager::Create(instrument_id_t Key, InstrumentConsumer* pConsumer, void*& pArg) { - // get gig file from inernal gig file manager - ::gig::File* pGig = Gigs.Borrow(Key.FileName, (GigConsumer*) Key.iInstrument); // conversion kinda hackish :/ + // get gig file from internal gig file manager + ::gig::File* pGig = Gigs.Borrow(Key.FileName, (GigConsumer*) Key.Index); // conversion kinda hackish :/ // we pass this to the progress callback mechanism of libgig progress_callback_arg_t callbackArg; @@ -70,12 +390,12 @@ progress.callback = OnInstrumentLoadingProgress; progress.custom = &callbackArg; - dmsg(1,("Loading gig instrument...")); - ::gig::Instrument* pInstrument = pGig->GetInstrument(Key.iInstrument, &progress); + dmsg(1,("Loading gig instrument ('%s',%d)...",Key.FileName.c_str(),Key.Index)); + ::gig::Instrument* pInstrument = pGig->GetInstrument(Key.Index, &progress); if (!pInstrument) { std::stringstream msg; - msg << "There's no instrument with index " << Key.iInstrument << "."; - throw InstrumentResourceManagerException(msg.str()); + msg << "There's no instrument with index " << Key.Index << "."; + throw InstrumentManagerException(msg.str()); } pGig->GetFirstSample(); // just to force complete instrument loading dmsg(1,("OK\n")); @@ -87,14 +407,14 @@ while (pRgn) { // we randomly schedule 90% for the .gig file loading and the remaining 10% now for sample caching const float localProgress = 0.9f + 0.1f * (float) iRegion / (float) pInstrument->Regions; - DispatchResourceProgressEvent(Key, localProgress); - + DispatchResourceProgressEvent(Key, localProgress); + if (pRgn->GetSample() && !pRgn->GetSample()->GetCache().Size) { dmsg(2,("C")); - CacheInitialSamples(pRgn->GetSample(), dynamic_cast(pConsumer)); + CacheInitialSamples(pRgn->GetSample(), (gig::EngineChannel*) pConsumer); } for (uint i = 0; i < pRgn->DimensionRegions; i++) { - CacheInitialSamples(pRgn->pDimensionRegions[i]->pSample, dynamic_cast(pConsumer)); + CacheInitialSamples(pRgn->pDimensionRegions[i]->pSample, (gig::EngineChannel*) pConsumer); } pRgn = pInstrument->GetNextRegion(); @@ -105,14 +425,17 @@ // we need the following for destruction later instr_entry_t* pEntry = new instr_entry_t; - pEntry->iInstrument = Key.iInstrument; + pEntry->ID.FileName = Key.FileName; + pEntry->ID.Index = Key.Index; pEntry->pGig = pGig; gig::EngineChannel* pEngineChannel = dynamic_cast(pConsumer); // and we save this to check if we need to reallocate for a engine with higher value of 'MaxSamplesPerSecond' pEntry->MaxSamplesPerCycle = - (pEngineChannel->GetEngine()) ? dynamic_cast(pEngineChannel->GetEngine())->pAudioOutputDevice->MaxSamplesPerCycle() - : GIG_RESOURCE_MANAGER_DEFAULT_MAX_SAMPLES_PER_CYCLE; + (!pEngineChannel) ? 0 /* don't care for instrument editors */ : + (pEngineChannel->GetEngine()) ? + dynamic_cast(pEngineChannel->GetEngine())->pAudioOutputDevice->MaxSamplesPerCycle() + : GIG_RESOURCE_MANAGER_DEFAULT_MAX_SAMPLES_PER_CYCLE; pArg = pEntry; return pInstrument; @@ -120,7 +443,8 @@ void InstrumentResourceManager::Destroy( ::gig::Instrument* pResource, void* pArg) { instr_entry_t* pEntry = (instr_entry_t*) pArg; - Gigs.HandBack(pEntry->pGig, (GigConsumer*) pEntry->iInstrument); // conversion kinda hackish :/ + // we don't need the .gig file here anymore + Gigs.HandBack(pEntry->pGig, (GigConsumer*) pEntry->ID.Index); // conversion kinda hackish :/ delete pEntry; } @@ -128,7 +452,7 @@ instr_entry_t* pEntry = (instr_entry_t*) pArg; gig::EngineChannel* pEngineChannel = dynamic_cast(pConsumer); uint maxSamplesPerCycle = - (pEngineChannel->GetEngine()) ? dynamic_cast(pEngineChannel->GetEngine())->pAudioOutputDevice->MaxSamplesPerCycle() + (pEngineChannel && pEngineChannel->GetEngine()) ? dynamic_cast(pEngineChannel->GetEngine())->pAudioOutputDevice->MaxSamplesPerCycle() : GIG_RESOURCE_MANAGER_DEFAULT_MAX_SAMPLES_PER_CYCLE; if (pEntry->MaxSamplesPerCycle < maxSamplesPerCycle) { Update(pResource, pConsumer); @@ -136,31 +460,98 @@ } /** + * Give back an instrument. This should be used instead of + * HandBack if there are some dimension regions that are still in + * use. (When an instrument is changed, the voices currently + * playing are allowed to keep playing with the old instrument + * until note off arrives. New notes will use the new instrument.) + */ + void InstrumentResourceManager::HandBackInstrument(::gig::Instrument* pResource, InstrumentConsumer* pConsumer, + RTList< ::gig::DimensionRegion*>* pDimRegionsInUse) { + DimRegInfoMutex.Lock(); + for (RTList< ::gig::DimensionRegion*>::Iterator i = pDimRegionsInUse->first() ; i != pDimRegionsInUse->end() ; i++) { + DimRegInfo[*i].refCount++; + SampleRefCount[(*i)->pSample]++; + } + HandBack(pResource, pConsumer, true); + DimRegInfoMutex.Unlock(); + } + + /** + * Give back a dimension region that belongs to an instrument that + * was previously handed back. + */ + void InstrumentResourceManager::HandBackDimReg(::gig::DimensionRegion* pDimReg) { + DimRegInfoMutex.Lock(); + dimreg_info_t& dimRegInfo = DimRegInfo[pDimReg]; + int dimRegRefCount = --dimRegInfo.refCount; + int sampleRefCount = --SampleRefCount[pDimReg->pSample]; + if (dimRegRefCount == 0) { + ::gig::File* gig = dimRegInfo.file; + ::RIFF::File* riff = dimRegInfo.riff; + DimRegInfo.erase(pDimReg); + // TODO: we could delete Region and Instrument here if + // they have become unused + + if (sampleRefCount == 0) { + SampleRefCount.erase(pDimReg->pSample); + + if (gig) { + gig->DeleteSample(pDimReg->pSample); + if (!gig->GetFirstSample()) { + dmsg(2,("No more samples in use - freeing gig\n")); + delete gig; + delete riff; + } + } + } + } + DimRegInfoMutex.Unlock(); + } + + /** + * Just a wrapper around the other @c CacheInitialSamples() method. + * + * @param pSample - points to the sample to be cached + * @param pEngine - pointer to Gig Engine Channel which caused this call + * (may be NULL, in this case default amount of samples + * will be cached) + */ + void InstrumentResourceManager::CacheInitialSamples(::gig::Sample* pSample, gig::EngineChannel* pEngineChannel) { + gig::Engine* pEngine = + (pEngineChannel && pEngineChannel->GetEngine()) ? + dynamic_cast(pEngineChannel->GetEngine()) : NULL; + CacheInitialSamples(pSample, pEngine); + } + + /** * Caches a certain size at the beginning of the given sample in RAM. If the * sample is very short, the whole sample will be loaded into RAM and thus * no disk streaming is needed for this sample. Caching an initial part of * samples is needed to compensate disk reading latency. * * @param pSample - points to the sample to be cached - * @param pEngineChannel - pointer to Gig Engine Channel which caused this call + * @param pEngine - pointer to Gig Engine which caused this call + * (may be NULL, in this case default amount of samples + * will be cached) */ - void InstrumentResourceManager::CacheInitialSamples(::gig::Sample* pSample, gig::EngineChannel* pEngineChannel) { + void InstrumentResourceManager::CacheInitialSamples(::gig::Sample* pSample, gig::Engine* pEngine) { if (!pSample) { dmsg(4,("gig::InstrumentResourceManager: Skipping sample (pSample == NULL)\n")); return; } if (!pSample->SamplesTotal) return; // skip zero size samples - if (pSample->SamplesTotal <= NUM_RAM_PRELOAD_SAMPLES) { + if (pSample->SamplesTotal <= CONFIG_PRELOAD_SAMPLES) { // Sample is too short for disk streaming, so we load the whole - // sample into RAM and place 'pAudioIO->FragmentSize << MAX_PITCH' + // sample into RAM and place 'pAudioIO->FragmentSize << CONFIG_MAX_PITCH' // number of '0' samples (silence samples) behind the official buffer // border, to allow the interpolator do it's work even at the end of // the sample. const uint maxSamplesPerCycle = - (pEngineChannel->GetEngine()) ? dynamic_cast(pEngineChannel->GetEngine())->pAudioOutputDevice->MaxSamplesPerCycle() - : GIG_RESOURCE_MANAGER_DEFAULT_MAX_SAMPLES_PER_CYCLE; - const uint neededSilenceSamples = (maxSamplesPerCycle << MAX_PITCH) + 3; + (pEngine) ? pEngine->pAudioOutputDevice->MaxSamplesPerCycle() + : GIG_RESOURCE_MANAGER_DEFAULT_MAX_SAMPLES_PER_CYCLE; + const uint neededSilenceSamples = (maxSamplesPerCycle << CONFIG_MAX_PITCH) + 3; const uint currentlyCachedSilenceSamples = pSample->GetCache().NullExtensionSize / pSample->FrameSize; if (currentlyCachedSilenceSamples < neededSilenceSamples) { dmsg(3,("Caching whole sample (sample name: \"%s\", sample size: %d)\n", pSample->pInfo->Name.c_str(), pSample->SamplesTotal)); @@ -168,13 +559,188 @@ dmsg(4,("Cached %d Bytes, %d silence bytes.\n", buf.Size, buf.NullExtensionSize)); } } - else { // we only cache NUM_RAM_PRELOAD_SAMPLES and stream the other sample points from disk - if (!pSample->GetCache().Size) pSample->LoadSampleData(NUM_RAM_PRELOAD_SAMPLES); + else { // we only cache CONFIG_PRELOAD_SAMPLES and stream the other sample points from disk + if (!pSample->GetCache().Size) pSample->LoadSampleData(CONFIG_PRELOAD_SAMPLES); } if (!pSample->GetCache().Size) std::cerr << "Unable to cache sample - maybe memory full!" << std::endl << std::flush; } + void InstrumentResourceManager::UncacheInitialSamples(::gig::Sample* pSample) { + dmsg(1,("Uncaching sample %x\n",pSample)); + if (pSample->GetCache().Size) pSample->ReleaseSampleData(); + } + + /** + * Returns a list with all instruments currently in use, that are part of + * the given file. + * + * @param pFile - search criteria + * @param bLock - whether we should lock (mutex) the instrument manager + * during this call and unlock at the end of this call + */ + std::vector< ::gig::Instrument*> InstrumentResourceManager::GetInstrumentsCurrentlyUsedOf(::gig::File* pFile, bool bLock) { + if (bLock) Lock(); + std::vector< ::gig::Instrument*> result; + std::vector< ::gig::Instrument*> allInstruments = Resources(false/*don't lock again*/); + for (int i = 0; i < allInstruments.size(); i++) + if ( + (::gig::File*) allInstruments[i]->GetParent() + == pFile + ) result.push_back(allInstruments[i]); + if (bLock) Unlock(); + return result; + } + + /** + * Returns a list with all gig Engines that are currently using the given + * instrument. + * + * @param pInstrument - search criteria + * @param bLock - whether we should lock (mutex) the instrument manager + * during this call and unlock at the end of this call + */ + std::set InstrumentResourceManager::GetEnginesUsing(::gig::Instrument* pInstrument, bool bLock) { + if (bLock) Lock(); + std::set result; + std::set*> consumers = ConsumersOf(pInstrument); + std::set*>::iterator iter = consumers.begin(); + std::set*>::iterator end = consumers.end(); + for (; iter != end; ++iter) { + gig::EngineChannel* pEngineChannel = dynamic_cast(*iter); + if (!pEngineChannel) continue; + gig::Engine* pEngine = dynamic_cast(pEngineChannel->GetEngine()); + if (!pEngine) continue; + result.insert(pEngine); + } + if (bLock) Unlock(); + return result; + } + + /** + * Returns a list with all gig Engines that are currently using an + * instrument that is part of the given instrument file. + * + * @param pFile - search criteria + * @param bLock - whether we should lock (mutex) the instrument manager + * during this call and unlock at the end of this call + */ + std::set InstrumentResourceManager::GetEnginesUsing(::gig::File* pFile, bool bLock) { + if (bLock) Lock(); + // get all instruments (currently in usage) that use that same gig::File + std::vector< ::gig::Instrument*> instrumentsOfInterest = + GetInstrumentsCurrentlyUsedOf(pFile, false/*don't lock again*/); + + // get all engines that use that same gig::File + std::set result; + { + for (int i = 0; i < instrumentsOfInterest.size(); i++) { + std::set*> consumers = ConsumersOf(instrumentsOfInterest[i]); + std::set*>::iterator iter = consumers.begin(); + std::set*>::iterator end = consumers.end(); + for (; iter != end; ++iter) { + gig::EngineChannel* pEngineChannel = dynamic_cast(*iter); + if (!pEngineChannel) continue; + gig::Engine* pEngine = dynamic_cast(pEngineChannel->GetEngine()); + if (!pEngine) continue; + // the unique, sorted container std::set makes + // sure we won't have duplicates + result.insert(pEngine); + } + } + } + if (bLock) Unlock(); + return result; + } + + /** + * Returns @c true in case the given sample is referenced somewhere by the + * given instrument, @c false otherwise. + * + * @param pSample - sample reference + * @param pInstrument - instrument that might use that sample + */ + bool InstrumentResourceManager::SampleReferencedByInstrument(::gig::Sample* pSample, ::gig::Instrument* pInstrument) { + for ( + ::gig::Region* pRegion = pInstrument->GetFirstRegion(); + pRegion; pRegion = pInstrument->GetNextRegion() + ) { + for ( + int i = 0; i < pRegion->DimensionRegions && + pRegion->pDimensionRegions[i]; i++ + ) { + if (pRegion->pDimensionRegions[i]->pSample == pSample) + return true; + } + } + return false; + } + + /** + * Suspend all gig engines that use the given instrument. This means + * completely stopping playback on those engines and killing all their + * voices and disk streams. This method will block until all voices AND + * their disk streams are finally deleted and the engine turned into a + * complete idle loop. + * + * All @c SuspendEnginesUsing() methods only serve one thread by one and + * block all other threads until the current active thread called + * @c ResumeAllEngines() . + * + * @param pInstrument - search criteria + */ + void InstrumentResourceManager::SuspendEnginesUsing(::gig::Instrument* pInstrument) { + // make sure no other thread suspends whole engines at the same time + suspendedEnginesMutex.Lock(); + // get all engines that use that same gig::Instrument + suspendedEngines = GetEnginesUsing(pInstrument, true/*lock*/); + // finally, completely suspend all engines that use that same gig::Instrument + std::set::iterator iter = suspendedEngines.begin(); + std::set::iterator end = suspendedEngines.end(); + for (; iter != end; ++iter) (*iter)->SuspendAll(); + } + + /** + * Suspend all gig engines that use the given instrument file. This means + * completely stopping playback on those engines and killing all their + * voices and disk streams. This method will block until all voices AND + * their disk streams are finally deleted and the engine turned into a + * complete idle loop. + * + * All @c SuspendEnginesUsing() methods only serve one thread by one and + * block all other threads until the current active thread called + * @c ResumeAllEngines() . + * + * @param pFile - search criteria + */ + void InstrumentResourceManager::SuspendEnginesUsing(::gig::File* pFile) { + // make sure no other thread suspends whole engines at the same time + suspendedEnginesMutex.Lock(); + // get all engines that use that same gig::File + suspendedEngines = GetEnginesUsing(pFile, true/*lock*/); + // finally, completely suspend all engines that use that same gig::File + std::set::iterator iter = suspendedEngines.begin(); + std::set::iterator end = suspendedEngines.end(); + for (; iter != end; ++iter) (*iter)->SuspendAll(); + } + + /** + * MUST be called after one called one of the @c SuspendEnginesUsing() + * methods, to resume normal playback on all previously suspended engines. + * As it's only possible for one thread to suspend whole engines at the + * same time, this method doesn't take any arguments. + */ + void InstrumentResourceManager::ResumeAllEngines() { + // resume all previously completely suspended engines + std::set::iterator iter = suspendedEngines.begin(); + std::set::iterator end = suspendedEngines.end(); + for (; iter != end; ++iter) (*iter)->ResumeAll(); + // no more suspended engines ... + suspendedEngines.clear(); + // allow another thread to suspend whole engines + suspendedEnginesMutex.Unlock(); + } + // internal gig file manager @@ -190,8 +756,53 @@ void InstrumentResourceManager::GigResourceManager::Destroy(::gig::File* pResource, void* pArg) { dmsg(1,("Freeing gig file from memory...")); - delete pResource; - delete (::RIFF::File*) pArg; + + // Delete as much as possible of the gig file. Some of the + // dimension regions and samples may still be in use - these + // will be deleted later by the HandBackDimReg function. + bool deleteFile = true; + ::gig::Instrument* nextInstrument; + for (::gig::Instrument* instrument = pResource->GetFirstInstrument() ; + instrument ; + instrument = nextInstrument) { + nextInstrument = pResource->GetNextInstrument(); + bool deleteInstrument = true; + ::gig::Region* nextRegion; + for (::gig::Region *region = instrument->GetFirstRegion() ; + region ; + region = nextRegion) { + nextRegion = instrument->GetNextRegion(); + bool deleteRegion = true; + for (int i = 0 ; i < region->DimensionRegions ; i++) + { + ::gig::DimensionRegion *d = region->pDimensionRegions[i]; + std::map< ::gig::DimensionRegion*, dimreg_info_t>::iterator iter = parent->DimRegInfo.find(d); + if (iter != parent->DimRegInfo.end()) { + dimreg_info_t& dimRegInfo = (*iter).second; + dimRegInfo.file = pResource; + dimRegInfo.riff = (::RIFF::File*)pArg; + deleteFile = deleteInstrument = deleteRegion = false; + } + } + if (deleteRegion) instrument->DeleteRegion(region); + } + if (deleteInstrument) pResource->DeleteInstrument(instrument); + } + if (deleteFile) { + delete pResource; + delete (::RIFF::File*) pArg; + } else { + dmsg(2,("keeping some samples that are in use...")); + ::gig::Sample* nextSample; + for (::gig::Sample* sample = pResource->GetFirstSample() ; + sample ; + sample = nextSample) { + nextSample = pResource->GetNextSample(); + if (parent->SampleRefCount.find(sample) == parent->SampleRefCount.end()) { + pResource->DeleteSample(sample); + } + } + } dmsg(1,("OK\n")); }