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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchSampleStoreSndFile</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="IpatchSampleStoreRom.html" title="IpatchSampleStoreRom">
<link rel="next" href="IpatchSampleStoreSplit24.html" title="IpatchSampleStoreSplit24">
<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="IpatchSampleStoreRom.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="IpatchSampleStoreSplit24.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchSampleStoreSndFile.synopsis" class="shortcut">Top</a>
|
<a href="#IpatchSampleStoreSndFile.description" class="shortcut">Description</a>
|
<a href="#IpatchSampleStoreSndFile.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#IpatchSampleStoreSndFile.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#IpatchSampleStoreSndFile.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="IpatchSampleStoreSndFile">
<a name="IpatchSampleStoreSndFile"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchSampleStoreSndFile.top_of_page"></a>IpatchSampleStoreSndFile</span></h2>
<p>IpatchSampleStoreSndFile — Sample store object type which uses libsndfile to access
audio in sound files</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchSampleStoreSndFile.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchSampleStoreSndFile.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile-struct"
>IpatchSampleStoreSndFile</a>;
#define <a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IPATCH-SAMPLE-STORE-SND-FILE-UNUSED-FLAG-SHIFT--CAPS"
>IPATCH_SAMPLE_STORE_SND_FILE_UNUSED_FLAG_SHIFT</a>
<a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a> * <a
href="../libinstpatch/IpatchSampleStoreSndFile.html#ipatch-sample-store-snd-file-new"
>ipatch_sample_store_snd_file_new</a> (const char *filename);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/IpatchSampleStoreSndFile.html#ipatch-sample-store-snd-file-init-read"
>ipatch_sample_store_snd_file_init_read</a>
(<a
href="../libinstpatch/IpatchSampleStoreSndFile.html"
>IpatchSampleStoreSndFile</a> *store);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/IpatchSampleStoreSndFile.html#ipatch-sample-store-snd-file-init-write"
>ipatch_sample_store_snd_file_init_write</a>
(<a
href="../libinstpatch/IpatchSampleStoreSndFile.html"
>IpatchSampleStoreSndFile</a> *store,
int file_format,
int sub_format,
int endian,
int channels,
int samplerate);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchSampleStoreSndFile.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>
+----IpatchSampleStoreSndFile
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="IpatchSampleStoreSndFile.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
IpatchSampleStoreSndFile implements
<a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="IpatchSampleStoreSndFile.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile--endian"
>endian</a>" <a
href="../libinstpatch/IpatchSndFile.html#IpatchSndFileEndian"
>IpatchSndFileEndian</a> : Read / Write
"<a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile--file-format"
>file-format</a>" IpatchSndFileFormat : Read / Write
"<a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile--file-name"
>file-name</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write
"<a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile--fine-tune"
>fine-tune</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write
"<a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile--loop-end"
>loop-end</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> : Read / Write
"<a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile--loop-start"
>loop-start</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> : Read / Write
"<a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile--loop-type"
>loop-type</a>" <a
href="../libinstpatch/IpatchSample.html#IpatchSampleLoopType"
>IpatchSampleLoopType</a> : Read / Write
"<a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile--root-note"
>root-note</a>" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write
"<a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile--sub-format"
>sub-format</a>" IpatchSndFileSubFormat : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchSampleStoreSndFile.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchSampleStoreSndFile.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchSampleStoreSndFile">
<a name="IpatchSampleStoreSndFile-struct"></a><h3>IpatchSampleStoreSndFile</h3>
<pre class="programlisting">typedef struct _IpatchSampleStoreSndFile IpatchSampleStoreSndFile;</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_STORE_SND_FILE_UNUSED_FLAG_SHIFT">
<a name="IPATCH-SAMPLE-STORE-SND-FILE-UNUSED-FLAG-SHIFT--CAPS"></a><h3>IPATCH_SAMPLE_STORE_SND_FILE_UNUSED_FLAG_SHIFT</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_STORE_SND_FILE_UNUSED_FLAG_SHIFT</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_snd_file_new ()">
<a name="ipatch-sample-store-snd-file-new"></a><h3>ipatch_sample_store_snd_file_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchSample.html"
>IpatchSample</a> * ipatch_sample_store_snd_file_new (const char *filename);</pre>
<p>
Creates a new libsndfile sample store. <a
href="../libinstpatch/IpatchSampleStoreSndFile.html#ipatch-sample-store-snd-file-init-read"
><code class="function">ipatch_sample_store_snd_file_init_read()</code></a>
or <a
href="../libinstpatch/IpatchSampleStoreSndFile.html#ipatch-sample-store-snd-file-init-write"
><code class="function">ipatch_sample_store_snd_file_init_write()</code></a> must be called, depending on
audio file mode, prior to opening the sample.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td> File name to assign to the new libsndfile sample store
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New libsndfile 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_snd_file_init_read ()">
<a name="ipatch-sample-store-snd-file-init-read"></a><h3>ipatch_sample_store_snd_file_init_read ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_sample_store_snd_file_init_read
(<a
href="../libinstpatch/IpatchSampleStoreSndFile.html"
>IpatchSampleStoreSndFile</a> *store);</pre>
<p>
Initialize a libsndfile sample store for reading. Should be called prior to
opening the sample store and after the filename has been assigned. Fills in
the <a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile--file-format"
><span class="type">"file-format"</span></a>, <a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile--sub-format"
><span class="type">"sub-format"</span></a>,
<a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile--endian"
><span class="type">"endian"</span></a>, <a
href="../libinstpatch/IpatchSample.html#IpatchSample--sample-rate"
><span class="type">"sample-rate"</span></a> and
<a
href="../libinstpatch/IpatchSample.html#IpatchSample--sample-size"
><span class="type">"sample-size"</span></a> information properties. In addition the
<a
href="../libinstpatch/IpatchSample.html#IpatchSample--sample-format"
><span class="type">"sample-format"</span></a> property is set to a value for optimal loading of the
audio data (least amount of conversion necessary to yield uncompressed PCM
audio), which will be the audio format of the sample store.</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> libsndfile sample store
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_store_snd_file_init_write ()">
<a name="ipatch-sample-store-snd-file-init-write"></a><h3>ipatch_sample_store_snd_file_init_write ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_sample_store_snd_file_init_write
(<a
href="../libinstpatch/IpatchSampleStoreSndFile.html"
>IpatchSampleStoreSndFile</a> *store,
int file_format,
int sub_format,
int endian,
int channels,
int samplerate);</pre>
<p>
Initialize a libsndfile sample store for writing. Should be called prior to
opening the sample store. The <a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile--file-format"
><span class="type">"file-format"</span></a>,
<a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile--sub-format"
><span class="type">"sub-format"</span></a>, <a
href="../libinstpatch/IpatchSampleStoreSndFile.html#IpatchSampleStoreSndFile--endian"
><span class="type">"endian"</span></a>
and <a
href="../libinstpatch/IpatchSample.html#IpatchSample--sample-rate"
><span class="type">"sample-rate"</span></a> properties will be assigned the provided values.
In addition the <a
href="../libinstpatch/IpatchSample.html#IpatchSample--sample-format"
><span class="type">"sample-format"</span></a> property is set to a value for optimal
writing of the audio data (including the <em class="parameter"><code>channels</code></em> value), which will be the
audio format of the sample store.</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> libsndfile sample store
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_format</code></em> :</span></p></td>
<td> libsndfile file format type (GEnum "IpatchSndFileFormat")
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sub_format</code></em> :</span></p></td>
<td> libsndfile audio format type (GEnum "IpatchSndFileSubFormat")
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>endian</code></em> :</span></p></td>
<td> libsndfile endian selection (<span class="type">IpatchSampleStoreSndFileEndian</span>)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>channels</code></em> :</span></p></td>
<td> Number of channels (1-8, 1=mono, 2=stereo, etc)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>samplerate</code></em> :</span></p></td>
<td> Audio sample rate
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if format variables are valid, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="IpatchSampleStoreSndFile.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "endian" property'>
<a name="IpatchSampleStoreSndFile--endian"></a><h3>The <code class="literal">"endian"</code> property</h3>
<pre class="programlisting"> "endian" <a
href="../libinstpatch/IpatchSndFile.html#IpatchSndFileEndian"
>IpatchSndFileEndian</a> : Read / Write</pre>
<p>Endian byte order of file.</p>
<p>Default value: IPATCH_SND_FILE_ENDIAN_FILE</p>
</div>
<hr>
<div class="refsect2" title='The "file-format" property'>
<a name="IpatchSampleStoreSndFile--file-format"></a><h3>The <code class="literal">"file-format"</code> property</h3>
<pre class="programlisting"> "file-format" IpatchSndFileFormat : Read / Write</pre>
<p>File format.</p>
<p>Default value: wav</p>
</div>
<hr>
<div class="refsect2" title='The "file-name" property'>
<a name="IpatchSampleStoreSndFile--file-name"></a><h3>The <code class="literal">"file-name"</code> property</h3>
<pre class="programlisting"> "file-name" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write</pre>
<p>File name.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" title='The "fine-tune" property'>
<a name="IpatchSampleStoreSndFile--fine-tune"></a><h3>The <code class="literal">"fine-tune"</code> property</h3>
<pre class="programlisting"> "fine-tune" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write</pre>
<p>Fine tuning in cents.</p>
<p>Allowed values: [-99,99]</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "loop-end" property'>
<a name="IpatchSampleStoreSndFile--loop-end"></a><h3>The <code class="literal">"loop-end"</code> property</h3>
<pre class="programlisting"> "loop-end" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> : Read / Write</pre>
<p>Loop end in frames (after loop).</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "loop-start" property'>
<a name="IpatchSampleStoreSndFile--loop-start"></a><h3>The <code class="literal">"loop-start"</code> property</h3>
<pre class="programlisting"> "loop-start" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> : Read / Write</pre>
<p>Start of loop in frames.</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2" title='The "loop-type" property'>
<a name="IpatchSampleStoreSndFile--loop-type"></a><h3>The <code class="literal">"loop-type"</code> property</h3>
<pre class="programlisting"> "loop-type" <a
href="../libinstpatch/IpatchSample.html#IpatchSampleLoopType"
>IpatchSampleLoopType</a> : Read / Write</pre>
<p>Loop method type.</p>
<p>Default value: IPATCH_SAMPLE_LOOP_NONE</p>
</div>
<hr>
<div class="refsect2" title='The "root-note" property'>
<a name="IpatchSampleStoreSndFile--root-note"></a><h3>The <code class="literal">"root-note"</code> property</h3>
<pre class="programlisting"> "root-note" <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write</pre>
<p>Root MIDI note.</p>
<p>Allowed values: [0,127]</p>
<p>Default value: 60</p>
</div>
<hr>
<div class="refsect2" title='The "sub-format" property'>
<a name="IpatchSampleStoreSndFile--sub-format"></a><h3>The <code class="literal">"sub-format"</code> property</h3>
<pre class="programlisting"> "sub-format" IpatchSndFileSubFormat : Read / Write</pre>
<p>File sub audio format.</p>
<p>Default value: Signed 16 bit PCM</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|
