240 lines
38 KiB
HTML
240 lines
38 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>libctru: include/3ds/services/mic.h Source File</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">libctru
|
|
 <span id="projectnumber">v2.4.1</span>
|
|
</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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li><li class="navelem"><a class="el" href="dir_0e005207343684f6967052d1f51a7e66.html">services</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">mic.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="mic_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * @file mic.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief MIC (Microphone) service.</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/// Microphone audio encodings.</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54f"> 8</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> {</div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fa52c56be2bb309b8f9c90ef50df2e3aac"> 10</a></span>  <a class="code" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fa52c56be2bb309b8f9c90ef50df2e3aac">MICU_ENCODING_PCM8</a> = 0, <span class="comment">///< Unsigned 8-bit PCM.</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fa31b7d400f110e7c1e6c7b48d019435a2"> 11</a></span>  <a class="code" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fa31b7d400f110e7c1e6c7b48d019435a2">MICU_ENCODING_PCM16</a> = 1, <span class="comment">///< Unsigned 16-bit PCM.</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fa6cfc9ded08c2da0254777e294feae5dc"> 12</a></span>  <a class="code" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fa6cfc9ded08c2da0254777e294feae5dc">MICU_ENCODING_PCM8_SIGNED</a> = 2, <span class="comment">///< Signed 8-bit PCM.</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fab94c760d37cb05a0f9b35dfe308adf92"> 13</a></span>  <a class="code" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fab94c760d37cb05a0f9b35dfe308adf92">MICU_ENCODING_PCM16_SIGNED</a> = 3, <span class="comment">///< Signed 16-bit PCM.</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> } <a class="code" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54f">MICU_Encoding</a>;</div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">/// Microphone audio sampling rates.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="mic_8h.html#ae126d52922918356ed810bcc398ad62b"> 17</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> {</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="mic_8h.html#ae126d52922918356ed810bcc398ad62bac8da93f3cdac62489f4551f4a47856d8"> 19</a></span>  <a class="code" href="mic_8h.html#ae126d52922918356ed810bcc398ad62bac8da93f3cdac62489f4551f4a47856d8">MICU_SAMPLE_RATE_32730</a> = 0, <span class="comment">///< 32728.498 Hz</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="mic_8h.html#ae126d52922918356ed810bcc398ad62ba2b9d600ba6fd888107ddcf0fabc1f5bf"> 20</a></span>  <a class="code" href="mic_8h.html#ae126d52922918356ed810bcc398ad62ba2b9d600ba6fd888107ddcf0fabc1f5bf">MICU_SAMPLE_RATE_16360</a> = 1, <span class="comment">///< 16364.479 Hz</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="mic_8h.html#ae126d52922918356ed810bcc398ad62bafeff0b1c15a58a63e8321c19a0c33130"> 21</a></span>  <a class="code" href="mic_8h.html#ae126d52922918356ed810bcc398ad62bafeff0b1c15a58a63e8321c19a0c33130">MICU_SAMPLE_RATE_10910</a> = 2, <span class="comment">///< 10909.499 Hz</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="mic_8h.html#ae126d52922918356ed810bcc398ad62bac2a768cc557b9c41aef9028824906fb0"> 22</a></span>  <a class="code" href="mic_8h.html#ae126d52922918356ed810bcc398ad62bac2a768cc557b9c41aef9028824906fb0">MICU_SAMPLE_RATE_8180</a> = 3, <span class="comment">///< 8182.1245 Hz</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> } <a class="code" href="mic_8h.html#ae126d52922918356ed810bcc398ad62b">MICU_SampleRate</a>;</div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * @brief Initializes MIC.</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * @param size Shared memory buffer to write audio data to. Must be aligned to 0x1000 bytes.</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * @param handle Size of the shared memory buffer.</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="mic_8h.html#a01ab8a1440cd4d38855336e47e5ae380"> 30</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mic_8h.html#a01ab8a1440cd4d38855336e47e5ae380">micInit</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>* buffer, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> bufferSize);</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/// Exits MIC.</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="mic_8h.html#a5de3831a1aa13b444a812ebfef218361"> 33</a></span> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="mic_8h.html#a5de3831a1aa13b444a812ebfef218361">micExit</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * @brief Gets the size of the sample data area within the shared memory buffer.</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * @return The sample data's size.</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="mic_8h.html#a09361b33179e9ca5fd099161cf25d70a"> 39</a></span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="mic_8h.html#a09361b33179e9ca5fd099161cf25d70a">micGetSampleDataSize</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @brief Gets the offset within the shared memory buffer of the last sample written.</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * @return The last sample's offset.</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="mic_8h.html#aa2590afec7ac205e877ab94c9203a4c9"> 45</a></span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="mic_8h.html#aa2590afec7ac205e877ab94c9203a4c9">micGetLastSampleOffset</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * @brief Maps MIC shared memory.</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @param size Size of the shared memory.</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * @param handle Handle of the shared memory.</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="mic_8h.html#a3dd3e9152bbddcafe2babc371c210222"> 52</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mic_8h.html#a3dd3e9152bbddcafe2babc371c210222">MICU_MapSharedMem</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size, <a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> handle);</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">/// Unmaps MIC shared memory.</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="mic_8h.html#ab728c230d454422b4fdc119eec7f0510"> 55</a></span> <span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mic_8h.html#ab728c230d454422b4fdc119eec7f0510">MICU_UnmapSharedMem</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * @brief Begins sampling microphone input.</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * @param encoding Encoding of outputted audio.</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * @param sampleRate Sample rate of outputted audio.</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * @param sharedMemAudioOffset Offset to write audio data to in the shared memory buffer.</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * @param sharedMemAudioSize Size of audio data to write to the shared memory buffer. This should be at most "bufferSize - 4".</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * @param loop Whether to loop back to the beginning of the buffer when the end is reached.</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="mic_8h.html#a79266af4aa50d790fba3680d423f6ff0"> 65</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mic_8h.html#a79266af4aa50d790fba3680d423f6ff0">MICU_StartSampling</a>(<a class="code" href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54f">MICU_Encoding</a> encoding, <a class="code" href="mic_8h.html#ae126d52922918356ed810bcc398ad62b">MICU_SampleRate</a> sampleRate, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> offset, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size, <span class="keywordtype">bool</span> loop);</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * @brief Adjusts the configuration of the current sampling session.</span></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * @param sampleRate Sample rate of outputted audio.</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="mic_8h.html#afdc168c4f160192b7b3b04e49d15ec86"> 71</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mic_8h.html#afdc168c4f160192b7b3b04e49d15ec86">MICU_AdjustSampling</a>(<a class="code" href="mic_8h.html#ae126d52922918356ed810bcc398ad62b">MICU_SampleRate</a> sampleRate);</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">/// Stops sampling microphone input.</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="mic_8h.html#a7ea7f514ee9e50db3bc49bd3106fa967"> 74</a></span> <span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mic_8h.html#a7ea7f514ee9e50db3bc49bd3106fa967">MICU_StopSampling</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * @brief Gets whether microphone input is currently being sampled.</span></div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * @param sampling Pointer to output the sampling state to.</span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="mic_8h.html#a42078893931d09a8b27f3306c7f13a29"> 80</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mic_8h.html#a42078893931d09a8b27f3306c7f13a29">MICU_IsSampling</a>(<span class="keywordtype">bool</span>* sampling);</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * @brief Gets an event handle triggered when the shared memory buffer is full.</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * @param handle Pointer to output the event handle to.</span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="mic_8h.html#a8f17c21f1420682eb699cf39adf537b2"> 86</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mic_8h.html#a8f17c21f1420682eb699cf39adf537b2">MICU_GetEventHandle</a>(<a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>* handle);</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * @brief Sets the microphone's gain.</span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * @param gain Gain to set.</span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="mic_8h.html#a0c29ffb2d0addbaca328d8aad082e3bf"> 92</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mic_8h.html#a0c29ffb2d0addbaca328d8aad082e3bf">MICU_SetGain</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> gain);</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * @brief Gets the microphone's gain.</span></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * @param gain Pointer to output the current gain to.</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="mic_8h.html#add912c11a5b5ff8dabe224e2f380be9b"> 98</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mic_8h.html#add912c11a5b5ff8dabe224e2f380be9b">MICU_GetGain</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>* gain);</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * @brief Sets whether the microphone is powered on.</span></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * @param power Whether the microphone is powered on.</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="mic_8h.html#a3a26bd2ff5eeaaf538df29230b3fda61"> 104</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mic_8h.html#a3a26bd2ff5eeaaf538df29230b3fda61">MICU_SetPower</a>(<span class="keywordtype">bool</span> power);</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * @brief Gets whether the microphone is powered on.</span></div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * @param power Pointer to output the power state to.</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"><a class="line" href="mic_8h.html#a38f4599e0d974a89a4448b3a53360cc6"> 110</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mic_8h.html#a38f4599e0d974a89a4448b3a53360cc6">MICU_GetPower</a>(<span class="keywordtype">bool</span>* power);</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * @brief Sets whether to clamp microphone input.</span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * @param clamp Whether to clamp microphone input.</span></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="mic_8h.html#a0a156a0b69714f334c004c7137a7592c"> 116</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mic_8h.html#a0a156a0b69714f334c004c7137a7592c">MICU_SetClamp</a>(<span class="keywordtype">bool</span> clamp);</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * @brief Gets whether to clamp microphone input.</span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * @param clamp Pointer to output the clamp state to.</span></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="mic_8h.html#aed8b72fbff68362b9c6a047a0b0c7307"> 122</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mic_8h.html#aed8b72fbff68362b9c6a047a0b0c7307">MICU_GetClamp</a>(<span class="keywordtype">bool</span>* clamp);</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * @brief Sets whether to allow sampling when the shell is closed.</span></div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * @param allowShellClosed Whether to allow sampling when the shell is closed.</span></div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="mic_8h.html#a913ee846ab9633883625e6477ae10cdf"> 128</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mic_8h.html#a913ee846ab9633883625e6477ae10cdf">MICU_SetAllowShellClosed</a>(<span class="keywordtype">bool</span> allowShellClosed);</div>
|
|
<div class="ttc" id="amic_8h_html_a01ab8a1440cd4d38855336e47e5ae380"><div class="ttname"><a href="mic_8h.html#a01ab8a1440cd4d38855336e47e5ae380">micInit</a></div><div class="ttdeci">Result micInit(u8 *buffer, u32 bufferSize)</div><div class="ttdoc">Initializes MIC.</div></div>
|
|
<div class="ttc" id="amic_8h_html_a09361b33179e9ca5fd099161cf25d70a"><div class="ttname"><a href="mic_8h.html#a09361b33179e9ca5fd099161cf25d70a">micGetSampleDataSize</a></div><div class="ttdeci">u32 micGetSampleDataSize(void)</div><div class="ttdoc">Gets the size of the sample data area within the shared memory buffer.</div></div>
|
|
<div class="ttc" id="amic_8h_html_a0a156a0b69714f334c004c7137a7592c"><div class="ttname"><a href="mic_8h.html#a0a156a0b69714f334c004c7137a7592c">MICU_SetClamp</a></div><div class="ttdeci">Result MICU_SetClamp(bool clamp)</div><div class="ttdoc">Sets whether to clamp microphone input.</div></div>
|
|
<div class="ttc" id="amic_8h_html_a0c29ffb2d0addbaca328d8aad082e3bf"><div class="ttname"><a href="mic_8h.html#a0c29ffb2d0addbaca328d8aad082e3bf">MICU_SetGain</a></div><div class="ttdeci">Result MICU_SetGain(u8 gain)</div><div class="ttdoc">Sets the microphone's gain.</div></div>
|
|
<div class="ttc" id="amic_8h_html_a38f4599e0d974a89a4448b3a53360cc6"><div class="ttname"><a href="mic_8h.html#a38f4599e0d974a89a4448b3a53360cc6">MICU_GetPower</a></div><div class="ttdeci">Result MICU_GetPower(bool *power)</div><div class="ttdoc">Gets whether the microphone is powered on.</div></div>
|
|
<div class="ttc" id="amic_8h_html_a3a26bd2ff5eeaaf538df29230b3fda61"><div class="ttname"><a href="mic_8h.html#a3a26bd2ff5eeaaf538df29230b3fda61">MICU_SetPower</a></div><div class="ttdeci">Result MICU_SetPower(bool power)</div><div class="ttdoc">Sets whether the microphone is powered on.</div></div>
|
|
<div class="ttc" id="amic_8h_html_a3dd3e9152bbddcafe2babc371c210222"><div class="ttname"><a href="mic_8h.html#a3dd3e9152bbddcafe2babc371c210222">MICU_MapSharedMem</a></div><div class="ttdeci">Result MICU_MapSharedMem(u32 size, Handle handle)</div><div class="ttdoc">Maps MIC shared memory.</div></div>
|
|
<div class="ttc" id="amic_8h_html_a3ead458d1aabf74550446b463b4fb54f"><div class="ttname"><a href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54f">MICU_Encoding</a></div><div class="ttdeci">MICU_Encoding</div><div class="ttdoc">Microphone audio encodings.</div><div class="ttdef"><b>Definition:</b> mic.h:9</div></div>
|
|
<div class="ttc" id="amic_8h_html_a3ead458d1aabf74550446b463b4fb54fa31b7d400f110e7c1e6c7b48d019435a2"><div class="ttname"><a href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fa31b7d400f110e7c1e6c7b48d019435a2">MICU_ENCODING_PCM16</a></div><div class="ttdeci">@ MICU_ENCODING_PCM16</div><div class="ttdoc">Unsigned 16-bit PCM.</div><div class="ttdef"><b>Definition:</b> mic.h:11</div></div>
|
|
<div class="ttc" id="amic_8h_html_a3ead458d1aabf74550446b463b4fb54fa52c56be2bb309b8f9c90ef50df2e3aac"><div class="ttname"><a href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fa52c56be2bb309b8f9c90ef50df2e3aac">MICU_ENCODING_PCM8</a></div><div class="ttdeci">@ MICU_ENCODING_PCM8</div><div class="ttdoc">Unsigned 8-bit PCM.</div><div class="ttdef"><b>Definition:</b> mic.h:10</div></div>
|
|
<div class="ttc" id="amic_8h_html_a3ead458d1aabf74550446b463b4fb54fa6cfc9ded08c2da0254777e294feae5dc"><div class="ttname"><a href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fa6cfc9ded08c2da0254777e294feae5dc">MICU_ENCODING_PCM8_SIGNED</a></div><div class="ttdeci">@ MICU_ENCODING_PCM8_SIGNED</div><div class="ttdoc">Signed 8-bit PCM.</div><div class="ttdef"><b>Definition:</b> mic.h:12</div></div>
|
|
<div class="ttc" id="amic_8h_html_a3ead458d1aabf74550446b463b4fb54fab94c760d37cb05a0f9b35dfe308adf92"><div class="ttname"><a href="mic_8h.html#a3ead458d1aabf74550446b463b4fb54fab94c760d37cb05a0f9b35dfe308adf92">MICU_ENCODING_PCM16_SIGNED</a></div><div class="ttdeci">@ MICU_ENCODING_PCM16_SIGNED</div><div class="ttdoc">Signed 16-bit PCM.</div><div class="ttdef"><b>Definition:</b> mic.h:13</div></div>
|
|
<div class="ttc" id="amic_8h_html_a42078893931d09a8b27f3306c7f13a29"><div class="ttname"><a href="mic_8h.html#a42078893931d09a8b27f3306c7f13a29">MICU_IsSampling</a></div><div class="ttdeci">Result MICU_IsSampling(bool *sampling)</div><div class="ttdoc">Gets whether microphone input is currently being sampled.</div></div>
|
|
<div class="ttc" id="amic_8h_html_a5de3831a1aa13b444a812ebfef218361"><div class="ttname"><a href="mic_8h.html#a5de3831a1aa13b444a812ebfef218361">micExit</a></div><div class="ttdeci">void micExit(void)</div><div class="ttdoc">Exits MIC.</div></div>
|
|
<div class="ttc" id="amic_8h_html_a79266af4aa50d790fba3680d423f6ff0"><div class="ttname"><a href="mic_8h.html#a79266af4aa50d790fba3680d423f6ff0">MICU_StartSampling</a></div><div class="ttdeci">Result MICU_StartSampling(MICU_Encoding encoding, MICU_SampleRate sampleRate, u32 offset, u32 size, bool loop)</div><div class="ttdoc">Begins sampling microphone input.</div></div>
|
|
<div class="ttc" id="amic_8h_html_a7ea7f514ee9e50db3bc49bd3106fa967"><div class="ttname"><a href="mic_8h.html#a7ea7f514ee9e50db3bc49bd3106fa967">MICU_StopSampling</a></div><div class="ttdeci">Result MICU_StopSampling(void)</div><div class="ttdoc">Stops sampling microphone input.</div></div>
|
|
<div class="ttc" id="amic_8h_html_a8f17c21f1420682eb699cf39adf537b2"><div class="ttname"><a href="mic_8h.html#a8f17c21f1420682eb699cf39adf537b2">MICU_GetEventHandle</a></div><div class="ttdeci">Result MICU_GetEventHandle(Handle *handle)</div><div class="ttdoc">Gets an event handle triggered when the shared memory buffer is full.</div></div>
|
|
<div class="ttc" id="amic_8h_html_a913ee846ab9633883625e6477ae10cdf"><div class="ttname"><a href="mic_8h.html#a913ee846ab9633883625e6477ae10cdf">MICU_SetAllowShellClosed</a></div><div class="ttdeci">Result MICU_SetAllowShellClosed(bool allowShellClosed)</div><div class="ttdoc">Sets whether to allow sampling when the shell is closed.</div></div>
|
|
<div class="ttc" id="amic_8h_html_aa2590afec7ac205e877ab94c9203a4c9"><div class="ttname"><a href="mic_8h.html#aa2590afec7ac205e877ab94c9203a4c9">micGetLastSampleOffset</a></div><div class="ttdeci">u32 micGetLastSampleOffset(void)</div><div class="ttdoc">Gets the offset within the shared memory buffer of the last sample written.</div></div>
|
|
<div class="ttc" id="amic_8h_html_ab728c230d454422b4fdc119eec7f0510"><div class="ttname"><a href="mic_8h.html#ab728c230d454422b4fdc119eec7f0510">MICU_UnmapSharedMem</a></div><div class="ttdeci">Result MICU_UnmapSharedMem(void)</div><div class="ttdoc">Unmaps MIC shared memory.</div></div>
|
|
<div class="ttc" id="amic_8h_html_add912c11a5b5ff8dabe224e2f380be9b"><div class="ttname"><a href="mic_8h.html#add912c11a5b5ff8dabe224e2f380be9b">MICU_GetGain</a></div><div class="ttdeci">Result MICU_GetGain(u8 *gain)</div><div class="ttdoc">Gets the microphone's gain.</div></div>
|
|
<div class="ttc" id="amic_8h_html_ae126d52922918356ed810bcc398ad62b"><div class="ttname"><a href="mic_8h.html#ae126d52922918356ed810bcc398ad62b">MICU_SampleRate</a></div><div class="ttdeci">MICU_SampleRate</div><div class="ttdoc">Microphone audio sampling rates.</div><div class="ttdef"><b>Definition:</b> mic.h:18</div></div>
|
|
<div class="ttc" id="amic_8h_html_ae126d52922918356ed810bcc398ad62ba2b9d600ba6fd888107ddcf0fabc1f5bf"><div class="ttname"><a href="mic_8h.html#ae126d52922918356ed810bcc398ad62ba2b9d600ba6fd888107ddcf0fabc1f5bf">MICU_SAMPLE_RATE_16360</a></div><div class="ttdeci">@ MICU_SAMPLE_RATE_16360</div><div class="ttdoc">16364.479 Hz</div><div class="ttdef"><b>Definition:</b> mic.h:20</div></div>
|
|
<div class="ttc" id="amic_8h_html_ae126d52922918356ed810bcc398ad62bac2a768cc557b9c41aef9028824906fb0"><div class="ttname"><a href="mic_8h.html#ae126d52922918356ed810bcc398ad62bac2a768cc557b9c41aef9028824906fb0">MICU_SAMPLE_RATE_8180</a></div><div class="ttdeci">@ MICU_SAMPLE_RATE_8180</div><div class="ttdoc">8182.1245 Hz</div><div class="ttdef"><b>Definition:</b> mic.h:22</div></div>
|
|
<div class="ttc" id="amic_8h_html_ae126d52922918356ed810bcc398ad62bac8da93f3cdac62489f4551f4a47856d8"><div class="ttname"><a href="mic_8h.html#ae126d52922918356ed810bcc398ad62bac8da93f3cdac62489f4551f4a47856d8">MICU_SAMPLE_RATE_32730</a></div><div class="ttdeci">@ MICU_SAMPLE_RATE_32730</div><div class="ttdoc">32728.498 Hz</div><div class="ttdef"><b>Definition:</b> mic.h:19</div></div>
|
|
<div class="ttc" id="amic_8h_html_ae126d52922918356ed810bcc398ad62bafeff0b1c15a58a63e8321c19a0c33130"><div class="ttname"><a href="mic_8h.html#ae126d52922918356ed810bcc398ad62bafeff0b1c15a58a63e8321c19a0c33130">MICU_SAMPLE_RATE_10910</a></div><div class="ttdeci">@ MICU_SAMPLE_RATE_10910</div><div class="ttdoc">10909.499 Hz</div><div class="ttdef"><b>Definition:</b> mic.h:21</div></div>
|
|
<div class="ttc" id="amic_8h_html_aed8b72fbff68362b9c6a047a0b0c7307"><div class="ttname"><a href="mic_8h.html#aed8b72fbff68362b9c6a047a0b0c7307">MICU_GetClamp</a></div><div class="ttdeci">Result MICU_GetClamp(bool *clamp)</div><div class="ttdoc">Gets whether to clamp microphone input.</div></div>
|
|
<div class="ttc" id="amic_8h_html_afdc168c4f160192b7b3b04e49d15ec86"><div class="ttname"><a href="mic_8h.html#afdc168c4f160192b7b3b04e49d15ec86">MICU_AdjustSampling</a></div><div class="ttdeci">Result MICU_AdjustSampling(MICU_SampleRate sampleRate)</div><div class="ttdoc">Adjusts the configuration of the current sampling session.</div></div>
|
|
<div class="ttc" id="atypes_8h_html_a92c50087ca0e64fa93fc59402c55f8ca"><div class="ttname"><a href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a></div><div class="ttdeci">uint8_t u8</div><div class="ttdoc">would be nice if newlib had this already</div><div class="ttdef"><b>Definition:</b> types.h:21</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ab6d744c6b5de129f12937e482dc674fb"><div class="ttname"><a href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a></div><div class="ttdeci">u32 Handle</div><div class="ttdoc">Resource handle.</div><div class="ttdef"><b>Definition:</b> types.h:41</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ac830bf5a4f2cf8273f61ab99a46cf163"><div class="ttname"><a href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a></div><div class="ttdeci">s32 Result</div><div class="ttdoc">Function result.</div><div class="ttdef"><b>Definition:</b> types.h:42</div></div>
|
|
<div class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer</div><div class="ttdef"><b>Definition:</b> types.h:23</div></div>
|
|
</div><!-- fragment --></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>
|