-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathaudio_8h.html
More file actions
444 lines (411 loc) · 28.6 KB
/
audio_8h.html
File metadata and controls
444 lines (411 loc) · 28.6 KB
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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libfluidsynth: audio.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libfluidsynth
 <span id="projectnumber">1.1.11</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e9d22631e23def53df9d7c08c7c6097f.html">fluidsynth</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">audio.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Functions for audio driver output.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a3bcb63db55c58403dad66496422ec462"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#a3bcb63db55c58403dad66496422ec462">fluid_audio_func_t</a>) (void *data, int len, int nin, float **in, int nout, float **out)</td></tr>
<tr class="memdesc:a3bcb63db55c58403dad66496422ec462"><td class="mdescLeft"> </td><td class="mdescRight">Callback function type used with <a class="el" href="audio_8h.html#a3959d8add1dea97e507a5ea2c802c0bc" title="Create a new audio driver. ">new_fluid_audio_driver2()</a> to allow for custom user audio processing before the audio is sent to the driver. <a href="#a3bcb63db55c58403dad66496422ec462">More...</a><br /></td></tr>
<tr class="separator:a3bcb63db55c58403dad66496422ec462"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a4ad51317b10b89bfe94ade5db345864b"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API <a class="el" href="types_8h.html#ac3706330ce49cac5b7dd079e90d376d8">fluid_audio_driver_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#a4ad51317b10b89bfe94ade5db345864b">new_fluid_audio_driver</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, <a class="el" href="types_8h.html#ae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a> *synth)</td></tr>
<tr class="memdesc:a4ad51317b10b89bfe94ade5db345864b"><td class="mdescLeft"> </td><td class="mdescRight">Create a new audio driver. <a href="#a4ad51317b10b89bfe94ade5db345864b">More...</a><br /></td></tr>
<tr class="separator:a4ad51317b10b89bfe94ade5db345864b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3959d8add1dea97e507a5ea2c802c0bc"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API <a class="el" href="types_8h.html#ac3706330ce49cac5b7dd079e90d376d8">fluid_audio_driver_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#a3959d8add1dea97e507a5ea2c802c0bc">new_fluid_audio_driver2</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, <a class="el" href="audio_8h.html#a3bcb63db55c58403dad66496422ec462">fluid_audio_func_t</a> func, void *data)</td></tr>
<tr class="memdesc:a3959d8add1dea97e507a5ea2c802c0bc"><td class="mdescLeft"> </td><td class="mdescRight">Create a new audio driver. <a href="#a3959d8add1dea97e507a5ea2c802c0bc">More...</a><br /></td></tr>
<tr class="separator:a3959d8add1dea97e507a5ea2c802c0bc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a05678e633d37da0f93000045393e9442"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#a05678e633d37da0f93000045393e9442">delete_fluid_audio_driver</a> (<a class="el" href="types_8h.html#ac3706330ce49cac5b7dd079e90d376d8">fluid_audio_driver_t</a> *driver)</td></tr>
<tr class="memdesc:a05678e633d37da0f93000045393e9442"><td class="mdescLeft"> </td><td class="mdescRight">Deletes an audio driver instance. <a href="#a05678e633d37da0f93000045393e9442">More...</a><br /></td></tr>
<tr class="separator:a05678e633d37da0f93000045393e9442"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d9338a870c5f71ba6fad6db7d17a93e"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API <a class="el" href="types_8h.html#a8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#a9d9338a870c5f71ba6fad6db7d17a93e">new_fluid_file_renderer</a> (<a class="el" href="types_8h.html#ae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a> *synth)</td></tr>
<tr class="memdesc:a9d9338a870c5f71ba6fad6db7d17a93e"><td class="mdescLeft"> </td><td class="mdescRight">Create a new file renderer and open the file. <a href="#a9d9338a870c5f71ba6fad6db7d17a93e">More...</a><br /></td></tr>
<tr class="separator:a9d9338a870c5f71ba6fad6db7d17a93e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abdea2fb753cf1a5fa9b5dca38c177d80"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#abdea2fb753cf1a5fa9b5dca38c177d80">fluid_file_renderer_process_block</a> (<a class="el" href="types_8h.html#a8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a> *dev)</td></tr>
<tr class="memdesc:abdea2fb753cf1a5fa9b5dca38c177d80"><td class="mdescLeft"> </td><td class="mdescRight">Write period_size samples to file. <a href="#abdea2fb753cf1a5fa9b5dca38c177d80">More...</a><br /></td></tr>
<tr class="separator:abdea2fb753cf1a5fa9b5dca38c177d80"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6893d780de15030366e2399293ed7362"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#a6893d780de15030366e2399293ed7362">delete_fluid_file_renderer</a> (<a class="el" href="types_8h.html#a8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a> *dev)</td></tr>
<tr class="memdesc:a6893d780de15030366e2399293ed7362"><td class="mdescLeft"> </td><td class="mdescRight">Close file and destroy a file renderer object. <a href="#a6893d780de15030366e2399293ed7362">More...</a><br /></td></tr>
<tr class="separator:a6893d780de15030366e2399293ed7362"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9915ff06a55cc1fa52fe6eb079cb8718"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#a9915ff06a55cc1fa52fe6eb079cb8718">fluid_file_set_encoding_quality</a> (<a class="el" href="types_8h.html#a8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a> *dev, double q)</td></tr>
<tr class="memdesc:a9915ff06a55cc1fa52fe6eb079cb8718"><td class="mdescLeft"> </td><td class="mdescRight">Set vbr encoding quality (only available with libsndfile support) <a href="#a9915ff06a55cc1fa52fe6eb079cb8718">More...</a><br /></td></tr>
<tr class="separator:a9915ff06a55cc1fa52fe6eb079cb8718"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad35f9fb8b124e8e9e8829fa9efefeb34"><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="audio_8h.html#ad35f9fb8b124e8e9e8829fa9efefeb34">fluid_audio_driver_register</a> (const char **adrivers)</td></tr>
<tr class="memdesc:ad35f9fb8b124e8e9e8829fa9efefeb34"><td class="mdescLeft"> </td><td class="mdescRight">Registers audio drivers to use. <a href="#ad35f9fb8b124e8e9e8829fa9efefeb34">More...</a><br /></td></tr>
<tr class="separator:ad35f9fb8b124e8e9e8829fa9efefeb34"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Functions for audio driver output. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a3bcb63db55c58403dad66496422ec462"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bcb63db55c58403dad66496422ec462">◆ </a></span>fluid_audio_func_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* fluid_audio_func_t) (void *data, int len, int nin, float **in, int nout, float **out)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback function type used with <a class="el" href="audio_8h.html#a3959d8add1dea97e507a5ea2c802c0bc" title="Create a new audio driver. ">new_fluid_audio_driver2()</a> to allow for custom user audio processing before the audio is sent to the driver. </p>
<p>This function is responsible for rendering the audio to the buffers. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>The user data parameter as passed to <a class="el" href="audio_8h.html#a3959d8add1dea97e507a5ea2c802c0bc" title="Create a new audio driver. ">new_fluid_audio_driver2()</a>. </td></tr>
<tr><td class="paramname">len</td><td>Length of the audio in frames. </td></tr>
<tr><td class="paramname">nin</td><td>Count of buffers in 'in' </td></tr>
<tr><td class="paramname">in</td><td>Not used currently </td></tr>
<tr><td class="paramname">nout</td><td>Count of arrays in 'out' (i.e., channel count) </td></tr>
<tr><td class="paramname">out</td><td>Output buffers, one for each channel </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Should return 0 on success, non-zero if an error occured. </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a4ad51317b10b89bfe94ade5db345864b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4ad51317b10b89bfe94ade5db345864b">◆ </a></span>new_fluid_audio_driver()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API <a class="el" href="types_8h.html#ac3706330ce49cac5b7dd079e90d376d8">fluid_audio_driver_t</a>* new_fluid_audio_driver </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"><em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a> * </td>
<td class="paramname"><em>synth</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new audio driver. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>Configuration settings used to select and create the audio driver. </td></tr>
<tr><td class="paramname">synth</td><td>Synthesizer instance for which the audio driver is created for. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The new audio driver instance.</dd></dl>
<p>Creates a new audio driver for a given 'synth' instance with a defined set of configuration 'settings'. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example_8c-example.html#a2">example.c</a>, <a class="el" href="fluidsynth_arpeggio_8c-example.html#a10">fluidsynth_arpeggio.c</a>, <a class="el" href="fluidsynth_metronome_8c-example.html#a9">fluidsynth_metronome.c</a>, <a class="el" href="fluidsynth_register_adriver_8c-example.html#a5">fluidsynth_register_adriver.c</a>, and <a class="el" href="fluidsynth_simple_8c-example.html#a3">fluidsynth_simple.c</a>.</dd>
</dl>
</div>
</div>
<a id="a3959d8add1dea97e507a5ea2c802c0bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3959d8add1dea97e507a5ea2c802c0bc">◆ </a></span>new_fluid_audio_driver2()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API <a class="el" href="types_8h.html#ac3706330ce49cac5b7dd079e90d376d8">fluid_audio_driver_t</a>* new_fluid_audio_driver2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"><em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="audio_8h.html#a3bcb63db55c58403dad66496422ec462">fluid_audio_func_t</a> </td>
<td class="paramname"><em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new audio driver. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>Configuration settings used to select and create the audio driver. </td></tr>
<tr><td class="paramname">func</td><td>Function called to fill audio buffers for audio playback </td></tr>
<tr><td class="paramname">data</td><td>User defined data pointer to pass to 'func' </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The new audio driver instance.</dd></dl>
<p>Like <a class="el" href="audio_8h.html#a4ad51317b10b89bfe94ade5db345864b" title="Create a new audio driver. ">new_fluid_audio_driver()</a> but allows for custom audio processing before audio is sent to audio driver. It is the responsibility of the callback 'func' to render the audio into the buffers.</p>
<p>NOTE: Not as efficient as <a class="el" href="audio_8h.html#a4ad51317b10b89bfe94ade5db345864b" title="Create a new audio driver. ">new_fluid_audio_driver()</a>. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="fluidsynth_fx_8c-example.html#a4">fluidsynth_fx.c</a>.</dd>
</dl>
<p class="reference">References <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9ea5542b67c606598020b832c31729175fc">FLUID_DBG</a>.</p>
</div>
</div>
<a id="a05678e633d37da0f93000045393e9442"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05678e633d37da0f93000045393e9442">◆ </a></span>delete_fluid_audio_driver()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void delete_fluid_audio_driver </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ac3706330ce49cac5b7dd079e90d376d8">fluid_audio_driver_t</a> * </td>
<td class="paramname"><em>driver</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deletes an audio driver instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">driver</td><td>Audio driver instance to delete</td></tr>
</table>
</dd>
</dl>
<p>Shuts down an audio driver and deletes its instance. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example_8c-example.html#a6">example.c</a>, <a class="el" href="fluidsynth_arpeggio_8c-example.html#a17">fluidsynth_arpeggio.c</a>, <a class="el" href="fluidsynth_fx_8c-example.html#a6">fluidsynth_fx.c</a>, <a class="el" href="fluidsynth_metronome_8c-example.html#a16">fluidsynth_metronome.c</a>, <a class="el" href="fluidsynth_register_adriver_8c-example.html#a6">fluidsynth_register_adriver.c</a>, and <a class="el" href="fluidsynth_simple_8c-example.html#a5">fluidsynth_simple.c</a>.</dd>
</dl>
</div>
</div>
<a id="a9d9338a870c5f71ba6fad6db7d17a93e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d9338a870c5f71ba6fad6db7d17a93e">◆ </a></span>new_fluid_file_renderer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API <a class="el" href="types_8h.html#a8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a>* new_fluid_file_renderer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a> * </td>
<td class="paramname"><em>synth</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new file renderer and open the file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">synth</td><td>The synth that creates audio data. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the new object, or NULL on failure </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.1.0</dd></dl>
<p>NOTE: Available file types and formats depends on if libfluidsynth was built with libsndfile support or not. If not then only RAW 16 bit output is supported.</p>
<p>Uses the following settings from the synth object:</p><ul>
<li>audio.file.name: Output filename</li>
<li>audio.file.type: File type, "auto" tries to determine type from filename extension with fallback to "wav".</li>
<li>audio.file.format: Audio format</li>
<li>audio.file.endian: Endian byte order, "auto" for file type's default byte order</li>
<li>audio.period-size: Size of audio blocks to process</li>
<li>synth.sample-rate: Sample rate to use </li>
</ul>
<p class="reference">References <a class="el" href="audio_8h.html#a6893d780de15030366e2399293ed7362">delete_fluid_file_renderer()</a>, <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9eabc0ff48d192b3b0fc721946ccf095d25">FLUID_ERR</a>, <a class="el" href="settings_8h.html#aa2cf8ed808a4ce5fcfdfb208ea77811b">fluid_settings_dupstr()</a>, <a class="el" href="settings_8h.html#a4a570095ef3de25e77f4dd9c574bc56c">fluid_settings_getint()</a>, and <a class="el" href="settings_8h.html#a619c930e119a4a3889131d67293e2089">fluid_settings_getnum()</a>.</p>
</div>
</div>
<a id="abdea2fb753cf1a5fa9b5dca38c177d80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdea2fb753cf1a5fa9b5dca38c177d80">◆ </a></span>fluid_file_renderer_process_block()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_file_renderer_process_block </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a> * </td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write period_size samples to file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>File renderer instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions. ">FLUID_OK</a> or <a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61" title="Value that indicates failure, used by most libfluidsynth functions. ">FLUID_FAILED</a> if an error occurred </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.1.0 </dd></dl>
<p class="reference">References <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9eabc0ff48d192b3b0fc721946ccf095d25">FLUID_ERR</a>, <a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61">FLUID_FAILED</a>, <a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886">FLUID_OK</a>, <a class="el" href="synth_8h.html#ac86a79a943fc5d5d485ccc5a5fcad03d">fluid_synth_write_float()</a>, <a class="el" href="synth_8h.html#a0d7c287342eb282d4ec63ea7f35cd791">fluid_synth_write_s16()</a>, and <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9ea394460be1ec74fce15e1ff683606df0f">FLUID_WARN</a>.</p>
</div>
</div>
<a id="a6893d780de15030366e2399293ed7362"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6893d780de15030366e2399293ed7362">◆ </a></span>delete_fluid_file_renderer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void delete_fluid_file_renderer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a> * </td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close file and destroy a file renderer object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>File renderer object. </td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>1.1.0 </dd></dl>
<p class="reference">References <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9ea394460be1ec74fce15e1ff683606df0f">FLUID_WARN</a>.</p>
<p class="reference">Referenced by <a class="el" href="audio_8h.html#a9d9338a870c5f71ba6fad6db7d17a93e">new_fluid_file_renderer()</a>.</p>
</div>
</div>
<a id="a9915ff06a55cc1fa52fe6eb079cb8718"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9915ff06a55cc1fa52fe6eb079cb8718">◆ </a></span>fluid_file_set_encoding_quality()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_file_set_encoding_quality </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a> * </td>
<td class="paramname"><em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>q</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set vbr encoding quality (only available with libsndfile support) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>File renderer object. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions. ">FLUID_OK</a> if the quality has been successfully set, <a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61" title="Value that indicates failure, used by most libfluidsynth functions. ">FLUID_FAILED</a> otherwise </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.1.7 </dd></dl>
<p class="reference">References <a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61">FLUID_FAILED</a>, and <a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886">FLUID_OK</a>.</p>
</div>
</div>
<a id="ad35f9fb8b124e8e9e8829fa9efefeb34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad35f9fb8b124e8e9e8829fa9efefeb34">◆ </a></span>fluid_audio_driver_register()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_audio_driver_register </td>
<td>(</td>
<td class="paramtype">const char ** </td>
<td class="paramname"><em>adrivers</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers audio drivers to use. </p>
<p>When creating a settings instance with <a class="el" href="settings_8h.html#ad7ab9269a28c2b5852d512ffe3546949" title="Create a new settings object. ">new_fluid_settings()</a>, all audio drivers are initialized once. In the past this has caused segfaults and application crashes due to buggy soundcard drivers.</p>
<p>This function enables the user to only initialize specific audio drivers when settings instances are created. Therefore pass a NULL-terminated array of C-strings containing the <code>names</code> of audio drivers to register for the usage with fluidsynth. The <code>names</code> are the same as being used for the <code>audio.driver</code> setting.</p>
<p>By default all audio drivers fluidsynth has been compiled with are registered, so calling this function is optional.</p>
<dl class="section warning"><dt>Warning</dt><dd>This function may only be called if no thread is residing in fluidsynth's API and no instances of any kind are alive (e.g. as it would be the case right after fluidsynth's inital creation). Else the behaviour is undefined. Furtermore any attempt of using audio drivers that have not been registered is undefined behaviour!</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">adrivers</td><td>NULL-terminated array of audio drivers to register. Pass NULL to register all available drivers. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions. ">FLUID_OK</a> if all the audio drivers requested by the user are supported by fluidsynth and have been successfully registered. Otherwise <a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61" title="Value that indicates failure, used by most libfluidsynth functions. ">FLUID_FAILED</a> is returned and this function has no effect.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function is not thread safe and will never be! </dd></dl>
<dl class="section since"><dt>Since</dt><dd>1.1.9 </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="fluidsynth_register_adriver_8c-example.html#a0">fluidsynth_register_adriver.c</a>.</dd>
</dl>
<p class="reference">References <a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61">FLUID_FAILED</a>, and <a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886">FLUID_OK</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>