/[svn]/linuxsampler/trunk/src/engines/gig/InstrumentResourceManager.cpp
ViewVC logotype

Diff of /linuxsampler/trunk/src/engines/gig/InstrumentResourceManager.cpp

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1321 by schoenebeck, Tue Sep 4 01:12:49 2007 UTC revision 1852 by schoenebeck, Sun Mar 1 22:22:03 2009 UTC
# Line 3  Line 3 
3   *   LinuxSampler - modular, streaming capable sampler                     *   *   LinuxSampler - modular, streaming capable sampler                     *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *   *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
6   *   Copyright (C) 2005 - 2007 Christian Schoenebeck                       *   *   Copyright (C) 2005 - 2009 Christian Schoenebeck                       *
7   *                                                                         *   *                                                                         *
8   *   This program is free software; you can redistribute it and/or modify  *   *   This program is free software; you can redistribute it and/or modify  *
9   *   it under the terms of the GNU General Public License as published by  *   *   it under the terms of the GNU General Public License as published by  *
# Line 25  Line 25 
25    
26  #include "InstrumentResourceManager.h"  #include "InstrumentResourceManager.h"
27    
28  #include "../InstrumentEditorFactory.h"  #include "../../common/global_private.h"
29    #include "../../plugins/InstrumentEditorFactory.h"
30    
31  // We need to know the maximum number of sample points which are going to  // We need to know the maximum number of sample points which are going to
32  // be processed for each render cycle of the audio output driver, to know  // be processed for each render cycle of the audio output driver, to know
# Line 66  namespace LinuxSampler { namespace gig { Line 67  namespace LinuxSampler { namespace gig {
67    
68          // the instrument we borrowed on behalf of the editor          // the instrument we borrowed on behalf of the editor
69          ::gig::Instrument* pInstrument;          ::gig::Instrument* pInstrument;
70            // the instrument editor we work on behalf
71            InstrumentEditor* pEditor;
72      };      };
73    
74      /**      /**
# Line 114  namespace LinuxSampler { namespace gig { Line 117  namespace LinuxSampler { namespace gig {
117          return ::gig::libraryVersion();          return ::gig::libraryVersion();
118      }      }
119    
120        std::vector<InstrumentResourceManager::instrument_id_t> InstrumentResourceManager::GetInstrumentFileContent(String File) throw (InstrumentManagerException) {
121            ::RIFF::File* riff = NULL;
122            ::gig::File*  gig  = NULL;
123            try {
124                std::vector<instrument_id_t> result;
125                riff = new ::RIFF::File(File);
126                gig  = new ::gig::File(riff);
127                gig->SetAutoLoad(false); // avoid time consuming samples scanning
128                for (int i = 0; gig->GetInstrument(i); i++) {
129                    instrument_id_t id;
130                    id.FileName = File;
131                    id.Index    = i;
132                    result.push_back(id);
133                }
134                if (gig)  delete gig;
135                if (riff) delete riff;
136                return result;
137            } catch (::RIFF::Exception e) {
138                if (gig)  delete gig;
139                if (riff) delete riff;
140                throw InstrumentManagerException(e.Message);
141            } catch (...) {
142                if (gig)  delete gig;
143                if (riff) delete riff;
144                throw InstrumentManagerException("Unknown exception while trying to parse '" + File + "'");
145            }
146        }
147    
148        InstrumentResourceManager::instrument_info_t InstrumentResourceManager::GetInstrumentInfo(instrument_id_t ID) throw (InstrumentManagerException) {
149            Lock();
150            ::gig::Instrument* pInstrument = Resource(ID, false);
151            bool loaded = (pInstrument != NULL);
152            if (!loaded) Unlock();
153    
154            ::RIFF::File* riff = NULL;
155            ::gig::File*  gig  = NULL;
156            try {
157                if(!loaded) {
158                    riff = new ::RIFF::File(ID.FileName);
159                    gig  = new ::gig::File(riff);
160                    gig->SetAutoLoad(false); // avoid time consuming samples scanning
161                    pInstrument = gig->GetInstrument(ID.Index);
162                }
163    
164                if (!pInstrument) throw InstrumentManagerException("There is no instrument " + ToString(ID.Index) + " in " + ID.FileName);
165    
166                instrument_info_t info;
167                for (int i = 0; i < 128; i++) { info.KeyBindings[i] = info.KeySwitchBindings[i] = 0; }
168    
169                ::gig::File* pFile = (::gig::File*) pInstrument->GetParent();
170    
171                if (pFile->pVersion) {
172                    info.FormatVersion = ToString(pFile->pVersion->major);
173                    info.Product = pFile->pInfo->Product;
174                    info.Artists = pFile->pInfo->Artists;
175                }
176    
177                info.InstrumentName = pInstrument->pInfo->Name;
178    
179                ::gig::Region* pRegion = pInstrument->GetFirstRegion();
180                while (pRegion) {
181                    int low = pRegion->KeyRange.low;
182                    int high = pRegion->KeyRange.high;
183                    if (low < 0 || low > 127 || high < 0 || high > 127 || low > high) {
184                        std::cerr << "Invalid key range: " << low << " - " << high << std::endl;
185                    } else {
186                        for (int i = low; i <= high; i++) info.KeyBindings[i] = 1;
187                    }
188    
189                    pRegion = pInstrument->GetNextRegion();
190                }
191    
192                if (loaded) { // retrieve keyswitching only if the instrument is fully loaded.
193    
194                    // only return keyswitch range if keyswitching is used
195                    bool hasKeyswitches = false;
196                    for (::gig::Region* pRegion = pInstrument->GetFirstRegion() ;
197                         pRegion && !hasKeyswitches ;
198                         pRegion = pInstrument->GetNextRegion()) {
199                        for (int i = 0 ; i < pRegion->Dimensions ; i++) {
200                            if (pRegion->pDimensionDefinitions[i].dimension == ::gig::dimension_keyboard) {
201                                hasKeyswitches = true;
202                                break;
203                            }
204                        }
205                    }
206    
207                    if (hasKeyswitches) {
208                        int low = pInstrument->DimensionKeyRange.low;
209                        int high = pInstrument->DimensionKeyRange.high;
210                        if (low < 0 || low > 127 || high < 0 || high > 127 || low > high) {
211                            std::cerr << "Invalid keyswitch range: " << low << " - " << high << std::endl;
212                        } else {
213                            for (int i = low; i <= high; i++) info.KeySwitchBindings[i] = 1;
214                        }
215                    }
216                }
217    
218                if (loaded) Unlock();
219    
220                if (gig)  delete gig;
221                if (riff) delete riff;
222                return info;
223            } catch (::RIFF::Exception e) {
224                if (loaded) Unlock();
225                if (gig)  delete gig;
226                if (riff) delete riff;
227                throw InstrumentManagerException(e.Message);
228            } catch (...) {
229                if (loaded) Unlock();
230                if (gig)  delete gig;
231                if (riff) delete riff;
232                throw InstrumentManagerException("Unknown exception while trying to parse '" + ID.FileName + "'");
233            }
234        }
235    
236      void InstrumentResourceManager::LaunchInstrumentEditor(instrument_id_t ID) throw (InstrumentManagerException) {      void InstrumentResourceManager::LaunchInstrumentEditor(instrument_id_t ID) throw (InstrumentManagerException) {
237          const String sDataType    = GetInstrumentDataStructureName(ID);          const String sDataType    = GetInstrumentDataStructureName(ID);
238          const String sDataVersion = GetInstrumentDataStructureVersion(ID);          const String sDataVersion = GetInstrumentDataStructureVersion(ID);
# Line 136  namespace LinuxSampler { namespace gig { Line 255  namespace LinuxSampler { namespace gig {
255          ::gig::Instrument* pInstrument = Borrow(ID, pProxy);          ::gig::Instrument* pInstrument = Borrow(ID, pProxy);
256          // remember the proxy and instrument for this instrument editor          // remember the proxy and instrument for this instrument editor
257          pProxy->pInstrument = pInstrument;          pProxy->pInstrument = pInstrument;
258            pProxy->pEditor     = pEditor;
259          InstrumentEditorProxiesMutex.Lock();          InstrumentEditorProxiesMutex.Lock();
260          InstrumentEditorProxies[pEditor] = pProxy;          InstrumentEditorProxies.add(pProxy);
261          InstrumentEditorProxiesMutex.Unlock();          InstrumentEditorProxiesMutex.Unlock();
262          // launch the instrument editor for the given instrument          // launch the instrument editor for the given instrument
263          pEditor->Launch(pInstrument, sDataType, sDataVersion);          pEditor->Launch(pInstrument, sDataType, sDataVersion);
264    
265            // register the instrument editor as virtual MIDI device as well ...
266            VirtualMidiDevice* pVirtualMidiDevice =
267                dynamic_cast<VirtualMidiDevice*>(pEditor);
268            if (!pVirtualMidiDevice) {
269                std::cerr << "Instrument editor not a virtual MIDI device\n" << std::flush;
270                return;
271            }
272            // 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 ? )
273            Lock();
274            std::set<gig::EngineChannel*> engineChannels =
275                GetEngineChannelsUsing(pInstrument, false/*don't lock again*/);
276            std::set<gig::EngineChannel*>::iterator iter = engineChannels.begin();
277            std::set<gig::EngineChannel*>::iterator end  = engineChannels.end();
278            for (; iter != end; ++iter) (*iter)->Connect(pVirtualMidiDevice);
279            Unlock();
280      }      }
281    
282      /**      /**
# Line 152  namespace LinuxSampler { namespace gig { Line 288  namespace LinuxSampler { namespace gig {
288       */       */
289      void InstrumentResourceManager::OnInstrumentEditorQuit(InstrumentEditor* pSender) {      void InstrumentResourceManager::OnInstrumentEditorQuit(InstrumentEditor* pSender) {
290          dmsg(1,("InstrumentResourceManager: instrument editor quit, doing cleanup\n"));          dmsg(1,("InstrumentResourceManager: instrument editor quit, doing cleanup\n"));
291          // hand back instrument and free proxy  
292            ::gig::Instrument* pInstrument = NULL;
293            InstrumentEditorProxy* pProxy  = NULL;
294            int iProxyIndex                = -1;
295    
296            // first find the editor proxy entry for this editor
297          InstrumentEditorProxiesMutex.Lock();          InstrumentEditorProxiesMutex.Lock();
298          if (InstrumentEditorProxies.count(pSender)) {          for (int i = 0; i < InstrumentEditorProxies.size(); i++) {
299              InstrumentEditorProxy* pProxy =              InstrumentEditorProxy* pCurProxy =
300                  dynamic_cast<InstrumentEditorProxy*>(                  dynamic_cast<InstrumentEditorProxy*>(
301                      InstrumentEditorProxies[pSender]                      InstrumentEditorProxies[i]
302                  );                  );
303              InstrumentEditorProxies.erase(pSender);              if (pCurProxy->pEditor == pSender) {
304              InstrumentEditorProxiesMutex.Unlock();                  pProxy      = pCurProxy;
305              HandBack(pProxy->pInstrument, pProxy);                  iProxyIndex = i;
306              if (pProxy) delete pProxy;                  pInstrument = pCurProxy->pInstrument;
307                }
308            }
309            InstrumentEditorProxiesMutex.Unlock();
310    
311            if (!pProxy) {
312                std::cerr << "Eeeek, could not find instrument editor proxy, "
313                             "this is a bug!\n" << std::flush;
314                return;
315            }
316    
317            // now unregister editor as not being available as a virtual MIDI device anymore
318            VirtualMidiDevice* pVirtualMidiDevice =
319                dynamic_cast<VirtualMidiDevice*>(pSender);
320            if (pVirtualMidiDevice) {
321                Lock();
322                // NOTE: see note in LaunchInstrumentEditor()
323                std::set<gig::EngineChannel*> engineChannels =
324                    GetEngineChannelsUsing(pInstrument, false/*don't lock again*/);
325                std::set<gig::EngineChannel*>::iterator iter = engineChannels.begin();
326                std::set<gig::EngineChannel*>::iterator end  = engineChannels.end();
327                for (; iter != end; ++iter) (*iter)->Disconnect(pVirtualMidiDevice);
328                Unlock();
329          } else {          } else {
330                std::cerr << "Could not unregister editor as not longer acting as "
331                             "virtual MIDI device. Wasn't it registered?\n"
332                          << std::flush;
333            }
334    
335            // finally delete proxy entry and hand back instrument
336            if (pInstrument) {
337                InstrumentEditorProxiesMutex.Lock();
338                InstrumentEditorProxies.remove(iProxyIndex);
339              InstrumentEditorProxiesMutex.Unlock();              InstrumentEditorProxiesMutex.Unlock();
340              std::cerr << "Eeeek, could not find instrument editor proxy, this is a bug!\n" << std::flush;  
341                HandBack(pInstrument, pProxy);
342                delete pProxy;
343            }
344    
345            // Note that we don't need to free the editor here. As it
346            // derives from Thread, it will delete itself when the thread
347            // dies.
348        }
349    
350    #if 0 // currently unused :
351        /**
352         * Try to inform the respective instrument editor(s), that a note on
353         * event just occured. This method is called by the MIDI thread. If any
354         * obstacles are in the way (e.g. if a wait for an unlock would be
355         * required) we give up immediately, since the RT safeness of the MIDI
356         * thread has absolute priority.
357         */
358        void InstrumentResourceManager::TrySendNoteOnToEditors(uint8_t Key, uint8_t Velocity, ::gig::Instrument* pInstrument) {
359            const bool bGotLock = InstrumentEditorProxiesMutex.Trylock(); // naively assumes RT safe implementation
360            if (!bGotLock) return; // hell, forget it, not worth the hassle
361            for (int i = 0; i < InstrumentEditorProxies.size(); i++) {
362                InstrumentEditorProxy* pProxy =
363                    dynamic_cast<InstrumentEditorProxy*>(
364                        InstrumentEditorProxies[i]
365                    );
366                if (pProxy->pInstrument == pInstrument)
367                    pProxy->pEditor->SendNoteOnToDevice(Key, Velocity);
368            }
369            InstrumentEditorProxiesMutex.Unlock(); // naively assumes RT safe implementation
370        }
371    
372        /**
373         * Try to inform the respective instrument editor(s), that a note off
374         * event just occured. This method is called by the MIDI thread. If any
375         * obstacles are in the way (e.g. if a wait for an unlock would be
376         * required) we give up immediately, since the RT safeness of the MIDI
377         * thread has absolute priority.
378         */
379        void InstrumentResourceManager::TrySendNoteOffToEditors(uint8_t Key, uint8_t Velocity, ::gig::Instrument* pInstrument) {
380            const bool bGotLock = InstrumentEditorProxiesMutex.Trylock(); // naively assumes RT safe implementation
381            if (!bGotLock) return; // hell, forget it, not worth the hassle
382            for (int i = 0; i < InstrumentEditorProxies.size(); i++) {
383                InstrumentEditorProxy* pProxy =
384                    dynamic_cast<InstrumentEditorProxy*>(
385                        InstrumentEditorProxies[i]
386                    );
387                if (pProxy->pInstrument == pInstrument)
388                    pProxy->pEditor->SendNoteOffToDevice(Key, Velocity);
389          }          }
390          // free the editor          InstrumentEditorProxiesMutex.Unlock(); // naively assumes RT safe implementation
         InstrumentEditorFactory::Destroy(pSender);  
391      }      }
392    #endif // unused
393    
394      void InstrumentResourceManager::OnSamplesToBeRemoved(std::set<void*> Samples, InstrumentEditor* pSender) {      void InstrumentResourceManager::OnSamplesToBeRemoved(std::set<void*> Samples, InstrumentEditor* pSender) {
395          if (Samples.empty()) {          if (Samples.empty()) {
# Line 250  namespace LinuxSampler { namespace gig { Line 470  namespace LinuxSampler { namespace gig {
470          } else if (sStructType == "gig::Instrument") {          } else if (sStructType == "gig::Instrument") {
471              // resume all previously suspended engines              // resume all previously suspended engines
472              ResumeAllEngines();              ResumeAllEngines();
473            } else if (sStructType == "gig::Sample") {
474                // we're assuming here, that OnDataStructureToBeChanged() with
475                // "gig::File" was called previously, so we won't resume anything
476                // here, but just re-cache the given sample
477                Lock();
478                ::gig::Sample* pSample = (::gig::Sample*) pStruct;
479                ::gig::File* pFile = (::gig::File*) pSample->GetParent();
480                UncacheInitialSamples(pSample);
481                // now re-cache ...
482                std::vector< ::gig::Instrument*> instruments =
483                    GetInstrumentsCurrentlyUsedOf(pFile, false/*don't lock again*/);
484                for (int i = 0; i < instruments.size(); i++) {
485                    if (SampleReferencedByInstrument(pSample, instruments[i])) {
486                        std::set<gig::EngineChannel*> engineChannels =
487                            GetEngineChannelsUsing(instruments[i], false/*don't lock again*/);
488                        std::set<gig::EngineChannel*>::iterator iter = engineChannels.begin();
489                        std::set<gig::EngineChannel*>::iterator end  = engineChannels.end();
490                        for (; iter != end; ++iter)
491                            CacheInitialSamples(pSample, *iter);
492                    }
493                }
494                Unlock();
495          } else if (sStructType == "gig::Region") {          } else if (sStructType == "gig::Region") {
496              // advice the engines to resume the given region, that is to              // advice the engines to resume the given region, that is to
497              // using it for playback again              // using it for playback again
# Line 293  namespace LinuxSampler { namespace gig { Line 535  namespace LinuxSampler { namespace gig {
535              Lock();              Lock();
536              ::gig::Sample* pSample = (::gig::Sample*) pOldSample;              ::gig::Sample* pSample = (::gig::Sample*) pOldSample;
537              ::gig::File* pFile = (::gig::File*) pSample->GetParent();              ::gig::File* pFile = (::gig::File*) pSample->GetParent();
538                bool bSampleStillInUse = false;
539              std::vector< ::gig::Instrument*> instruments =              std::vector< ::gig::Instrument*> instruments =
540                  GetInstrumentsCurrentlyUsedOf(pFile, false/*don't lock again*/);                  GetInstrumentsCurrentlyUsedOf(pFile, false/*don't lock again*/);
541              for (int i = 0; i < instruments.size(); i++)              for (int i = 0; i < instruments.size(); i++) {
542                  if (!SampleReferencedByInstrument(pSample, instruments[i]))                  if (SampleReferencedByInstrument(pSample, instruments[i])) {
543                      UncacheInitialSamples(pSample);                      bSampleStillInUse = true;
544                        break;
545                    }
546                }
547                if (!bSampleStillInUse) UncacheInitialSamples(pSample);
548              Unlock();              Unlock();
549          }          }
550          // make sure new sample reference is cached          // make sure new sample reference is cached
# Line 401  namespace LinuxSampler { namespace gig { Line 648  namespace LinuxSampler { namespace gig {
648       * Give back an instrument. This should be used instead of       * Give back an instrument. This should be used instead of
649       * HandBack if there are some dimension regions that are still in       * HandBack if there are some dimension regions that are still in
650       * use. (When an instrument is changed, the voices currently       * use. (When an instrument is changed, the voices currently
651       * playing is allowed to keep playing with the old instrument       * playing are allowed to keep playing with the old instrument
652       * until note off arrives. New notes will use the new instrument.)       * until note off arrives. New notes will use the new instrument.)
653       */       */
654      void InstrumentResourceManager::HandBackInstrument(::gig::Instrument* pResource, InstrumentConsumer* pConsumer,      void InstrumentResourceManager::HandBackInstrument(::gig::Instrument* pResource, InstrumentConsumer* pConsumer,
655                                                         ::gig::DimensionRegion** dimRegionsInUse) {                                                         RTList< ::gig::DimensionRegion*>* pDimRegionsInUse) {
656          DimRegInfoMutex.Lock();          DimRegInfoMutex.Lock();
657          for (int i = 0 ; dimRegionsInUse[i] ; i++) {          for (RTList< ::gig::DimensionRegion*>::Iterator i = pDimRegionsInUse->first() ; i != pDimRegionsInUse->end() ; i++) {
658              DimRegInfo[dimRegionsInUse[i]].refCount++;              DimRegInfo[*i].refCount++;
659              SampleRefCount[dimRegionsInUse[i]->pSample]++;              SampleRefCount[(*i)->pSample]++;
660          }          }
661          HandBack(pResource, pConsumer, true);          HandBack(pResource, pConsumer, true);
662          DimRegInfoMutex.Unlock();          DimRegInfoMutex.Unlock();
# Line 531  namespace LinuxSampler { namespace gig { Line 778  namespace LinuxSampler { namespace gig {
778      }      }
779    
780      /**      /**
781         * Returns a list with all gig engine channels that are currently using
782         * the given instrument.
783         *
784         * @param pInstrument - search criteria
785         * @param bLock - whether we should lock (mutex) the instrument manager
786         *                during this call and unlock at the end of this call
787         */
788        std::set<gig::EngineChannel*> InstrumentResourceManager::GetEngineChannelsUsing(::gig::Instrument* pInstrument, bool bLock) {
789            if (bLock) Lock();
790            std::set<gig::EngineChannel*> result;
791            std::set<ResourceConsumer< ::gig::Instrument>*> consumers = ConsumersOf(pInstrument);
792            std::set<ResourceConsumer< ::gig::Instrument>*>::iterator iter = consumers.begin();
793            std::set<ResourceConsumer< ::gig::Instrument>*>::iterator end  = consumers.end();
794            for (; iter != end; ++iter) {
795                gig::EngineChannel* pEngineChannel = dynamic_cast<gig::EngineChannel*>(*iter);
796                if (!pEngineChannel) continue;
797                result.insert(pEngineChannel);
798            }
799            if (bLock) Unlock();
800            return result;
801        }
802    
803        /**
804       * Returns a list with all gig Engines that are currently using the given       * Returns a list with all gig Engines that are currently using the given
805       * instrument.       * instrument.
806       *       *
# Line 540  namespace LinuxSampler { namespace gig { Line 810  namespace LinuxSampler { namespace gig {
810       */       */
811      std::set<gig::Engine*> InstrumentResourceManager::GetEnginesUsing(::gig::Instrument* pInstrument, bool bLock) {      std::set<gig::Engine*> InstrumentResourceManager::GetEnginesUsing(::gig::Instrument* pInstrument, bool bLock) {
812          if (bLock) Lock();          if (bLock) Lock();
813          std::set<gig::Engine*> result;          std::set<gig::Engine*> result;
814          std::set<ResourceConsumer< ::gig::Instrument>*> consumers = ConsumersOf(pInstrument);          std::set<ResourceConsumer< ::gig::Instrument>*> consumers = ConsumersOf(pInstrument);
815          std::set<ResourceConsumer< ::gig::Instrument>*>::iterator iter = consumers.begin();          std::set<ResourceConsumer< ::gig::Instrument>*>::iterator iter = consumers.begin();
816          std::set<ResourceConsumer< ::gig::Instrument>*>::iterator end  = consumers.end();          std::set<ResourceConsumer< ::gig::Instrument>*>::iterator end  = consumers.end();
Legend:
Removed from v.1321  
changed lines
  Added in v.1852
  ViewVC Help
Powered by ViewVC