arduino/arduino-audio-tools
1
0
Fork 0
mirror of https://github.com/pschatzmann/arduino-audio-tools.git synced 2024-09-21 10:27:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
doxygen
arduino-audio-tools/classaudio__tools_1_1_l_c3_encoder.html

196 lines
17 KiB
HTML
Raw Permalink Blame History

<!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: LC3Encoder 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&amp;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&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="namespaceaudio__tools.html">audio_tools</a></li><li class="navelem"><a class="el" href="classaudio__tools_1_1_l_c3_encoder.html">LC3Encoder</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classaudio__tools_1_1_l_c3_encoder-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LC3Encoder Class Reference<div class="ingroups"><a class="el" href="group__main.html">Arduino Audio Tools</a> &raquo; <a class="el" href="group__codecs.html">Codecs</a> &#124; <a class="el" href="group__main.html">Arduino Audio Tools</a> &raquo; <a class="el" href="group__codecs.html">Codecs</a> &raquo; <a class="el" href="group__encoder.html">Encoder</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Encoder for LC3 - Depends on <a href="https://github.com/pschatzmann/arduino-liblc3">https://github.com/pschatzmann/arduino-liblc3</a>.
<a href="classaudio__tools_1_1_l_c3_encoder.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="_codec_l_c3_8h_source.html">CodecLC3.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for LC3Encoder:</div>
<div class="dyncontent">
<div class="center">
<img src="classaudio__tools_1_1_l_c3_encoder.png" usemap="#LC3Encoder_map" alt=""/>
<map id="LC3Encoder_map" name="LC3Encoder_map">
<area href="classaudio__tools_1_1_audio_encoder.html" title="Encoding of PCM data." alt="AudioEncoder" shape="rect" coords="0,112,110,136"/>
<area href="classaudio__tools_1_1_audio_writer.html" title="E.g. used by Encoders and Decoders." alt="AudioWriter" shape="rect" coords="0,56,110,80"/>
<area href="classaudio__tools_1_1_audio_info_support.html" title="Supports changes to the sampling rate, bits and channels." alt="AudioInfoSupport" shape="rect" coords="0,0,110,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:ad7670cc5e83cb7f4f2948467686d4d9b"><td class="memItemLeft" align="right" valign="top"><a id="ad7670cc5e83cb7f4f2948467686d4d9b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>LC3Encoder</b> (int dt_us=7500, uint16_t outputByteCount=40)</td></tr>
<tr class="separator:ad7670cc5e83cb7f4f2948467686d4d9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a78cb84ad6d022a3d5f1b4267c4150b82"><td class="memItemLeft" align="right" valign="top"><a id="a78cb84ad6d022a3d5f1b4267c4150b82"></a>
<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_encoder.html#a78cb84ad6d022a3d5f1b4267c4150b82">audioInfo</a> ()</td></tr>
<tr class="memdesc:a78cb84ad6d022a3d5f1b4267c4150b82"><td class="mdescLeft">&#160;</td><td class="mdescRight">provides the actual input <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a> <br /></td></tr>
<tr class="separator:a78cb84ad6d022a3d5f1b4267c4150b82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c77cb3dbe910c765ea439d103bdcbb9"><td class="memItemLeft" align="right" valign="top"><a id="a1c77cb3dbe910c765ea439d103bdcbb9"></a>
virtual <a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_info_support.html#a1c77cb3dbe910c765ea439d103bdcbb9">audioInfoOut</a> ()</td></tr>
<tr class="memdesc:a1c77cb3dbe910c765ea439d103bdcbb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">provides the actual output <a class="el" href="structaudio__tools_1_1_audio_info.html" title="Basic Audio information which drives e.g. I2S.">AudioInfo</a>: this is usually the same as <a class="el" href="classaudio__tools_1_1_audio_info_support.html#ae0d5f156b0564368220fa8d328db3880" title="provides the actual input AudioInfo">audioInfo()</a> unless we use a transforming stream <br /></td></tr>
<tr class="separator:a1c77cb3dbe910c765ea439d103bdcbb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a601fb7cf1fc15db50c71a826f084f934"><td class="memItemLeft" align="right" valign="top"><a id="a601fb7cf1fc15db50c71a826f084f934"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>begin</b> ()</td></tr>
<tr class="separator:a601fb7cf1fc15db50c71a826f084f934"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a419d5bfacb0a1e5bf46b5fbd8d94f446"><td class="memItemLeft" align="right" valign="top"><a id="a419d5bfacb0a1e5bf46b5fbd8d94f446"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>begin</b> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> info)</td></tr>
<tr class="separator:a419d5bfacb0a1e5bf46b5fbd8d94f446"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc34417a19a7b70626d19c41072d72a5"><td class="memItemLeft" align="right" valign="top"><a id="adc34417a19a7b70626d19c41072d72a5"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>end</b> ()</td></tr>
<tr class="separator:adc34417a19a7b70626d19c41072d72a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae25cee0d848eeb729a79fd46347a70da"><td class="memItemLeft" align="right" valign="top"><a id="ae25cee0d848eeb729a79fd46347a70da"></a>
virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_l_c3_encoder.html#ae25cee0d848eeb729a79fd46347a70da">mime</a> ()</td></tr>
<tr class="memdesc:ae25cee0d848eeb729a79fd46347a70da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides the mime type of the encoded result. <br /></td></tr>
<tr class="separator:ae25cee0d848eeb729a79fd46347a70da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b3baad8c612d81b96e46f84d7e97580"><td class="memItemLeft" align="right" valign="top"><a id="a9b3baad8c612d81b96e46f84d7e97580"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>operator bool</b> ()</td></tr>
<tr class="separator:a9b3baad8c612d81b96e46f84d7e97580"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c749802992efec8bc20ba4a522b027f"><td class="memItemLeft" align="right" valign="top"><a id="a5c749802992efec8bc20ba4a522b027f"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classaudio__tools_1_1_audio_encoder.html#a5c749802992efec8bc20ba4a522b027f">setAudioInfo</a> (<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a> from) override</td></tr>
<tr class="memdesc:a5c749802992efec8bc20ba4a522b027f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines the sample rate, number of channels and bits per sample. <br /></td></tr>
<tr class="separator:a5c749802992efec8bc20ba4a522b027f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33190106b1d5de89d6af68ad5924f7be"><td class="memItemLeft" align="right" valign="top"><a id="a33190106b1d5de89d6af68ad5924f7be"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><b>setOutput</b> (<a class="el" href="classaudio__tools_1_1_print.html">Print</a> &amp;out_stream)</td></tr>
<tr class="separator:a33190106b1d5de89d6af68ad5924f7be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b8471dbbdc5527cdf9bfd31612cc973"><td class="memItemLeft" align="right" valign="top"><a id="a8b8471dbbdc5527cdf9bfd31612cc973"></a>
virtual size_t&#160;</td><td class="memItemRight" valign="bottom"><b>write</b> (const uint8_t *data, size_t len)</td></tr>
<tr class="separator:a8b8471dbbdc5527cdf9bfd31612cc973"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ae7ccc4f030c435ed00da0493eb4063e3"><td class="memItemLeft" align="right" valign="top"><a id="ae7ccc4f030c435ed00da0493eb4063e3"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>checkValues</b> ()</td></tr>
<tr class="separator:ae7ccc4f030c435ed00da0493eb4063e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e475070d3df18395c90a10c9d38eb0a"><td class="memItemLeft" align="right" valign="top"><a id="a2e475070d3df18395c90a10c9d38eb0a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>writeBlocking</b> (<a class="el" href="classaudio__tools_1_1_print.html">Print</a> *out, uint8_t *data, size_t len)</td></tr>
<tr class="separator:a2e475070d3df18395c90a10c9d38eb0a"><td class="memSeparator" colspan="2">&#160;</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:a03c996f9fcf0e10baeb3e700be0c409a"><td class="memItemLeft" align="right" valign="top"><a id="a03c996f9fcf0e10baeb3e700be0c409a"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>active</b> = false</td></tr>
<tr class="separator:a03c996f9fcf0e10baeb3e700be0c409a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92310a15914c0783b1f9ffcfb8c62cd6"><td class="memItemLeft" align="right" valign="top"><a id="a92310a15914c0783b1f9ffcfb8c62cd6"></a>
unsigned&#160;</td><td class="memItemRight" valign="bottom"><b>dt_us</b> = 1000</td></tr>
<tr class="separator:a92310a15914c0783b1f9ffcfb8c62cd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47385aa19435f5fca9d3083a748258c5"><td class="memItemLeft" align="right" valign="top"><a id="a47385aa19435f5fca9d3083a748258c5"></a>
<a class="el" href="structaudio__tools_1_1_audio_info.html">AudioInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><b>info</b></td></tr>
<tr class="separator:a47385aa19435f5fca9d3083a748258c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfb16e7a13d6ef570abb92ecdb760705"><td class="memItemLeft" align="right" valign="top"><a id="adfb16e7a13d6ef570abb92ecdb760705"></a>
<a class="el" href="classaudio__tools_1_1_vector.html">Vector</a>&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>input_buffer</b></td></tr>
<tr class="separator:adfb16e7a13d6ef570abb92ecdb760705"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c3648243dc862e994ca2acd6918a5db"><td class="memItemLeft" align="right" valign="top"><a id="a0c3648243dc862e994ca2acd6918a5db"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>input_pos</b> = 0</td></tr>
<tr class="separator:a0c3648243dc862e994ca2acd6918a5db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc030801d88a26bf8d3593d20368e01a"><td class="memItemLeft" align="right" valign="top"><a id="abc030801d88a26bf8d3593d20368e01a"></a>
lc3_encoder_t&#160;</td><td class="memItemRight" valign="bottom"><b>lc3_encoder</b> = nullptr</td></tr>
<tr class="separator:abc030801d88a26bf8d3593d20368e01a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef089545b6467f313976ee2343f85738"><td class="memItemLeft" align="right" valign="top"><a id="aef089545b6467f313976ee2343f85738"></a>
<a class="el" href="classaudio__tools_1_1_vector.html">Vector</a>&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>lc3_encoder_memory</b></td></tr>
<tr class="separator:aef089545b6467f313976ee2343f85738"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5dcf08066a79d07d20174446ea180257"><td class="memItemLeft" align="right" valign="top"><a id="a5dcf08066a79d07d20174446ea180257"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>num_frames</b></td></tr>
<tr class="separator:a5dcf08066a79d07d20174446ea180257"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b2aeb7d4446ff2690028f69fd420fd5"><td class="memItemLeft" align="right" valign="top"><a id="a4b2aeb7d4446ff2690028f69fd420fd5"></a>
<a class="el" href="classaudio__tools_1_1_vector.html">Vector</a>&lt; uint8_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>output_buffer</b></td></tr>
<tr class="separator:a4b2aeb7d4446ff2690028f69fd420fd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa14a216810a3ce8cca662e18f473a08"><td class="memItemLeft" align="right" valign="top"><a id="aaa14a216810a3ce8cca662e18f473a08"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>output_byte_count</b> = 20</td></tr>
<tr class="separator:aaa14a216810a3ce8cca662e18f473a08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdad90adc3ba71f7b1e16444c23b5502"><td class="memItemLeft" align="right" valign="top"><a id="acdad90adc3ba71f7b1e16444c23b5502"></a>
<a class="el" href="classaudio__tools_1_1_print.html">Print</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>p_print</b> = nullptr</td></tr>
<tr class="separator:acdad90adc3ba71f7b1e16444c23b5502"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9396734a7fa4092537e9916327ad152c"><td class="memItemLeft" align="right" valign="top"><a id="a9396734a7fa4092537e9916327ad152c"></a>
lc3_pcm_format&#160;</td><td class="memItemRight" valign="bottom"><b>pcm_format</b></td></tr>
<tr class="separator:a9396734a7fa4092537e9916327ad152c"><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>Encoder for LC3 - Depends on <a href="https://github.com/pschatzmann/arduino-liblc3">https://github.com/pschatzmann/arduino-liblc3</a>. </p>
<dl class="section author"><dt>Author</dt><dd>Phil Schatzmann </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>GPLv3 </dd></dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>src/AudioCodecs/<a class="el" href="_codec_l_c3_8h_source.html">CodecLC3.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>
Reference in New Issue View Git Blame Copy Permalink