-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathstruct__fluid__sfont__t.html
More file actions
241 lines (218 loc) · 13.7 KB
/
struct__fluid__sfont__t.html
File metadata and controls
241 lines (218 loc) · 13.7 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
<!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: _fluid_sfont_t Struct 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">_fluid_sfont_t Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Virtual SoundFont instance structure.
<a href="struct__fluid__sfont__t.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a5a79644021fa078479da5273c4ebfbbc"><td class="memItemLeft" align="right" valign="top"><a id="a5a79644021fa078479da5273c4ebfbbc"></a>
void * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#a5a79644021fa078479da5273c4ebfbbc">data</a></td></tr>
<tr class="memdesc:a5a79644021fa078479da5273c4ebfbbc"><td class="mdescLeft"> </td><td class="mdescRight">User defined data. <br /></td></tr>
<tr class="separator:a5a79644021fa078479da5273c4ebfbbc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae955816cff10890c6369ac04733d37fb"><td class="memItemLeft" align="right" valign="top"><a id="ae955816cff10890c6369ac04733d37fb"></a>
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#ae955816cff10890c6369ac04733d37fb">id</a></td></tr>
<tr class="memdesc:ae955816cff10890c6369ac04733d37fb"><td class="mdescLeft"> </td><td class="mdescRight">SoundFont ID. <br /></td></tr>
<tr class="separator:ae955816cff10890c6369ac04733d37fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a01d49f3cf9d17b20cd284204d265eef5"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#a01d49f3cf9d17b20cd284204d265eef5">free</a> )(<a class="el" href="types_8h.html#aa6c18288f76608acbb10b80a153f4ab8">fluid_sfont_t</a> *sfont)</td></tr>
<tr class="memdesc:a01d49f3cf9d17b20cd284204d265eef5"><td class="mdescLeft"> </td><td class="mdescRight">Method to free a virtual SoundFont bank. <a href="#a01d49f3cf9d17b20cd284204d265eef5">More...</a><br /></td></tr>
<tr class="separator:a01d49f3cf9d17b20cd284204d265eef5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab46352841c9afa1b407f3652ce0ded73"><td class="memItemLeft" align="right" valign="top">char *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#ab46352841c9afa1b407f3652ce0ded73">get_name</a> )(<a class="el" href="types_8h.html#aa6c18288f76608acbb10b80a153f4ab8">fluid_sfont_t</a> *sfont)</td></tr>
<tr class="memdesc:ab46352841c9afa1b407f3652ce0ded73"><td class="mdescLeft"> </td><td class="mdescRight">Method to return the name of a virtual SoundFont. <a href="#ab46352841c9afa1b407f3652ce0ded73">More...</a><br /></td></tr>
<tr class="separator:ab46352841c9afa1b407f3652ce0ded73"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3eb510a8ccd6814dfe4c9b5ccfd0996f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a985e5ee05f433da841127750f67a4723">fluid_preset_t</a> *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#a3eb510a8ccd6814dfe4c9b5ccfd0996f">get_preset</a> )(<a class="el" href="types_8h.html#aa6c18288f76608acbb10b80a153f4ab8">fluid_sfont_t</a> *sfont, unsigned int bank, unsigned int prenum)</td></tr>
<tr class="memdesc:a3eb510a8ccd6814dfe4c9b5ccfd0996f"><td class="mdescLeft"> </td><td class="mdescRight">Get a virtual SoundFont preset by bank and program numbers. <a href="#a3eb510a8ccd6814dfe4c9b5ccfd0996f">More...</a><br /></td></tr>
<tr class="separator:a3eb510a8ccd6814dfe4c9b5ccfd0996f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abdd94ccc6084fa8ec20e65d2021f6df5"><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#abdd94ccc6084fa8ec20e65d2021f6df5">iteration_start</a> )(<a class="el" href="types_8h.html#aa6c18288f76608acbb10b80a153f4ab8">fluid_sfont_t</a> *sfont)</td></tr>
<tr class="memdesc:abdd94ccc6084fa8ec20e65d2021f6df5"><td class="mdescLeft"> </td><td class="mdescRight">Start virtual SoundFont preset iteration method. <a href="#abdd94ccc6084fa8ec20e65d2021f6df5">More...</a><br /></td></tr>
<tr class="separator:abdd94ccc6084fa8ec20e65d2021f6df5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa972dd8cb3caa4dea1e8f0fd01d1f0e3"><td class="memItemLeft" align="right" valign="top">int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__fluid__sfont__t.html#aa972dd8cb3caa4dea1e8f0fd01d1f0e3">iteration_next</a> )(<a class="el" href="types_8h.html#aa6c18288f76608acbb10b80a153f4ab8">fluid_sfont_t</a> *sfont, <a class="el" href="types_8h.html#a985e5ee05f433da841127750f67a4723">fluid_preset_t</a> *preset)</td></tr>
<tr class="memdesc:aa972dd8cb3caa4dea1e8f0fd01d1f0e3"><td class="mdescLeft"> </td><td class="mdescRight">Virtual SoundFont preset iteration function. <a href="#aa972dd8cb3caa4dea1e8f0fd01d1f0e3">More...</a><br /></td></tr>
<tr class="separator:aa972dd8cb3caa4dea1e8f0fd01d1f0e3"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Virtual SoundFont instance structure. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a01d49f3cf9d17b20cd284204d265eef5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01d49f3cf9d17b20cd284204d265eef5">◆ </a></span>free</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* _fluid_sfont_t::free) (<a class="el" href="types_8h.html#aa6c18288f76608acbb10b80a153f4ab8">fluid_sfont_t</a> *sfont)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Method to free a virtual SoundFont bank. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sfont</td><td>Virtual SoundFont to free. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Should return 0 when it was able to free all resources or non-zero if some of the samples could not be freed because they are still in use, in which case the free will be tried again later, until success. </dd></dl>
<p class="reference">Referenced by <a class="el" href="ramsfont_8h.html#adaaf00a64687fd1f2121e27483b9d02e">fluid_ramsfont_create_sfont()</a>.</p>
</div>
</div>
<a id="ab46352841c9afa1b407f3652ce0ded73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab46352841c9afa1b407f3652ce0ded73">◆ </a></span>get_name</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char*(* _fluid_sfont_t::get_name) (<a class="el" href="types_8h.html#aa6c18288f76608acbb10b80a153f4ab8">fluid_sfont_t</a> *sfont)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Method to return the name of a virtual SoundFont. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sfont</td><td>Virtual SoundFont </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The name of the virtual SoundFont. </dd></dl>
<p class="reference">Referenced by <a class="el" href="ramsfont_8h.html#adaaf00a64687fd1f2121e27483b9d02e">fluid_ramsfont_create_sfont()</a>.</p>
</div>
</div>
<a id="a3eb510a8ccd6814dfe4c9b5ccfd0996f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3eb510a8ccd6814dfe4c9b5ccfd0996f">◆ </a></span>get_preset</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a985e5ee05f433da841127750f67a4723">fluid_preset_t</a>*(* _fluid_sfont_t::get_preset) (<a class="el" href="types_8h.html#aa6c18288f76608acbb10b80a153f4ab8">fluid_sfont_t</a> *sfont, unsigned int bank, unsigned int prenum)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a virtual SoundFont preset by bank and program numbers. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sfont</td><td>Virtual SoundFont </td></tr>
<tr><td class="paramname">bank</td><td>MIDI bank number (0-16383) </td></tr>
<tr><td class="paramname">prenum</td><td>MIDI preset number (0-127) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Should return an allocated virtual preset or NULL if it could not be found. </dd></dl>
<p class="reference">Referenced by <a class="el" href="ramsfont_8h.html#adaaf00a64687fd1f2121e27483b9d02e">fluid_ramsfont_create_sfont()</a>.</p>
</div>
</div>
<a id="abdd94ccc6084fa8ec20e65d2021f6df5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdd94ccc6084fa8ec20e65d2021f6df5">◆ </a></span>iteration_start</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* _fluid_sfont_t::iteration_start) (<a class="el" href="types_8h.html#aa6c18288f76608acbb10b80a153f4ab8">fluid_sfont_t</a> *sfont)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Start virtual SoundFont preset iteration method. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sfont</td><td>Virtual SoundFont</td></tr>
</table>
</dd>
</dl>
<p>Starts/re-starts virtual preset iteration in a SoundFont. </p>
<p class="reference">Referenced by <a class="el" href="ramsfont_8h.html#adaaf00a64687fd1f2121e27483b9d02e">fluid_ramsfont_create_sfont()</a>.</p>
</div>
</div>
<a id="aa972dd8cb3caa4dea1e8f0fd01d1f0e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa972dd8cb3caa4dea1e8f0fd01d1f0e3">◆ </a></span>iteration_next</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int(* _fluid_sfont_t::iteration_next) (<a class="el" href="types_8h.html#aa6c18288f76608acbb10b80a153f4ab8">fluid_sfont_t</a> *sfont, <a class="el" href="types_8h.html#a985e5ee05f433da841127750f67a4723">fluid_preset_t</a> *preset)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual SoundFont preset iteration function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sfont</td><td>Virtual SoundFont </td></tr>
<tr><td class="paramname">preset</td><td>Caller supplied preset to fill in with current preset information </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 when no more presets are available, 1 otherwise</dd></dl>
<p>Should store preset information to the caller supplied <em>preset</em> structure and advance the internal iteration state to the next preset for subsequent calls. </p>
<p class="reference">Referenced by <a class="el" href="ramsfont_8h.html#adaaf00a64687fd1f2121e27483b9d02e">fluid_ramsfont_create_sfont()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="sfont_8h.html">sfont.h</a></li>
</ul>
</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>