<!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: ramsfont.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="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>ramsfont.h File Reference</h1> </div>
</div>
<div class="contents">
<p>API for creating and managing SoundFont instruments in RAM.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API <a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ramsfont_8h.html#adaaf00a64687fd1f2121e27483b9d02e">fluid_ramsfont_create_sfont</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="types_8h.html#aa6c18288f76608acbb10b80a153f4ab8" title="SoundFont.">fluid_sfont_t</a> wrapping a <a class="el" href="types_8h.html#a093fe32472dd43adaef22c62feb2d15e" title="RAM SoundFont.">fluid_ramsfont_t</a>. <a href="#adaaf00a64687fd1f2121e27483b9d02e"></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="ramsfont_8h.html#a12210f68350c4d978c56fe791b45bd01">fluid_ramsfont_set_name</a> (<a class="el" href="types_8h.html#a093fe32472dd43adaef22c62feb2d15e">fluid_ramsfont_t</a> *sfont, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a RAM SoundFont name. <a href="#a12210f68350c4d978c56fe791b45bd01"></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="ramsfont_8h.html#a322992894df06b9df150ff852236a4c3">fluid_ramsfont_add_izone</a> (<a class="el" href="types_8h.html#a093fe32472dd43adaef22c62feb2d15e">fluid_ramsfont_t</a> *sfont, unsigned int bank, unsigned int num, <a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a> *sample, int lokey, int hikey)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates one instrument zone for the sample inside the preset defined by <em>bank</em> and <em>num</em>. <a href="#a322992894df06b9df150ff852236a4c3"></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="ramsfont_8h.html#ae2eae43727acac8d16612c156e54f634">fluid_ramsfont_remove_izone</a> (<a class="el" href="types_8h.html#a093fe32472dd43adaef22c62feb2d15e">fluid_ramsfont_t</a> *sfont, unsigned int bank, unsigned int num, <a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a> *sample)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes the instrument zone corresponding to <em>bank</em>, <em>num</em> and <em>sample</em>. <a href="#ae2eae43727acac8d16612c156e54f634"></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="ramsfont_8h.html#ab99bc520a406081f29b9b4933d5a7804">fluid_ramsfont_izone_set_gen</a> (<a class="el" href="types_8h.html#a093fe32472dd43adaef22c62feb2d15e">fluid_ramsfont_t</a> *sfont, unsigned int bank, unsigned int num, <a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a> *sample, int gen_type, float value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a generator on an instrument zone identified by <em>bank</em>, <em>num</em> and <em>sample</em>. <a href="#ab99bc520a406081f29b9b4933d5a7804"></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="ramsfont_8h.html#aee8fd1530458fe14fa2d2b019a18fe1d">fluid_ramsfont_izone_set_loop</a> (<a class="el" href="types_8h.html#a093fe32472dd43adaef22c62feb2d15e">fluid_ramsfont_t</a> *sfont, unsigned int bank, unsigned int num, <a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a> *sample, int on, float loopstart, float loopend)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets loop start/end values of the instrument zone identified by <em>bank</em>, <em>num</em> and <em>sample</em>. <a href="#aee8fd1530458fe14fa2d2b019a18fe1d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API <a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="ramsfont_8h.html#aa9b1e154a5537083ef81d9d7da9177b2">new_fluid_ramsample</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create new RAM SoundFont sample. <a href="#aa9b1e154a5537083ef81d9d7da9177b2"></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="ramsfont_8h.html#a47f5fa03bea5dec23873f98599049d98">delete_fluid_ramsample</a> (<a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a> *sample)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete a RAM SoundFont sample. <a href="#a47f5fa03bea5dec23873f98599049d98"></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="ramsfont_8h.html#af248362e3555a71621e738c80a673eec">fluid_sample_set_name</a> (<a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a> *sample, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name of a RAM SoundFont sample. <a href="#af248362e3555a71621e738c80a673eec"></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="ramsfont_8h.html#a3aa8f2d33f591985db92a740ba765069">fluid_sample_set_sound_data</a> (<a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a> *sample, short *data, unsigned int nbframes, short copy_data, int rootkey)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign sample data to a RAM SoundFont sample. <a href="#a3aa8f2d33f591985db92a740ba765069"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>API for creating and managing SoundFont instruments in RAM. </p>
<p>RAM SoundFonts live in ram. The samples are loaded from files or from RAM. A minimal API manages a soundFont structure, with presets, each preset having only one preset-zone, which instrument has potentially many instrument-zones. No global zones, and nor generator nor modulator other than the default ones are permitted. This may be extensible in the future. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="adaaf00a64687fd1f2121e27483b9d02e"></a><!-- doxytag: member="ramsfont.h::fluid_ramsfont_create_sfont" ref="adaaf00a64687fd1f2121e27483b9d02e" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API <a class="el" href="struct__fluid__sfont__t.html">fluid_sfont_t</a>* fluid_ramsfont_create_sfont </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <a class="el" href="types_8h.html#aa6c18288f76608acbb10b80a153f4ab8" title="SoundFont.">fluid_sfont_t</a> wrapping a <a class="el" href="types_8h.html#a093fe32472dd43adaef22c62feb2d15e" title="RAM SoundFont.">fluid_ramsfont_t</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>New <a class="el" href="types_8h.html#aa6c18288f76608acbb10b80a153f4ab8" title="SoundFont.">fluid_sfont_t</a> or NULL if out of memory </dd></dl>
<p>References <a class="el" href="struct__fluid__sfont__t.html#a5a79644021fa078479da5273c4ebfbbc">_fluid_sfont_t::data</a>, <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9eabc0ff48d192b3b0fc721946ccf095d25">FLUID_ERR</a>, <a class="el" href="ramsfont_8h.html#adaaf00a64687fd1f2121e27483b9d02e">fluid_ramsfont_create_sfont()</a>, <a class="el" href="struct__fluid__sfont__t.html#a7e57ed204828e112df6ac3b6fe0285f3">_fluid_sfont_t::free</a>, <a class="el" href="struct__fluid__sfont__t.html#a05299d68a39b2084a16c54f6c86c0561">_fluid_sfont_t::get_name</a>, <a class="el" href="struct__fluid__sfont__t.html#a115f22a8b4cd766d38b223e785b8e983">_fluid_sfont_t::get_preset</a>, <a class="el" href="struct__fluid__sfont__t.html#a95939cbe06becceda1f075380206c237">_fluid_sfont_t::iteration_next</a>, and <a class="el" href="struct__fluid__sfont__t.html#adeaea711c108c1239d98b00936337ac2">_fluid_sfont_t::iteration_start</a>.</p>
<p>Referenced by <a class="el" href="ramsfont_8h.html#adaaf00a64687fd1f2121e27483b9d02e">fluid_ramsfont_create_sfont()</a>.</p>
</div>
</div>
<a class="anchor" id="a12210f68350c4d978c56fe791b45bd01"></a><!-- doxytag: member="ramsfont.h::fluid_ramsfont_set_name" ref="a12210f68350c4d978c56fe791b45bd01" args="(fluid_ramsfont_t *sfont, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_ramsfont_set_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a093fe32472dd43adaef22c62feb2d15e">fluid_ramsfont_t</a> * </td>
<td class="paramname"> <em>sfont</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a RAM SoundFont name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sfont</em> </td><td>RAM SoundFont </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name to assign (should be 20 chars in length with a NULL terminator) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions.">FLUID_OK</a> </dd></dl>
<p>References <a class="el" href="ramsfont_8h.html#a12210f68350c4d978c56fe791b45bd01">fluid_ramsfont_set_name()</a>.</p>
<p>Referenced by <a class="el" href="ramsfont_8h.html#a12210f68350c4d978c56fe791b45bd01">fluid_ramsfont_set_name()</a>.</p>
</div>
</div>
<a class="anchor" id="a322992894df06b9df150ff852236a4c3"></a><!-- doxytag: member="ramsfont.h::fluid_ramsfont_add_izone" ref="a322992894df06b9df150ff852236a4c3" args="(fluid_ramsfont_t *sfont, unsigned int bank, unsigned int num, fluid_sample_t *sample, int lokey, int hikey)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_ramsfont_add_izone </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a093fe32472dd43adaef22c62feb2d15e">fluid_ramsfont_t</a> * </td>
<td class="paramname"> <em>sfont</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>bank</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a> * </td>
<td class="paramname"> <em>sample</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>lokey</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>hikey</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates one instrument zone for the sample inside the preset defined by <em>bank</em> and <em>num</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sfont</em> </td><td>RAM SoundFont </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bank</em> </td><td>Preset bank number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>num</em> </td><td>Preset program number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sample</em> </td><td>Sample to use for instrument zone </td></tr>
<tr><td valign="top"></td><td valign="top"><em>lokey</em> </td><td>Lower MIDI key range of zone (0-127, <= <em>hikey</em>) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hikey</em> </td><td>Upper MIDI key range of zone (0-127, >= <em>lokey</em>) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions.">FLUID_OK</a> on success, <a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61" title="Value that indicates failure, used by most libfluidsynth functions.">FLUID_FAILED</a> otherwise </dd></dl>
<p>References <a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886">FLUID_OK</a>, and <a class="el" href="ramsfont_8h.html#a322992894df06b9df150ff852236a4c3">fluid_ramsfont_add_izone()</a>.</p>
<p>Referenced by <a class="el" href="ramsfont_8h.html#a322992894df06b9df150ff852236a4c3">fluid_ramsfont_add_izone()</a>.</p>
</div>
</div>
<a class="anchor" id="ae2eae43727acac8d16612c156e54f634"></a><!-- doxytag: member="ramsfont.h::fluid_ramsfont_remove_izone" ref="ae2eae43727acac8d16612c156e54f634" args="(fluid_ramsfont_t *sfont, unsigned int bank, unsigned int num, fluid_sample_t *sample)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_ramsfont_remove_izone </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a093fe32472dd43adaef22c62feb2d15e">fluid_ramsfont_t</a> * </td>
<td class="paramname"> <em>sfont</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>bank</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a> * </td>
<td class="paramname"> <em>sample</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes the instrument zone corresponding to <em>bank</em>, <em>num</em> and <em>sample</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sfont</em> </td><td>RAM SoundFont </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bank</em> </td><td>Preset bank number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>num</em> </td><td>Preset program number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sample</em> </td><td>Sample of the preset zone </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions.">FLUID_OK</a> on success, <a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61" title="Value that indicates failure, used by most libfluidsynth functions.">FLUID_FAILED</a> otherwise </dd></dl>
<p>References <a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886">FLUID_OK</a>, and <a class="el" href="ramsfont_8h.html#ae2eae43727acac8d16612c156e54f634">fluid_ramsfont_remove_izone()</a>.</p>
<p>Referenced by <a class="el" href="ramsfont_8h.html#ae2eae43727acac8d16612c156e54f634">fluid_ramsfont_remove_izone()</a>.</p>
</div>
</div>
<a class="anchor" id="ab99bc520a406081f29b9b4933d5a7804"></a><!-- doxytag: member="ramsfont.h::fluid_ramsfont_izone_set_gen" ref="ab99bc520a406081f29b9b4933d5a7804" args="(fluid_ramsfont_t *sfont, unsigned int bank, unsigned int num, fluid_sample_t *sample, int gen_type, float value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_ramsfont_izone_set_gen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a093fe32472dd43adaef22c62feb2d15e">fluid_ramsfont_t</a> * </td>
<td class="paramname"> <em>sfont</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>bank</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a> * </td>
<td class="paramname"> <em>sample</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>gen_type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets a generator on an instrument zone identified by <em>bank</em>, <em>num</em> and <em>sample</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sfont</em> </td><td>RAM SoundFont </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bank</em> </td><td>Preset bank number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>num</em> </td><td>Preset program number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sample</em> </td><td>Sample of the instrument zone. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>gen_type</em> </td><td>Generator ID (<a class="el" href="gen_8h.html#ad17a24ae3b25f3b8cc5762f818eef9b4" title="Generator (effect) numbers (Soundfont 2.01 specifications section 8.1.3).">fluid_gen_type</a>) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Generator value </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions.">FLUID_OK</a> on success, <a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61" title="Value that indicates failure, used by most libfluidsynth functions.">FLUID_FAILED</a> otherwise </dd></dl>
<p>References <a class="el" href="ramsfont_8h.html#ab99bc520a406081f29b9b4933d5a7804">fluid_ramsfont_izone_set_gen()</a>.</p>
<p>Referenced by <a class="el" href="ramsfont_8h.html#ab99bc520a406081f29b9b4933d5a7804">fluid_ramsfont_izone_set_gen()</a>.</p>
</div>
</div>
<a class="anchor" id="aee8fd1530458fe14fa2d2b019a18fe1d"></a><!-- doxytag: member="ramsfont.h::fluid_ramsfont_izone_set_loop" ref="aee8fd1530458fe14fa2d2b019a18fe1d" args="(fluid_ramsfont_t *sfont, unsigned int bank, unsigned int num, fluid_sample_t *sample, int on, float loopstart, float loopend)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_ramsfont_izone_set_loop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a093fe32472dd43adaef22c62feb2d15e">fluid_ramsfont_t</a> * </td>
<td class="paramname"> <em>sfont</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>bank</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a> * </td>
<td class="paramname"> <em>sample</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>on</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>loopstart</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"> <em>loopend</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets loop start/end values of the instrument zone identified by <em>bank</em>, <em>num</em> and <em>sample</em>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sfont</em> </td><td>RAM SoundFont </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bank</em> </td><td>Preset bank number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>num</em> </td><td>Preset program number </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sample</em> </td><td>Sample of the instrument zone </td></tr>
<tr><td valign="top"></td><td valign="top"><em>on</em> </td><td>TRUE to enable looping, FALSE for one shot (<em>loopstart</em> and <em>loopend</em> not used) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>loopstart</em> </td><td>Loop start, in frames (counted from 0) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>loopend</em> </td><td>Loop end, in frames (counted from last frame, thus is < 0) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions.">FLUID_OK</a> on success, <a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61" title="Value that indicates failure, used by most libfluidsynth functions.">FLUID_FAILED</a> otherwise </dd></dl>
<p>References <a class="el" href="ramsfont_8h.html#aee8fd1530458fe14fa2d2b019a18fe1d">fluid_ramsfont_izone_set_loop()</a>.</p>
<p>Referenced by <a class="el" href="ramsfont_8h.html#aee8fd1530458fe14fa2d2b019a18fe1d">fluid_ramsfont_izone_set_loop()</a>.</p>
</div>
</div>
<a class="anchor" id="aa9b1e154a5537083ef81d9d7da9177b2"></a><!-- doxytag: member="ramsfont.h::new_fluid_ramsample" ref="aa9b1e154a5537083ef81d9d7da9177b2" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API <a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a>* new_fluid_ramsample </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create new RAM SoundFont sample. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>New RAM SoundFont sample or NULL if out of memory </dd></dl>
<p>References <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9eabc0ff48d192b3b0fc721946ccf095d25">FLUID_ERR</a>, and <a class="el" href="ramsfont_8h.html#aa9b1e154a5537083ef81d9d7da9177b2">new_fluid_ramsample()</a>.</p>
<p>Referenced by <a class="el" href="ramsfont_8h.html#aa9b1e154a5537083ef81d9d7da9177b2">new_fluid_ramsample()</a>.</p>
</div>
</div>
<a class="anchor" id="a47f5fa03bea5dec23873f98599049d98"></a><!-- doxytag: member="ramsfont.h::delete_fluid_ramsample" ref="a47f5fa03bea5dec23873f98599049d98" args="(fluid_sample_t *sample)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int delete_fluid_ramsample </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a> * </td>
<td class="paramname"> <em>sample</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete a RAM SoundFont sample. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sample</em> </td><td>Sample to delete </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions.">FLUID_OK</a> </dd></dl>
<p>References <a class="el" href="struct__fluid__sample__t.html#a8c7262f51500369fd1a3e5306b458d55">_fluid_sample_t::data</a>, and <a class="el" href="ramsfont_8h.html#a47f5fa03bea5dec23873f98599049d98">delete_fluid_ramsample()</a>.</p>
<p>Referenced by <a class="el" href="ramsfont_8h.html#a47f5fa03bea5dec23873f98599049d98">delete_fluid_ramsample()</a>.</p>
</div>
</div>
<a class="anchor" id="af248362e3555a71621e738c80a673eec"></a><!-- doxytag: member="ramsfont.h::fluid_sample_set_name" ref="af248362e3555a71621e738c80a673eec" args="(fluid_sample_t *sample, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_sample_set_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a> * </td>
<td class="paramname"> <em>sample</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the name of a RAM SoundFont sample. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sample</em> </td><td>RAM SoundFont sample </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name to assign to sample (20 chars in length, 0 terminated) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions.">FLUID_OK</a> </dd></dl>
<p>References <a class="el" href="ramsfont_8h.html#af248362e3555a71621e738c80a673eec">fluid_sample_set_name()</a>, and <a class="el" href="struct__fluid__sample__t.html#a054c9821ce07e9c680331bfc29cf7a1f">_fluid_sample_t::name</a>.</p>
<p>Referenced by <a class="el" href="ramsfont_8h.html#af248362e3555a71621e738c80a673eec">fluid_sample_set_name()</a>.</p>
</div>
</div>
<a class="anchor" id="a3aa8f2d33f591985db92a740ba765069"></a><!-- doxytag: member="ramsfont.h::fluid_sample_set_sound_data" ref="a3aa8f2d33f591985db92a740ba765069" args="(fluid_sample_t *sample, short *data, unsigned int nbframes, short copy_data, int rootkey)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_sample_set_sound_data </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct__fluid__sample__t.html">fluid_sample_t</a> * </td>
<td class="paramname"> <em>sample</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">short * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>nbframes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">short </td>
<td class="paramname"> <em>copy_data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>rootkey</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Assign sample data to a RAM SoundFont sample. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sample</em> </td><td>RAM SoundFont sample </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Buffer containing 16 bit audio sample data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nbframes</em> </td><td>Number of samples in <em>data</em> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>copy_data</em> </td><td>TRUE to copy the data, FALSE to use it directly </td></tr>
<tr><td valign="top"></td><td valign="top"><em>rootkey</em> </td><td>Root MIDI note of sample (0-127) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="misc_8h.html#ae4efb1c3ce0d550c922504adfb0fb886" title="Value that indicates success, used by most libfluidsynth functions.">FLUID_OK</a> on success, <a class="el" href="misc_8h.html#a90e8bdbc5a507bbfa5c45bac85a63a61" title="Value that indicates failure, used by most libfluidsynth functions.">FLUID_FAILED</a> otherwise</dd></dl>
<p>WARNING: If <em>copy_data</em> is FALSE, data should have 8 unused frames at start and 8 unused frames at the end. </p>
<p>References <a class="el" href="struct__fluid__sample__t.html#a8c7262f51500369fd1a3e5306b458d55">_fluid_sample_t::data</a>, <a class="el" href="struct__fluid__sample__t.html#a955d338a740c562bd9b298d87b165b0c">_fluid_sample_t::end</a>, <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9eabc0ff48d192b3b0fc721946ccf095d25">FLUID_ERR</a>, <a class="el" href="ramsfont_8h.html#a3aa8f2d33f591985db92a740ba765069">fluid_sample_set_sound_data()</a>, <a class="el" href="struct__fluid__sample__t.html#a3baa4ca199a55b77c2692d9d3211e0d0">_fluid_sample_t::loopend</a>, <a class="el" href="struct__fluid__sample__t.html#a708e728c1dd67bb62a70e4edd7fc1f1c">_fluid_sample_t::loopstart</a>, <a class="el" href="struct__fluid__sample__t.html#a1a2bb5f13ed47a3e59b650f9f0cf4bf9">_fluid_sample_t::origpitch</a>, <a class="el" href="struct__fluid__sample__t.html#a12b4133d7631a3043d008fdaa78eb5dc">_fluid_sample_t::pitchadj</a>, <a class="el" href="struct__fluid__sample__t.html#a323da7b5b6db34a67cb59a4b4b0e3e9a">_fluid_sample_t::samplerate</a>, <a class="el" href="struct__fluid__sample__t.html#a081352a55ed01814a219875eee20628b">_fluid_sample_t::sampletype</a>, <a class="el" href="struct__fluid__sample__t.html#a239a49135dad3eedf6ea9ada921f9583">_fluid_sample_t::start</a>, and <a class="el" href="struct__fluid__sample__t.html#ad95a25c77565b132e686cc3f14687221">_fluid_sample_t::valid</a>.</p>
<p>Referenced by <a class="el" href="ramsfont_8h.html#a3aa8f2d33f591985db92a740ba765069">fluid_sample_set_sound_data()</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
>
2eb128636afdc4a8c8207ec3ec09861d
>
files
>
74
