-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathFileRenderer.html
More file actions
162 lines (160 loc) · 17.7 KB
/
FileRenderer.html
File metadata and controls
162 lines (160 loc) · 17.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
<!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: Fast file renderer for non-realtime MIDI file rendering</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('FileRenderer.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="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Fast file renderer for non-realtime MIDI file rendering </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Instead of creating an audio driver as described in section <a class="el" href="MIDIPlayer.html">Loading and playing a MIDI file</a> one may chose to use the file renderer, which is the fastest way to synthesize MIDI files.</p>
<div class="fragment"><div class="line"><a class="code" href="group__Types.html#gaa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a>* settings;</div>
<div class="line"><a class="code" href="group__Types.html#gae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a>* synth;</div>
<div class="line"><a class="code" href="group__Types.html#gaf6c718e19d8c9c6632cb8ffac6974d80">fluid_player_t</a>* player;</div>
<div class="line"><a class="code" href="group__Types.html#ga8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a>* renderer;</div>
<div class="line"> </div>
<div class="line">settings = <a class="code" href="group__settings.html#ga7623af35fb3d1abace21ef7d5b4f4781">new_fluid_settings</a>();</div>
<div class="line"> </div>
<div class="line"><span class="comment">// specify the file to store the audio to</span></div>
<div class="line"><span class="comment">// make sure you compiled fluidsynth with libsndfile to get a real wave file</span></div>
<div class="line"><span class="comment">// otherwise this file will only contain raw s16 stereo PCM</span></div>
<div class="line"><a class="code" href="group__settings.html#ga58cbabbb8990c2934b3eeea925e01804">fluid_settings_setstr</a>(settings, <span class="stringliteral">"audio.file.name"</span>, <span class="stringliteral">"/path/to/output.wav"</span>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// use number of samples processed as timing source, rather than the system timer</span></div>
<div class="line"><a class="code" href="group__settings.html#ga58cbabbb8990c2934b3eeea925e01804">fluid_settings_setstr</a>(settings, <span class="stringliteral">"player.timing-source"</span>, <span class="stringliteral">"sample"</span>);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// since this is a non-realtime scenario, there is no need to pin the sample data</span></div>
<div class="line"><a class="code" href="group__settings.html#gaec566c035617c2e12de85b82297ac90b">fluid_settings_setint</a>(settings, <span class="stringliteral">"synth.lock-memory"</span>, 0);</div>
<div class="line"> </div>
<div class="line">synth = <a class="code" href="group__synth.html#ga2aab8e0b82dc9fd086849efacb3c1b1b">new_fluid_synth</a>(settings);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// *** loading of a soundfont omitted ***</span></div>
<div class="line"> </div>
<div class="line">player = <a class="code" href="group__midi__player.html#gaa56e6bd17cc34198296af0f8199062a5">new_fluid_player</a>(synth);</div>
<div class="line"><a class="code" href="group__midi__player.html#gaf17b468585c60d343ee950c412336903">fluid_player_add</a>(player, <span class="stringliteral">"/path/to/midifile.mid"</span>);</div>
<div class="line"><a class="code" href="group__midi__player.html#ga80cc6b4c4a81696a2d07466f3da6d6b9">fluid_player_play</a>(player);</div>
<div class="line"> </div>
<div class="line">renderer = <a class="code" href="group__file__renderer.html#ga20cf09534dcc7b9de623f0e41e0d9a68">new_fluid_file_renderer</a> (synth);</div>
<div class="line"> </div>
<div class="line"><span class="keywordflow">while</span> (<a class="code" href="group__midi__player.html#ga621b4fb7de2cea0a88a50e9f5a0e15b8">fluid_player_get_status</a>(player) == <a class="code" href="group__midi__player.html#gga5ec93766f61465dedbbac9bdb76ced83a98ece3a92210189eaad462edc8545bc5">FLUID_PLAYER_PLAYING</a>)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">if</span> (<a class="code" href="group__file__renderer.html#gae59b0226321ae517f1a71a8368acef42">fluid_file_renderer_process_block</a>(renderer) != <a class="code" href="group__misc.html#gae4efb1c3ce0d550c922504adfb0fb886">FLUID_OK</a>)</div>
<div class="line"> {</div>
<div class="line"> <span class="keywordflow">break</span>;</div>
<div class="line"> }</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">// just for sure: stop the playback explicitly and wait until finished</span></div>
<div class="line"><a class="code" href="group__midi__player.html#gae630aa680bb891be30bffa3d6d5e1b21">fluid_player_stop</a>(player);</div>
<div class="line"><a class="code" href="group__midi__player.html#ga6a953d057b72855d2e366d324a5d04e0">fluid_player_join</a>(player);</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__file__renderer.html#gaa3ee9fcd3d56c41738db8fc8c9197038">delete_fluid_file_renderer</a>(renderer);</div>
<div class="line"><a class="code" href="group__midi__player.html#ga9e655b26be62b17c59319a287ef382f3">delete_fluid_player</a>(player);</div>
<div class="line"><a class="code" href="group__synth.html#gab42ea6e25476be548deb428c839d7d2b">delete_fluid_synth</a>(synth);</div>
<div class="line"><a class="code" href="group__settings.html#gabd13a1e869bfaaaebfc58a72af5a66ac">delete_fluid_settings</a>(settings);</div>
<div class="ttc" id="agroup__Types_html_ga8e8a634da121763271ed819dfe866b3d"><div class="ttname"><a href="group__Types.html#ga8e8a634da121763271ed819dfe866b3d">fluid_file_renderer_t</a></div><div class="ttdeci">struct _fluid_file_renderer_t fluid_file_renderer_t</div><div class="ttdoc">Audio file renderer instance.</div><div class="ttdef"><b>Definition:</b> types.h:46</div></div>
<div class="ttc" id="agroup__Types_html_gaa363402d3c77333b0f070ba531d034ba"><div class="ttname"><a href="group__Types.html#gaa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a></div><div class="ttdeci">struct _fluid_hashtable_t fluid_settings_t</div><div class="ttdoc">Configuration settings instance.</div><div class="ttdef"><b>Definition:</b> types.h:37</div></div>
<div class="ttc" id="agroup__Types_html_gae265f10ae174a13afe010de50d87e1a4"><div class="ttname"><a href="group__Types.html#gae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a></div><div class="ttdeci">struct _fluid_synth_t fluid_synth_t</div><div class="ttdoc">Synthesizer instance.</div><div class="ttdef"><b>Definition:</b> types.h:38</div></div>
<div class="ttc" id="agroup__Types_html_gaf6c718e19d8c9c6632cb8ffac6974d80"><div class="ttname"><a href="group__Types.html#gaf6c718e19d8c9c6632cb8ffac6974d80">fluid_player_t</a></div><div class="ttdeci">struct _fluid_player_t fluid_player_t</div><div class="ttdoc">MIDI player instance.</div><div class="ttdef"><b>Definition:</b> types.h:47</div></div>
<div class="ttc" id="agroup__file__renderer_html_ga20cf09534dcc7b9de623f0e41e0d9a68"><div class="ttname"><a href="group__file__renderer.html#ga20cf09534dcc7b9de623f0e41e0d9a68">new_fluid_file_renderer</a></div><div class="ttdeci">fluid_file_renderer_t * new_fluid_file_renderer(fluid_synth_t *synth)</div><div class="ttdoc">Create a new file renderer and open the file.</div><div class="ttdef"><b>Definition:</b> fluid_filerenderer.c:193</div></div>
<div class="ttc" id="agroup__file__renderer_html_gaa3ee9fcd3d56c41738db8fc8c9197038"><div class="ttname"><a href="group__file__renderer.html#gaa3ee9fcd3d56c41738db8fc8c9197038">delete_fluid_file_renderer</a></div><div class="ttdeci">void delete_fluid_file_renderer(fluid_file_renderer_t *dev)</div><div class="ttdoc">Close file and destroy a file renderer object.</div><div class="ttdef"><b>Definition:</b> fluid_filerenderer.c:391</div></div>
<div class="ttc" id="agroup__file__renderer_html_gae59b0226321ae517f1a71a8368acef42"><div class="ttname"><a href="group__file__renderer.html#gae59b0226321ae517f1a71a8368acef42">fluid_file_renderer_process_block</a></div><div class="ttdeci">int fluid_file_renderer_process_block(fluid_file_renderer_t *dev)</div><div class="ttdoc">Write period_size samples to file.</div><div class="ttdef"><b>Definition:</b> fluid_filerenderer.c:427</div></div>
<div class="ttc" id="agroup__midi__player_html_ga621b4fb7de2cea0a88a50e9f5a0e15b8"><div class="ttname"><a href="group__midi__player.html#ga621b4fb7de2cea0a88a50e9f5a0e15b8">fluid_player_get_status</a></div><div class="ttdeci">int fluid_player_get_status(fluid_player_t *player)</div><div class="ttdoc">Get MIDI player status.</div><div class="ttdef"><b>Definition:</b> fluid_midi.c:2346</div></div>
<div class="ttc" id="agroup__midi__player_html_ga6a953d057b72855d2e366d324a5d04e0"><div class="ttname"><a href="group__midi__player.html#ga6a953d057b72855d2e366d324a5d04e0">fluid_player_join</a></div><div class="ttdeci">int fluid_player_join(fluid_player_t *player)</div><div class="ttdoc">Wait for a MIDI player until the playback has been stopped.</div><div class="ttdef"><b>Definition:</b> fluid_midi.c:2589</div></div>
<div class="ttc" id="agroup__midi__player_html_ga80cc6b4c4a81696a2d07466f3da6d6b9"><div class="ttname"><a href="group__midi__player.html#ga80cc6b4c4a81696a2d07466f3da6d6b9">fluid_player_play</a></div><div class="ttdeci">int fluid_player_play(fluid_player_t *player)</div><div class="ttdoc">Activates play mode for a MIDI player if not already playing.</div><div class="ttdef"><b>Definition:</b> fluid_midi.c:2294</div></div>
<div class="ttc" id="agroup__midi__player_html_ga9e655b26be62b17c59319a287ef382f3"><div class="ttname"><a href="group__midi__player.html#ga9e655b26be62b17c59319a287ef382f3">delete_fluid_player</a></div><div class="ttdeci">void delete_fluid_player(fluid_player_t *player)</div><div class="ttdoc">Delete a MIDI player instance.</div><div class="ttdef"><b>Definition:</b> fluid_midi.c:1768</div></div>
<div class="ttc" id="agroup__midi__player_html_gaa56e6bd17cc34198296af0f8199062a5"><div class="ttname"><a href="group__midi__player.html#gaa56e6bd17cc34198296af0f8199062a5">new_fluid_player</a></div><div class="ttdeci">fluid_player_t * new_fluid_player(fluid_synth_t *synth)</div><div class="ttdoc">Create a new MIDI player.</div><div class="ttdef"><b>Definition:</b> fluid_midi.c:1678</div></div>
<div class="ttc" id="agroup__midi__player_html_gae630aa680bb891be30bffa3d6d5e1b21"><div class="ttname"><a href="group__midi__player.html#gae630aa680bb891be30bffa3d6d5e1b21">fluid_player_stop</a></div><div class="ttdeci">int fluid_player_stop(fluid_player_t *player)</div><div class="ttdoc">Pauses the MIDI playback.</div><div class="ttdef"><b>Definition:</b> fluid_midi.c:2331</div></div>
<div class="ttc" id="agroup__midi__player_html_gaf17b468585c60d343ee950c412336903"><div class="ttname"><a href="group__midi__player.html#gaf17b468585c60d343ee950c412336903">fluid_player_add</a></div><div class="ttdeci">int fluid_player_add(fluid_player_t *player, const char *midifile)</div><div class="ttdoc">Add a MIDI file to a player queue.</div><div class="ttdef"><b>Definition:</b> fluid_midi.c:1914</div></div>
<div class="ttc" id="agroup__midi__player_html_gga5ec93766f61465dedbbac9bdb76ced83a98ece3a92210189eaad462edc8545bc5"><div class="ttname"><a href="group__midi__player.html#gga5ec93766f61465dedbbac9bdb76ced83a98ece3a92210189eaad462edc8545bc5">FLUID_PLAYER_PLAYING</a></div><div class="ttdeci">@ FLUID_PLAYER_PLAYING</div><div class="ttdoc">Player is currently playing.</div><div class="ttdef"><b>Definition:</b> midi.h:247</div></div>
<div class="ttc" id="agroup__misc_html_gae4efb1c3ce0d550c922504adfb0fb886"><div class="ttname"><a href="group__misc.html#gae4efb1c3ce0d550c922504adfb0fb886">FLUID_OK</a></div><div class="ttdeci">#define FLUID_OK</div><div class="ttdoc">Value that indicates success, used by most libfluidsynth functions.</div><div class="ttdef"><b>Definition:</b> misc.h:55</div></div>
<div class="ttc" id="agroup__settings_html_ga58cbabbb8990c2934b3eeea925e01804"><div class="ttname"><a href="group__settings.html#ga58cbabbb8990c2934b3eeea925e01804">fluid_settings_setstr</a></div><div class="ttdeci">int fluid_settings_setstr(fluid_settings_t *settings, const char *name, const char *str)</div><div class="ttdoc">Set a string value for a named setting.</div><div class="ttdef"><b>Definition:</b> fluid_settings.c:962</div></div>
<div class="ttc" id="agroup__settings_html_ga7623af35fb3d1abace21ef7d5b4f4781"><div class="ttname"><a href="group__settings.html#ga7623af35fb3d1abace21ef7d5b4f4781">new_fluid_settings</a></div><div class="ttdeci">fluid_settings_t * new_fluid_settings(void)</div><div class="ttdoc">Create a new settings object.</div><div class="ttdef"><b>Definition:</b> fluid_settings.c:261</div></div>
<div class="ttc" id="agroup__settings_html_gabd13a1e869bfaaaebfc58a72af5a66ac"><div class="ttname"><a href="group__settings.html#gabd13a1e869bfaaaebfc58a72af5a66ac">delete_fluid_settings</a></div><div class="ttdeci">void delete_fluid_settings(fluid_settings_t *settings)</div><div class="ttdoc">Delete the provided settings object.</div><div class="ttdef"><b>Definition:</b> fluid_settings.c:285</div></div>
<div class="ttc" id="agroup__settings_html_gaec566c035617c2e12de85b82297ac90b"><div class="ttname"><a href="group__settings.html#gaec566c035617c2e12de85b82297ac90b">fluid_settings_setint</a></div><div class="ttdeci">int fluid_settings_setint(fluid_settings_t *settings, const char *name, int val)</div><div class="ttdoc">Set an integer value for a setting.</div><div class="ttdef"><b>Definition:</b> fluid_settings.c:1533</div></div>
<div class="ttc" id="agroup__synth_html_ga2aab8e0b82dc9fd086849efacb3c1b1b"><div class="ttname"><a href="group__synth.html#ga2aab8e0b82dc9fd086849efacb3c1b1b">new_fluid_synth</a></div><div class="ttdeci">fluid_synth_t * new_fluid_synth(fluid_settings_t *settings)</div><div class="ttdoc">Create new FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:711</div></div>
<div class="ttc" id="agroup__synth_html_gab42ea6e25476be548deb428c839d7d2b"><div class="ttname"><a href="group__synth.html#gab42ea6e25476be548deb428c839d7d2b">delete_fluid_synth</a></div><div class="ttdeci">void delete_fluid_synth(fluid_synth_t *synth)</div><div class="ttdoc">Delete a FluidSynth instance.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:1192</div></div>
</div><!-- fragment --><p>Various output files types are supported, if compiled with libsndfile. Those can be specified via the <code>settings</code> object as well. Refer to the <a class="el" href="settings_audio.html">Audio driver settings</a> documentation for more <code>audio.file.*</code> options. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
</body>
</html>