<!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>GNU Radio 3.6.4.1 C++ API: Voice Encoders and Decoders</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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">GNU Radio 3.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__vocoder__blk.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Voice Encoders and Decoders<div class="ingroups"><a class="el" href="group__block.html">GNU Radio C++ Signal Processing Blocks</a></div></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for Voice Encoders and Decoders:</div>
<div class="dyncontent">
<center><table><tr><td><img src="group__vocoder__blk.png" border="0" alt="" usemap="#group____vocoder____blk"/>
<map name="group____vocoder____blk" id="group____vocoder____blk">
<area shape="rect" id="node2" href="group__block.html" title="All C++ blocks that can be used in GR graphs are listed here or in the subcategories below..." alt="" coords="5,5,165,46"/></map>
</td></tr></table></center>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__alaw__decode__bs.html">vocoder_alaw_decode_bs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This block performs alaw audio decoding. <a href="classvocoder__alaw__decode__bs.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__alaw__encode__sb.html">vocoder_alaw_encode_sb</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This block performs g.711 alaw audio encoding. <a href="classvocoder__alaw__encode__sb.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__codec2__decode__ps.html">vocoder_codec2_decode_ps</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structCODEC2.html">CODEC2</a> Vocoder Decoder. <a href="classvocoder__codec2__decode__ps.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__codec2__encode__sp.html">vocoder_codec2_encode_sp</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structCODEC2.html">CODEC2</a> Vocoder Encoder. <a href="classvocoder__codec2__encode__sp.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__cvsd__decode__bs.html">vocoder_cvsd_decode_bs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This block performs CVSD audio decoding. Its design and implementation is modeled after the CVSD encoder/decoder specifications defined in the Bluetooth standard. <a href="classvocoder__cvsd__decode__bs.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__cvsd__encode__sb.html">vocoder_cvsd_encode_sb</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This block performs CVSD audio encoding. Its design and implementation is modeled after the CVSD encoder/decoder specifications defined in the Bluetooth standard. <a href="classvocoder__cvsd__encode__sb.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__g721__decode__bs.html">vocoder_g721_decode_bs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This block performs g721 audio decoding. <a href="classvocoder__g721__decode__bs.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__g721__encode__sb.html">vocoder_g721_encode_sb</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This block performs g721 audio encoding. <a href="classvocoder__g721__encode__sb.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__g723__24__decode__bs.html">vocoder_g723_24_decode_bs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This block performs g723_24 audio decoding. <a href="classvocoder__g723__24__decode__bs.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__g723__24__encode__sb.html">vocoder_g723_24_encode_sb</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This block performs g723_24 audio encoding. <a href="classvocoder__g723__24__encode__sb.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__g723__40__decode__bs.html">vocoder_g723_40_decode_bs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This block performs g723_40 audio decoding. <a href="classvocoder__g723__40__decode__bs.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__g723__40__encode__sb.html">vocoder_g723_40_encode_sb</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This block performs g723_40 audio encoding. <a href="classvocoder__g723__40__encode__sb.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__gsm__fr__decode__ps.html">vocoder_gsm_fr_decode_ps</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">GSM 06.10 Full Rate Vocoder Decoder. <a href="classvocoder__gsm__fr__decode__ps.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__gsm__fr__encode__sp.html">vocoder_gsm_fr_encode_sp</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">GSM 06.10 Full Rate Vocoder Encodershorts in; 33 byte packets out. <a href="classvocoder__gsm__fr__encode__sp.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__ulaw__decode__bs.html">vocoder_ulaw_decode_bs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This block performs ulaw audio decoding. <a href="classvocoder__ulaw__decode__bs.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classvocoder__ulaw__encode__sb.html">vocoder_ulaw_encode_sb</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This block performs g.711 ulaw audio encoding. <a href="classvocoder__ulaw__encode__sb.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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga40312ddfd1a1633dfcf5ceb5d2965ea8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vocoder__api_8h.html#a8a56d8b0d26cf75df04dcad9064a0aeb">VOCODER_API</a> <br class="typebreak"/>
<a class="el" href="classboost_1_1shared__ptr.html">vocoder_cvsd_decode_bs_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vocoder__blk.html#ga40312ddfd1a1633dfcf5ceb5d2965ea8">vocoder_make_cvsd_decode_bs</a> (short min_step=10, short max_step=1280, double step_decay=0.9990234375, double accum_decay=0.96875, int K=32, int J=4, short pos_accum_max=32767, short neg_accum_max=-32767)</td></tr>
<tr class="memdesc:ga40312ddfd1a1633dfcf5ceb5d2965ea8"><td class="mdescLeft"> </td><td class="mdescRight">Constructor parameters to initialize the CVSD decoder. The default values are modeled after the Bluetooth standard and should not be changed, except by an advanced user. <a href="#ga40312ddfd1a1633dfcf5ceb5d2965ea8"></a><br/></td></tr>
<tr class="separator:ga40312ddfd1a1633dfcf5ceb5d2965ea8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa50f5d6389e5fc6b2545a780efedf225"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vocoder__api_8h.html#a8a56d8b0d26cf75df04dcad9064a0aeb">VOCODER_API</a> <br class="typebreak"/>
<a class="el" href="classboost_1_1shared__ptr.html">vocoder_cvsd_encode_sb_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__vocoder__blk.html#gaa50f5d6389e5fc6b2545a780efedf225">vocoder_make_cvsd_encode_sb</a> (short min_step=10, short max_step=1280, double step_decay=0.9990234375, double accum_decay=0.96875, int K=32, int J=4, short pos_accum_max=32767, short neg_accum_max=-32767)</td></tr>
<tr class="memdesc:gaa50f5d6389e5fc6b2545a780efedf225"><td class="mdescLeft"> </td><td class="mdescRight">Constructor parameters to initialize the CVSD encoder. The default values are modeled after the Bluetooth standard and should not be changed except by an advanced user. <a href="#gaa50f5d6389e5fc6b2545a780efedf225"></a><br/></td></tr>
<tr class="separator:gaa50f5d6389e5fc6b2545a780efedf225"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga40312ddfd1a1633dfcf5ceb5d2965ea8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="vocoder__api_8h.html#a8a56d8b0d26cf75df04dcad9064a0aeb">VOCODER_API</a> <a class="el" href="classboost_1_1shared__ptr.html">vocoder_cvsd_decode_bs_sptr</a> vocoder_make_cvsd_decode_bs </td>
<td>(</td>
<td class="paramtype">short </td>
<td class="paramname"><em>min_step</em> = <code>10</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">short </td>
<td class="paramname"><em>max_step</em> = <code>1280</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>step_decay</em> = <code>0.9990234375</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>accum_decay</em> = <code>0.96875</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>K</em> = <code>32</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>J</em> = <code>4</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">short </td>
<td class="paramname"><em>pos_accum_max</em> = <code>32767</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">short </td>
<td class="paramname"><em>neg_accum_max</em> = <code>-32767</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor parameters to initialize the CVSD decoder. The default values are modeled after the Bluetooth standard and should not be changed, except by an advanced user. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">min_step</td><td>Minimum step size used to update the internal reference. Default: "10" </td></tr>
<tr><td class="paramname">max_step</td><td>Maximum step size used to update the internal reference. Default: "1280" </td></tr>
<tr><td class="paramname">step_decay</td><td>Decay factor applied to step size when there is not a run of J output 1s or 0s. Default: "0.9990234375" (i.e. 1-1/1024) </td></tr>
<tr><td class="paramname">accum_decay</td><td>Decay factor applied to the internal reference during every interation of the codec. Default: "0.96875" (i.e. 1-1/32) </td></tr>
<tr><td class="paramname">K;</td><td>Size of shift register; the number of output bits remembered by codec (must be less or equal to 32). Default: "32" </td></tr>
<tr><td class="paramname">J;</td><td>Number of bits in the shift register that are equal; i.e. the size of a run of 1s, 0s. Default: "4" </td></tr>
<tr><td class="paramname">pos_accum_max</td><td>Maximum integer value allowed for the internal reference. Default: "32767" (2^15 - 1 or MAXSHORT) </td></tr>
<tr><td class="paramname">neg_accum_max</td><td>Minimum integer value allowed for the internal reference. Default: "-32767" (-2^15 + 1 or MINSHORT+1) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaa50f5d6389e5fc6b2545a780efedf225"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="vocoder__api_8h.html#a8a56d8b0d26cf75df04dcad9064a0aeb">VOCODER_API</a> <a class="el" href="classboost_1_1shared__ptr.html">vocoder_cvsd_encode_sb_sptr</a> vocoder_make_cvsd_encode_sb </td>
<td>(</td>
<td class="paramtype">short </td>
<td class="paramname"><em>min_step</em> = <code>10</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">short </td>
<td class="paramname"><em>max_step</em> = <code>1280</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>step_decay</em> = <code>0.9990234375</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>accum_decay</em> = <code>0.96875</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>K</em> = <code>32</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>J</em> = <code>4</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">short </td>
<td class="paramname"><em>pos_accum_max</em> = <code>32767</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">short </td>
<td class="paramname"><em>neg_accum_max</em> = <code>-32767</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor parameters to initialize the CVSD encoder. The default values are modeled after the Bluetooth standard and should not be changed except by an advanced user. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">min_step</td><td>Minimum step size used to update the internal reference. Default: "10" </td></tr>
<tr><td class="paramname">max_step</td><td>Maximum step size used to update the internal reference. Default: "1280" </td></tr>
<tr><td class="paramname">step_decay</td><td>Decay factor applied to step size when there is not a run of J output 1s or 0s. Default: "0.9990234375" (i.e. 1-1/1024) </td></tr>
<tr><td class="paramname">accum_decay</td><td>Decay factor applied to the internal reference during every interation of the codec. Default: "0.96875" (i.e. 1-1/32) </td></tr>
<tr><td class="paramname">K;</td><td>Size of shift register; the number of output bits remembered by codec (must be less or equal to 32). Default: "32" </td></tr>
<tr><td class="paramname">J;</td><td>Number of bits in the shift register that are equal; i.e. the size of a run of 1s, 0s. Default: "4" </td></tr>
<tr><td class="paramname">pos_accum_max</td><td>Maximum integer value allowed for the internal reference. Default: "32767" (2^15 - 1 or MAXSHORT) </td></tr>
<tr><td class="paramname">neg_accum_max</td><td>Minimum integer value allowed for the internal reference. Default: "-32767" (-2^15 + 1 or MINSHORT+1) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Fri Apr 19 2013 16:20:35 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
