<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SAC Effects: Encoder 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</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="projectlogo"><img alt="Logo" src="TFM - Banner.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SAC Effects
   &#160;<span id="projectnumber">v1.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</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('class_encoder.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_encoder-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Encoder Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="class_encoder.html" title="Encoder window interface. ">Encoder</a> window interface.  
 <a href="class_encoder.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_encoder_8h_source.html">Encoder.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Encoder:</div>
<div class="dyncontent">
<div class="center"><img src="class_encoder__inherit__graph.png" border="0" usemap="#_encoder_inherit__map" alt="Inheritance graph"/></div>
<map name="_encoder_inherit__map" id="_encoder_inherit__map">
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Encoder:</div>
<div class="dyncontent">
<div class="center"><img src="class_encoder__coll__graph.png" border="0" usemap="#_encoder_coll__map" alt="Collaboration graph"/></div>
<map name="_encoder_coll__map" id="_encoder_coll__map">
<area shape="rect" id="node3" href="class_w_a_v_file.html" title="Audio file as WAV format class. " alt="" coords="208,95,281,121"/>
<area shape="rect" id="node4" href="class_file.html" title="Audio file class. " alt="" coords="108,5,152,32"/>
<area shape="rect" id="node5" href="struct_w_a_v_file_1_1_header.html" title="Audio file header struct. " alt="" coords="182,5,307,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></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:a0b084c3a7e670faafd9d651d6913d105"><td class="memItemLeft" align="right" valign="top"><a id="a0b084c3a7e670faafd9d651d6913d105"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_encoder.html#a0b084c3a7e670faafd9d651d6913d105">Encoder</a> (QWidget *parent=0)</td></tr>
<tr class="memdesc:a0b084c3a7e670faafd9d651d6913d105"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_encoder.html" title="Encoder window interface. ">Encoder</a> constructor. <br /></td></tr>
<tr class="separator:a0b084c3a7e670faafd9d651d6913d105"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87cc8067c98c0ab2134dee3822e3b250"><td class="memItemLeft" align="right" valign="top"><a id="a87cc8067c98c0ab2134dee3822e3b250"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_encoder.html#a87cc8067c98c0ab2134dee3822e3b250">~Encoder</a> ()</td></tr>
<tr class="memdesc:a87cc8067c98c0ab2134dee3822e3b250"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_encoder.html" title="Encoder window interface. ">Encoder</a> destructor. <br /></td></tr>
<tr class="separator:a87cc8067c98c0ab2134dee3822e3b250"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5623d0bd5fc7b1b2be27375d2994eb1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_encoder.html#af5623d0bd5fc7b1b2be27375d2994eb1">setInput</a> (std::string filename)</td></tr>
<tr class="memdesc:af5623d0bd5fc7b1b2be27375d2994eb1"><td class="mdescLeft">&#160;</td><td class="mdescRight">It sets the input audio file.  <a href="#af5623d0bd5fc7b1b2be27375d2994eb1">More...</a><br /></td></tr>
<tr class="separator:af5623d0bd5fc7b1b2be27375d2994eb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81e43409dc83e9118472a81ba65e6779"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_encoder.html#a81e43409dc83e9118472a81ba65e6779">setOutput</a> (std::string filename)</td></tr>
<tr class="memdesc:a81e43409dc83e9118472a81ba65e6779"><td class="mdescLeft">&#160;</td><td class="mdescRight">It sets the output audio file.  <a href="#a81e43409dc83e9118472a81ba65e6779">More...</a><br /></td></tr>
<tr class="separator:a81e43409dc83e9118472a81ba65e6779"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc879a1000d99660b36d7369e00f4f06"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_encoder.html#adc879a1000d99660b36d7369e00f4f06">setTree</a> (int tree)</td></tr>
<tr class="memdesc:adc879a1000d99660b36d7369e00f4f06"><td class="mdescLeft">&#160;</td><td class="mdescRight">It sets a tree configuration.  <a href="#adc879a1000d99660b36d7369e00f4f06">More...</a><br /></td></tr>
<tr class="separator:adc879a1000d99660b36d7369e00f4f06"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aa0549b597ab8fda7191f2e659a56044b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_encoder.html#aa0549b597ab8fda7191f2e659a56044b">fs</a></td></tr>
<tr class="separator:aa0549b597ab8fda7191f2e659a56044b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa851a11113fd12d5cfa04a4a72013157"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_w_a_v_file.html">WAVFile</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_encoder.html#aa851a11113fd12d5cfa04a4a72013157">input</a></td></tr>
<tr class="separator:aa851a11113fd12d5cfa04a4a72013157"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4d4774d75750c1fdddd3740b7f30985"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_w_a_v_file.html">WAVFile</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_encoder.html#ac4d4774d75750c1fdddd3740b7f30985">output</a></td></tr>
<tr class="separator:ac4d4774d75750c1fdddd3740b7f30985"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8cd18343fe80007dba58b4d716227544"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_file.html">File</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_encoder.html#a8cd18343fe80007dba58b4d716227544">bitstream</a></td></tr>
<tr class="separator:a8cd18343fe80007dba58b4d716227544"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section author"><dt>Author</dt><dd>Andrés González Fornell </dd></dl>

