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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchSampleStore</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="IpatchSampleData.html" title="IpatchSampleData">
<link rel="next" href="libinstpatch-IpatchSampleTransform.html" title="IpatchSampleTransform">
<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="IpatchSampleData.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="libinstpatch-IpatchSampleTransform.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchSampleStore.synopsis" class="shortcut">Top</a>
|
<a href="#IpatchSampleStore.description" class="shortcut">Description</a>
|
<a href="#IpatchSampleStore.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#IpatchSampleStore.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#IpatchSampleStore.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="IpatchSampleStore">
<a name="IpatchSampleStore"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchSampleStore.top_of_page"></a>IpatchSampleStore</span></h2>
<p>IpatchSampleStore — Abstract sample storage object</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchSampleStore.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchSampleStore.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a
href="../libinstpatch/IpatchSampleStore.html#IpatchSampleStore-struct"
>IpatchSampleStore</a>;
#define <a
href="../libinstpatch/IpatchSampleStore.html#IPATCH-SAMPLE-STORE-FORMAT-SHIFT--CAPS"
>IPATCH_SAMPLE_STORE_FORMAT_SHIFT</a>
#define <a
href="../libinstpatch/IpatchSampleStore.html#ipatch-sample-store-get-format"
>ipatch_sample_store_get_format</a> (store)
#define <a
href="../libinstpatch/IpatchSampleStore.html#ipatch-sample-store-get-size"
>ipatch_sample_store_get_size</a> (store)
#define <a
href="../libinstpatch/IpatchSampleStore.html#ipatch-sample-store-get-rate"
>ipatch_sample_store_get_rate</a> (store)
#define <a
href="../libinstpatch/IpatchSampleStore.html#ipatch-sample-store-get-size-bytes"
>ipatch_sample_store_get_size_bytes</a> (store)
#define <a
href="../libinstpatch/IpatchSampleStore.html#IPATCH-SAMPLE-STORE-UNUSED-FLAG-SHIFT--CAPS"
>IPATCH_SAMPLE_STORE_UNUSED_FLAG_SHIFT</a>
<a
href="../libinstpatch/IpatchSampleStore.html"
>IpatchSampleStore</a> * <a
href="../libinstpatch/IpatchSampleStore.html#ipatch-sample-store-first"
>ipatch_sample_store_first</a> (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);
<a
href="../libinstpatch/IpatchSampleStore.html"
>IpatchSampleStore</a> * <a
href="../libinstpatch/IpatchSampleStore.html#ipatch-sample-store-next"
>ipatch_sample_store_next</a> (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchSampleStore.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>
+----IpatchSampleStore
+----<a
href="../libinstpatch/IpatchSampleStoreFile.html"
>IpatchSampleStoreFile</a>
+----<a
href="../libinstpatch/IpatchSampleStoreRam.html"
>IpatchSampleStoreRam</a>
+----<a
href="../libinstpatch/IpatchSampleStoreRom.html"
>IpatchSampleStoreRom</a>
+----<a
href="../libinstpatch/IpatchSampleStoreSndFile.html"
>IpatchSampleStoreSndFile</a>
+----<a
href="../libinstpatch/IpatchSampleStoreVirtual.html"
>IpatchSampleStoreVirtual</a>
+----<a
href="../libinstpatch/IpatchSampleStoreCache.html"
>IpatchSampleStoreCache</a>
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="IpatchSampleStore.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
IpatchSampleStore implements
<a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="IpatchSampleStore.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a
href="../libinstpatch/IpatchSampleStore.html#IpatchSampleStore--sample-format"
>sample-format</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write
"<a
href="../libinstpatch/IpatchSampleStore.html#IpatchSampleStore--sample-rate"
>sample-rate</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write
"<a
href="../libinstpatch/IpatchSampleStore.html#IpatchSampleStore--sample-size"
>sample-size</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchSampleStore.description"></a><h2>Description</h2>
<p>
Sample stores provide for various storage methods for audio data.
Examples include: <a
href="../libinstpatch/IpatchSampleStoreFile.html"
><span class="type">IpatchSampleStoreFile</span></a> for audio data stored in files
on disk, <span class="type">IpatchSampleStoreRAM</span> for audio in RAM, <span class="type">IpatchSampleStoreROM</span> for
samples in ROM of a sound card, etc.</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchSampleStore.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchSampleStore">
<a name="IpatchSampleStore-struct"></a><h3>IpatchSampleStore</h3>
<pre class="programlisting">typedef struct _IpatchSampleStore IpatchSampleStore;</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_STORE_FORMAT_SHIFT">
<a name="IPATCH-SAMPLE-STORE-FORMAT-SHIFT--CAPS"></a><h3>IPATCH_SAMPLE_STORE_FORMAT_SHIFT</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_STORE_FORMAT_SHIFT IPATCH_ITEM_UNUSED_FLAG_SHIFT
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_get_format()">
<a name="ipatch-sample-store-get-format"></a><h3>ipatch_sample_store_get_format()</h3>
<pre class="programlisting">#define ipatch_sample_store_get_format(store)</pre>
<p>
Macro for getting the sample format from a sample store. No lock is required
since format can only be set prior to the store being actively used.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Sample format field. See <span class="type">sample</span>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_get_size()">
<a name="ipatch-sample-store-get-size"></a><h3>ipatch_sample_store_get_size()</h3>
<pre class="programlisting">#define ipatch_sample_store_get_size(store) ((store)->size)
</pre>
<p>
Macro for getting the sample size in frames of a sample store. No lock is required
since size can only be set prior to the store being actively used.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Sample store size in frames.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_get_rate()">
<a name="ipatch-sample-store-get-rate"></a><h3>ipatch_sample_store_get_rate()</h3>
<pre class="programlisting">#define ipatch_sample_store_get_rate(store) ((store)->rate)
</pre>
<p>
Macro for getting the sample rate from a sample store. No lock is required
since rate can only be set prior to the store being actively used.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Sample rate in HZ.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_get_size_bytes()">
<a name="ipatch-sample-store-get-size-bytes"></a><h3>ipatch_sample_store_get_size_bytes()</h3>
<pre class="programlisting">#define ipatch_sample_store_get_size_bytes(store)</pre>
<p>
Macro for getting the sample store data size in bytes. No lock is required
since format and size can only be set prior to the store being actively used.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Sample store size in bytes.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_STORE_UNUSED_FLAG_SHIFT">
<a name="IPATCH-SAMPLE-STORE-UNUSED-FLAG-SHIFT--CAPS"></a><h3>IPATCH_SAMPLE_STORE_UNUSED_FLAG_SHIFT</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_STORE_UNUSED_FLAG_SHIFT</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_first ()">
<a name="ipatch-sample-store-first"></a><h3>ipatch_sample_store_first ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchSampleStore.html"
>IpatchSampleStore</a> * ipatch_sample_store_first (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);</pre>
<p>
Gets the first item in a sample store iterator. A convenience wrapper for
<a
href="../libinstpatch/libinstpatch-IpatchIter.html#ipatch-iter-first"
><code class="function">ipatch_iter_first()</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>iter</code></em> :</span></p></td>
<td> Patch item iterator containing <a
href="../libinstpatch/IpatchSampleStore.html"
><span class="type">IpatchSampleStore</span></a> items
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The first sample store in <em class="parameter"><code>iter</code></em> or <code class="literal">NULL</code> if empty.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_next ()">
<a name="ipatch-sample-store-next"></a><h3>ipatch_sample_store_next ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchSampleStore.html"
>IpatchSampleStore</a> * ipatch_sample_store_next (<a
href="../libinstpatch/libinstpatch-IpatchIter.html#IpatchIter"
>IpatchIter</a> *iter);</pre>
<p>
Gets the next item in a sample store iterator. A convenience wrapper for
<a
href="../libinstpatch/libinstpatch-IpatchIter.html#ipatch-iter-next"
><code class="function">ipatch_iter_next()</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>iter</code></em> :</span></p></td>
<td> Patch item iterator containing <a
href="../libinstpatch/IpatchSampleStore.html"
><span class="type">IpatchSampleStore</span></a> items
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The next sample store in <em class="parameter"><code>iter</code></em> or <code class="literal">NULL</code> if at the end of the list.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="IpatchSampleStore.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "sample-format" property'>
<a name="IpatchSampleStore--sample-format"></a><h3>The <code class="literal">"sample-format"</code> property</h3>
<pre class="programlisting"> "sample-format" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write</pre>
<p>Sample format.</p>
<p>Allowed values: >= 0</p>
<p>Default value: 2</p>
</div>
<hr>
<div class="refsect2" title='The "sample-rate" property'>
<a name="IpatchSampleStore--sample-rate"></a><h3>The <code class="literal">"sample-rate"</code> property</h3>
<pre class="programlisting"> "sample-rate" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write</pre>
<p>Sampling rate in Hertz.</p>
<p>Allowed values: [8000,192000]</p>
<p>Default value: 44100</p>
</div>
<hr>
<div class="refsect2" title='The "sample-size" property'>
<a name="IpatchSampleStore--sample-size"></a><h3>The <code class="literal">"sample-size"</code> property</h3>
<pre class="programlisting"> "sample-size" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> : Read / Write</pre>
<p>Size in frames.</p>
<p>Default value: 0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|
