libinstpatch-doc 1.0.0-7 / usr / share / gtk-doc / html / libinstpatch / IpatchSF2Reader.html

This file is indexed.

/usr/share/gtk-doc/html/libinstpatch/IpatchSF2Reader.html is in libinstpatch-doc 1.0.0-7.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchSF2Reader</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="ch05.html" title="SoundFont patches">
<link rel="prev" href="IpatchSF2File.html" title="IpatchSF2File">
<link rel="next" href="IpatchSF2Writer.html" title="IpatchSF2Writer">
<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="IpatchSF2File.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch05.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="IpatchSF2Writer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchSF2Reader.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#IpatchSF2Reader.description" class="shortcut">Description</a>
                 | 
                <a href="#IpatchSF2Reader.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" title="IpatchSF2Reader">
<a name="IpatchSF2Reader"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchSF2Reader.top_of_page"></a>IpatchSF2Reader</span></h2>
<p>IpatchSF2Reader — SoundFont file reader</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchSF2Reader.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchSF2Reader.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a
href="../libinstpatch/IpatchSF2Reader.html#IpatchSF2Reader-struct"
>IpatchSF2Reader</a>;
<a
href="../libinstpatch/IpatchSF2Reader.html"
>IpatchSF2Reader</a> *   <a
href="../libinstpatch/IpatchSF2Reader.html#ipatch-sf2-reader-new"
>ipatch_sf2_reader_new</a>               (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle);
void                <a
href="../libinstpatch/IpatchSF2Reader.html#ipatch-sf2-reader-set-file-handle"
>ipatch_sf2_reader_set_file_handle</a>   (<a
href="../libinstpatch/IpatchSF2Reader.html"
>IpatchSF2Reader</a> *reader,
                                                         <a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle);
<a
href="../libinstpatch/IpatchSF2.html"
>IpatchSF2</a> *         <a
href="../libinstpatch/IpatchSF2Reader.html#ipatch-sf2-reader-load"
>ipatch_sf2_reader_load</a>              (<a
href="../libinstpatch/IpatchSF2Reader.html"
>IpatchSF2Reader</a> *reader,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err);
void                <a
href="../libinstpatch/IpatchSF2Reader.html#ipatch-sf2-load-phdr"
>ipatch_sf2_load_phdr</a>                (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/IpatchSF2File.html#IpatchSF2Phdr"
>IpatchSF2Phdr</a> *phdr);
void                <a
href="../libinstpatch/IpatchSF2Reader.html#ipatch-sf2-load-ihdr"
>ipatch_sf2_load_ihdr</a>                (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/IpatchSF2File.html#IpatchSF2Ihdr"
>IpatchSF2Ihdr</a> *ihdr);
void                <a
href="../libinstpatch/IpatchSF2Reader.html#ipatch-sf2-load-shdr"
>ipatch_sf2_load_shdr</a>                (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/IpatchSF2File.html#IpatchSF2Shdr"
>IpatchSF2Shdr</a> *shdr);
void                <a
href="../libinstpatch/IpatchSF2Reader.html#ipatch-sf2-load-bag"
>ipatch_sf2_load_bag</a>                 (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/IpatchSF2File.html#IpatchSF2Bag"
>IpatchSF2Bag</a> *bag);
void                <a
href="../libinstpatch/IpatchSF2Reader.html#ipatch-sf2-load-mod"
>ipatch_sf2_load_mod</a>                 (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *mod);
void                <a
href="../libinstpatch/IpatchSF2Reader.html#ipatch-sf2-load-gen"
>ipatch_sf2_load_gen</a>                 (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         int *genid,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *amount);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchSF2Reader.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/IpatchRiff.html"
>IpatchRiff</a>
         +----IpatchSF2Reader
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchSF2Reader.description"></a><h2>Description</h2>
<p>
Reads a SoundFont file and loads it into a object tree (<a
href="../libinstpatch/IpatchSF2.html"
><span class="type">IpatchSF2</span></a>).</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchSF2Reader.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchSF2Reader">
<a name="IpatchSF2Reader-struct"></a><h3>IpatchSF2Reader</h3>
<pre class="programlisting">typedef struct _IpatchSF2Reader IpatchSF2Reader;</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_reader_new ()">
<a name="ipatch-sf2-reader-new"></a><h3>ipatch_sf2_reader_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchSF2Reader.html"
>IpatchSF2Reader</a> *   ipatch_sf2_reader_new               (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle);</pre>
<p>
Create a new SoundFont file reader</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td> SoundFont 2 file handle to parse or <code class="literal">NULL</code> to set later
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The new SoundFont file reader
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_reader_set_file_handle ()">
<a name="ipatch-sf2-reader-set-file-handle"></a><h3>ipatch_sf2_reader_set_file_handle ()</h3>
<pre class="programlisting">void                ipatch_sf2_reader_set_file_handle   (<a
href="../libinstpatch/IpatchSF2Reader.html"
>IpatchSF2Reader</a> *reader,
                                                         <a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle);</pre>
