/[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 56 by schoenebeck, Tue Apr 27 09:21:58 2004 UTC revision 970 by schoenebeck, Wed Dec 6 22:28:17 2006 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, 2006 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 24  Line 25 
25    
26  #include "InstrumentResourceManager.h"  #include "InstrumentResourceManager.h"
27    
28    // We need to know the maximum number of sample points which are going to
29    // be processed for each render cycle of the audio output driver, to know
30    // how much initial sample points we need to cache into RAM. If the given
31    // sampler channel does not have an audio output device assigned yet
32    // though, we simply use this default value.
33    #define GIG_RESOURCE_MANAGER_DEFAULT_MAX_SAMPLES_PER_CYCLE     128
34    
35  namespace LinuxSampler { namespace gig {  namespace LinuxSampler { namespace gig {
36    
37        // data stored as long as an instrument resource exists
38        struct instr_entry_t {
39            InstrumentManager::instrument_id_t ID;
40            ::gig::File*                       pGig;
41            uint                               MaxSamplesPerCycle; ///< if some engine requests an already allocated instrument with a higher value, we have to reallocate the instrument
42        };
43    
44        // some data needed for the libgig callback function
45        struct progress_callback_arg_t {
46            InstrumentResourceManager*          pManager;
47            InstrumentManager::instrument_id_t* pInstrumentKey;
48        };
49    
50        /**
51         * Callback function which will be called by libgig during loading of
52         * instruments to inform about the current progress. Or to be more
53         * specific; it will be called during the GetInstrument() call.
54         *
55         * @param pProgress - contains current progress value, pointer to the
56         *                    InstrumentResourceManager instance and
57         *                    instrument ID
58         */
59        void InstrumentResourceManager::OnInstrumentLoadingProgress(::gig::progress_t* pProgress) {
60            dmsg(7,("gig::InstrumentResourceManager: progress %f%", pProgress->factor));
61            progress_callback_arg_t* pArg = static_cast<progress_callback_arg_t*>(pProgress->custom);
62            // we randomly schedule 90% for the .gig file loading and the remaining 10% later for sample caching
63            const float localProgress = 0.9f * pProgress->factor;
64            pArg->pManager->DispatchResourceProgressEvent(*pArg->pInstrumentKey, localProgress);
65        }
66    
67        std::vector<InstrumentResourceManager::instrument_id_t> InstrumentResourceManager::Instruments() {
68            return Entries();
69        }
70    
71        InstrumentManager::mode_t InstrumentResourceManager::GetMode(const instrument_id_t& ID) {
72            return static_cast<InstrumentManager::mode_t>(AvailabilityMode(ID));
73        }
74    
75        void InstrumentResourceManager::SetMode(const instrument_id_t& ID, InstrumentManager::mode_t Mode) {
76            dmsg(2,("gig::InstrumentResourceManager: setting mode for %s (Index=%d) to %d\n",ID.FileName.c_str(),ID.Index,Mode));
77            SetAvailabilityMode(ID, static_cast<ResourceManager<InstrumentManager::instrument_id_t, ::gig::Instrument>::mode_t>(Mode));
78        }
79    
80        String InstrumentResourceManager::GetInstrumentName(instrument_id_t ID) {
81            Lock();
82            ::gig::Instrument* pInstrument = Resource(ID, false);
83            String res = (pInstrument) ? pInstrument->pInfo->Name : "";
84            Unlock();
85            return res;
86        }
87    
88      ::gig::Instrument* InstrumentResourceManager::Create(instrument_id_t Key, InstrumentConsumer* pConsumer, void*& pArg) {      ::gig::Instrument* InstrumentResourceManager::Create(instrument_id_t Key, InstrumentConsumer* pConsumer, void*& pArg) {
89          // get gig file from inernal gig file manager          // get gig file from inernal gig file manager
90          ::gig::File* pGig = Gigs.Borrow(Key.FileName, (GigConsumer*) Key.iInstrument); // conversion kinda hackish :/          ::gig::File* pGig = Gigs.Borrow(Key.FileName, (GigConsumer*) Key.Index); // conversion kinda hackish :/
91    
92            // we pass this to the progress callback mechanism of libgig
93            progress_callback_arg_t callbackArg;
94            callbackArg.pManager       = this;
95            callbackArg.pInstrumentKey = &Key;
96    
97            ::gig::progress_t progress;
98            progress.callback = OnInstrumentLoadingProgress;
99            progress.custom   = &callbackArg;
100    
101          dmsg(1,("Loading gig instrument..."));          dmsg(1,("Loading gig instrument ('%s',%d)...",Key.FileName.c_str(),Key.Index));
102          ::gig::Instrument* pInstrument = pGig->GetInstrument(Key.iInstrument);          ::gig::Instrument* pInstrument = pGig->GetInstrument(Key.Index, &progress);
103          if (!pInstrument) {          if (!pInstrument) {
104              std::stringstream msg;              std::stringstream msg;
105              msg << "There's no instrument with index " << Key.iInstrument << ".";              msg << "There's no instrument with index " << Key.Index << ".";
106              throw InstrumentResourceManagerException(msg.str());              throw InstrumentResourceManagerException(msg.str());
107          }          }
108          pGig->GetFirstSample(); // just to force complete instrument loading          pGig->GetFirstSample(); // just to force complete instrument loading
# Line 42  namespace LinuxSampler { namespace gig { Line 110  namespace LinuxSampler { namespace gig {
110    
111          // cache initial samples points (for actually needed samples)          // cache initial samples points (for actually needed samples)
112          dmsg(1,("Caching initial samples..."));          dmsg(1,("Caching initial samples..."));
113            uint iRegion = 0; // just for progress calculation
114          ::gig::Region* pRgn = pInstrument->GetFirstRegion();          ::gig::Region* pRgn = pInstrument->GetFirstRegion();
115          while (pRgn) {          while (pRgn) {
116              if (!pRgn->GetSample()->GetCache().Size) {              // we randomly schedule 90% for the .gig file loading and the remaining 10% now for sample caching
117                const float localProgress = 0.9f + 0.1f * (float) iRegion / (float) pInstrument->Regions;
118                DispatchResourceProgressEvent(Key, localProgress);
119    
120                if (pRgn->GetSample() && !pRgn->GetSample()->GetCache().Size) {
121                  dmsg(2,("C"));                  dmsg(2,("C"));
122                  CacheInitialSamples(pRgn->GetSample(), dynamic_cast<gig::Engine*>(pConsumer));                  CacheInitialSamples(pRgn->GetSample(), (gig::EngineChannel*) pConsumer);
123              }              }
124              for (uint i = 0; i < pRgn->DimensionRegions; i++) {              for (uint i = 0; i < pRgn->DimensionRegions; i++) {
125                  CacheInitialSamples(pRgn->pDimensionRegions[i]->pSample, dynamic_cast<gig::Engine*>(pConsumer));                  CacheInitialSamples(pRgn->pDimensionRegions[i]->pSample, (gig::EngineChannel*) pConsumer);
126              }              }
127    
128              pRgn = pInstrument->GetNextRegion();              pRgn = pInstrument->GetNextRegion();
129                iRegion++;
130          }          }
131          dmsg(1,("OK\n"));          dmsg(1,("OK\n"));
132            DispatchResourceProgressEvent(Key, 1.0f); // done; notify all consumers about progress 100%
133    
134          // we need the following for destruction later          // we need the following for destruction later
135          instr_entry_t* pEntry = new instr_entry_t;          instr_entry_t* pEntry = new instr_entry_t;
136          pEntry->iInstrument   = Key.iInstrument;          pEntry->ID.FileName   = Key.FileName;
137            pEntry->ID.Index      = Key.Index;
138          pEntry->pGig          = pGig;          pEntry->pGig          = pGig;
139          // and this to check if we need to reallocate for a engine with higher value of 'MaxSamplesPerSecond'  
140          pEntry->MaxSamplesPerCycle = dynamic_cast<gig::Engine*>(pConsumer)->pAudioOutputDevice->MaxSamplesPerCycle();          gig::EngineChannel* pEngineChannel = (gig::EngineChannel*) pConsumer;
141            // and we save this to check if we need to reallocate for a engine with higher value of 'MaxSamplesPerSecond'
142            pEntry->MaxSamplesPerCycle =
143                (pEngineChannel && pEngineChannel->GetEngine()) ? dynamic_cast<gig::Engine*>(pEngineChannel->GetEngine())->pAudioOutputDevice->MaxSamplesPerCycle()
144                                              : GIG_RESOURCE_MANAGER_DEFAULT_MAX_SAMPLES_PER_CYCLE;
145          pArg = pEntry;          pArg = pEntry;
146    
147          return pInstrument;          return pInstrument;
# Line 69  namespace LinuxSampler { namespace gig { Line 149  namespace LinuxSampler { namespace gig {
149    
150      void InstrumentResourceManager::Destroy( ::gig::Instrument* pResource, void* pArg) {      void InstrumentResourceManager::Destroy( ::gig::Instrument* pResource, void* pArg) {
151          instr_entry_t* pEntry = (instr_entry_t*) pArg;          instr_entry_t* pEntry = (instr_entry_t*) pArg;
152          Gigs.HandBack(pEntry->pGig, (GigConsumer*) pEntry->iInstrument); // conversion kinda hackish :/          // we don't need the .gig file here anymore
153            Gigs.HandBack(pEntry->pGig, (GigConsumer*) pEntry->ID.Index); // conversion kinda hackish :/
154          delete pEntry;          delete pEntry;
155      }      }
156    
157      void InstrumentResourceManager::OnBorrow(::gig::Instrument* pResource, InstrumentConsumer* pConsumer, void*& pArg) {      void InstrumentResourceManager::OnBorrow(::gig::Instrument* pResource, InstrumentConsumer* pConsumer, void*& pArg) {
158          instr_entry_t* pEntry = (instr_entry_t*) pArg;          instr_entry_t* pEntry = (instr_entry_t*) pArg;
159          if (pEntry->MaxSamplesPerCycle < dynamic_cast<gig::Engine*>(pConsumer)->pAudioOutputDevice->MaxSamplesPerCycle()) {          gig::EngineChannel* pEngineChannel = dynamic_cast<gig::EngineChannel*>(pConsumer);
160            uint maxSamplesPerCycle =
161                (pEngineChannel->GetEngine()) ? dynamic_cast<gig::Engine*>(pEngineChannel->GetEngine())->pAudioOutputDevice->MaxSamplesPerCycle()
162                                              : GIG_RESOURCE_MANAGER_DEFAULT_MAX_SAMPLES_PER_CYCLE;
163            if (pEntry->MaxSamplesPerCycle < maxSamplesPerCycle) {
164              Update(pResource, pConsumer);              Update(pResource, pConsumer);
165          }          }
166      }      }
# Line 87  namespace LinuxSampler { namespace gig { Line 172  namespace LinuxSampler { namespace gig {
172       *  samples is needed to compensate disk reading latency.       *  samples is needed to compensate disk reading latency.
173       *       *
174       *  @param pSample - points to the sample to be cached       *  @param pSample - points to the sample to be cached
175       *  @param pEngine - pointer to Gig Engine which caused this call       *  @param pEngineChannel - pointer to Gig Engine Channel which caused this call
176       */       */
177      void InstrumentResourceManager::CacheInitialSamples(::gig::Sample* pSample, gig::Engine* pEngine) {      void InstrumentResourceManager::CacheInitialSamples(::gig::Sample* pSample, gig::EngineChannel* pEngineChannel) {
178          if (!pSample || pSample->GetCache().Size) return;          if (!pSample) {
179          if (pSample->SamplesTotal <= NUM_RAM_PRELOAD_SAMPLES) {              dmsg(4,("gig::InstrumentResourceManager: Skipping sample (pSample == NULL)\n"));
180                return;
181            }
182            if (!pSample->SamplesTotal) return; // skip zero size samples
183    
184            if (pSample->SamplesTotal <= CONFIG_PRELOAD_SAMPLES) {
185              // Sample is too short for disk streaming, so we load the whole              // Sample is too short for disk streaming, so we load the whole
186              // sample into RAM and place 'pAudioIO->FragmentSize << MAX_PITCH'              // sample into RAM and place 'pAudioIO->FragmentSize << CONFIG_MAX_PITCH'
187              // number of '0' samples (silence samples) behind the official buffer              // number of '0' samples (silence samples) behind the official buffer
188              // border, to allow the interpolator do it's work even at the end of              // border, to allow the interpolator do it's work even at the end of
189              // the sample.              // the sample.
190              ::gig::buffer_t buf = pSample->LoadSampleDataWithNullSamplesExtension((pEngine->pAudioOutputDevice->MaxSamplesPerCycle() << MAX_PITCH) + 3);              const uint maxSamplesPerCycle =
191              dmsg(4,("Cached %d Bytes, %d silence bytes.\n", buf.Size, buf.NullExtensionSize));                  (pEngineChannel && pEngineChannel->GetEngine()) ? dynamic_cast<gig::Engine*>(pEngineChannel->GetEngine())->pAudioOutputDevice->MaxSamplesPerCycle()
192                                                  : GIG_RESOURCE_MANAGER_DEFAULT_MAX_SAMPLES_PER_CYCLE;
193                const uint neededSilenceSamples = (maxSamplesPerCycle << CONFIG_MAX_PITCH) + 3;
194                const uint currentlyCachedSilenceSamples = pSample->GetCache().NullExtensionSize / pSample->FrameSize;
195                if (currentlyCachedSilenceSamples < neededSilenceSamples) {
196                    dmsg(3,("Caching whole sample (sample name: \"%s\", sample size: %d)\n", pSample->pInfo->Name.c_str(), pSample->SamplesTotal));
197                    ::gig::buffer_t buf = pSample->LoadSampleDataWithNullSamplesExtension(neededSilenceSamples);
198                    dmsg(4,("Cached %d Bytes, %d silence bytes.\n", buf.Size, buf.NullExtensionSize));
199                }
200          }          }
201          else { // we only cache NUM_RAM_PRELOAD_SAMPLES and stream the other sample points from disk          else { // we only cache CONFIG_PRELOAD_SAMPLES and stream the other sample points from disk
202              pSample->LoadSampleData(NUM_RAM_PRELOAD_SAMPLES);              if (!pSample->GetCache().Size) pSample->LoadSampleData(CONFIG_PRELOAD_SAMPLES);
203          }          }
204    
205          if (!pSample->GetCache().Size) std::cerr << "Unable to cache sample - maybe memory full!" << std::endl << std::flush;          if (!pSample->GetCache().Size) std::cerr << "Unable to cache sample - maybe memory full!" << std::endl << std::flush;
Legend:
Removed from v.56  
changed lines
  Added in v.970
  ViewVC Help
Powered by ViewVC