<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libnjb: /builddir/build/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.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_a231d544ee85f784af5e92462fb4d8ea.html">src</a>
</div>
</div>
<div class="contents">
<h1>eax.c File Reference</h1><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>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="eax_8c.html#618df2014818da5cdef1764186d825e6">eax_unpack</a> (void *data, size_t nbytes, njb_state_t *state)</td></tr>
<tr><td class="memItemLeft" nowrap 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#307b5211bd175a2c324b0c1180ea69fc">new_eax_type</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="eax_8c.html#68d4cf24e77a020af43da96e63159bfd">destroy_eax_type</a> (<a class="el" href="structnjb__eax__struct.html">njb_eax_t</a> *eax)</td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="eax_8c.html#60db410c9e82d9e61b1bf0be607922ed">__sub_depth</a></td></tr>
</table>
<hr><h2>Detailed Description</h2>
This file contains functions specific to manipulate EAX API including other sound settings like volume. <hr><h2>Function Documentation</h2>
<a class="anchor" name="68d4cf24e77a020af43da96e63159bfd"></a><!-- doxytag: member="eax.c::destroy_eax_type" ref="68d4cf24e77a020af43da96e63159bfd" 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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>eax</em> </td><td>the EAX type holder to destroy </td></tr>
</table>
</dl>
<p>References <a class="el" href="libnjb_8h_source.html#l00385">njb_eax_struct::max_value</a>, <a class="el" href="libnjb_8h_source.html#l00380">njb_eax_struct::min_value</a>, <a class="el" href="libnjb_8h_source.html#l00351">njb_eax_struct::name</a>, <a class="el" href="libnjb_8h_source.html#l00389">njb_eax_struct::option_names</a>, and <a class="el" href="libnjb_8h_source.html#l00367">njb_eax_struct::type</a>.</p>
<p>Referenced by <a class="el" href="eax_8c_source.html#l00066">eax_unpack()</a>, and <a class="el" href="procedure_8c_source.html#l01978">NJB_Destroy_EAX_Type()</a>.</p>
</div>
</div><p>
<a class="anchor" name="618df2014818da5cdef1764186d825e6"></a><!-- doxytag: member="eax.c::eax_unpack" ref="618df2014818da5cdef1764186d825e6" 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">njb_state_t * </td>
<td class="paramname"> <em>state</em></td><td> </td>
</tr>
<tr>
<td></td>
<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 compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>raw chunk of data to be converted to EAX effects </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nbytes</em> </td><td>the size of the data chunk </td></tr>
<tr><td valign="top"></td><td valign="top"><em>state</em> </td><td>the device state that holds the linked list to add the effects to </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, -1 on failure </dd></dl>
<p>References <a class="el" href="libnjb_8h_source.html#l00375">njb_eax_struct::current_value</a>, <a class="el" href="eax_8c_source.html#l00319">destroy_eax_type()</a>, <a class="el" href="libnjb_8h_source.html#l00361">njb_eax_struct::group</a>, <a class="el" href="libnjb_8h_source.html#l00385">njb_eax_struct::max_value</a>, <a class="el" href="libnjb_8h_source.html#l00380">njb_eax_struct::min_value</a>, <a class="el" href="libnjb_8h_source.html#l00351">njb_eax_struct::name</a>, <a class="el" href="eax_8c_source.html#l00286">new_eax_type()</a>, <a class="el" href="libnjb_8h_source.html#l00395">njb_eax_struct::next</a>, <a class="el" href="byteorder_8c_source.html#l00146">njb1_bytes_to_16bit()</a>, <a class="el" href="libnjb_8h_source.html#l00350">njb_eax_struct::number</a>, <a class="el" href="libnjb_8h_source.html#l00389">njb_eax_struct::option_names</a>, and <a class="el" href="libnjb_8h_source.html#l00367">njb_eax_struct::type</a>.</p>
<p>Referenced by <a class="el" href="protocol_8c_source.html#l01197">njb_read_eaxtypes()</a>.</p>
</div>
</div><p>
<a class="anchor" name="307b5211bd175a2c324b0c1180ea69fc"></a><!-- doxytag: member="eax.c::new_eax_type" ref="307b5211bd175a2c324b0c1180ea69fc" 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" compact><dt><b>Returns:</b></dt><dd>the new EAX type holder </dd></dl>
<p>References <a class="el" href="libnjb_8h_source.html#l00375">njb_eax_struct::current_value</a>, <a class="el" href="libnjb_8h_source.html#l00353">njb_eax_struct::exclusive</a>, <a class="el" href="libnjb_8h_source.html#l00361">njb_eax_struct::group</a>, <a class="el" href="libnjb_8h_source.html#l00385">njb_eax_struct::max_value</a>, <a class="el" href="libnjb_8h_source.html#l00380">njb_eax_struct::min_value</a>, <a class="el" href="libnjb_8h_source.html#l00351">njb_eax_struct::name</a>, <a class="el" href="libnjb_8h_source.html#l00395">njb_eax_struct::next</a>, <a class="el" href="libnjb_8h_source.html#l00350">njb_eax_struct::number</a>, <a class="el" href="libnjb_8h_source.html#l00389">njb_eax_struct::option_names</a>, and <a class="el" href="libnjb_8h_source.html#l00367">njb_eax_struct::type</a>.</p>
<p>Referenced by <a class="el" href="eax_8c_source.html#l00066">eax_unpack()</a>.</p>
</div>
</div><p>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="60db410c9e82d9e61b1bf0be607922ed"></a><!-- doxytag: member="eax.c::__sub_depth" ref="60db410c9e82d9e61b1bf0be607922ed" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="usb__io_8c.html#60db410c9e82d9e61b1bf0be607922ed">__sub_depth</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The current subroutine depth for all of libnjb (global)
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jul 26 17:17:29 2009 for libnjb by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
