-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathgroup__file__renderer.html
More file actions
254 lines (239 loc) · 14.2 KB
/
group__file__renderer.html
File metadata and controls
254 lines (239 loc) · 14.2 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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libfluidsynth: File Renderer</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
<link href="custom.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">2.5.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__file__renderer.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">File Renderer<div class="ingroups"><a class="el" href="group__audio__output.html">Audio Output</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Functions for managing file renderers and triggering the rendering.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader">Lifecycle Functions for File Renderer</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpd33f2318964e16bd7bb8c69674270c62"></a></p>
</td></tr>
<tr class="memitem:ga20cf09534dcc7b9de623f0e41e0d9a68"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Types.html#ga8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__file__renderer.html#ga20cf09534dcc7b9de623f0e41e0d9a68">new_fluid_file_renderer</a> (<a class="el" href="group__Types.html#gae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a> *synth)</td></tr>
<tr class="memdesc:ga20cf09534dcc7b9de623f0e41e0d9a68"><td class="mdescLeft"> </td><td class="mdescRight">Create a new file renderer and open the file. <a href="group__file__renderer.html#ga20cf09534dcc7b9de623f0e41e0d9a68">More...</a><br /></td></tr>
<tr class="separator:ga20cf09534dcc7b9de623f0e41e0d9a68"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa3ee9fcd3d56c41738db8fc8c9197038"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__file__renderer.html#gaa3ee9fcd3d56c41738db8fc8c9197038">delete_fluid_file_renderer</a> (<a class="el" href="group__Types.html#ga8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a> *dev)</td></tr>
<tr class="memdesc:gaa3ee9fcd3d56c41738db8fc8c9197038"><td class="mdescLeft"> </td><td class="mdescRight">Close file and destroy a file renderer object. <a href="group__file__renderer.html#gaa3ee9fcd3d56c41738db8fc8c9197038">More...</a><br /></td></tr>
<tr class="separator:gaa3ee9fcd3d56c41738db8fc8c9197038"><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:gae59b0226321ae517f1a71a8368acef42"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__file__renderer.html#gae59b0226321ae517f1a71a8368acef42">fluid_file_renderer_process_block</a> (<a class="el" href="group__Types.html#ga8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a> *dev)</td></tr>
<tr class="memdesc:gae59b0226321ae517f1a71a8368acef42"><td class="mdescLeft"> </td><td class="mdescRight">Write period_size samples to file. <a href="group__file__renderer.html#gae59b0226321ae517f1a71a8368acef42">More...</a><br /></td></tr>
<tr class="separator:gae59b0226321ae517f1a71a8368acef42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad69ba2fdcb9edba71b0cb6fddf6e18ae"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__file__renderer.html#gad69ba2fdcb9edba71b0cb6fddf6e18ae">fluid_file_set_encoding_quality</a> (<a class="el" href="group__Types.html#ga8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a> *dev, double q)</td></tr>
<tr class="memdesc:gad69ba2fdcb9edba71b0cb6fddf6e18ae"><td class="mdescLeft"> </td><td class="mdescRight">Set vbr encoding quality (only available with libsndfile support) <a href="group__file__renderer.html#gad69ba2fdcb9edba71b0cb6fddf6e18ae">More...</a><br /></td></tr>
<tr class="separator:gad69ba2fdcb9edba71b0cb6fddf6e18ae"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions for managing file renderers and triggering the rendering. </p>
<p>The file renderer is only used to render a MIDI file to audio as fast as possible. Please see <a class="el" href="FileRenderer.html">Fast file renderer for non-realtime MIDI file rendering</a> for a full example.</p>
<p>If you are looking for a way to write audio generated from realtime events (for example from an external sequencer or a MIDI controller) to a file, please have a look at the <code>file</code> <a class="el" href="group__audio__driver.html">Audio Driver</a> instead. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaa3ee9fcd3d56c41738db8fc8c9197038"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa3ee9fcd3d56c41738db8fc8c9197038">◆ </a></span>delete_fluid_file_renderer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void delete_fluid_file_renderer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga8e8a634da121763271ed819dfe866b3d">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>
</div>
</div>
<a id="gae59b0226321ae517f1a71a8368acef42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae59b0226321ae517f1a71a8368acef42">◆ </a></span>fluid_file_renderer_process_block()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_file_renderer_process_block </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga8e8a634da121763271ed819dfe866b3d">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="group__misc.html#gae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions.">FLUID_OK</a> or <a class="el" href="group__misc.html#ga90e8bdbc5a507bbfa5c45bac85a63a61" 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>
</div>
</div>
<a id="gad69ba2fdcb9edba71b0cb6fddf6e18ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad69ba2fdcb9edba71b0cb6fddf6e18ae">◆ </a></span>fluid_file_set_encoding_quality()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_file_set_encoding_quality </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a> * </td>
<td class="paramname"><em>dev</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>
<tr><td class="paramname">q</td><td>The encoding quality, see libsndfile documentation of <code>SFC_SET_VBR_ENCODING_QUALITY</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__misc.html#gae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions.">FLUID_OK</a> if the quality has been successfully set, <a class="el" href="group__misc.html#ga90e8bdbc5a507bbfa5c45bac85a63a61" 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>
</div>
</div>
<a id="ga20cf09534dcc7b9de623f0e41e0d9a68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga20cf09534dcc7b9de623f0e41e0d9a68">◆ </a></span>new_fluid_file_renderer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Types.html#ga8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a>* new_fluid_file_renderer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#gae265f10ae174a13afe010de50d87e1a4">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 note"><dt>Note</dt><dd>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.</dd></dl>
<p>Uses the following settings from the synth object:</p><ul>
<li><a class="el" href="settings_audio.html#settings_audio_file_name">audio.file.name</a> : Output filename</li>
<li><a class="el" href="settings_audio.html#settings_audio_file_type">audio.file.type</a> : File type, "auto" tries to determine type from filename extension with fallback to "wav".</li>
<li><a class="el" href="settings_audio.html#settings_audio_file_format">audio.file.format</a> : Audio format</li>
<li><a class="el" href="settings_audio.html#settings_audio_file_endian">audio.file.endian</a> : Endian byte order, "auto" for file type's default byte order</li>
<li><a class="el" href="settings_audio.html#settings_audio_period-size">audio.period-size</a> : Size of audio blocks to process</li>
<li><a class="el" href="settings_synth.html#settings_synth_sample-rate">synth.sample-rate</a> : Sample rate to use</li>
</ul>
<dl class="section since"><dt>Since</dt><dd>1.1.0 </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>