<p class="definition">Definition at line <a class="el" href="_encoder_8h_source.html#l00029">29</a> of file <a class="el" href="_encoder_8h_source.html">Encoder.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="af5623d0bd5fc7b1b2be27375d2994eb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5623d0bd5fc7b1b2be27375d2994eb1">&#9670;&nbsp;</a></span>setInput()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Encoder::setInput </td>
          <td>(</td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>filename</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>file path </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="_encoder_8cpp_source.html#l00052">52</a> of file <a class="el" href="_encoder_8cpp_source.html">Encoder.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_encoder_af5623d0bd5fc7b1b2be27375d2994eb1_cgraph.png" border="0" usemap="#class_encoder_af5623d0bd5fc7b1b2be27375d2994eb1_cgraph" alt=""/></div>
<map name="class_encoder_af5623d0bd5fc7b1b2be27375d2994eb1_cgraph" id="class_encoder_af5623d0bd5fc7b1b2be27375d2994eb1_cgraph">
<area shape="rect" id="node2" href="class_file.html#a4260fca380a387a8347b83bb4bee91b5" title="It indicates if the file object exists. " alt="" coords="199,5,285,32"/>
<area shape="rect" id="node3" href="_logger_8cpp.html#ad3268f5fc285cfb356a498e2d24b27f4" title="Log a message on console. " alt="" coords="199,56,285,83"/>
<area shape="rect" id="node5" href="class_file.html#aff78fc9f04aecc0a56c151a5f328944a" title="It gets the file path name. " alt="" coords="180,107,304,133"/>
<area shape="rect" id="node4" href="_logger_8cpp.html#a551ee9103bbb16b6eea45a3f536617bd" title="It returns the string tab code to align log messages. " alt="" coords="352,56,392,83"/>
</map>
</div>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_encoder_af5623d0bd5fc7b1b2be27375d2994eb1_icgraph.png" border="0" usemap="#class_encoder_af5623d0bd5fc7b1b2be27375d2994eb1_icgraph" alt=""/></div>
<map name="class_encoder_af5623d0bd5fc7b1b2be27375d2994eb1_icgraph" id="class_encoder_af5623d0bd5fc7b1b2be27375d2994eb1_icgraph">
<area shape="rect" id="node2" href="class_encoder.html#a0b084c3a7e670faafd9d651d6913d105" title="Encoder constructor. " alt="" coords="180,5,309,32"/>
<area shape="rect" id="node3" href="class_encoder.html#adc879a1000d99660b36d7369e00f4f06" title="It sets a tree configuration. " alt="" coords="183,56,307,83"/>
</map>
</div>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Encoder::setOutput </td>
          <td>(</td>
          <td class="paramtype">std::string&#160;</td>
          <td class="paramname"><em>filename</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filename</td><td>file path </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="_encoder_8cpp_source.html#l00085">85</a> of file <a class="el" href="_encoder_8cpp_source.html">Encoder.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_encoder_a81e43409dc83e9118472a81ba65e6779_cgraph.png" border="0" usemap="#class_encoder_a81e43409dc83e9118472a81ba65e6779_cgraph" alt=""/></div>
<map name="class_encoder_a81e43409dc83e9118472a81ba65e6779_cgraph" id="class_encoder_a81e43409dc83e9118472a81ba65e6779_cgraph">
<area shape="rect" id="node2" href="class_file.html#a4260fca380a387a8347b83bb4bee91b5" title="It indicates if the file object exists. " alt="" coords="210,5,295,32"/>
<area shape="rect" id="node3" href="_logger_8cpp.html#ad3268f5fc285cfb356a498e2d24b27f4" title="Log a message on console. " alt="" coords="210,56,295,83"/>
<area shape="rect" id="node5" href="class_file.html#aff78fc9f04aecc0a56c151a5f328944a" title="It gets the file path name. " alt="" coords="191,107,315,133"/>
<area shape="rect" id="node4" href="_logger_8cpp.html#a551ee9103bbb16b6eea45a3f536617bd" title="It returns the string tab code to align log messages. " alt="" coords="363,56,403,83"/>
</map>
</div>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_encoder_a81e43409dc83e9118472a81ba65e6779_icgraph.png" border="0" usemap="#class_encoder_a81e43409dc83e9118472a81ba65e6779_icgraph" alt=""/></div>
<map name="class_encoder_a81e43409dc83e9118472a81ba65e6779_icgraph" id="class_encoder_a81e43409dc83e9118472a81ba65e6779_icgraph">
<area shape="rect" id="node2" href="class_encoder.html#adc879a1000d99660b36d7369e00f4f06" title="It sets a tree configuration. " alt="" coords="191,5,315,32"/>
</map>
</div>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Encoder::setTree </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>tree</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">tree</td><td>configuration index </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="_encoder_8cpp_source.html#l00116">116</a> of file <a class="el" href="_encoder_8cpp_source.html">Encoder.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_encoder_adc879a1000d99660b36d7369e00f4f06_cgraph.png" border="0" usemap="#class_encoder_adc879a1000d99660b36d7369e00f4f06_cgraph" alt=""/></div>
<map name="class_encoder_adc879a1000d99660b36d7369e00f4f06_cgraph" id="class_encoder_adc879a1000d99660b36d7369e00f4f06_cgraph">
<area shape="rect" id="node2" href="_logger_8cpp.html#ad3268f5fc285cfb356a498e2d24b27f4" title="Log a message on console. " alt="" coords="382,5,467,32"/>
<area shape="rect" id="node4" href="class_encoder.html#af5623d0bd5fc7b1b2be27375d2994eb1" title="It sets the input audio file. " alt="" coords="183,31,309,57"/>
<area shape="rect" id="node6" href="class_file.html#aff78fc9f04aecc0a56c151a5f328944a" title="It gets the file path name. " alt="" coords="363,107,487,133"/>
<area shape="rect" id="node7" href="class_encoder.html#a81e43409dc83e9118472a81ba65e6779" title="It sets the output audio file. " alt="" coords="177,81,315,108"/>
<area shape="rect" id="node3" href="_logger_8cpp.html#a551ee9103bbb16b6eea45a3f536617bd" title="It returns the string tab code to align log messages. " alt="" coords="535,5,575,32"/>
<area shape="rect" id="node5" href="class_file.html#a4260fca380a387a8347b83bb4bee91b5" title="It indicates if the file object exists. " alt="" coords="382,56,467,83"/>
</map>
</div>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8cd18343fe80007dba58b4d716227544"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8cd18343fe80007dba58b4d716227544">&#9670;&nbsp;</a></span>bitstream</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_file.html">File</a>* Encoder::bitstream</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>output bit stream file object </p>

<p class="definition">Definition at line <a class="el" href="_encoder_8h_source.html#l00035">35</a> of file <a class="el" href="_encoder_8h_source.html">Encoder.h</a>.</p>

</div>
</div>
<a id="aa0549b597ab8fda7191f2e659a56044b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0549b597ab8fda7191f2e659a56044b">&#9670;&nbsp;</a></span>fs</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int Encoder::fs</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>signal sampling frequency [Hz] </p>

<p class="definition">Definition at line <a class="el" href="_encoder_8h_source.html#l00032">32</a> of file <a class="el" href="_encoder_8h_source.html">Encoder.h</a>.</p>

</div>
</div>
<a id="aa851a11113fd12d5cfa04a4a72013157"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa851a11113fd12d5cfa04a4a72013157">&#9670;&nbsp;</a></span>input</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_w_a_v_file.html">WAVFile</a>* Encoder::input</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>input file object </p>

<p class="definition">Definition at line <a class="el" href="_encoder_8h_source.html#l00033">33</a> of file <a class="el" href="_encoder_8h_source.html">Encoder.h</a>.</p>

</div>
</div>
<a id="ac4d4774d75750c1fdddd3740b7f30985"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4d4774d75750c1fdddd3740b7f30985">&#9670;&nbsp;</a></span>output</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_w_a_v_file.html">WAVFile</a>* Encoder::output</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>output file object </p>

<p class="definition">Definition at line <a class="el" href="_encoder_8h_source.html#l00034">34</a> of file <a class="el" href="_encoder_8h_source.html">Encoder.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/interface/<a class="el" href="_encoder_8h_source.html">Encoder.h</a></li>
<li>src/interface/<a class="el" href="_encoder_8cpp_source.html">Encoder.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_encoder.html">Encoder</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
