Files
picovga-cmake/docs/pwmsnd_8h.html
2025-08-26 20:47:11 -07:00

190 lines
14 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>PicoVGA: src/util/pwmsnd.h File 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>
<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" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="custom.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="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">PicoVGA
&#160;<span id="projectnumber">1.2-cmake</span>
</div>
<div id="projectbrief">VGA/TV display on Raspberry Pico</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>
</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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('pwmsnd_8h.html',''); initResizable(); });
/* @license-end */
</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="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">pwmsnd.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">File Description</h2>
<div class="textblock"><p>PWM sound output. </p>
<dl class="section author"><dt>Author</dt><dd>Miroslav Nemecek <a href="#" onclick="location.href='mai'+'lto:'+'Pan'+'da'+'38@'+'se'+'zna'+'m.'+'cz'; return false;">Panda<span style="display: none;">.nosp@m.</span>38@s<span style="display: none;">.nosp@m.</span>eznam<span style="display: none;">.nosp@m.</span>.cz</a> </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__PWMGroup.html">PWM Audio</a> </dd></dl>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="pwmsnd_8h__dep__incl.png" border="0" usemap="#asrc_2util_2pwmsnd_8hdep" alt=""/></div>
</div>
</div>
<p><a href="pwmsnd_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ac2328dd6b9cf9676f62bc389ba199988"><td class="memItemLeft" align="right" valign="top"><a id="ac2328dd6b9cf9676f62bc389ba199988"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>PWMSND_GPIO</b>&#160;&#160;&#160;19</td></tr>
<tr class="separator:ac2328dd6b9cf9676f62bc389ba199988"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00d6dc414eb6af8dc6b0db5414f13717"><td class="memItemLeft" align="right" valign="top"><a id="a00d6dc414eb6af8dc6b0db5414f13717"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>PWMSND_SLICE</b>&#160;&#160;&#160;((PWMSND_GPIO&gt;&gt;1)&amp;7)</td></tr>
<tr class="separator:a00d6dc414eb6af8dc6b0db5414f13717"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac145742440bb45c5a582b49b08a79e02"><td class="memItemLeft" align="right" valign="top"><a id="ac145742440bb45c5a582b49b08a79e02"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>PWMSND_CHAN</b>&#160;&#160;&#160;(PWMSND_GPIO&amp;1)</td></tr>
<tr class="separator:ac145742440bb45c5a582b49b08a79e02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58a3fea96512d81f539db07507a8f301"><td class="memItemLeft" align="right" valign="top"><a id="a58a3fea96512d81f539db07507a8f301"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SOUNDRATE</b>&#160;&#160;&#160;22050</td></tr>
<tr class="separator:a58a3fea96512d81f539db07507a8f301"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4305d89f4c43ae22807fb7a4465892b1"><td class="memItemLeft" align="right" valign="top"><a id="a4305d89f4c43ae22807fb7a4465892b1"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>PWMSND_TOP</b>&#160;&#160;&#160;255</td></tr>
<tr class="separator:a4305d89f4c43ae22807fb7a4465892b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a303815caa7194ff25089fd1fd0ebd383"><td class="memItemLeft" align="right" valign="top"><a id="a303815caa7194ff25089fd1fd0ebd383"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>PWMSND_CLOCK</b>&#160;&#160;&#160;(SOUNDRATE*(PWMSND_TOP+1))</td></tr>
<tr class="separator:a303815caa7194ff25089fd1fd0ebd383"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae24d7c0b06c55d8c29d46e1701c48a63"><td class="memItemLeft" align="right" valign="top"><a id="ae24d7c0b06c55d8c29d46e1701c48a63"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SNDFRAC</b>&#160;&#160;&#160;10</td></tr>
<tr class="separator:ae24d7c0b06c55d8c29d46e1701c48a63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b2ec0a9fe8aef61e1c207e60c7761fa"><td class="memItemLeft" align="right" valign="top"><a id="a1b2ec0a9fe8aef61e1c207e60c7761fa"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SNDINT</b>&#160;&#160;&#160;(1&lt;&lt;SNDFRAC)</td></tr>
<tr class="separator:a1b2ec0a9fe8aef61e1c207e60c7761fa"><td class="memSeparator" colspan="2">&#160;</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:ga125653aeeb2dc605e83d0927a635983c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PWMGroup.html#ga125653aeeb2dc605e83d0927a635983c">PWMSndInit</a> ()</td></tr>
<tr class="memdesc:ga125653aeeb2dc605e83d0927a635983c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize PWM sound output. <a href="group__PWMGroup.html#ga125653aeeb2dc605e83d0927a635983c">More...</a><br /></td></tr>
<tr class="separator:ga125653aeeb2dc605e83d0927a635983c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7d7587ed33cbb0e94588c96735b5e6d5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PWMGroup.html#ga7d7587ed33cbb0e94588c96735b5e6d5">PlaySound</a> (const u8 *snd, int len, Bool rep=False, float speed=1.0f)</td></tr>
<tr class="memdesc:ga7d7587ed33cbb0e94588c96735b5e6d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Output PWM sound. <a href="group__PWMGroup.html#ga7d7587ed33cbb0e94588c96735b5e6d5">More...</a><br /></td></tr>
<tr class="separator:ga7d7587ed33cbb0e94588c96735b5e6d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gace7ff7d9e5fec2fa9c349305e72f1503"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PWMGroup.html#gace7ff7d9e5fec2fa9c349305e72f1503">StopSound</a> ()</td></tr>
<tr class="memdesc:gace7ff7d9e5fec2fa9c349305e72f1503"><td class="mdescLeft">&#160;</td><td class="mdescRight">stop playing sound <a href="group__PWMGroup.html#gace7ff7d9e5fec2fa9c349305e72f1503">More...</a><br /></td></tr>
<tr class="separator:gace7ff7d9e5fec2fa9c349305e72f1503"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa69a3c0ca6e5f20455ef1e60c2ea7b31"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PWMGroup.html#gaa69a3c0ca6e5f20455ef1e60c2ea7b31">SpeedSound</a> (float speed)</td></tr>
<tr class="memdesc:gaa69a3c0ca6e5f20455ef1e60c2ea7b31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Update sound speed. <a href="group__PWMGroup.html#gaa69a3c0ca6e5f20455ef1e60c2ea7b31">More...</a><br /></td></tr>
<tr class="separator:gaa69a3c0ca6e5f20455ef1e60c2ea7b31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac5cdc29178dd50bc69a6925a6af5c84a"><td class="memItemLeft" align="right" valign="top">
Bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PWMGroup.html#gac5cdc29178dd50bc69a6925a6af5c84a">PlayingSound</a> ()</td></tr>
<tr class="memdesc:gac5cdc29178dd50bc69a6925a6af5c84a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if playing sound. <br /></td></tr>
<tr class="separator:gac5cdc29178dd50bc69a6925a6af5c84a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf9f5fbc637ae75e22d2f628cbfd9b665"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PWMGroup.html#gaf9f5fbc637ae75e22d2f628cbfd9b665">SetNextSound</a> (const u8 *snd, int len)</td></tr>
<tr class="memdesc:gaf9f5fbc637ae75e22d2f628cbfd9b665"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the next sound to play. <a href="group__PWMGroup.html#gaf9f5fbc637ae75e22d2f628cbfd9b665">More...</a><br /></td></tr>
<tr class="separator:gaf9f5fbc637ae75e22d2f628cbfd9b665"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:af2362264a6496bd608fedc8cf9ca639a"><td class="memItemLeft" align="right" valign="top"><a id="af2362264a6496bd608fedc8cf9ca639a"></a>
const u8 *&#160;</td><td class="memItemRight" valign="bottom"><b>CurSound</b></td></tr>
<tr class="separator:af2362264a6496bd608fedc8cf9ca639a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84a93db0a4742999691ab24cca6f5b3b"><td class="memItemLeft" align="right" valign="top"><a id="a84a93db0a4742999691ab24cca6f5b3b"></a>
volatile int&#160;</td><td class="memItemRight" valign="bottom"><b>SoundCnt</b></td></tr>
<tr class="separator:a84a93db0a4742999691ab24cca6f5b3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c084a6f051bb50236a657187060001f"><td class="memItemLeft" align="right" valign="top"><a id="a2c084a6f051bb50236a657187060001f"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>SoundInc</b></td></tr>
<tr class="separator:a2c084a6f051bb50236a657187060001f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5133a0c870e6dbc6988427f04b0f8b4"><td class="memItemLeft" align="right" valign="top"><a id="af5133a0c870e6dbc6988427f04b0f8b4"></a>
volatile int&#160;</td><td class="memItemRight" valign="bottom"><b>SoundAcc</b></td></tr>
<tr class="separator:af5133a0c870e6dbc6988427f04b0f8b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92c626b547d3f8a6364bd094e1c96eac"><td class="memItemLeft" align="right" valign="top"><a id="a92c626b547d3f8a6364bd094e1c96eac"></a>
const u8 *&#160;</td><td class="memItemRight" valign="bottom"><b>NextSound</b></td></tr>
<tr class="separator:a92c626b547d3f8a6364bd094e1c96eac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a683b1052cae4ed2fa2b6349965bd54f7"><td class="memItemLeft" align="right" valign="top"><a id="a683b1052cae4ed2fa2b6349965bd54f7"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>NextSoundCnt</b></td></tr>
<tr class="separator:a683b1052cae4ed2fa2b6349965bd54f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b7878ad5ecbf2506f4125b9d34c97e45.html">util</a></li><li class="navelem"><a class="el" href="pwmsnd_8h.html">pwmsnd.h</a></li>
<li class="footer">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 </li>
</ul>
</div>
</body>
</html>