<!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"/>
<title>libfluidsynth: misc.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>misc.h File Reference</h1> </div>
</div>
<div class="contents">
<p>Miscellaneous utility functions and defines.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886">FLUID_OK</a> (0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Value that indicates success, used by most libfluidsynth functions. <a href="#ae4efb1c3ce0d550c922504adfb0fb886"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61">FLUID_FAILED</a> (-1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Value that indicates failure, used by most libfluidsynth functions. <a href="#a90e8bdbc5a507bbfa5c45bac85a63a61"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#a09b28945cdc794f1f9b5c8edb34fcd6e">fluid_is_soundfont</a> (const char *filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a file is a SoundFont file. <a href="#a09b28945cdc794f1f9b5c8edb34fcd6e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="misc_8h.html#abf08bf4bb750d787d551559471069fdf">fluid_is_midifile</a> (const char *filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a file is a MIDI file. <a href="#abf08bf4bb750d787d551559471069fdf"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Miscellaneous utility functions and defines. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="ae4efb1c3ce0d550c922504adfb0fb886"></a><!-- doxytag: member="misc.h::FLUID_OK" ref="ae4efb1c3ce0d550c922504adfb0fb886" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FLUID_OK (0)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Value that indicates success, used by most libfluidsynth functions. </p>
<dl class="since"><dt><b>Since:</b></dt><dd>1.1.0</dd></dl>
<p>NOTE: This was not publicly defined prior to libfluidsynth 1.1.0. When writing code which should also be compatible with older versions, something like the following can be used:</p>
<div class="fragment"><pre class="fragment"><span class="preprocessor"> #include <<a class="code" href="fluidsynth_8h.html" title="FluidSynth is a real-time synthesizer designed for SoundFont(R) files.">fluidsynth.h</a>></span>
<span class="preprocessor"> #ifndef FLUID_OK</span>
<span class="preprocessor"></span><span class="preprocessor"> #define FLUID_OK (0)</span>
<span class="preprocessor"></span><span class="preprocessor"> #define FLUID_FAILED (-1)</span>
<span class="preprocessor"> #endif</span>
</pre></div>
<p>Referenced by <a class="el" href="ramsfont_8h.html#a322992894df06b9df150ff852236a4c3">fluid_ramsfont_add_izone()</a>, <a class="el" href="ramsfont_8h.html#ae2eae43727acac8d16612c156e54f634">fluid_ramsfont_remove_izone()</a>, <a class="el" href="synth_8h.html#a005a5e8e6b34eb5a44b41d9020ce32d5">fluid_synth_alloc_voice()</a>, <a class="el" href="synth_8h.html#a97b0f45f00922a46b1c1961d5b1f8cb5">fluid_synth_bank_select()</a>, <a class="el" href="synth_8h.html#ac3eacfd879445107389aa2b7b44fa0ca">fluid_synth_get_cc()</a>, <a class="el" href="synth_8h.html#a24735d9a0c92630f30cbad5fe9b7353d">fluid_synth_get_pitch_bend()</a>, <a class="el" href="synth_8h.html#afa1c6c8d98c068154678bf29e6c7f32b">fluid_synth_get_pitch_wheel_sens()</a>, <a class="el" href="synth_8h.html#af8771f60cfb9f4b352fa7423621d35e5">fluid_synth_get_program()</a>, <a class="el" href="synth_8h.html#ab8ab8f57ab6efedd6c371894c42a10f7">fluid_synth_program_reset()</a>, <a class="el" href="synth_8h.html#a8b533b00ff0884d3a2bb3f61abfe7682">fluid_synth_set_bank_offset()</a>, <a class="el" href="synth_8h.html#ae5d823189a618befba732ec679beac74">fluid_synth_set_gen()</a>, <a class="el" href="synth_8h.html#a14386a2821c1f6d253fd2d53a21c3b98">fluid_synth_set_gen2()</a>, <a class="el" href="synth_8h.html#a4268f661c6b7f8552fdf5ed5bdfcddfc">fluid_synth_set_interp_method()</a>, <a class="el" href="synth_8h.html#addc8179bfc47d467956ed26f14793775">fluid_synth_sfont_select()</a>, <a class="el" href="synth_8h.html#a578273544b162af97633430b5c9b23ae">fluid_synth_sfreload()</a>, <a class="el" href="synth_8h.html#a212bb602e9022c8d8cdb4bc5957f7693">fluid_synth_sfunload()</a>, <a class="el" href="synth_8h.html#a09a491acce286532beb9e44fe858f0ce">fluid_synth_tuning_dump()</a>, and <a class="el" href="voice_8h.html#a57eda19dd187b4ba46fcd121c992f3b9">fluid_voice_optimize_sample()</a>.</p>
</div>
</div>
<a class="anchor" id="a90e8bdbc5a507bbfa5c45bac85a63a61"></a><!-- doxytag: member="misc.h::FLUID_FAILED" ref="a90e8bdbc5a507bbfa5c45bac85a63a61" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FLUID_FAILED (-1)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Value that indicates failure, used by most libfluidsynth functions. </p>
<dl class="since"><dt><b>Since:</b></dt><dd>1.1.0</dd></dl>
<p>NOTE: See <a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions.">FLUID_OK</a> for more details. </p>
<p>Referenced by <a class="el" href="midi_8h.html#a48f3cd2fcebc5f80c8a9ce43973b9fdc">delete_fluid_midi_router()</a>, <a class="el" href="midi_8h.html#aa1894a103cde4f1efe80c7c9d5096ae2">fluid_midi_router_add_rule()</a>, <a class="el" href="midi_8h.html#a57aed5e84828c202452e13f265dd72f7">fluid_midi_router_clear_rules()</a>, <a class="el" href="midi_8h.html#a9d3a463c348a3b98076e5cc4a7f6d678">fluid_midi_router_handle_midi_event()</a>, <a class="el" href="midi_8h.html#a32ecd2bdcc9bce39d0e0c68e5c1b80cb">fluid_midi_router_set_default_rules()</a>, <a class="el" href="synth_8h.html#a82eea41553b546ec063c2dc840ca711d">fluid_synth_activate_key_tuning()</a>, <a class="el" href="synth_8h.html#a50ffe674e0e4ae9c778cfe41eabf110b">fluid_synth_activate_octave_tuning()</a>, <a class="el" href="synth_8h.html#ad370b81904a65188981c45ee840204d3">fluid_synth_activate_tuning()</a>, <a class="el" href="synth_8h.html#af97291d30d6ff54a475f7446f181e6f7">fluid_synth_add_sfont()</a>, <a class="el" href="synth_8h.html#a97b0f45f00922a46b1c1961d5b1f8cb5">fluid_synth_bank_select()</a>, <a class="el" href="synth_8h.html#a96b535f5acee6f807033d6cc9ccab555">fluid_synth_cc()</a>, <a class="el" href="synth_8h.html#a908d5ea45d97d17757a8a3bda504fd44">fluid_synth_channel_pressure()</a>, <a class="el" href="synth_8h.html#a7d3c0e7ce720c8f1b8a2de2f950d438f">fluid_synth_deactivate_tuning()</a>, <a class="el" href="synth_8h.html#a5d6f71e63f60df1a83e8490a867d8910">fluid_synth_get_active_voice_count()</a>, <a class="el" href="synth_8h.html#ac3eacfd879445107389aa2b7b44fa0ca">fluid_synth_get_cc()</a>, <a class="el" href="synth_8h.html#a00a22e3f06eba8c3d14d3f1aa49490e6">fluid_synth_get_channel_info()</a>, <a class="el" href="synth_8h.html#a77847dc600410fefcc229c8cf576fa54">fluid_synth_get_gen()</a>, <a class="el" href="synth_8h.html#a24735d9a0c92630f30cbad5fe9b7353d">fluid_synth_get_pitch_bend()</a>, <a class="el" href="synth_8h.html#afa1c6c8d98c068154678bf29e6c7f32b">fluid_synth_get_pitch_wheel_sens()</a>, <a class="el" href="synth_8h.html#a20b59114a7e53fcbd8465666ba2790e2">fluid_synth_get_polyphony()</a>, <a class="el" href="synth_8h.html#af8771f60cfb9f4b352fa7423621d35e5">fluid_synth_get_program()</a>, <a class="el" href="synth_8h.html#a5e8f96cacbc6460f7677a6191cbd4472">fluid_synth_noteoff()</a>, <a class="el" href="synth_8h.html#a4a98222fe1c36bfd598dc4cd89f4b75c">fluid_synth_noteon()</a>, <a class="el" href="synth_8h.html#ad5341f8e7c86835b197628f84a2d2c90">fluid_synth_pitch_bend()</a>, <a class="el" href="synth_8h.html#adb4df1ba450816d42ef40a16b2993549">fluid_synth_pitch_wheel_sens()</a>, <a class="el" href="synth_8h.html#aad8df89a90669268b6bee09da40088a6">fluid_synth_program_change()</a>, <a class="el" href="synth_8h.html#ac783362b155fc9c3997f7fd3cf9b1d7f">fluid_synth_program_select()</a>, <a class="el" href="synth_8h.html#a38d8dc2f680024ce927f01424c13d32b">fluid_synth_program_select_by_sfont_name()</a>, <a class="el" href="synth_8h.html#a8b533b00ff0884d3a2bb3f61abfe7682">fluid_synth_set_bank_offset()</a>, <a class="el" href="synth_8h.html#ae5d823189a618befba732ec679beac74">fluid_synth_set_gen()</a>, <a class="el" href="synth_8h.html#a14386a2821c1f6d253fd2d53a21c3b98">fluid_synth_set_gen2()</a>, <a class="el" href="synth_8h.html#a4268f661c6b7f8552fdf5ed5bdfcddfc">fluid_synth_set_interp_method()</a>, <a class="el" href="synth_8h.html#ab6cfd644bacad8ae3a408c8475116878">fluid_synth_set_polyphony()</a>, <a class="el" href="synth_8h.html#aaf9376cf7189f9c64da5ffdeed85c9c4">fluid_synth_sfload()</a>, <a class="el" href="synth_8h.html#addc8179bfc47d467956ed26f14793775">fluid_synth_sfont_select()</a>, <a class="el" href="synth_8h.html#a578273544b162af97633430b5c9b23ae">fluid_synth_sfreload()</a>, <a class="el" href="synth_8h.html#a212bb602e9022c8d8cdb4bc5957f7693">fluid_synth_sfunload()</a>, <a class="el" href="synth_8h.html#ac467475b877fa4c831cfe496c5801d25">fluid_synth_start()</a>, <a class="el" href="synth_8h.html#a159e0f4c860e9d9828baa8365d8accb8">fluid_synth_stop()</a>, <a class="el" href="synth_8h.html#a28f34d0493b102ac4b99c021257b5b5e">fluid_synth_sysex()</a>, <a class="el" href="synth_8h.html#a3783aa3a825dfd81208d37039b6d2906">fluid_synth_system_reset()</a>, <a class="el" href="synth_8h.html#a06f6053f5eed13b59132fc7255f24ef0">fluid_synth_tune_notes()</a>, <a class="el" href="synth_8h.html#a09a491acce286532beb9e44fe858f0ce">fluid_synth_tuning_dump()</a>, and <a class="el" href="synth_8h.html#a5541af149bb98e0eaaf91f5d3419cb10">fluid_synth_unset_program()</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a09b28945cdc794f1f9b5c8edb34fcd6e"></a><!-- doxytag: member="misc.h::fluid_is_soundfont" ref="a09b28945cdc794f1f9b5c8edb34fcd6e" args="(const char *filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_is_soundfont </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filename</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if a file is a SoundFont file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>Path to the file to check </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if it could be a SoundFont, FALSE otherwise</dd></dl>
<p>The current implementation only checks for the "RIFF" header in the file. It is useful only to distinguish between SoundFont and MIDI files. </p>
<p>References <a class="el" href="misc_8h.html#a09b28945cdc794f1f9b5c8edb34fcd6e">fluid_is_soundfont()</a>.</p>
<p>Referenced by <a class="el" href="misc_8h.html#a09b28945cdc794f1f9b5c8edb34fcd6e">fluid_is_soundfont()</a>.</p>
</div>
</div>
<a class="anchor" id="abf08bf4bb750d787d551559471069fdf"></a><!-- doxytag: member="misc.h::fluid_is_midifile" ref="abf08bf4bb750d787d551559471069fdf" args="(const char *filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_is_midifile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filename</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if a file is a MIDI file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>Path to the file to check </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if it could be a MIDI file, FALSE otherwise</dd></dl>
<p>The current implementation only checks for the "MThd" header in the file. It is useful only to distinguish between SoundFont and MIDI files. </p>
<p>References <a class="el" href="misc_8h.html#abf08bf4bb750d787d551559471069fdf">fluid_is_midifile()</a>.</p>
<p>Referenced by <a class="el" href="misc_8h.html#abf08bf4bb750d787d551559471069fdf">fluid_is_midifile()</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Oct 12 2010 for libfluidsynth by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
0a2d1da5078620d6abbc0a5e920f2a92
>
files
>
67
