fluidsynth.github.io/api/MIDIPlayer.html at main · FluidSynth/fluidsynth.github.io · GitHub

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
<!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: Loading and playing a MIDI file</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
   &#160;<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&amp;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&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('MIDIPlayer.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">Loading and playing a MIDI file </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>FluidSynth can be used to play MIDI files, using the MIDI File Player interface. It follows a high level implementation, though its implementation is currently incomplete. After initializing the synthesizer, create the player passing the synth instance to <a class="el" href="group__midi__player.html#gaa56e6bd17cc34198296af0f8199062a5" title="Create a new MIDI player.">new_fluid_player()</a>. Then, you can add some SMF file names to the player using <a class="el" href="group__midi__player.html#gaf17b468585c60d343ee950c412336903" title="Add a MIDI file to a player queue.">fluid_player_add()</a>, and finally call <a class="el" href="group__midi__player.html#ga80cc6b4c4a81696a2d07466f3da6d6b9" title="Activates play mode for a MIDI player if not already playing.">fluid_player_play()</a> to start the playback. You can check if the player has finished by calling <a class="el" href="group__midi__player.html#ga621b4fb7de2cea0a88a50e9f5a0e15b8" title="Get MIDI player status.">fluid_player_get_status()</a>, or wait for the player to terminate using <a class="el" href="group__midi__player.html#ga6a953d057b72855d2e366d324a5d04e0" title="Wait for a MIDI player until the playback has been stopped.">fluid_player_join()</a>.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include &lt;fluidsynth.h&gt;</span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>** argv) </div>
<div class="line">{</div>
<div class="line">    <span class="keywordtype">int</span> i;</div>
<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#gac3706330ce49cac5b7dd079e90d376d8">fluid_audio_driver_t</a>* adriver;</div>
<div class="line">    settings = <a class="code" href="group__settings.html#ga7623af35fb3d1abace21ef7d5b4f4781">new_fluid_settings</a>();</div>
<div class="line">    synth = <a class="code" href="group__synth.html#ga2aab8e0b82dc9fd086849efacb3c1b1b">new_fluid_synth</a>(settings);</div>
<div class="line">    player = <a class="code" href="group__midi__player.html#gaa56e6bd17cc34198296af0f8199062a5">new_fluid_player</a>(synth);</div>
<div class="line">    <span class="comment">/* process command line arguments */</span></div>
<div class="line">    <span class="keywordflow">for</span> (i = 1; i &lt; argc; i++) {</div>
<div class="line">        <span class="keywordflow">if</span> (<a class="code" href="group__misc.html#gaab23ae9dead8de39d85b45a638e23d6f">fluid_is_soundfont</a>(argv[i])) {</div>
<div class="line">           <a class="code" href="group__soundfont__management.html#ga0ba0bc9d4a19c789f9969cd22d22bf66">fluid_synth_sfload</a>(synth, argv[1], 1);</div>
<div class="line">        }</div>
<div class="line">        <span class="keywordflow">if</span> (<a class="code" href="group__misc.html#ga7211b701745f57e3cef4007bc3d6da13">fluid_is_midifile</a>(argv[i])) {</div>
<div class="line">            <a class="code" href="group__midi__player.html#gaf17b468585c60d343ee950c412336903">fluid_player_add</a>(player, argv[i]);</div>
<div class="line">        }</div>
<div class="line">    }</div>
<div class="line">    <span class="comment">/* start the synthesizer thread */</span></div>
<div class="line">    adriver = <a class="code" href="group__audio__driver.html#ga7c66ef86f0008807bdd955770fca6925">new_fluid_audio_driver</a>(settings, synth);</div>
<div class="line">    <span class="comment">/* play the midi files, if any */</span></div>
<div class="line">    <a class="code" href="group__midi__player.html#ga80cc6b4c4a81696a2d07466f3da6d6b9">fluid_player_play</a>(player);</div>
<div class="line">    <span class="comment">/* wait for playback termination */</span></div>
<div class="line">    <a class="code" href="group__midi__player.html#ga6a953d057b72855d2e366d324a5d04e0">fluid_player_join</a>(player);</div>
<div class="line">    <span class="comment">/* cleanup */</span></div>
<div class="line">    <a class="code" href="group__audio__driver.html#ga9c6f54ffa43a8ca482aca81582316f5a">delete_fluid_audio_driver</a>(adriver);</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="line">    <span class="keywordflow">return</span> 0;</div>
<div class="line">}</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_gac3706330ce49cac5b7dd079e90d376d8"><div class="ttname"><a href="group__Types.html#gac3706330ce49cac5b7dd079e90d376d8">fluid_audio_driver_t</a></div><div class="ttdeci">struct _fluid_audio_driver_t fluid_audio_driver_t</div><div class="ttdoc">Audio driver instance.</div><div class="ttdef"><b>Definition:</b> types.h:45</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__audio__driver_html_ga7c66ef86f0008807bdd955770fca6925"><div class="ttname"><a href="group__audio__driver.html#ga7c66ef86f0008807bdd955770fca6925">new_fluid_audio_driver</a></div><div class="ttdeci">fluid_audio_driver_t * new_fluid_audio_driver(fluid_settings_t *settings, fluid_synth_t *synth)</div><div class="ttdoc">Create a new audio driver.</div><div class="ttdef"><b>Definition:</b> fluid_adriver.c:343</div></div>
<div class="ttc" id="agroup__audio__driver_html_ga9c6f54ffa43a8ca482aca81582316f5a"><div class="ttname"><a href="group__audio__driver.html#ga9c6f54ffa43a8ca482aca81582316f5a">delete_fluid_audio_driver</a></div><div class="ttdeci">void delete_fluid_audio_driver(fluid_audio_driver_t *driver)</div><div class="ttdoc">Deletes an audio driver instance.</div><div class="ttdef"><b>Definition:</b> fluid_adriver.c:442</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_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__misc_html_ga7211b701745f57e3cef4007bc3d6da13"><div class="ttname"><a href="group__misc.html#ga7211b701745f57e3cef4007bc3d6da13">fluid_is_midifile</a></div><div class="ttdeci">int fluid_is_midifile(const char *filename)</div><div class="ttdoc">Check if a file is a MIDI file.</div><div class="ttdef"><b>Definition:</b> fluid_midi.c:88</div></div>
<div class="ttc" id="agroup__misc_html_gaab23ae9dead8de39d85b45a638e23d6f"><div class="ttname"><a href="group__misc.html#gaab23ae9dead8de39d85b45a638e23d6f">fluid_is_soundfont</a></div><div class="ttdeci">int fluid_is_soundfont(const char *filename)</div><div class="ttdoc">Check if a file is a SoundFont file.</div><div class="ttdef"><b>Definition:</b> fluid_sffile.c:269</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__soundfont__management_html_ga0ba0bc9d4a19c789f9969cd22d22bf66"><div class="ttname"><a href="group__soundfont__management.html#ga0ba0bc9d4a19c789f9969cd22d22bf66">fluid_synth_sfload</a></div><div class="ttdeci">int fluid_synth_sfload(fluid_synth_t *synth, const char *filename, int reset_presets)</div><div class="ttdoc">Load a SoundFont file.</div><div class="ttdef"><b>Definition:</b> fluid_synth.c:5563</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>A list of available <b>MIDI player settings</b> can be found in the <a class="el" href="settings_player.html">MIDI player settings</a> documentation. </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
</body>
</html>