--- linuxsampler/trunk/src/engines/gig/InstrumentResourceManager.cpp 2008/02/03 16:21:38 1662 +++ linuxsampler/trunk/src/engines/gig/InstrumentResourceManager.cpp 2009/10/23 17:53:17 2012 @@ -3,7 +3,7 @@ * LinuxSampler - modular, streaming capable sampler * * * * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck * - * Copyright (C) 2005 - 2008 Christian Schoenebeck * + * Copyright (C) 2005 - 2009 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 * @@ -24,6 +24,8 @@ #include #include "InstrumentResourceManager.h" +#include "EngineChannel.h" +#include "Engine.h" #include "../../common/global_private.h" #include "../../plugins/InstrumentEditorFactory.h" @@ -92,15 +94,6 @@ 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); @@ -146,37 +139,94 @@ } InstrumentResourceManager::instrument_info_t InstrumentResourceManager::GetInstrumentInfo(instrument_id_t ID) throw (InstrumentManagerException) { - std::vector result; + Lock(); + ::gig::Instrument* pInstrument = Resource(ID, false); + bool loaded = (pInstrument != NULL); + if (!loaded) Unlock(); + ::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(!loaded) { + riff = new ::RIFF::File(ID.FileName); + gig = new ::gig::File(riff); + gig->SetAutoLoad(false); // avoid time consuming samples scanning + 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; + for (int i = 0; i < 128; i++) { info.KeyBindings[i] = info.KeySwitchBindings[i] = 0; } + + ::gig::File* pFile = (::gig::File*) pInstrument->GetParent(); + + if (pFile->pVersion) { + info.FormatVersion = ToString(pFile->pVersion->major); + info.Product = pFile->pInfo->Product; + info.Artists = pFile->pInfo->Artists; } + info.InstrumentName = pInstrument->pInfo->Name; + + ::gig::Region* pRegion = pInstrument->GetFirstRegion(); + while (pRegion) { + int low = pRegion->KeyRange.low; + int high = pRegion->KeyRange.high; + if (low < 0 || low > 127 || high < 0 || high > 127 || low > high) { + std::cerr << "Invalid key range: " << low << " - " << high << std::endl; + } else { + for (int i = low; i <= high; i++) info.KeyBindings[i] = 1; + } + + pRegion = pInstrument->GetNextRegion(); + } + + if (loaded) { // retrieve keyswitching only if the instrument is fully loaded. + + // only return keyswitch range if keyswitching is used + bool hasKeyswitches = false; + for (::gig::Region* pRegion = pInstrument->GetFirstRegion() ; + pRegion && !hasKeyswitches ; + pRegion = pInstrument->GetNextRegion()) { + for (int i = 0 ; i < pRegion->Dimensions ; i++) { + if (pRegion->pDimensionDefinitions[i].dimension == ::gig::dimension_keyboard) { + hasKeyswitches = true; + break; + } + } + } + + if (hasKeyswitches) { + int low = pInstrument->DimensionKeyRange.low; + int high = pInstrument->DimensionKeyRange.high; + if (low < 0 || low > 127 || high < 0 || high > 127 || low > high) { + std::cerr << "Invalid keyswitch range: " << low << " - " << high << std::endl; + } else { + for (int i = low; i <= high; i++) info.KeySwitchBindings[i] = 1; + } + } + } + + if (loaded) Unlock(); + if (gig) delete gig; if (riff) delete riff; return info; } catch (::RIFF::Exception e) { + if (loaded) Unlock(); if (gig) delete gig; if (riff) delete riff; throw InstrumentManagerException(e.Message); } catch (...) { + if (loaded) Unlock(); 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) { + InstrumentEditor* InstrumentResourceManager::LaunchInstrumentEditor(instrument_id_t ID, void* pUserData) throw (InstrumentManagerException) { const String sDataType = GetInstrumentDataStructureName(ID); const String sDataVersion = GetInstrumentDataStructureVersion(ID); // find instrument editors capable to handle given instrument @@ -203,23 +253,25 @@ InstrumentEditorProxies.add(pProxy); InstrumentEditorProxiesMutex.Unlock(); // launch the instrument editor for the given instrument - pEditor->Launch(pInstrument, sDataType, sDataVersion); + pEditor->Launch(pInstrument, sDataType, sDataVersion, pUserData); // register the instrument editor as virtual MIDI device as well ... VirtualMidiDevice* pVirtualMidiDevice = dynamic_cast(pEditor); if (!pVirtualMidiDevice) { std::cerr << "Instrument editor not a virtual MIDI device\n" << std::flush; - return; + return pEditor; } // NOTE: for now connect the virtual MIDI keyboard of the instrument editor (if any) with all engine channels that have the same instrument as the editor was opened for ( other ideas ? ) Lock(); - std::set engineChannels = + std::set engineChannels = GetEngineChannelsUsing(pInstrument, false/*don't lock again*/); - std::set::iterator iter = engineChannels.begin(); - std::set::iterator end = engineChannels.end(); - for (; iter != end; ++iter) (*iter)->Connect(pVirtualMidiDevice); + std::set::iterator iter = engineChannels.begin(); + std::set::iterator end = engineChannels.end(); + for (; iter != end; ++iter) (static_cast(*iter))->Connect(pVirtualMidiDevice); Unlock(); + + return pEditor; } /** @@ -263,10 +315,10 @@ if (pVirtualMidiDevice) { Lock(); // NOTE: see note in LaunchInstrumentEditor() - std::set engineChannels = + std::set engineChannels = GetEngineChannelsUsing(pInstrument, false/*don't lock again*/); - std::set::iterator iter = engineChannels.begin(); - std::set::iterator end = engineChannels.end(); + std::set::iterator iter = engineChannels.begin(); + std::set::iterator end = engineChannels.end(); for (; iter != end; ++iter) (*iter)->Disconnect(pVirtualMidiDevice); Unlock(); } else { @@ -373,10 +425,10 @@ ::gig::Instrument* pInstrument = (::gig::Instrument*) pRegion->GetParent(); Lock(); - std::set engines = + std::set engines = GetEnginesUsing(pInstrument, false/*don't lock again*/); - std::set::iterator iter = engines.begin(); - std::set::iterator end = engines.end(); + 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") { @@ -390,10 +442,10 @@ ::gig::Instrument* pInstrument = (::gig::Instrument*) pRegion->GetParent(); Lock(); - std::set engines = + std::set engines = GetEnginesUsing(pInstrument, false/*don't lock again*/); - std::set::iterator iter = engines.begin(); - std::set::iterator end = engines.end(); + std::set::iterator iter = engines.begin(); + std::set::iterator end = engines.end(); for (; iter != end; ++iter) (*iter)->Suspend(pRegion); Unlock(); } else { @@ -413,6 +465,28 @@ } else if (sStructType == "gig::Instrument") { // resume all previously suspended engines ResumeAllEngines(); + } else if (sStructType == "gig::Sample") { + // we're assuming here, that OnDataStructureToBeChanged() with + // "gig::File" was called previously, so we won't resume anything + // here, but just re-cache the given sample + Lock(); + ::gig::Sample* pSample = (::gig::Sample*) pStruct; + ::gig::File* pFile = (::gig::File*) pSample->GetParent(); + UncacheInitialSamples(pSample); + // now re-cache ... + 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])) { + std::set engineChannels = + GetEngineChannelsUsing(instruments[i], false/*don't lock again*/); + std::set::iterator iter = engineChannels.begin(); + std::set::iterator end = engineChannels.end(); + for (; iter != end; ++iter) + CacheInitialSamples(pSample, *iter); + } + } + Unlock(); } else if (sStructType == "gig::Region") { // advice the engines to resume the given region, that is to // using it for playback again @@ -420,10 +494,10 @@ ::gig::Instrument* pInstrument = (::gig::Instrument*) pRegion->GetParent(); Lock(); - std::set engines = + std::set engines = GetEnginesUsing(pInstrument, false/*don't lock again*/); - std::set::iterator iter = engines.begin(); - std::set::iterator end = engines.end(); + 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") { @@ -435,10 +509,10 @@ ::gig::Instrument* pInstrument = (::gig::Instrument*) pRegion->GetParent(); Lock(); - std::set engines = + std::set engines = GetEnginesUsing(pInstrument, false/*don't lock again*/); - std::set::iterator iter = engines.begin(); - std::set::iterator end = engines.end(); + std::set::iterator iter = engines.begin(); + std::set::iterator end = engines.end(); for (; iter != end; ++iter) (*iter)->Resume(pRegion); Unlock(); } else { @@ -456,11 +530,16 @@ Lock(); ::gig::Sample* pSample = (::gig::Sample*) pOldSample; ::gig::File* pFile = (::gig::File*) pSample->GetParent(); + bool bSampleStillInUse = false; 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); + for (int i = 0; i < instruments.size(); i++) { + if (SampleReferencedByInstrument(pSample, instruments[i])) { + bSampleStillInUse = true; + break; + } + } + if (!bSampleStillInUse) UncacheInitialSamples(pSample); Unlock(); } // make sure new sample reference is cached @@ -469,9 +548,9 @@ ::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(); + 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(); @@ -512,10 +591,10 @@ if (pRgn->GetSample() && !pRgn->GetSample()->GetCache().Size) { dmsg(2,("C")); - CacheInitialSamples(pRgn->GetSample(), (gig::EngineChannel*) pConsumer); + CacheInitialSamples(pRgn->GetSample(), (EngineChannel*) pConsumer); } for (uint i = 0; i < pRgn->DimensionRegions; i++) { - CacheInitialSamples(pRgn->pDimensionRegions[i]->pSample, (gig::EngineChannel*) pConsumer); + CacheInitialSamples(pRgn->pDimensionRegions[i]->pSample, (EngineChannel*) pConsumer); } pRgn = pInstrument->GetNextRegion(); @@ -530,12 +609,12 @@ pEntry->ID.Index = Key.Index; pEntry->pGig = pGig; - gig::EngineChannel* pEngineChannel = dynamic_cast(pConsumer); + 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) ? 0 /* don't care for instrument editors */ : (pEngineChannel->GetEngine()) ? - dynamic_cast(pEngineChannel->GetEngine())->pAudioOutputDevice->MaxSamplesPerCycle() + dynamic_cast(pEngineChannel->GetEngine())->pAudioOutputDevice->MaxSamplesPerCycle() : GIG_RESOURCE_MANAGER_DEFAULT_MAX_SAMPLES_PER_CYCLE; pArg = pEntry; @@ -551,63 +630,29 @@ void InstrumentResourceManager::OnBorrow(::gig::Instrument* pResource, InstrumentConsumer* pConsumer, void*& pArg) { instr_entry_t* pEntry = (instr_entry_t*) pArg; - gig::EngineChannel* pEngineChannel = dynamic_cast(pConsumer); + EngineChannel* pEngineChannel = dynamic_cast(pConsumer); uint maxSamplesPerCycle = - (pEngineChannel && 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); } } - /** - * 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(); + void InstrumentResourceManager::DeleteRegionIfNotUsed(::gig::DimensionRegion* pRegion, region_info_t* pRegInfo) { + // TODO: we could delete Region and Instrument here if they have become unused } - - /** - * 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; - } - } + void InstrumentResourceManager::DeleteSampleIfNotUsed(::gig::Sample* pSample, region_info_t* pRegInfo) { + ::gig::File* gig = pRegInfo->file; + ::RIFF::File* riff = static_cast< ::RIFF::File*>(pRegInfo->pArg); + if (gig) { + gig->DeleteSample(pSample); + if (!gig->GetFirstSample()) { + dmsg(2,("No more samples in use - freeing gig\n")); + delete gig; + delete riff; } } - DimRegInfoMutex.Unlock(); } /** @@ -618,10 +663,10 @@ * (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 = + void InstrumentResourceManager::CacheInitialSamples(::gig::Sample* pSample, EngineChannel* pEngineChannel) { + Engine* pEngine = (pEngineChannel && pEngineChannel->GetEngine()) ? - dynamic_cast(pEngineChannel->GetEngine()) : NULL; + dynamic_cast(pEngineChannel->GetEngine()) : NULL; CacheInitialSamples(pSample, pEngine); } @@ -636,7 +681,7 @@ * (may be NULL, in this case default amount of samples * will be cached) */ - void InstrumentResourceManager::CacheInitialSamples(::gig::Sample* pSample, gig::Engine* pEngine) { + void InstrumentResourceManager::CacheInitialSamples(::gig::Sample* pSample, AbstractEngine* pEngine) { if (!pSample) { dmsg(4,("gig::InstrumentResourceManager: Skipping sample (pSample == NULL)\n")); return; @@ -701,14 +746,14 @@ * @param bLock - whether we should lock (mutex) the instrument manager * during this call and unlock at the end of this call */ - std::set InstrumentResourceManager::GetEngineChannelsUsing(::gig::Instrument* pInstrument, bool bLock) { + std::set InstrumentResourceManager::GetEngineChannelsUsing(::gig::Instrument* pInstrument, bool bLock) { if (bLock) Lock(); - std::set result; + 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); + EngineChannel* pEngineChannel = dynamic_cast(*iter); if (!pEngineChannel) continue; result.insert(pEngineChannel); } @@ -724,16 +769,16 @@ * @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) { + std::set InstrumentResourceManager::GetEnginesUsing(::gig::Instrument* pInstrument, bool bLock) { if (bLock) Lock(); - std::set result; + 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); + EngineChannel* pEngineChannel = dynamic_cast(*iter); if (!pEngineChannel) continue; - gig::Engine* pEngine = dynamic_cast(pEngineChannel->GetEngine()); + Engine* pEngine = dynamic_cast(pEngineChannel->GetEngine()); if (!pEngine) continue; result.insert(pEngine); } @@ -749,23 +794,23 @@ * @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) { + 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; + 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); + EngineChannel* pEngineChannel = dynamic_cast(*iter); if (!pEngineChannel) continue; - gig::Engine* pEngine = dynamic_cast(pEngineChannel->GetEngine()); + Engine* pEngine = dynamic_cast(pEngineChannel->GetEngine()); if (!pEngine) continue; // the unique, sorted container std::set makes // sure we won't have duplicates @@ -819,8 +864,8 @@ // 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(); + std::set::iterator iter = suspendedEngines.begin(); + std::set::iterator end = suspendedEngines.end(); for (; iter != end; ++iter) (*iter)->SuspendAll(); } @@ -843,8 +888,8 @@ // 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(); + std::set::iterator iter = suspendedEngines.begin(); + std::set::iterator end = suspendedEngines.end(); for (; iter != end; ++iter) (*iter)->SuspendAll(); } @@ -900,11 +945,11 @@ 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; + std::map< ::gig::DimensionRegion*, region_info_t>::iterator iter = parent->RegionInfo.find(d); + if (iter != parent->RegionInfo.end()) { + region_info_t& dimRegInfo = (*iter).second; dimRegInfo.file = pResource; - dimRegInfo.riff = (::RIFF::File*)pArg; + dimRegInfo.pArg = (::RIFF::File*)pArg; deleteFile = deleteInstrument = deleteRegion = false; } }