<p>
Set the SoundFont file handle of a SoundFont reader. A convenience
function, since <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-set-file-handle"
><code class="function">ipatch_riff_set_file_handle()</code></a> could also be used, albeit
without stricter type casting.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>reader</code></em> :</span></p></td>
<td> SoundFont reader object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td> SoundFont 2 file handle
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_reader_load ()">
<a name="ipatch-sf2-reader-load"></a><h3>ipatch_sf2_reader_load ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchSF2.html"
>IpatchSF2</a> *         ipatch_sf2_reader_load              (<a
href="../libinstpatch/IpatchSF2Reader.html"
>IpatchSF2Reader</a> *reader,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
Load an SF2 file.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>reader</code></em> :</span></p></td>
<td> SF2 reader object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New SF2 object with refcount of 1.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_load_phdr ()">
<a name="ipatch-sf2-load-phdr"></a><h3>ipatch_sf2_load_phdr ()</h3>
<pre class="programlisting">void                ipatch_sf2_load_phdr                (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/IpatchSF2File.html#IpatchSF2Phdr"
>IpatchSF2Phdr</a> *phdr);</pre>
<p>
Parses a raw preset header in file <em class="parameter"><code>handle</code></em> with buffered data.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td> File handle containing buffered data
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>phdr</code></em> :</span></p></td>
<td> Pointer to a user supplied preset header structure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_load_ihdr ()">
<a name="ipatch-sf2-load-ihdr"></a><h3>ipatch_sf2_load_ihdr ()</h3>
<pre class="programlisting">void                ipatch_sf2_load_ihdr                (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/IpatchSF2File.html#IpatchSF2Ihdr"
>IpatchSF2Ihdr</a> *ihdr);</pre>
<p>
Parses a raw instrument header in file <em class="parameter"><code>handle</code></em> with buffered data.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td> File handle containing buffered data
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ihdr</code></em> :</span></p></td>
<td> Pointer to a user supplied instrument header structure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_load_shdr ()">
<a name="ipatch-sf2-load-shdr"></a><h3>ipatch_sf2_load_shdr ()</h3>
<pre class="programlisting">void                ipatch_sf2_load_shdr                (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/IpatchSF2File.html#IpatchSF2Shdr"
>IpatchSF2Shdr</a> *shdr);</pre>
<p>
Parses a raw sample header in file <em class="parameter"><code>handle</code></em> with buffered data.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td> File handle containing buffered data
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>shdr</code></em> :</span></p></td>
<td> Pointer to a user supplied sample header structure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_load_bag ()">
<a name="ipatch-sf2-load-bag"></a><h3>ipatch_sf2_load_bag ()</h3>
<pre class="programlisting">void                ipatch_sf2_load_bag                 (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/IpatchSF2File.html#IpatchSF2Bag"
>IpatchSF2Bag</a> *bag);</pre>
<p>
Parses a raw preset or instrument bag in file <em class="parameter"><code>handle</code></em> with buffered data.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td> File handle containing buffered data
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>bag</code></em> :</span></p></td>
<td> Pointer to a user supplied bag structure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_load_mod ()">
<a name="ipatch-sf2-load-mod"></a><h3>ipatch_sf2_load_mod ()</h3>
<pre class="programlisting">void                ipatch_sf2_load_mod                 (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *mod);</pre>
<p>
Parses a raw modulator in file <em class="parameter"><code>handle</code></em> with buffered data.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td> File handle containing buffered data
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mod</code></em> :</span></p></td>
<td> Pointer to a user supplied modulator structure
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_load_gen ()">
<a name="ipatch-sf2-load-gen"></a><h3>ipatch_sf2_load_gen ()</h3>
<pre class="programlisting">void                ipatch_sf2_load_gen                 (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         int *genid,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *amount);</pre>
<p>
Parses a raw generator in file <em class="parameter"><code>handle</code></em> with buffered data.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td> File handle containing buffered data
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>genid</code></em> :</span></p></td>
<td> Pointer to store the generator ID in
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>amount</code></em> :</span></p></td>
<td> Pointer to a generator amount to store the amount in
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.