1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchSampleStoreCache</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="libinstpatch Reference Manual">
<link rel="up" href="ch03.html" title="Sample data objects and functions">
<link rel="prev" href="IpatchSndFile.html" title="IpatchSndFile">
<link rel="next" href="IpatchSampleStoreFile.html" title="IpatchSampleStoreFile">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Base objects and functions">
<link rel="chapter" href="ch02.html" title="Utility objects and functions">
<link rel="chapter" href="ch03.html" title="Sample data objects and functions">
<link rel="chapter" href="ch04.html" title="DLS patches">
<link rel="chapter" href="ch05.html" title="SoundFont patches">
<link rel="chapter" href="ch06.html" title="GigaSampler patches">
<link rel="chapter" href="ch07.html" title="Virtual banks">
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
<link rel="index" href="api-index-full.html" title="API Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="IpatchSndFile.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinstpatch Reference Manual</th>
<td><a accesskey="n" href="IpatchSampleStoreFile.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchSampleStoreCache.synopsis" class="shortcut">Top</a>
|
<a href="#IpatchSampleStoreCache.description" class="shortcut">Description</a>
|
<a href="#IpatchSampleStoreCache.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#IpatchSampleStoreCache.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#IpatchSampleStoreCache.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="IpatchSampleStoreCache">
<a name="IpatchSampleStoreCache"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchSampleStoreCache.top_of_page"></a>IpatchSampleStoreCache</span></h2>
<p>IpatchSampleStoreCache — Sample store object for cached samples in RAM</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchSampleStoreCache.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchSampleStoreCache.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a
href="../libinstpatch/IpatchSampleStoreCache.html#IpatchSampleStoreCache-struct"
>IpatchSampleStoreCache</a>;
#define <a
href="../libinstpatch/IpatchSampleStoreCache.html#ipatch-sample-store-cache-get-location"
>ipatch_sample_store_cache_get_location</a>(store)
#define <a
href="../libinstpatch/IpatchSampleStoreCache.html#ipatch-sample-store-cache-get-channel-map"
>ipatch_sample_store_cache_get_channel_map</a>(store)
#define <a
href="../libinstpatch/IpatchSampleStoreCache.html#ipatch-sample-store-cache-get-open-count"
>ipatch_sample_store_cache_get_open_count</a>(store)
#define <a
href="../libinstpatch/IpatchSampleStoreCache.html#IPATCH-SAMPLE-STORE-CACHE-UNUSED-FLAG-SHIFT--CAPS"
>IPATCH_SAMPLE_STORE_CACHE_UNUSED_FLAG_SHIFT</a>
<a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a> * <a
href="../libinstpatch/IpatchSampleStoreCache.html#ipatch-sample-store-cache-new"
>ipatch_sample_store_cache_new</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> location);
void <a
href="../libinstpatch/IpatchSampleStoreCache.html#ipatch-sample-store-cache-open"
>ipatch_sample_store_cache_open</a> (<a
href="../libinstpatch/IpatchSampleStoreCache.html"
>IpatchSampleStoreCache</a> *store);
void <a
href="../libinstpatch/IpatchSampleStoreCache.html#ipatch-sample-store-cache-close"
>ipatch_sample_store_cache_close</a> (<a
href="../libinstpatch/IpatchSampleStoreCache.html"
>IpatchSampleStoreCache</a> *store);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchSampleStoreCache.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../libinstpatch/IpatchItem.html"
>IpatchItem</a>
+----<a
href="../libinstpatch/IpatchSampleStore.html"
>IpatchSampleStore</a>
+----IpatchSampleStoreCache
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="IpatchSampleStoreCache.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
IpatchSampleStoreCache implements
<a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="IpatchSampleStoreCache.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a
href="../libinstpatch/IpatchSampleStoreCache.html#IpatchSampleStoreCache--location"
>location</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchSampleStoreCache.description"></a><h2>Description</h2>
<p>
This sample store type is tightly integrated with <a
href="../libinstpatch/IpatchSampleData.html"
><span class="type">IpatchSampleData</span></a> to provide
managed cached samples in RAM.</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchSampleStoreCache.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchSampleStoreCache">
<a name="IpatchSampleStoreCache-struct"></a><h3>IpatchSampleStoreCache</h3>
<pre class="programlisting">typedef struct _IpatchSampleStoreCache IpatchSampleStoreCache;</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_cache_get_location()">
<a name="ipatch-sample-store-cache-get-location"></a><h3>ipatch_sample_store_cache_get_location()</h3>
<pre class="programlisting">#define ipatch_sample_store_cache_get_location(store)</pre>
<p>
Macro to quickly fetch a cache sample store's data location pointer.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td> Sample store to get sample data location from
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Sample data pointer.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_cache_get_channel_map()">
<a name="ipatch-sample-store-cache-get-channel-map"></a><h3>ipatch_sample_store_cache_get_channel_map()</h3>
<pre class="programlisting">#define ipatch_sample_store_cache_get_channel_map(store)</pre>
<p>
Macro to quickly fetch a cache sample store's channel map value. Cached
samples store a channel map in reference to the native sample of their
parent <a
href="../libinstpatch/IpatchSampleData.html"
><span class="type">IpatchSampleData</span></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td> Sample store to get channel map from
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Channel map value.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_cache_get_open_count()">
<a name="ipatch-sample-store-cache-get-open-count"></a><h3>ipatch_sample_store_cache_get_open_count()</h3>
<pre class="programlisting">#define ipatch_sample_store_cache_get_open_count(store)</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_STORE_CACHE_UNUSED_FLAG_SHIFT">
<a name="IPATCH-SAMPLE-STORE-CACHE-UNUSED-FLAG-SHIFT--CAPS"></a><h3>IPATCH_SAMPLE_STORE_CACHE_UNUSED_FLAG_SHIFT</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_STORE_CACHE_UNUSED_FLAG_SHIFT</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_cache_new ()">
<a name="ipatch-sample-store-cache-new"></a><h3>ipatch_sample_store_cache_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a> * ipatch_sample_store_cache_new (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> location);</pre>
<p>
Creates a new cached RAM sample store. If <em class="parameter"><code>location</code></em> is provided, its allocation
is taken over by the store.
</p>
<p>
NOTE: This store type should not be used outside of the <a
href="../libinstpatch/IpatchSampleData.html"
><span class="type">IpatchSampleData</span></a>
implementation, as it is tightly coupled with it.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>location</code></em> :</span></p></td>
<td> Location of existing sample data or <code class="literal">NULL</code> if the sample buffer
should be allocated (in which case the sample must be written to first).
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New cached RAM sample store, cast as a <a
href="../libinstpatch/IpatchSample.html"
><span class="type">IpatchSample</span></a> for convenience.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_cache_open ()">
<a name="ipatch-sample-store-cache-open"></a><h3>ipatch_sample_store_cache_open ()</h3>
<pre class="programlisting">void ipatch_sample_store_cache_open (<a
href="../libinstpatch/IpatchSampleStoreCache.html"
>IpatchSampleStoreCache</a> *store);</pre>
<p>
A dummy open function which can be used if the location pointer will be
accessed directly, rather than opening a <a
href="../libinstpatch/IpatchSample.html#IpatchSampleHandle"
><span class="type">IpatchSampleHandle</span></a>. Keeping a
cached sample store open will ensure it isn't destroyed. Call
<a
href="../libinstpatch/IpatchSampleStoreCache.html#ipatch-sample-store-cache-close"
><code class="function">ipatch_sample_store_cache_close()</code></a> when done with it.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td> Sample cache store
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_cache_close ()">
<a name="ipatch-sample-store-cache-close"></a><h3>ipatch_sample_store_cache_close ()</h3>
<pre class="programlisting">void ipatch_sample_store_cache_close (<a
href="../libinstpatch/IpatchSampleStoreCache.html"
>IpatchSampleStoreCache</a> *store);</pre>
<p>
A dummy close function which is called after a sample store cache is no
longer needed after opening it with <a
href="../libinstpatch/IpatchSampleStoreCache.html#ipatch-sample-store-cache-open"
><code class="function">ipatch_sample_store_cache_open()</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>store</code></em> :</span></p></td>
<td> Sample cache store
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="IpatchSampleStoreCache.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "location" property'>
<a name="IpatchSampleStoreCache--location"></a><h3>The <code class="literal">"location"</code> property</h3>
<pre class="programlisting"> "location" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> : Read / Write</pre>
<p>Sample data pointer.</p>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="IpatchSampleStoreCache.see-also"></a><h2>See Also</h2>
#IpatchSampleData
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|
