1 |
/*************************************************************************** |
2 |
* * |
3 |
* LinuxSampler - modular, streaming capable sampler * |
4 |
* * |
5 |
* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck * |
6 |
* Copyright (C) 2005 Christian Schoenebeck * |
7 |
* * |
8 |
* 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 * |
10 |
* the Free Software Foundation; either version 2 of the License, or * |
11 |
* (at your option) any later version. * |
12 |
* * |
13 |
* This program is distributed in the hope that it will be useful, * |
14 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of * |
15 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * |
16 |
* GNU General Public License for more details. * |
17 |
* * |
18 |
* You should have received a copy of the GNU General Public License * |
19 |
* along with this program; if not, write to the Free Software * |
20 |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, * |
21 |
* MA 02111-1307 USA * |
22 |
***************************************************************************/ |
23 |
|
24 |
#include <sstream> |
25 |
|
26 |
#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 { |
36 |
|
37 |
::gig::Instrument* InstrumentResourceManager::Create(instrument_id_t Key, InstrumentConsumer* pConsumer, void*& pArg) { |
38 |
// get gig file from inernal gig file manager |
39 |
::gig::File* pGig = Gigs.Borrow(Key.FileName, (GigConsumer*) Key.iInstrument); // conversion kinda hackish :/ |
40 |
|
41 |
dmsg(1,("Loading gig instrument...")); |
42 |
::gig::Instrument* pInstrument = pGig->GetInstrument(Key.iInstrument); |
43 |
if (!pInstrument) { |
44 |
std::stringstream msg; |
45 |
msg << "There's no instrument with index " << Key.iInstrument << "."; |
46 |
throw InstrumentResourceManagerException(msg.str()); |
47 |
} |
48 |
pGig->GetFirstSample(); // just to force complete instrument loading |
49 |
dmsg(1,("OK\n")); |
50 |
|
51 |
// cache initial samples points (for actually needed samples) |
52 |
dmsg(1,("Caching initial samples...")); |
53 |
::gig::Region* pRgn = pInstrument->GetFirstRegion(); |
54 |
while (pRgn) { |
55 |
if (pRgn->GetSample() && !pRgn->GetSample()->GetCache().Size) { |
56 |
dmsg(2,("C")); |
57 |
CacheInitialSamples(pRgn->GetSample(), dynamic_cast<gig::EngineChannel*>(pConsumer)); |
58 |
} |
59 |
for (uint i = 0; i < pRgn->DimensionRegions; i++) { |
60 |
CacheInitialSamples(pRgn->pDimensionRegions[i]->pSample, dynamic_cast<gig::EngineChannel*>(pConsumer)); |
61 |
} |
62 |
|
63 |
pRgn = pInstrument->GetNextRegion(); |
64 |
} |
65 |
dmsg(1,("OK\n")); |
66 |
|
67 |
// we need the following for destruction later |
68 |
instr_entry_t* pEntry = new instr_entry_t; |
69 |
pEntry->iInstrument = Key.iInstrument; |
70 |
pEntry->pGig = pGig; |
71 |
|
72 |
gig::EngineChannel* pEngineChannel = dynamic_cast<gig::EngineChannel*>(pConsumer); |
73 |
// and we save this to check if we need to reallocate for a engine with higher value of 'MaxSamplesPerSecond' |
74 |
pEntry->MaxSamplesPerCycle = |
75 |
(pEngineChannel->GetEngine()) ? dynamic_cast<gig::Engine*>(pEngineChannel->GetEngine())->pAudioOutputDevice->MaxSamplesPerCycle() |
76 |
: GIG_RESOURCE_MANAGER_DEFAULT_MAX_SAMPLES_PER_CYCLE; |
77 |
pArg = pEntry; |
78 |
|
79 |
return pInstrument; |
80 |
} |
81 |
|
82 |
void InstrumentResourceManager::Destroy( ::gig::Instrument* pResource, void* pArg) { |
83 |
instr_entry_t* pEntry = (instr_entry_t*) pArg; |
84 |
Gigs.HandBack(pEntry->pGig, (GigConsumer*) pEntry->iInstrument); // conversion kinda hackish :/ |
85 |
delete pEntry; |
86 |
} |
87 |
|
88 |
void InstrumentResourceManager::OnBorrow(::gig::Instrument* pResource, InstrumentConsumer* pConsumer, void*& pArg) { |
89 |
instr_entry_t* pEntry = (instr_entry_t*) pArg; |
90 |
gig::EngineChannel* pEngineChannel = dynamic_cast<gig::EngineChannel*>(pConsumer); |
91 |
uint maxSamplesPerCycle = |
92 |
(pEngineChannel->GetEngine()) ? dynamic_cast<gig::Engine*>(pEngineChannel->GetEngine())->pAudioOutputDevice->MaxSamplesPerCycle() |
93 |
: GIG_RESOURCE_MANAGER_DEFAULT_MAX_SAMPLES_PER_CYCLE; |
94 |
if (pEntry->MaxSamplesPerCycle < maxSamplesPerCycle) { |
95 |
Update(pResource, pConsumer); |
96 |
} |
97 |
} |
98 |
|
99 |
/** |
100 |
* Caches a certain size at the beginning of the given sample in RAM. If the |
101 |
* sample is very short, the whole sample will be loaded into RAM and thus |
102 |
* no disk streaming is needed for this sample. Caching an initial part of |
103 |
* samples is needed to compensate disk reading latency. |
104 |
* |
105 |
* @param pSample - points to the sample to be cached |
106 |
* @param pEngineChannel - pointer to Gig Engine Channel which caused this call |
107 |
*/ |
108 |
void InstrumentResourceManager::CacheInitialSamples(::gig::Sample* pSample, gig::EngineChannel* pEngineChannel) { |
109 |
if (!pSample) { |
110 |
dmsg(4,("gig::InstrumentResourceManager: Skipping sample (pSample == NULL)\n")); |
111 |
return; |
112 |
} |
113 |
if (!pSample->SamplesTotal) return; // skip zero size samples |
114 |
|
115 |
if (pSample->SamplesTotal <= NUM_RAM_PRELOAD_SAMPLES) { |
116 |
// Sample is too short for disk streaming, so we load the whole |
117 |
// sample into RAM and place 'pAudioIO->FragmentSize << MAX_PITCH' |
118 |
// number of '0' samples (silence samples) behind the official buffer |
119 |
// border, to allow the interpolator do it's work even at the end of |
120 |
// the sample. |
121 |
const uint maxSamplesPerCycle = |
122 |
(pEngineChannel->GetEngine()) ? dynamic_cast<gig::Engine*>(pEngineChannel->GetEngine())->pAudioOutputDevice->MaxSamplesPerCycle() |
123 |
: GIG_RESOURCE_MANAGER_DEFAULT_MAX_SAMPLES_PER_CYCLE; |
124 |
const uint neededSilenceSamples = (maxSamplesPerCycle << MAX_PITCH) + 3; |
125 |
const uint currentlyCachedSilenceSamples = pSample->GetCache().NullExtensionSize / pSample->FrameSize; |
126 |
if (currentlyCachedSilenceSamples < neededSilenceSamples) { |
127 |
dmsg(3,("Caching whole sample (sample name: \"%s\", sample size: %d)\n", pSample->pInfo->Name.c_str(), pSample->SamplesTotal)); |
128 |
::gig::buffer_t buf = pSample->LoadSampleDataWithNullSamplesExtension(neededSilenceSamples); |
129 |
dmsg(4,("Cached %d Bytes, %d silence bytes.\n", buf.Size, buf.NullExtensionSize)); |
130 |
} |
131 |
} |
132 |
else { // we only cache NUM_RAM_PRELOAD_SAMPLES and stream the other sample points from disk |
133 |
if (!pSample->GetCache().Size) pSample->LoadSampleData(NUM_RAM_PRELOAD_SAMPLES); |
134 |
} |
135 |
|
136 |
if (!pSample->GetCache().Size) std::cerr << "Unable to cache sample - maybe memory full!" << std::endl << std::flush; |
137 |
} |
138 |
|
139 |
|
140 |
|
141 |
// internal gig file manager |
142 |
|
143 |
::gig::File* InstrumentResourceManager::GigResourceManager::Create(String Key, GigConsumer* pConsumer, void*& pArg) { |
144 |
dmsg(1,("Loading gig file \'%s\'...", Key.c_str())); |
145 |
::RIFF::File* pRIFF = new ::RIFF::File(Key); |
146 |
::gig::File* pGig = new ::gig::File(pRIFF); |
147 |
pArg = pRIFF; |
148 |
dmsg(1,("OK\n")); |
149 |
return pGig; |
150 |
} |
151 |
|
152 |
void InstrumentResourceManager::GigResourceManager::Destroy(::gig::File* pResource, void* pArg) { |
153 |
dmsg(1,("Freeing gig file from memory...")); |
154 |
delete pResource; |
155 |
delete (::RIFF::File*) pArg; |
156 |
dmsg(1,("OK\n")); |
157 |
} |
158 |
|
159 |
}} // namespace LinuxSampler::gig |