<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.3"/> <title>gavl: DSP Context</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="doxygen.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 style="padding-left: 0.5em;"> <div id="projectname">gavl </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3 --> <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><a href="files.html"><span>Files</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#groups">Modules</a> | <a href="#nested-classes">Data Structures</a> | <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">DSP Context</div> </div> </div><!--header--> <div class="contents"> <p>DSP Context. <a href="#details">More...</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a> Modules</h2></td></tr> <tr class="memitem:group__dsputils"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsputils.html">DSP Utilities</a></td></tr> <tr class="memdesc:group__dsputils"><td class="mdescLeft"> </td><td class="mdescRight">DSP Utilities. <br/></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Data Structures</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgavl__dsp__funcs__t.html">gavl_dsp_funcs_t</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Function table. <a href="structgavl__dsp__funcs__t.html#details">More...</a><br/></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:gafe123d8ea3bcd946fedfa03c292a05f1"><td class="memItemLeft" align="right" valign="top">typedef struct gavl_dsp_context_s </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsp.html#gafe123d8ea3bcd946fedfa03c292a05f1">gavl_dsp_context_t</a></td></tr> <tr class="memdesc:gafe123d8ea3bcd946fedfa03c292a05f1"><td class="mdescLeft"> </td><td class="mdescRight">Opaque DSP context. <a href="#gafe123d8ea3bcd946fedfa03c292a05f1"></a><br/></td></tr> <tr class="separator:gafe123d8ea3bcd946fedfa03c292a05f1"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:gae1236951171a8bc22848bc34b836dc88"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC <a class="el" href="group__dsp.html#gafe123d8ea3bcd946fedfa03c292a05f1">gavl_dsp_context_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsp.html#gae1236951171a8bc22848bc34b836dc88">gavl_dsp_context_create</a> ()</td></tr> <tr class="memdesc:gae1236951171a8bc22848bc34b836dc88"><td class="mdescLeft"> </td><td class="mdescRight">Create a DSP context. <a href="#gae1236951171a8bc22848bc34b836dc88"></a><br/></td></tr> <tr class="separator:gae1236951171a8bc22848bc34b836dc88"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga50363b4981fa3d1d13a8bbf289fe6cdf"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsp.html#ga50363b4981fa3d1d13a8bbf289fe6cdf">gavl_dsp_context_set_quality</a> (<a class="el" href="group__dsp.html#gafe123d8ea3bcd946fedfa03c292a05f1">gavl_dsp_context_t</a> *ctx, int q)</td></tr> <tr class="memdesc:ga50363b4981fa3d1d13a8bbf289fe6cdf"><td class="mdescLeft"> </td><td class="mdescRight">Set the quality for a DSP context. <a href="#ga50363b4981fa3d1d13a8bbf289fe6cdf"></a><br/></td></tr> <tr class="separator:ga50363b4981fa3d1d13a8bbf289fe6cdf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaf347635df485178c7da9796bb7347963"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsp.html#gaf347635df485178c7da9796bb7347963">gavl_dsp_context_set_accel_flags</a> (<a class="el" href="group__dsp.html#gafe123d8ea3bcd946fedfa03c292a05f1">gavl_dsp_context_t</a> *ctx, int flags)</td></tr> <tr class="memdesc:gaf347635df485178c7da9796bb7347963"><td class="mdescLeft"> </td><td class="mdescRight">Set the acceleration flags for a DSP context. <a href="#gaf347635df485178c7da9796bb7347963"></a><br/></td></tr> <tr class="separator:gaf347635df485178c7da9796bb7347963"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga100c077bd8d2e26aabbec7442574c44f"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC <a class="el" href="structgavl__dsp__funcs__t.html">gavl_dsp_funcs_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsp.html#ga100c077bd8d2e26aabbec7442574c44f">gavl_dsp_context_get_funcs</a> (<a class="el" href="group__dsp.html#gafe123d8ea3bcd946fedfa03c292a05f1">gavl_dsp_context_t</a> *ctx)</td></tr> <tr class="memdesc:ga100c077bd8d2e26aabbec7442574c44f"><td class="mdescLeft"> </td><td class="mdescRight">Get the functions. <a href="#ga100c077bd8d2e26aabbec7442574c44f"></a><br/></td></tr> <tr class="separator:ga100c077bd8d2e26aabbec7442574c44f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga3fa6e96c8c937e90d86d5c98210eb4d8"><td class="memItemLeft" align="right" valign="top">GAVL_PUBLIC void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dsp.html#ga3fa6e96c8c937e90d86d5c98210eb4d8">gavl_dsp_context_destroy</a> (<a class="el" href="group__dsp.html#gafe123d8ea3bcd946fedfa03c292a05f1">gavl_dsp_context_t</a> *ctx)</td></tr> <tr class="memdesc:ga3fa6e96c8c937e90d86d5c98210eb4d8"><td class="mdescLeft"> </td><td class="mdescRight">Destroy a DSP context. <a href="#ga3fa6e96c8c937e90d86d5c98210eb4d8"></a><br/></td></tr> <tr class="separator:ga3fa6e96c8c937e90d86d5c98210eb4d8"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>DSP Context. </p> <p>In addition to the higher level gavl converters, gavl provides some low-level dsp routines. They can be used for writing filters or codecs. The DSP context is initialized with a quality parameter (see <a class="el" href="group__quality.html">Quality settings</a>), which selects among various versions of a function. </p> <h2 class="groupheader">Typedef Documentation</h2> <a class="anchor" id="gafe123d8ea3bcd946fedfa03c292a05f1"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct gavl_dsp_context_s <a class="el" href="group__dsp.html#gafe123d8ea3bcd946fedfa03c292a05f1">gavl_dsp_context_t</a></td> </tr> </table> </div><div class="memdoc"> <p>Opaque DSP context. </p> <p>You don't want to know, what's inside here. </p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="gae1236951171a8bc22848bc34b836dc88"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GAVL_PUBLIC <a class="el" href="group__dsp.html#gafe123d8ea3bcd946fedfa03c292a05f1">gavl_dsp_context_t</a>* gavl_dsp_context_create </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Create a DSP context. </p> <dl class="section return"><dt>Returns</dt><dd>A newly allocated DSP context</dd></dl> <p>This initialized a DSP context with all functions chosen according to the default quality value. </p> </div> </div> <a class="anchor" id="ga50363b4981fa3d1d13a8bbf289fe6cdf"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GAVL_PUBLIC void gavl_dsp_context_set_quality </td> <td>(</td> <td class="paramtype"><a class="el" href="group__dsp.html#gafe123d8ea3bcd946fedfa03c292a05f1">gavl_dsp_context_t</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>q</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set the quality for a DSP context. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>A DSP context </td></tr> <tr><td class="paramname">q</td><td>A quality level</td></tr> </table> </dd> </dl> <p>See <a class="el" href="group__quality.html">Quality settings</a>. </p> </div> </div> <a class="anchor" id="gaf347635df485178c7da9796bb7347963"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GAVL_PUBLIC void gavl_dsp_context_set_accel_flags </td> <td>(</td> <td class="paramtype"><a class="el" href="group__dsp.html#gafe123d8ea3bcd946fedfa03c292a05f1">gavl_dsp_context_t</a> * </td> <td class="paramname"><em>ctx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>flags</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Set the acceleration flags for a DSP context. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>A DSP context </td></tr> <tr><td class="paramname">flags</td><td>Flags</td></tr> </table> </dd> </dl> <p>By default the flags are detected automatically and functions are chosen based on the quality </p> </div> </div> <a class="anchor" id="ga100c077bd8d2e26aabbec7442574c44f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GAVL_PUBLIC <a class="el" href="structgavl__dsp__funcs__t.html">gavl_dsp_funcs_t</a>* gavl_dsp_context_get_funcs </td> <td>(</td> <td class="paramtype"><a class="el" href="group__dsp.html#gafe123d8ea3bcd946fedfa03c292a05f1">gavl_dsp_context_t</a> * </td> <td class="paramname"><em>ctx</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Get the functions. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>A DSP context </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>The function table</dd></dl> <p>The address of the table itself won't change by a call to <a class="el" href="group__dsp.html#ga50363b4981fa3d1d13a8bbf289fe6cdf">gavl_dsp_context_set_quality</a>, but the contained functions will. </p> </div> </div> <a class="anchor" id="ga3fa6e96c8c937e90d86d5c98210eb4d8"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GAVL_PUBLIC void gavl_dsp_context_destroy </td> <td>(</td> <td class="paramtype"><a class="el" href="group__dsp.html#gafe123d8ea3bcd946fedfa03c292a05f1">gavl_dsp_context_t</a> * </td> <td class="paramname"><em>ctx</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Destroy a DSP context. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">ctx</td><td>A DSP context </td></tr> </table> </dd> </dl> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Jan 11 2013 22:07:38 for gavl by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.3 </small></address> </body> </html>