<!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>libnjb: /home/mandrake/rpm/BUILD/libnjb-2.2.6/src/eax.c 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.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libnjb <span id="projectnumber">2.2.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</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="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_c382854adf3ac0f9f97376793a1b657b.html">src</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<h1>eax.c File Reference</h1> </div>
</div>
<div class="contents">
<div class="textblock"><code>#include <string.h></code><br/>
<code>#include "<a class="el" href="libnjb_8h_source.html">libnjb.h</a>"</code><br/>
<code>#include "njb_error.h"</code><br/>
<code>#include "defs.h"</code><br/>
<code>#include "base.h"</code><br/>
<code>#include "byteorder.h"</code><br/>
<code>#include "eax.h"</code><br/>
</div><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">int </td><td class="memItemRight" valign="bottom"><a class="el" href="eax_8c.html#a618df2014818da5cdef1764186d825e6">eax_unpack</a> (void *data, size_t nbytes, <a class="el" href="structnjb__state__t.html">njb_state_t</a> *state)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structnjb__eax__struct.html">njb_eax_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="eax_8c.html#a307b5211bd175a2c324b0c1180ea69fc">new_eax_type</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="eax_8c.html#a68d4cf24e77a020af43da96e63159bfd">destroy_eax_type</a> (<a class="el" href="structnjb__eax__struct.html">njb_eax_t</a> *eax)</td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="eax_8c.html#a60db410c9e82d9e61b1bf0be607922ed">__sub_depth</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This file contains functions specific to manipulate EAX API including other sound settings like volume. </p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a68d4cf24e77a020af43da96e63159bfd"></a><!-- doxytag: member="eax.c::destroy_eax_type" ref="a68d4cf24e77a020af43da96e63159bfd" args="(njb_eax_t *eax)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void destroy_eax_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structnjb__eax__struct.html">njb_eax_t</a> * </td>
<td class="paramname"><em>eax</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function destroys an EAX type holder and free up the memory used by it.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">eax</td><td>the EAX type holder to destroy </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="structnjb__eax__struct.html#ae605e5c3487bef32a97186fae24e6b8e">njb_eax_struct::max_value</a>, <a class="el" href="structnjb__eax__struct.html#a1500b0227c7537a7644bb5a638257998">njb_eax_struct::min_value</a>, <a class="el" href="structnjb__eax__struct.html#abdb3bc8dbe965974e31dfe8a60de6125">njb_eax_struct::name</a>, <a class="el" href="structnjb__eax__struct.html#a827b00e65663f69ac950247913fba496">njb_eax_struct::option_names</a>, and <a class="el" href="structnjb__eax__struct.html#a920778f9df1f740be70efca4340197f2">njb_eax_struct::type</a>.</p>
<p>Referenced by <a class="el" href="eax_8c.html#a618df2014818da5cdef1764186d825e6">eax_unpack()</a>, and <a class="el" href="group__eaxapi.html#ga9690bd523ae9729ae9a6d5e21bb87d88">NJB_Destroy_EAX_Type()</a>.</p>
</div>
</div>
<a class="anchor" id="a618df2014818da5cdef1764186d825e6"></a><!-- doxytag: member="eax.c::eax_unpack" ref="a618df2014818da5cdef1764186d825e6" args="(void *data, size_t nbytes, njb_state_t *state)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int eax_unpack </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>nbytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structnjb__state__t.html">njb_state_t</a> * </td>
<td class="paramname"><em>state</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function inpacks an EAX block from the NJB1. The EAX effects are then added to the linked list in the device state and retrieved one by one by the user of the API.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>raw chunk of data to be converted to EAX effects </td></tr>
<tr><td class="paramname">nbytes</td><td>the size of the data chunk </td></tr>
<tr><td class="paramname">state</td><td>the device state that holds the linked list to add the effects to </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, -1 on failure </dd></dl>
<p>References <a class="el" href="structnjb__eax__struct.html#a4133ff6ae8d2d821fdda1a40e9e6c9b6">njb_eax_struct::current_value</a>, <a class="el" href="eax_8c.html#a68d4cf24e77a020af43da96e63159bfd">destroy_eax_type()</a>, <a class="el" href="structnjb__eax__struct.html#aa8c7d20648860165ae69bd6c4ab3a450">njb_eax_struct::group</a>, <a class="el" href="structnjb__eax__struct.html#ae605e5c3487bef32a97186fae24e6b8e">njb_eax_struct::max_value</a>, <a class="el" href="structnjb__eax__struct.html#a1500b0227c7537a7644bb5a638257998">njb_eax_struct::min_value</a>, <a class="el" href="structnjb__eax__struct.html#abdb3bc8dbe965974e31dfe8a60de6125">njb_eax_struct::name</a>, <a class="el" href="eax_8c.html#a307b5211bd175a2c324b0c1180ea69fc">new_eax_type()</a>, <a class="el" href="structnjb__eax__struct.html#a533be0dfe083727c31caf49e2ef3d33e">njb_eax_struct::next</a>, <a class="el" href="byteorder_8c.html#a77340c095fa6b6b32bea9f4132fc4081">njb1_bytes_to_16bit()</a>, <a class="el" href="structnjb__eax__struct.html#ac5e49d1efecf648a4e066d6a27e6b470">njb_eax_struct::number</a>, <a class="el" href="structnjb__eax__struct.html#a827b00e65663f69ac950247913fba496">njb_eax_struct::option_names</a>, and <a class="el" href="structnjb__eax__struct.html#a920778f9df1f740be70efca4340197f2">njb_eax_struct::type</a>.</p>
<p>Referenced by <a class="el" href="protocol_8c.html#afe8b51e10cf1a2a5d313a4c273133278">njb_read_eaxtypes()</a>.</p>
</div>
</div>
<a class="anchor" id="a307b5211bd175a2c324b0c1180ea69fc"></a><!-- doxytag: member="eax.c::new_eax_type" ref="a307b5211bd175a2c324b0c1180ea69fc" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structnjb__eax__struct.html">njb_eax_t</a>* new_eax_type </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function creates a new EAX type holder (allocates memory for it) with no information.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the new EAX type holder </dd></dl>
<p>References <a class="el" href="structnjb__eax__struct.html#a4133ff6ae8d2d821fdda1a40e9e6c9b6">njb_eax_struct::current_value</a>, <a class="el" href="structnjb__eax__struct.html#a52136d50f154229d9df24ea389478687">njb_eax_struct::exclusive</a>, <a class="el" href="structnjb__eax__struct.html#aa8c7d20648860165ae69bd6c4ab3a450">njb_eax_struct::group</a>, <a class="el" href="structnjb__eax__struct.html#ae605e5c3487bef32a97186fae24e6b8e">njb_eax_struct::max_value</a>, <a class="el" href="structnjb__eax__struct.html#a1500b0227c7537a7644bb5a638257998">njb_eax_struct::min_value</a>, <a class="el" href="structnjb__eax__struct.html#abdb3bc8dbe965974e31dfe8a60de6125">njb_eax_struct::name</a>, <a class="el" href="structnjb__eax__struct.html#a533be0dfe083727c31caf49e2ef3d33e">njb_eax_struct::next</a>, <a class="el" href="structnjb__eax__struct.html#ac5e49d1efecf648a4e066d6a27e6b470">njb_eax_struct::number</a>, <a class="el" href="structnjb__eax__struct.html#a827b00e65663f69ac950247913fba496">njb_eax_struct::option_names</a>, and <a class="el" href="structnjb__eax__struct.html#a920778f9df1f740be70efca4340197f2">njb_eax_struct::type</a>.</p>
<p>Referenced by <a class="el" href="eax_8c.html#a618df2014818da5cdef1764186d825e6">eax_unpack()</a>.</p>
</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="a60db410c9e82d9e61b1bf0be607922ed"></a><!-- doxytag: member="eax.c::__sub_depth" ref="a60db410c9e82d9e61b1bf0be607922ed" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="usb__io_8c.html#a60db410c9e82d9e61b1bf0be607922ed">__sub_depth</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The current subroutine depth for all of libnjb (global) </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon May 2 2011 06:05:24 for libnjb by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
