mirror of
https://github.com/pschatzmann/arduino-audio-tools.git
synced 2024-09-21 10:27:27 +00:00
141 lines
9.0 KiB
HTML
141 lines
9.0 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>arduino-audio-tools: Decimate 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">arduino-audio-tools
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @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&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="namespaceaudio__tools.html">audio_tools</a></li><li class="navelem"><a class="el" href="classaudio__tools_1_1_decimate.html">Decimate</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classaudio__tools_1_1_decimate-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Decimate Class Reference<div class="ingroups"><a class="el" href="group__main.html">Arduino Audio Tools</a> » <a class="el" href="group__tools.html">Tools</a> » <a class="el" href="group__convert.html">Converters</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Provides a reduced sampling rate by taking a sample at every factor location (ingoring factor-1 samples)
|
|
<a href="classaudio__tools_1_1_decimate.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_base_converter_8h_source.html">BaseConverter.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for Decimate:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classaudio__tools_1_1_decimate.png" usemap="#Decimate_map" alt=""/>
|
|
<map id="Decimate_map" name="Decimate_map">
|
|
<area href="classaudio__tools_1_1_base_converter.html" title="Abstract Base class for Converters A converter is processing the data in the indicated array." alt="BaseConverter" shape="rect" coords="0,0,97,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:a89289d538f0e371a255209492d148f9e"><td class="memItemLeft" align="right" valign="top"><a id="a89289d538f0e371a255209492d148f9e"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>Decimate</b> (int factor, int channels, int bits_per_sample)</td></tr>
|
|
<tr class="separator:a89289d538f0e371a255209492d148f9e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a65ed1c2e44cb48c5294dceeb0d0de040"><td class="memItemLeft" align="right" valign="top"><a id="a65ed1c2e44cb48c5294dceeb0d0de040"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>convert</b> (uint8_t *src, size_t size)</td></tr>
|
|
<tr class="separator:a65ed1c2e44cb48c5294dceeb0d0de040"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab42262038579ccc4e2b40cbbd4034847"><td class="memItemLeft" align="right" valign="top"><a id="ab42262038579ccc4e2b40cbbd4034847"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>convert</b> (uint8_t *target, uint8_t *src, size_t size)</td></tr>
|
|
<tr class="separator:ab42262038579ccc4e2b40cbbd4034847"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b3baad8c612d81b96e46f84d7e97580"><td class="memItemLeft" align="right" valign="top"><a id="a9b3baad8c612d81b96e46f84d7e97580"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>operator bool</b> ()</td></tr>
|
|
<tr class="separator:a9b3baad8c612d81b96e46f84d7e97580"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeca742f487a243d63e83083e80b93676"><td class="memItemLeft" align="right" valign="top"><a id="aeca742f487a243d63e83083e80b93676"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>setBits</b> (int bits)</td></tr>
|
|
<tr class="separator:aeca742f487a243d63e83083e80b93676"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab5a7ba68d6c150f9643e74f3838270a5"><td class="memItemLeft" align="right" valign="top"><a id="ab5a7ba68d6c150f9643e74f3838270a5"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_decimate.html#ab5a7ba68d6c150f9643e74f3838270a5">setChannels</a> (int channels)</td></tr>
|
|
<tr class="memdesc:ab5a7ba68d6c150f9643e74f3838270a5"><td class="mdescLeft"> </td><td class="mdescRight">Defines the number of channels. <br /></td></tr>
|
|
<tr class="separator:ab5a7ba68d6c150f9643e74f3838270a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2dc524acc6d34135c4fcbd44aa62b8e6"><td class="memItemLeft" align="right" valign="top"><a id="a2dc524acc6d34135c4fcbd44aa62b8e6"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_decimate.html#a2dc524acc6d34135c4fcbd44aa62b8e6">setFactor</a> (int factor)</td></tr>
|
|
<tr class="memdesc:a2dc524acc6d34135c4fcbd44aa62b8e6"><td class="mdescLeft"> </td><td class="mdescRight">Sets the factor: e.g. with 4 we keep every forth sample. <br /></td></tr>
|
|
<tr class="separator:a2dc524acc6d34135c4fcbd44aa62b8e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:ad1e28a1a66a25529b0b61b9ca4e66d44"><td class="memItemLeft" align="right" valign="top"><a id="ad1e28a1a66a25529b0b61b9ca4e66d44"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>bits</b> = 16</td></tr>
|
|
<tr class="separator:ad1e28a1a66a25529b0b61b9ca4e66d44"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a178795099d0608972755dfef8d8367e3"><td class="memItemLeft" align="right" valign="top"><a id="a178795099d0608972755dfef8d8367e3"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>channels</b> = 2</td></tr>
|
|
<tr class="separator:a178795099d0608972755dfef8d8367e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a42eac05293c31fef9b90c92698928d7d"><td class="memItemLeft" align="right" valign="top"><a id="a42eac05293c31fef9b90c92698928d7d"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>factor</b> = 1</td></tr>
|
|
<tr class="separator:a42eac05293c31fef9b90c92698928d7d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Provides a reduced sampling rate by taking a sample at every factor location (ingoring factor-1 samples) </p>
|
|
</div><hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/AudioTools/<a class="el" href="_base_converter_8h_source.html">BaseConverter.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|