classrespeaker_1_1HybridNode.html

<!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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>librespeaker: respeaker::HybridNode Class Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">librespeaker
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacerespeaker.html">respeaker</a></li><li class="navelem"><a class="el" href="classrespeaker_1_1HybridNode.html">HybridNode</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classrespeaker_1_1HybridNode-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">respeaker::HybridNode Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="hybrid__node_8h_source.html">hybrid_node.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for respeaker::HybridNode:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classrespeaker_1_1HybridNode.png" usemap="#respeaker::HybridNode_map" alt=""/>
  <map id="respeaker::HybridNode_map" name="respeaker::HybridNode_map">
<area href="classrespeaker_1_1BaseNode.html" alt="respeaker::BaseNode" shape="rect" coords="0,0,143,24"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afd2dfe3f2dcce5d3f1215ede40eff52a"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1HybridNode.html#afd2dfe3f2dcce5d3f1215ede40eff52a">OnStartThread</a> ()=0</td></tr>
<tr class="separator:afd2dfe3f2dcce5d3f1215ede40eff52a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a036abb34325ffacb2db8de7d11c08082"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1HybridNode.html#a036abb34325ffacb2db8de7d11c08082">FetchBlock</a> (bool &amp;exit)=0</td></tr>
<tr class="separator:a036abb34325ffacb2db8de7d11c08082"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50d2786baca97cc988b540f6c9ff79b2"><td class="memItemLeft" align="right" valign="top">virtual std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1HybridNode.html#a50d2786baca97cc988b540f6c9ff79b2">ProcessBlock</a> (std::string block, bool &amp;exit)=0</td></tr>
<tr class="separator:a50d2786baca97cc988b540f6c9ff79b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7a974f0d64e75ab7434932b7ccfac00"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1HybridNode.html#af7a974f0d64e75ab7434932b7ccfac00">OnJoinThread</a> ()=0</td></tr>
<tr class="separator:af7a974f0d64e75ab7434932b7ccfac00"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classrespeaker_1_1BaseNode"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classrespeaker_1_1BaseNode')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classrespeaker_1_1BaseNode.html">respeaker::BaseNode</a></td></tr>
<tr class="memitem:aa64e2eb930291b7763f6d18a8ef16e49 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classrespeaker_1_1BaseNode.html">BaseNode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1BaseNode.html#aa64e2eb930291b7763f6d18a8ef16e49">GetId</a> ()</td></tr>
<tr class="separator:aa64e2eb930291b7763f6d18a8ef16e49 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a786258a66118b4681fe77124dfe87ea4 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1BaseNode.html#a786258a66118b4681fe77124dfe87ea4">Uplink</a> (<a class="el" href="classrespeaker_1_1BaseNode.html">BaseNode</a> *uplink_node)</td></tr>
<tr class="separator:a786258a66118b4681fe77124dfe87ea4 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8b902a4e5fdb9ebdb276bcb9546a53a inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1BaseNode.html#aa8b902a4e5fdb9ebdb276bcb9546a53a">RegisterDownlinkNode</a> (<a class="el" href="classrespeaker_1_1BaseNode.html">BaseNode</a> *downlink_node)</td></tr>
<tr class="separator:aa8b902a4e5fdb9ebdb276bcb9546a53a inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54f95dc810c69f48af08e3f0770432de inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structrespeaker_1_1NodeParameter.html">NodeParameter</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1BaseNode.html#a54f95dc810c69f48af08e3f0770432de">GetNodeOutputParameter</a> ()</td></tr>
<tr class="separator:a54f95dc810c69f48af08e3f0770432de inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a1492da1aba5ad1c28e4824a0fdce2b inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1BaseNode.html#a9a1492da1aba5ad1c28e4824a0fdce2b">RecursivelyStartThread</a> (<a class="el" href="structrespeaker_1_1ChainSharedData.html">ChainSharedData</a> *shared_data)</td></tr>
<tr class="separator:a9a1492da1aba5ad1c28e4824a0fdce2b inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b6a49ceda9ded7386bad53bff315458 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="a3b6a49ceda9ded7386bad53bff315458"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>RecursivelyJoinThread</b> ()</td></tr>
<tr class="separator:a3b6a49ceda9ded7386bad53bff315458 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70a1aabbbe47c6f686239defb81d2ac5 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1BaseNode.html#a70a1aabbbe47c6f686239defb81d2ac5">StoreBlock</a> (std::string block, bool &amp;exit)</td></tr>
<tr class="separator:a70a1aabbbe47c6f686239defb81d2ac5 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79c8cb5ec6126776fe1b85c2864b5b62 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="a79c8cb5ec6126776fe1b85c2864b5b62"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>Pause</b> ()</td></tr>
<tr class="separator:a79c8cb5ec6126776fe1b85c2864b5b62 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6c0b8d6e4583e1995a283f9072a0e01 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="aa6c0b8d6e4583e1995a283f9072a0e01"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>Resume</b> ()</td></tr>
<tr class="separator:aa6c0b8d6e4583e1995a283f9072a0e01 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a993ac61f2ca80601d6188d957bef7102 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="a993ac61f2ca80601d6188d957bef7102"></a>
std::mutex *&#160;</td><td class="memItemRight" valign="bottom"><b>GetDownlinkDataQueueMutex</b> (<a class="el" href="classrespeaker_1_1BaseNode.html">BaseNode</a> *downlink_node_id=nullptr)</td></tr>
<tr class="separator:a993ac61f2ca80601d6188d957bef7102 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae332245863119fbd720fd642a3ca0410 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="ae332245863119fbd720fd642a3ca0410"></a>
std::condition_variable *&#160;</td><td class="memItemRight" valign="bottom"><b>GetDownlinkDataQueueConditionVar</b> (<a class="el" href="classrespeaker_1_1BaseNode.html">BaseNode</a> *downlink_node_id=nullptr)</td></tr>
<tr class="separator:ae332245863119fbd720fd642a3ca0410 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fbb35dc03773338d05cff433abadb6d inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="a4fbb35dc03773338d05cff433abadb6d"></a>
std::queue&lt; std::string &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>GetDownlinkDataQueue</b> (<a class="el" href="classrespeaker_1_1BaseNode.html">BaseNode</a> *downlink_node_id=nullptr)</td></tr>
<tr class="separator:a4fbb35dc03773338d05cff433abadb6d inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb2d0e40fc228d2d6a7c714837cba496 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1BaseNode.html#aeb2d0e40fc228d2d6a7c714837cba496">GetQueueDeepth</a> ()</td></tr>
<tr class="separator:aeb2d0e40fc228d2d6a7c714837cba496 inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72e3689fddd7f544d5027a7c7a6869ba inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1BaseNode.html#a72e3689fddd7f544d5027a7c7a6869ba">BindToCore</a> (int core_index)</td></tr>
<tr class="separator:a72e3689fddd7f544d5027a7c7a6869ba inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a1f5f6f0655912b8eca7f2d285a3dcd inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1BaseNode.html#a9a1f5f6f0655912b8eca7f2d285a3dcd">SetThreadPriority</a> (int priority)</td></tr>
<tr class="separator:a9a1f5f6f0655912b8eca7f2d285a3dcd inherit pub_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a95829d01a4ac83a26ca00a485d1743fd"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classrespeaker_1_1HybridNode.html">HybridNode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1HybridNode.html#a95829d01a4ac83a26ca00a485d1743fd">Create</a> (bool enable_ns, int ns_level, int agc_type, int agc_level, bool enable_vad, int vad_sensitivity, bool output_interleaved=false)</td></tr>
<tr class="separator:a95829d01a4ac83a26ca00a485d1743fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a059c56361a9fab5fe54e61488a09449a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classrespeaker_1_1HybridNode.html">HybridNode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1HybridNode.html#a059c56361a9fab5fe54e61488a09449a">CreateNsOnly</a> (int ns_level=0, bool output_interleaved=false)</td></tr>
<tr class="separator:a059c56361a9fab5fe54e61488a09449a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3aa0d8635d0d42f22531fffd348b10a6"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classrespeaker_1_1HybridNode.html">HybridNode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1HybridNode.html#a3aa0d8635d0d42f22531fffd348b10a6">CreateAgcOnly</a> (int agc_type=3, int agc_level=10, bool output_interleaved=false)</td></tr>
<tr class="separator:a3aa0d8635d0d42f22531fffd348b10a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2363194ced93e846d55173cf55a06145"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classrespeaker_1_1HybridNode.html">HybridNode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1HybridNode.html#a2363194ced93e846d55173cf55a06145">CreateVadOnly</a> (int vad_sensitivity=0, bool output_interleaved=false)</td></tr>
<tr class="separator:a2363194ced93e846d55173cf55a06145"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classrespeaker_1_1BaseNode"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classrespeaker_1_1BaseNode')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classrespeaker_1_1BaseNode.html">respeaker::BaseNode</a></td></tr>
<tr class="memitem:acde77c116f88c3643bc64964b5bf8c9c inherit pro_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1BaseNode.html#acde77c116f88c3643bc64964b5bf8c9c">EnableQueueFlush</a> (bool enable)</td></tr>
<tr class="separator:acde77c116f88c3643bc64964b5bf8c9c inherit pro_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af19fcacd824cf2549e8770ab15a72805 inherit pro_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="af19fcacd824cf2549e8770ab15a72805"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>_Interleave</b> (const int16_t *const *deinterleaved, size_t num_frames, size_t num_channels, int16_t *interleaved)</td></tr>
<tr class="separator:af19fcacd824cf2549e8770ab15a72805 inherit pro_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb276fd97a41540d79bbe7fe5af2eccb inherit pro_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="abb276fd97a41540d79bbe7fe5af2eccb"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>_Deinterleave</b> (const int16_t *interleaved, size_t num_frames, size_t num_channels, int16_t *const *deinterleaved)</td></tr>
<tr class="separator:abb276fd97a41540d79bbe7fe5af2eccb inherit pro_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a868a8ce8342fd762d6f9bd2d66d8039b inherit pro_methods_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="a868a8ce8342fd762d6f9bd2d66d8039b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>_Deinterleave</b> (const float *interleaved, size_t num_frames, size_t num_channels, float *const *deinterleaved)</td></tr>
<tr class="separator:a868a8ce8342fd762d6f9bd2d66d8039b inherit pro_methods_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classrespeaker_1_1BaseNode"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classrespeaker_1_1BaseNode')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classrespeaker_1_1BaseNode.html">respeaker::BaseNode</a></td></tr>
<tr class="memitem:acbc797af16d1d2b2ee3a4677cbdbfd52 inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classrespeaker_1_1BaseNode.html">BaseNode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1BaseNode.html#acbc797af16d1d2b2ee3a4677cbdbfd52">_uplink_node</a> = nullptr</td></tr>
<tr class="separator:acbc797af16d1d2b2ee3a4677cbdbfd52 inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada26f5cc0c9a649f3d98c7b829426c4b inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top">std::list&lt; <a class="el" href="classrespeaker_1_1BaseNode.html">BaseNode</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classrespeaker_1_1BaseNode.html#ada26f5cc0c9a649f3d98c7b829426c4b">_list_downlink_nodes</a></td></tr>
<tr class="separator:ada26f5cc0c9a649f3d98c7b829426c4b inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ffc3f266b114e71180c1302ebfcf93e inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="a8ffc3f266b114e71180c1302ebfcf93e"></a>
<a class="el" href="structrespeaker_1_1NodeParameter.html">NodeParameter</a>&#160;</td><td class="memItemRight" valign="bottom"><b>_input_parameter</b></td></tr>
<tr class="separator:a8ffc3f266b114e71180c1302ebfcf93e inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af77eba5ccadaf5700e37d0615160659f inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="af77eba5ccadaf5700e37d0615160659f"></a>
<a class="el" href="structrespeaker_1_1NodeParameter.html">NodeParameter</a>&#160;</td><td class="memItemRight" valign="bottom"><b>_output_parameter</b></td></tr>
<tr class="separator:af77eba5ccadaf5700e37d0615160659f inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabaadd03e527db413e5c08bff855fb21 inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="aabaadd03e527db413e5c08bff855fb21"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>_system_check</b> = 0</td></tr>
<tr class="separator:aabaadd03e527db413e5c08bff855fb21 inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfe38c4ea84934d8cdc6b630b0efce70 inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="abfe38c4ea84934d8cdc6b630b0efce70"></a>
<a class="el" href="structrespeaker_1_1ChainSharedData.html">ChainSharedData</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>_chain_shared_data</b> = nullptr</td></tr>
<tr class="separator:abfe38c4ea84934d8cdc6b630b0efce70 inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a873435ae89cd2b1103644bbd6ca949c3 inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="a873435ae89cd2b1103644bbd6ca949c3"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>_is_head</b> = false</td></tr>
<tr class="separator:a873435ae89cd2b1103644bbd6ca949c3 inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a610aa4f77aae2dbe3170dadd9088045a inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="a610aa4f77aae2dbe3170dadd9088045a"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>_is_tail</b> = false</td></tr>
<tr class="separator:a610aa4f77aae2dbe3170dadd9088045a inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9b09f9e45f6f448ecf7ee3f2fafde4d inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="ab9b09f9e45f6f448ecf7ee3f2fafde4d"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>_is_interleaved_after_process</b> = false</td></tr>
<tr class="separator:ab9b09f9e45f6f448ecf7ee3f2fafde4d inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab1b4451bc2ff6667b489cc9804663719 inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="ab1b4451bc2ff6667b489cc9804663719"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>_num_frames_for_store_block</b></td></tr>
<tr class="separator:ab1b4451bc2ff6667b489cc9804663719 inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d61c0cf63208a6a88ae529486cf7b0a inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="a7d61c0cf63208a6a88ae529486cf7b0a"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>_channels_for_store_block</b></td></tr>
<tr class="separator:a7d61c0cf63208a6a88ae529486cf7b0a inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad78650c657fd198def176d39286d57aa inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="ad78650c657fd198def176d39286d57aa"></a>
int16_t *&#160;</td><td class="memItemRight" valign="bottom"><b>_buffer_for_store_block</b></td></tr>
<tr class="separator:ad78650c657fd198def176d39286d57aa inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e50f8282e18033cc7f14a529be1b073 inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memItemLeft" align="right" valign="top"><a id="a5e50f8282e18033cc7f14a529be1b073"></a>
std::unique_ptr&lt; int16_t *[]&gt;&#160;</td><td class="memItemRight" valign="bottom"><b>_channels_ptr</b></td></tr>
<tr class="separator:a5e50f8282e18033cc7f14a529be1b073 inherit pro_attribs_classrespeaker_1_1BaseNode"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The HybirdNode can do the following: NS(Noise suppresstion), AGC(Automatic gain control) and (VAD)Voice available detection. These algorithms are all from the famous open-source library: WebRTC. You can find its source code at <a href="https://chromium.googlesource.com/external/webrtc/">https://chromium.googlesource.com/external/webrtc/</a> </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a95829d01a4ac83a26ca00a485d1743fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95829d01a4ac83a26ca00a485d1743fd">&#9670;&nbsp;</a></span>Create()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classrespeaker_1_1HybridNode.html">HybridNode</a>* respeaker::HybridNode::Create </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>enable_ns</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>ns_level</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>agc_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>agc_level</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>enable_vad</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>vad_sensitivity</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>output_interleaved</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>To know the description of the <code>level</code>s and <code>agc_type</code> , please see the comments of Create*Only methods. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">output_interleaved</td><td>- Set it true to output interleaved data, false to output deinterleaved data </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a3aa0d8635d0d42f22531fffd348b10a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3aa0d8635d0d42f22531fffd348b10a6">&#9670;&nbsp;</a></span>CreateAgcOnly()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classrespeaker_1_1HybridNode.html">HybridNode</a>* respeaker::HybridNode::CreateAgcOnly </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>agc_type</em> = <code>3</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>agc_level</em> = <code>10</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>output_interleaved</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">agc_type</td><td>- [1, 3], 1 is for AGC_DIGITAL_FIXED, 2 is for AGC_DIGITAL_ADAPTIVE, and 3 is for AGC_ANALOG_ADAPTIVE. </td></tr>
    <tr><td class="paramname">agc_level</td><td>- [0, 31], Sets the target peak |level| (or envelope) of the AGC in dBFs (decibels from digital full-scale). The convention is to use positive values. For instance, passing in a value of 10 corresponds to -10 dBFs, or a target level 10 dB below full-scale. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a059c56361a9fab5fe54e61488a09449a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a059c56361a9fab5fe54e61488a09449a">&#9670;&nbsp;</a></span>CreateNsOnly()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classrespeaker_1_1HybridNode.html">HybridNode</a>* respeaker::HybridNode::CreateNsOnly </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>ns_level</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>output_interleaved</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ns_level</td><td>- [0, 3], the higher the more noise suppression </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a2363194ced93e846d55173cf55a06145"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2363194ced93e846d55173cf55a06145">&#9670;&nbsp;</a></span>CreateVadOnly()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classrespeaker_1_1HybridNode.html">HybridNode</a>* respeaker::HybridNode::CreateVadOnly </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>vad_sensitivity</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>output_interleaved</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">vad_sesitivity</td><td>- [0, 3] the higher the more sensitive(more noise being detected as voice) </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a036abb34325ffacb2db8de7d11c08082"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a036abb34325ffacb2db8de7d11c08082">&#9670;&nbsp;</a></span>FetchBlock()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::string respeaker::HybridNode::FetchBlock </td>
          <td>(</td>
          <td class="paramtype">bool &amp;&#160;</td>
          <td class="paramname"><em>exit</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>The head node must override this method, to do real audio data fetching</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">exit</td><td>[out] - The exit flag of the <a class="el" href="structrespeaker_1_1ChainSharedData.html">ChainSharedData</a> is set, the thread should join now.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>std::string </dd></dl>

<p>Reimplemented from <a class="el" href="classrespeaker_1_1BaseNode.html#a82f301a825f6245864e5df280ffd2e80">respeaker::BaseNode</a>.</p>

</div>
</div>
<a id="af7a974f0d64e75ab7434932b7ccfac00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7a974f0d64e75ab7434932b7ccfac00">&#9670;&nbsp;</a></span>OnJoinThread()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool respeaker::HybridNode::OnJoinThread </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Do per node cleanup in this method. </p>

<p>Implements <a class="el" href="classrespeaker_1_1BaseNode.html#aed14c54e8a1bca55a384c23d13594613">respeaker::BaseNode</a>.</p>

</div>
</div>
<a id="afd2dfe3f2dcce5d3f1215ede40eff52a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd2dfe3f2dcce5d3f1215ede40eff52a">&#9670;&nbsp;</a></span>OnStartThread()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool respeaker::HybridNode::OnStartThread </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>The derived node must configure the output parameter in this method </p>

<p>Implements <a class="el" href="classrespeaker_1_1BaseNode.html#a54a8341faa495ff1f5d0b3cf93ba34e7">respeaker::BaseNode</a>.</p>

</div>
</div>
<a id="a50d2786baca97cc988b540f6c9ff79b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50d2786baca97cc988b540f6c9ff79b2">&#9670;&nbsp;</a></span>ProcessBlock()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::string respeaker::HybridNode::ProcessBlock </td>
          <td>(</td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>block</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool &amp;&#160;</td>
          <td class="paramname"><em>exit</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Every node must implement this method.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">block</td><td>[in] </td></tr>
    <tr><td class="paramname">exit</td><td>[out] - The exit flag of the <a class="el" href="structrespeaker_1_1ChainSharedData.html">ChainSharedData</a> is set, the thread should join now.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>std::string </dd></dl>

<p>Implements <a class="el" href="classrespeaker_1_1BaseNode.html#a58efcb38cbd0dc75a97060afb911e910">respeaker::BaseNode</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/gitlab-runner/builds/dc7d1974/0/seeedstudio/librespeaker/include/chain_nodes/<a class="el" href="hybrid__node_8h_source.html">hybrid_node.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>