1407 lines
69 KiB
HTML
1407 lines
69 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/ndsp/channel.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="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_953d82d0b36b92ff36f0c21b90fa146f.html">ndsp</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">channel.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Functions for interacting with DSP audio channels.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><a href="channel_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="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Basic channel operation</div></td></tr>
|
|
<tr class="memitem:a7b755904976d3b04b3303475d9605bd8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a7b755904976d3b04b3303475d9605bd8">ndspChnReset</a> (int id)</td></tr>
|
|
<tr class="memdesc:a7b755904976d3b04b3303475d9605bd8"><td class="mdescLeft"> </td><td class="mdescRight">Resets a channel. <a href="channel_8h.html#a7b755904976d3b04b3303475d9605bd8">More...</a><br /></td></tr>
|
|
<tr class="separator:a7b755904976d3b04b3303475d9605bd8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0936956c6d5700cdbab4ea3e3304f19d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a0936956c6d5700cdbab4ea3e3304f19d">ndspChnInitParams</a> (int id)</td></tr>
|
|
<tr class="memdesc:a0936956c6d5700cdbab4ea3e3304f19d"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the parameters of a channel. <a href="channel_8h.html#a0936956c6d5700cdbab4ea3e3304f19d">More...</a><br /></td></tr>
|
|
<tr class="separator:a0936956c6d5700cdbab4ea3e3304f19d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0eee6c9ebf357c8d55d087a378178f9b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a0eee6c9ebf357c8d55d087a378178f9b">ndspChnIsPlaying</a> (int id)</td></tr>
|
|
<tr class="memdesc:a0eee6c9ebf357c8d55d087a378178f9b"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether a channel is currently playing. <a href="channel_8h.html#a0eee6c9ebf357c8d55d087a378178f9b">More...</a><br /></td></tr>
|
|
<tr class="separator:a0eee6c9ebf357c8d55d087a378178f9b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a827bf43cb8dd8ccaa74a29456589a39d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a827bf43cb8dd8ccaa74a29456589a39d">ndspChnGetSamplePos</a> (int id)</td></tr>
|
|
<tr class="memdesc:a827bf43cb8dd8ccaa74a29456589a39d"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current sample position of a channel. <a href="channel_8h.html#a827bf43cb8dd8ccaa74a29456589a39d">More...</a><br /></td></tr>
|
|
<tr class="separator:a827bf43cb8dd8ccaa74a29456589a39d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a17607395e3725f7a35b4395cbd59cb60"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a17607395e3725f7a35b4395cbd59cb60">ndspChnGetWaveBufSeq</a> (int id)</td></tr>
|
|
<tr class="memdesc:a17607395e3725f7a35b4395cbd59cb60"><td class="mdescLeft"> </td><td class="mdescRight">Gets the sequence ID of the wave buffer that is currently playing in a channel. <a href="channel_8h.html#a17607395e3725f7a35b4395cbd59cb60">More...</a><br /></td></tr>
|
|
<tr class="separator:a17607395e3725f7a35b4395cbd59cb60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a14aa007d2ca0d6e87a90edf64e03b5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a8a14aa007d2ca0d6e87a90edf64e03b5">ndspChnIsPaused</a> (int id)</td></tr>
|
|
<tr class="memdesc:a8a14aa007d2ca0d6e87a90edf64e03b5"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether a channel is currently paused. <a href="channel_8h.html#a8a14aa007d2ca0d6e87a90edf64e03b5">More...</a><br /></td></tr>
|
|
<tr class="separator:a8a14aa007d2ca0d6e87a90edf64e03b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acdd5e211d825656d78503e111e98de6e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#acdd5e211d825656d78503e111e98de6e">ndspChnSetPaused</a> (int id, bool paused)</td></tr>
|
|
<tr class="memdesc:acdd5e211d825656d78503e111e98de6e"><td class="mdescLeft"> </td><td class="mdescRight">Sets the pause status of a channel. <a href="channel_8h.html#acdd5e211d825656d78503e111e98de6e">More...</a><br /></td></tr>
|
|
<tr class="separator:acdd5e211d825656d78503e111e98de6e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Configuration</div></td></tr>
|
|
<tr class="memitem:a7986171c79c227443ef5ea60c464de23"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a7986171c79c227443ef5ea60c464de23">ndspChnSetFormat</a> (int id, <a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> format)</td></tr>
|
|
<tr class="memdesc:a7986171c79c227443ef5ea60c464de23"><td class="mdescLeft"> </td><td class="mdescRight">Sets the format of a channel. <a href="channel_8h.html#a7986171c79c227443ef5ea60c464de23">More...</a><br /></td></tr>
|
|
<tr class="separator:a7986171c79c227443ef5ea60c464de23"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a10f1f8593e8df973c62a16367731c590"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a10f1f8593e8df973c62a16367731c590">ndspChnGetFormat</a> (int id)</td></tr>
|
|
<tr class="memdesc:a10f1f8593e8df973c62a16367731c590"><td class="mdescLeft"> </td><td class="mdescRight">Gets the format of a channel. <a href="channel_8h.html#a10f1f8593e8df973c62a16367731c590">More...</a><br /></td></tr>
|
|
<tr class="separator:a10f1f8593e8df973c62a16367731c590"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac98e0b63e35e22aeea5265fd93f5206f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#ac98e0b63e35e22aeea5265fd93f5206f">ndspChnSetInterp</a> (int id, <a class="el" href="channel_8h.html#a6319005cb21b18395a1452e95aabbec3">ndspInterpType</a> type)</td></tr>
|
|
<tr class="memdesc:ac98e0b63e35e22aeea5265fd93f5206f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the interpolation type of a channel. <a href="channel_8h.html#ac98e0b63e35e22aeea5265fd93f5206f">More...</a><br /></td></tr>
|
|
<tr class="separator:ac98e0b63e35e22aeea5265fd93f5206f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b51c4320d90814f037c1d58140ff17f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="channel_8h.html#a6319005cb21b18395a1452e95aabbec3">ndspInterpType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a5b51c4320d90814f037c1d58140ff17f">ndspChnGetInterp</a> (int id)</td></tr>
|
|
<tr class="memdesc:a5b51c4320d90814f037c1d58140ff17f"><td class="mdescLeft"> </td><td class="mdescRight">Gets the interpolation type of a channel. <a href="channel_8h.html#a5b51c4320d90814f037c1d58140ff17f">More...</a><br /></td></tr>
|
|
<tr class="separator:a5b51c4320d90814f037c1d58140ff17f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f1076a8981a5b6722b912ca969162ea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a6f1076a8981a5b6722b912ca969162ea">ndspChnSetRate</a> (int id, float rate)</td></tr>
|
|
<tr class="memdesc:a6f1076a8981a5b6722b912ca969162ea"><td class="mdescLeft"> </td><td class="mdescRight">Sets the sample rate of a channel. <a href="channel_8h.html#a6f1076a8981a5b6722b912ca969162ea">More...</a><br /></td></tr>
|
|
<tr class="separator:a6f1076a8981a5b6722b912ca969162ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc939493191883e908783048fa0216b4"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#afc939493191883e908783048fa0216b4">ndspChnGetRate</a> (int id)</td></tr>
|
|
<tr class="memdesc:afc939493191883e908783048fa0216b4"><td class="mdescLeft"> </td><td class="mdescRight">Gets the sample rate of a channel. <a href="channel_8h.html#afc939493191883e908783048fa0216b4">More...</a><br /></td></tr>
|
|
<tr class="separator:afc939493191883e908783048fa0216b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a30eb26f1972cc3ec28370263796c0444"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a30eb26f1972cc3ec28370263796c0444">ndspChnSetMix</a> (int id, float mix[12])</td></tr>
|
|
<tr class="memdesc:a30eb26f1972cc3ec28370263796c0444"><td class="mdescLeft"> </td><td class="mdescRight">Sets the mix parameters (volumes) of a channel. <a href="channel_8h.html#a30eb26f1972cc3ec28370263796c0444">More...</a><br /></td></tr>
|
|
<tr class="separator:a30eb26f1972cc3ec28370263796c0444"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a42c4aac60efde6f7b5ab273aee906a62"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a42c4aac60efde6f7b5ab273aee906a62">ndspChnGetMix</a> (int id, float mix[12])</td></tr>
|
|
<tr class="memdesc:a42c4aac60efde6f7b5ab273aee906a62"><td class="mdescLeft"> </td><td class="mdescRight">Gets the mix parameters (volumes) of a channel. <a href="channel_8h.html#a42c4aac60efde6f7b5ab273aee906a62">More...</a><br /></td></tr>
|
|
<tr class="separator:a42c4aac60efde6f7b5ab273aee906a62"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adbd48651f22341bb93cb9b7f1304a00f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#adbd48651f22341bb93cb9b7f1304a00f">ndspChnSetAdpcmCoefs</a> (int id, <a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> coefs[16])</td></tr>
|
|
<tr class="memdesc:adbd48651f22341bb93cb9b7f1304a00f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the DSPADPCM coefficients of a channel. <a href="channel_8h.html#adbd48651f22341bb93cb9b7f1304a00f">More...</a><br /></td></tr>
|
|
<tr class="separator:adbd48651f22341bb93cb9b7f1304a00f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Wave buffers</div></td></tr>
|
|
<tr class="memitem:a054a58a102d00590a33101fe0de516e6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a054a58a102d00590a33101fe0de516e6">ndspChnWaveBufClear</a> (int id)</td></tr>
|
|
<tr class="memdesc:a054a58a102d00590a33101fe0de516e6"><td class="mdescLeft"> </td><td class="mdescRight">Clears the wave buffer queue of a channel and stops playback. <a href="channel_8h.html#a054a58a102d00590a33101fe0de516e6">More...</a><br /></td></tr>
|
|
<tr class="separator:a054a58a102d00590a33101fe0de516e6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a354a90dd921879724d62d325c0128d6b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a354a90dd921879724d62d325c0128d6b">ndspChnWaveBufAdd</a> (int id, ndspWaveBuf *buf)</td></tr>
|
|
<tr class="memdesc:a354a90dd921879724d62d325c0128d6b"><td class="mdescLeft"> </td><td class="mdescRight">Adds a wave buffer to the wave buffer queue of a channel. <a href="channel_8h.html#a354a90dd921879724d62d325c0128d6b">More...</a><br /></td></tr>
|
|
<tr class="separator:a354a90dd921879724d62d325c0128d6b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">IIR filters</div></td></tr>
|
|
<tr class="memitem:a1da3b363c2edfd318c92276b527daae6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a1da3b363c2edfd318c92276b527daae6">ndspChnIirMonoSetEnable</a> (int id, bool enable)</td></tr>
|
|
<tr class="memdesc:a1da3b363c2edfd318c92276b527daae6"><td class="mdescLeft"> </td><td class="mdescRight">Configures whether the IIR monopole filter of a channel is enabled. <a href="channel_8h.html#a1da3b363c2edfd318c92276b527daae6">More...</a><br /></td></tr>
|
|
<tr class="separator:a1da3b363c2edfd318c92276b527daae6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4b7db8c300510523f0d13b4a88416c4d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a4b7db8c300510523f0d13b4a88416c4d">ndspChnIirMonoSetParamsCustomFilter</a> (int id, float a0, float a1, float b0)</td></tr>
|
|
<tr class="memdesc:a4b7db8c300510523f0d13b4a88416c4d"><td class="mdescLeft"> </td><td class="mdescRight">Manually sets up the parameters on monopole filter. <a href="channel_8h.html#a4b7db8c300510523f0d13b4a88416c4d">More...</a><br /></td></tr>
|
|
<tr class="separator:a4b7db8c300510523f0d13b4a88416c4d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abebeff0925fc86405750720efc11a7d0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#abebeff0925fc86405750720efc11a7d0">ndspChnIirMonoSetParamsLowPassFilter</a> (int id, float f0)</td></tr>
|
|
<tr class="memdesc:abebeff0925fc86405750720efc11a7d0"><td class="mdescLeft"> </td><td class="mdescRight">Sets the monopole to be a low pass filter. <a href="channel_8h.html#abebeff0925fc86405750720efc11a7d0">More...</a><br /></td></tr>
|
|
<tr class="separator:abebeff0925fc86405750720efc11a7d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e45d6a7193825ea7cd9bf9c6b8a6548"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a7e45d6a7193825ea7cd9bf9c6b8a6548">ndspChnIirMonoSetParamsHighPassFilter</a> (int id, float f0)</td></tr>
|
|
<tr class="memdesc:a7e45d6a7193825ea7cd9bf9c6b8a6548"><td class="mdescLeft"> </td><td class="mdescRight">Sets the monopole to be a high pass filter. <a href="channel_8h.html#a7e45d6a7193825ea7cd9bf9c6b8a6548">More...</a><br /></td></tr>
|
|
<tr class="separator:a7e45d6a7193825ea7cd9bf9c6b8a6548"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aafb95ce3188816694c51e30d7a64d8af"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#aafb95ce3188816694c51e30d7a64d8af">ndspChnIirBiquadSetEnable</a> (int id, bool enable)</td></tr>
|
|
<tr class="memdesc:aafb95ce3188816694c51e30d7a64d8af"><td class="mdescLeft"> </td><td class="mdescRight">Configures whether the IIR biquad filter of a channel is enabled. <a href="channel_8h.html#aafb95ce3188816694c51e30d7a64d8af">More...</a><br /></td></tr>
|
|
<tr class="separator:aafb95ce3188816694c51e30d7a64d8af"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7334f9d5dc89a43a5a78877665281fdc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a7334f9d5dc89a43a5a78877665281fdc">ndspChnIirBiquadSetParamsCustomFilter</a> (int id, float a0, float a1, float a2, float b0, float b1, float b2)</td></tr>
|
|
<tr class="memdesc:a7334f9d5dc89a43a5a78877665281fdc"><td class="mdescLeft"> </td><td class="mdescRight">Manually sets up the parameters of the biquad filter. <a href="channel_8h.html#a7334f9d5dc89a43a5a78877665281fdc">More...</a><br /></td></tr>
|
|
<tr class="separator:a7334f9d5dc89a43a5a78877665281fdc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78516636efb5eacd7b88ee54bd15bfb3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a78516636efb5eacd7b88ee54bd15bfb3">ndspChnIirBiquadSetParamsLowPassFilter</a> (int id, float f0, float Q)</td></tr>
|
|
<tr class="memdesc:a78516636efb5eacd7b88ee54bd15bfb3"><td class="mdescLeft"> </td><td class="mdescRight">Sets the biquad to be a low pass filter. <a href="channel_8h.html#a78516636efb5eacd7b88ee54bd15bfb3">More...</a><br /></td></tr>
|
|
<tr class="separator:a78516636efb5eacd7b88ee54bd15bfb3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8f543d0b8a10acbfb380b93b7bd47a75"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a8f543d0b8a10acbfb380b93b7bd47a75">ndspChnIirBiquadSetParamsHighPassFilter</a> (int id, float f0, float Q)</td></tr>
|
|
<tr class="memdesc:a8f543d0b8a10acbfb380b93b7bd47a75"><td class="mdescLeft"> </td><td class="mdescRight">Sets the biquad to be a high pass filter. <a href="channel_8h.html#a8f543d0b8a10acbfb380b93b7bd47a75">More...</a><br /></td></tr>
|
|
<tr class="separator:a8f543d0b8a10acbfb380b93b7bd47a75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af6c9d1d59c93164aae5a54ee7e8db2a9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#af6c9d1d59c93164aae5a54ee7e8db2a9">ndspChnIirBiquadSetParamsBandPassFilter</a> (int id, float f0, float Q)</td></tr>
|
|
<tr class="memdesc:af6c9d1d59c93164aae5a54ee7e8db2a9"><td class="mdescLeft"> </td><td class="mdescRight">Sets the biquad to be a band pass filter. <a href="channel_8h.html#af6c9d1d59c93164aae5a54ee7e8db2a9">More...</a><br /></td></tr>
|
|
<tr class="separator:af6c9d1d59c93164aae5a54ee7e8db2a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a671f5c90eb859c13eab4adf29f7943b3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a671f5c90eb859c13eab4adf29f7943b3">ndspChnIirBiquadSetParamsNotchFilter</a> (int id, float f0, float Q)</td></tr>
|
|
<tr class="memdesc:a671f5c90eb859c13eab4adf29f7943b3"><td class="mdescLeft"> </td><td class="mdescRight">Sets the biquad to be a notch filter. <a href="channel_8h.html#a671f5c90eb859c13eab4adf29f7943b3">More...</a><br /></td></tr>
|
|
<tr class="separator:a671f5c90eb859c13eab4adf29f7943b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ebeb91e95d5146358d0923a9d6fee0a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a9ebeb91e95d5146358d0923a9d6fee0a">ndspChnIirBiquadSetParamsPeakingEqualizer</a> (int id, float f0, float Q, float gain)</td></tr>
|
|
<tr class="memdesc:a9ebeb91e95d5146358d0923a9d6fee0a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the biquad to be a peaking equalizer. <a href="channel_8h.html#a9ebeb91e95d5146358d0923a9d6fee0a">More...</a><br /></td></tr>
|
|
<tr class="separator:a9ebeb91e95d5146358d0923a9d6fee0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader">Data types</h2></td></tr>
|
|
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpc2d7863fca30ab6c7f7119bf757962dd"></a>Supported sample encodings. </p>
|
|
</td></tr>
|
|
<tr class="memitem:ab722b50ffe7e9b2f87e2fb5200c2638d"><td class="memItemLeft" align="right" valign="top"><a id="ab722b50ffe7e9b2f87e2fb5200c2638d"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#ab722b50ffe7e9b2f87e2fb5200c2638d">NDSP_CHANNELS</a>(n)   ((<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>)(n) & 3)</td></tr>
|
|
<tr class="memdesc:ab722b50ffe7e9b2f87e2fb5200c2638d"><td class="mdescLeft"> </td><td class="mdescRight">Specifies the number of channels used in a sample. <br /></td></tr>
|
|
<tr class="separator:ab722b50ffe7e9b2f87e2fb5200c2638d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a3d697b96706c5e9750122d9db592cd"><td class="memItemLeft" align="right" valign="top"><a id="a6a3d697b96706c5e9750122d9db592cd"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a6a3d697b96706c5e9750122d9db592cd">NDSP_ENCODING</a>(n)   (((<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>)(n) & 3) << 2)</td></tr>
|
|
<tr class="memdesc:a6a3d697b96706c5e9750122d9db592cd"><td class="mdescLeft"> </td><td class="mdescRight">Specifies the encoding used in a sample. <br /></td></tr>
|
|
<tr class="separator:a6a3d697b96706c5e9750122d9db592cd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a458e651af6690959efa2afb96be7d609"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br />
|
|
  <a class="el" href="channel_8h.html#a458e651af6690959efa2afb96be7d609ae4f3bbb73c75334eed7c63bb947e3ec1">NDSP_ENCODING_PCM8</a> = 0
|
|
, <br />
|
|
  <a class="el" href="channel_8h.html#a458e651af6690959efa2afb96be7d609a641b555f1e09eb8ab7e684df4cdd463a">NDSP_ENCODING_PCM16</a>
|
|
, <br />
|
|
  <a class="el" href="channel_8h.html#a458e651af6690959efa2afb96be7d609ac588413fc3520d386b805e6db0c23c96">NDSP_ENCODING_ADPCM</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:a458e651af6690959efa2afb96be7d609"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f9aebf1de3ebbf4283a4dcf73308562"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br />
|
|
  <a class="el" href="channel_8h.html#a1f9aebf1de3ebbf4283a4dcf73308562a4d9a3eff8fae0658ed120ebadd5c6f42">NDSP_FORMAT_MONO_PCM8</a> = NDSP_CHANNELS(1) | NDSP_ENCODING(NDSP_ENCODING_PCM8)
|
|
, <br />
|
|
  <a class="el" href="channel_8h.html#a1f9aebf1de3ebbf4283a4dcf73308562af9368c39428fe9513f993ee4e9444cb6">NDSP_FORMAT_MONO_PCM16</a> = NDSP_CHANNELS(1) | NDSP_ENCODING(NDSP_ENCODING_PCM16)
|
|
, <br />
|
|
  <a class="el" href="channel_8h.html#a1f9aebf1de3ebbf4283a4dcf73308562a9e89ff35ab28474c60a4a642b3da2494">NDSP_FORMAT_MONO_ADPCM</a> = NDSP_CHANNELS(1) | NDSP_ENCODING(NDSP_ENCODING_ADPCM)
|
|
, <br />
|
|
  <a class="el" href="channel_8h.html#a1f9aebf1de3ebbf4283a4dcf73308562a5c451e1cb286465f8467767bc33696a3">NDSP_FORMAT_STEREO_PCM8</a> = NDSP_CHANNELS(2) | NDSP_ENCODING(NDSP_ENCODING_PCM8)
|
|
, <br />
|
|
  <a class="el" href="channel_8h.html#a1f9aebf1de3ebbf4283a4dcf73308562a834e1e072bc81fa728389d8759fc51b3">NDSP_FORMAT_STEREO_PCM16</a> = NDSP_CHANNELS(2) | NDSP_ENCODING(NDSP_ENCODING_PCM16)
|
|
, <br />
|
|
  <a class="el" href="channel_8h.html#a1f9aebf1de3ebbf4283a4dcf73308562afa20b191a6601f6634c5851b685da433">NDSP_FORMAT_PCM8</a> = NDSP_FORMAT_MONO_PCM8
|
|
, <br />
|
|
  <a class="el" href="channel_8h.html#a1f9aebf1de3ebbf4283a4dcf73308562a462360a2e9ccc2ccd634f1751c653477">NDSP_FORMAT_PCM16</a> = NDSP_FORMAT_MONO_PCM16
|
|
, <br />
|
|
  <a class="el" href="channel_8h.html#a1f9aebf1de3ebbf4283a4dcf73308562a4b28453b73b164bd85d5deaa084c357e">NDSP_FORMAT_ADPCM</a> = NDSP_FORMAT_MONO_ADPCM
|
|
, <br />
|
|
  <a class="el" href="channel_8h.html#a1f9aebf1de3ebbf4283a4dcf73308562a21a2e8f1b3fea65d9d636ebae1df2533">NDSP_FRONT_BYPASS</a> = BIT(4)
|
|
, <br />
|
|
  <a class="el" href="channel_8h.html#a1f9aebf1de3ebbf4283a4dcf73308562a7af2e3b4de379053f3edde298c3391ed">NDSP_3D_SURROUND_PREPROCESSED</a> = BIT(6)
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a1f9aebf1de3ebbf4283a4dcf73308562"><td class="mdescLeft"> </td><td class="mdescRight">Channel format flags for use with ndspChnSetFormat. <a href="channel_8h.html#a1f9aebf1de3ebbf4283a4dcf73308562">More...</a><br /></td></tr>
|
|
<tr class="separator:a1f9aebf1de3ebbf4283a4dcf73308562"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6319005cb21b18395a1452e95aabbec3"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="channel_8h.html#a6319005cb21b18395a1452e95aabbec3">ndspInterpType</a> { <br />
|
|
  <a class="el" href="channel_8h.html#a6319005cb21b18395a1452e95aabbec3ac8e204d77e18ef8913e2eab1b18e002b">NDSP_INTERP_POLYPHASE</a> = 0
|
|
, <br />
|
|
  <a class="el" href="channel_8h.html#a6319005cb21b18395a1452e95aabbec3a0d5a9ea8e53a246b1ac65dc294a5fd53">NDSP_INTERP_LINEAR</a> = 1
|
|
, <br />
|
|
  <a class="el" href="channel_8h.html#a6319005cb21b18395a1452e95aabbec3ad9872be8d23d3d2023e205d5f5fb388c">NDSP_INTERP_NONE</a> = 2
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a6319005cb21b18395a1452e95aabbec3"><td class="mdescLeft"> </td><td class="mdescRight">Interpolation types. <a href="channel_8h.html#a6319005cb21b18395a1452e95aabbec3">More...</a><br /></td></tr>
|
|
<tr class="separator:a6319005cb21b18395a1452e95aabbec3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Functions for interacting with DSP audio channels. </p>
|
|
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="a458e651af6690959efa2afb96be7d609"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a458e651af6690959efa2afb96be7d609">◆ </a></span>anonymous enum</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">anonymous enum</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a458e651af6690959efa2afb96be7d609ae4f3bbb73c75334eed7c63bb947e3ec1"></a>NDSP_ENCODING_PCM8 </td><td class="fielddoc"><p>PCM8. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a458e651af6690959efa2afb96be7d609a641b555f1e09eb8ab7e684df4cdd463a"></a>NDSP_ENCODING_PCM16 </td><td class="fielddoc"><p>PCM16. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a458e651af6690959efa2afb96be7d609ac588413fc3520d386b805e6db0c23c96"></a>NDSP_ENCODING_ADPCM </td><td class="fielddoc"><p>DSPADPCM (GameCube format) </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1f9aebf1de3ebbf4283a4dcf73308562"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1f9aebf1de3ebbf4283a4dcf73308562">◆ </a></span>anonymous enum</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">anonymous enum</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Channel format flags for use with ndspChnSetFormat. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a1f9aebf1de3ebbf4283a4dcf73308562a4d9a3eff8fae0658ed120ebadd5c6f42"></a>NDSP_FORMAT_MONO_PCM8 </td><td class="fielddoc"><p>Buffer contains Mono PCM8. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a1f9aebf1de3ebbf4283a4dcf73308562af9368c39428fe9513f993ee4e9444cb6"></a>NDSP_FORMAT_MONO_PCM16 </td><td class="fielddoc"><p>Buffer contains Mono PCM16. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a1f9aebf1de3ebbf4283a4dcf73308562a9e89ff35ab28474c60a4a642b3da2494"></a>NDSP_FORMAT_MONO_ADPCM </td><td class="fielddoc"><p>Buffer contains Mono ADPCM. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a1f9aebf1de3ebbf4283a4dcf73308562a5c451e1cb286465f8467767bc33696a3"></a>NDSP_FORMAT_STEREO_PCM8 </td><td class="fielddoc"><p>Buffer contains Stereo PCM8. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a1f9aebf1de3ebbf4283a4dcf73308562a834e1e072bc81fa728389d8759fc51b3"></a>NDSP_FORMAT_STEREO_PCM16 </td><td class="fielddoc"><p>Buffer contains Stereo PCM16. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a1f9aebf1de3ebbf4283a4dcf73308562afa20b191a6601f6634c5851b685da433"></a>NDSP_FORMAT_PCM8 </td><td class="fielddoc"><p>(Alias) Buffer contains Mono PCM8. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a1f9aebf1de3ebbf4283a4dcf73308562a462360a2e9ccc2ccd634f1751c653477"></a>NDSP_FORMAT_PCM16 </td><td class="fielddoc"><p>(Alias) Buffer contains Mono PCM16. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a1f9aebf1de3ebbf4283a4dcf73308562a4b28453b73b164bd85d5deaa084c357e"></a>NDSP_FORMAT_ADPCM </td><td class="fielddoc"><p>(Alias) Buffer contains Mono ADPCM. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a1f9aebf1de3ebbf4283a4dcf73308562a21a2e8f1b3fea65d9d636ebae1df2533"></a>NDSP_FRONT_BYPASS </td><td class="fielddoc"><p>Front bypass. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a1f9aebf1de3ebbf4283a4dcf73308562a7af2e3b4de379053f3edde298c3391ed"></a>NDSP_3D_SURROUND_PREPROCESSED </td><td class="fielddoc"><p>(?) Unknown, under research </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6319005cb21b18395a1452e95aabbec3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6319005cb21b18395a1452e95aabbec3">◆ </a></span>ndspInterpType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="channel_8h.html#a6319005cb21b18395a1452e95aabbec3">ndspInterpType</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Interpolation types. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a6319005cb21b18395a1452e95aabbec3ac8e204d77e18ef8913e2eab1b18e002b"></a>NDSP_INTERP_POLYPHASE </td><td class="fielddoc"><p>Polyphase interpolation. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a6319005cb21b18395a1452e95aabbec3a0d5a9ea8e53a246b1ac65dc294a5fd53"></a>NDSP_INTERP_LINEAR </td><td class="fielddoc"><p>Linear interpolation. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a6319005cb21b18395a1452e95aabbec3ad9872be8d23d3d2023e205d5f5fb388c"></a>NDSP_INTERP_NONE </td><td class="fielddoc"><p>No interpolation. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a10f1f8593e8df973c62a16367731c590"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a10f1f8593e8df973c62a16367731c590">◆ </a></span>ndspChnGetFormat()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> ndspChnGetFormat </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the format of a channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The format of the channel. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5b51c4320d90814f037c1d58140ff17f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5b51c4320d90814f037c1d58140ff17f">◆ </a></span>ndspChnGetInterp()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="channel_8h.html#a6319005cb21b18395a1452e95aabbec3">ndspInterpType</a> ndspChnGetInterp </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the interpolation type of a channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The interpolation type of the channel. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a42c4aac60efde6f7b5ab273aee906a62"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a42c4aac60efde6f7b5ab273aee906a62">◆ </a></span>ndspChnGetMix()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ndspChnGetMix </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>mix</em>[12] </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the mix parameters (volumes) of a channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23) </td></tr>
|
|
<tr><td class="paramname">mix</td><td>Mix parameters to write out to. See <a class="el" href="channel_8h.html#a30eb26f1972cc3ec28370263796c0444">ndspChnSetMix</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afc939493191883e908783048fa0216b4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afc939493191883e908783048fa0216b4">◆ </a></span>ndspChnGetRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float ndspChnGetRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the sample rate of a channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The sample rate of the channel. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a827bf43cb8dd8ccaa74a29456589a39d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a827bf43cb8dd8ccaa74a29456589a39d">◆ </a></span>ndspChnGetSamplePos()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> ndspChnGetSamplePos </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the current sample position of a channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The channel's sample position. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a17607395e3725f7a35b4395cbd59cb60"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a17607395e3725f7a35b4395cbd59cb60">◆ </a></span>ndspChnGetWaveBufSeq()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> ndspChnGetWaveBufSeq </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the sequence ID of the wave buffer that is currently playing in a channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The sequence ID of the wave buffer. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aafb95ce3188816694c51e30d7a64d8af"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aafb95ce3188816694c51e30d7a64d8af">◆ </a></span>ndspChnIirBiquadSetEnable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ndspChnIirBiquadSetEnable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures whether the IIR biquad filter of a channel is enabled. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">enable</td><td>Whether to enable the IIR biquad filter. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2filters_2source_2main_8c-example.html#a28">audio/filters/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af6c9d1d59c93164aae5a54ee7e8db2a9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af6c9d1d59c93164aae5a54ee7e8db2a9">◆ </a></span>ndspChnIirBiquadSetParamsBandPassFilter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ndspChnIirBiquadSetParamsBandPassFilter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>f0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>Q</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the biquad to be a band pass filter. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">f0</td><td>Mid-frequency. </td></tr>
|
|
<tr><td class="paramname">Q</td><td>"Quality factor", typically should be sqrt(2)/2 (i.e. 0.7071). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2filters_2source_2main_8c-example.html#a31">audio/filters/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7334f9d5dc89a43a5a78877665281fdc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7334f9d5dc89a43a5a78877665281fdc">◆ </a></span>ndspChnIirBiquadSetParamsCustomFilter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ndspChnIirBiquadSetParamsCustomFilter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>a0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>a1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>a2</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>b0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>b1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>b2</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Manually sets up the parameters of the biquad filter. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8f543d0b8a10acbfb380b93b7bd47a75"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8f543d0b8a10acbfb380b93b7bd47a75">◆ </a></span>ndspChnIirBiquadSetParamsHighPassFilter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ndspChnIirBiquadSetParamsHighPassFilter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>f0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>Q</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the biquad to be a high pass filter. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">f0</td><td>High pass cut-off frequency. </td></tr>
|
|
<tr><td class="paramname">Q</td><td>"Quality factor", typically should be sqrt(2)/2 (i.e. 0.7071). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2filters_2source_2main_8c-example.html#a30">audio/filters/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a78516636efb5eacd7b88ee54bd15bfb3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a78516636efb5eacd7b88ee54bd15bfb3">◆ </a></span>ndspChnIirBiquadSetParamsLowPassFilter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ndspChnIirBiquadSetParamsLowPassFilter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>f0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>Q</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the biquad to be a low pass filter. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">f0</td><td>Low pass cut-off frequency. </td></tr>
|
|
<tr><td class="paramname">Q</td><td>"Quality factor", typically should be sqrt(2)/2 (i.e. 0.7071). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2filters_2source_2main_8c-example.html#a29">audio/filters/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a671f5c90eb859c13eab4adf29f7943b3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a671f5c90eb859c13eab4adf29f7943b3">◆ </a></span>ndspChnIirBiquadSetParamsNotchFilter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ndspChnIirBiquadSetParamsNotchFilter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>f0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>Q</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the biquad to be a notch filter. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">f0</td><td>Notch frequency. </td></tr>
|
|
<tr><td class="paramname">Q</td><td>"Quality factor", typically should be sqrt(2)/2 (i.e. 0.7071). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2filters_2source_2main_8c-example.html#a32">audio/filters/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9ebeb91e95d5146358d0923a9d6fee0a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9ebeb91e95d5146358d0923a9d6fee0a">◆ </a></span>ndspChnIirBiquadSetParamsPeakingEqualizer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ndspChnIirBiquadSetParamsPeakingEqualizer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>f0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>Q</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>gain</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the biquad to be a peaking equalizer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">f0</td><td>Central frequency. </td></tr>
|
|
<tr><td class="paramname">Q</td><td>"Quality factor", typically should be sqrt(2)/2 (i.e. 0.7071). </td></tr>
|
|
<tr><td class="paramname">gain</td><td>Amount of gain (raw value = 10 ^ dB/40) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2filters_2source_2main_8c-example.html#a33">audio/filters/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1da3b363c2edfd318c92276b527daae6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1da3b363c2edfd318c92276b527daae6">◆ </a></span>ndspChnIirMonoSetEnable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ndspChnIirMonoSetEnable </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>enable</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Configures whether the IIR monopole filter of a channel is enabled. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">enable</td><td>Whether to enable the IIR monopole filter. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4b7db8c300510523f0d13b4a88416c4d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4b7db8c300510523f0d13b4a88416c4d">◆ </a></span>ndspChnIirMonoSetParamsCustomFilter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ndspChnIirMonoSetParamsCustomFilter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>a0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>a1</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>b0</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Manually sets up the parameters on monopole filter. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">enable</td><td>Whether to enable the IIR monopole filter. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7e45d6a7193825ea7cd9bf9c6b8a6548"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7e45d6a7193825ea7cd9bf9c6b8a6548">◆ </a></span>ndspChnIirMonoSetParamsHighPassFilter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ndspChnIirMonoSetParamsHighPassFilter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>f0</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the monopole to be a high pass filter. </p>
|
|
<p>(Note: This is a lower-quality filter than the biquad one.) </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">f0</td><td>High pass cut-off frequency. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abebeff0925fc86405750720efc11a7d0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abebeff0925fc86405750720efc11a7d0">◆ </a></span>ndspChnIirMonoSetParamsLowPassFilter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ndspChnIirMonoSetParamsLowPassFilter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>f0</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the monopole to be a low pass filter. </p>
|
|
<p>(Note: This is a lower-quality filter than the biquad one.) </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">f0</td><td>Low pass cut-off frequency. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0936956c6d5700cdbab4ea3e3304f19d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0936956c6d5700cdbab4ea3e3304f19d">◆ </a></span>ndspChnInitParams()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ndspChnInitParams </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initializes the parameters of a channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8a14aa007d2ca0d6e87a90edf64e03b5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8a14aa007d2ca0d6e87a90edf64e03b5">◆ </a></span>ndspChnIsPaused()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ndspChnIsPaused </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks whether a channel is currently paused. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Whether the channel is currently paused. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0eee6c9ebf357c8d55d087a378178f9b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0eee6c9ebf357c8d55d087a378178f9b">◆ </a></span>ndspChnIsPlaying()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ndspChnIsPlaying </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Checks whether a channel is currently playing. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Whether the channel is currently playing. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7b755904976d3b04b3303475d9605bd8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7b755904976d3b04b3303475d9605bd8">◆ </a></span>ndspChnReset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ndspChnReset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Resets a channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adbd48651f22341bb93cb9b7f1304a00f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adbd48651f22341bb93cb9b7f1304a00f">◆ </a></span>ndspChnSetAdpcmCoefs()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ndspChnSetAdpcmCoefs </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> </td>
|
|
<td class="paramname"><em>coefs</em>[16] </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the DSPADPCM coefficients of a channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">coefs</td><td>DSPADPCM coefficients to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7986171c79c227443ef5ea60c464de23"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7986171c79c227443ef5ea60c464de23">◆ </a></span>ndspChnSetFormat()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ndspChnSetFormat </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> </td>
|
|
<td class="paramname"><em>format</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the format of a channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">format</td><td>Format to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2filters_2source_2main_8c-example.html#a13">audio/filters/source/main.c</a>, and <a class="el" href="audio_2streaming_2source_2main_8c-example.html#a13">audio/streaming/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac98e0b63e35e22aeea5265fd93f5206f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac98e0b63e35e22aeea5265fd93f5206f">◆ </a></span>ndspChnSetInterp()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ndspChnSetInterp </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="channel_8h.html#a6319005cb21b18395a1452e95aabbec3">ndspInterpType</a> </td>
|
|
<td class="paramname"><em>type</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the interpolation type of a channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">type</td><td>Interpolation type to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2filters_2source_2main_8c-example.html#a10">audio/filters/source/main.c</a>, and <a class="el" href="audio_2streaming_2source_2main_8c-example.html#a10">audio/streaming/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a30eb26f1972cc3ec28370263796c0444"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a30eb26f1972cc3ec28370263796c0444">◆ </a></span>ndspChnSetMix()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ndspChnSetMix </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>mix</em>[12] </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the mix parameters (volumes) of a channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">mix</td><td>Mix parameters to use. Working hypothesis:<ul>
|
|
<li>0: Front left volume.</li>
|
|
<li>1: Front right volume.</li>
|
|
<li>2: Back left volume:</li>
|
|
<li>3: Back right volume:</li>
|
|
<li>4..7: Same as 0..3, but for auxiliary output 0.</li>
|
|
<li>8..11: Same as 0..3, but for auxiliary output 1. </li>
|
|
</ul>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2filters_2source_2main_8c-example.html#a15">audio/filters/source/main.c</a>, and <a class="el" href="audio_2streaming_2source_2main_8c-example.html#a15">audio/streaming/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acdd5e211d825656d78503e111e98de6e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acdd5e211d825656d78503e111e98de6e">◆ </a></span>ndspChnSetPaused()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ndspChnSetPaused </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>paused</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the pause status of a channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">paused</td><td>Whether the channel is to be paused (true) or unpaused (false). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6f1076a8981a5b6722b912ca969162ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6f1076a8981a5b6722b912ca969162ea">◆ </a></span>ndspChnSetRate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ndspChnSetRate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>rate</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the sample rate of a channel. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">rate</td><td>Sample rate to use. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2filters_2source_2main_8c-example.html#a12">audio/filters/source/main.c</a>, and <a class="el" href="audio_2streaming_2source_2main_8c-example.html#a12">audio/streaming/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a354a90dd921879724d62d325c0128d6b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a354a90dd921879724d62d325c0128d6b">◆ </a></span>ndspChnWaveBufAdd()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ndspChnWaveBufAdd </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">ndspWaveBuf * </td>
|
|
<td class="paramname"><em>buf</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adds a wave buffer to the wave buffer queue of a channel. </p>
|
|
<dl class="section remark"><dt>Remarks</dt><dd>If the channel's wave buffer queue was empty before the use of this function, playback is started. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
<tr><td class="paramname">buf</td><td>Wave buffer to add. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="audio_2filters_2source_2main_8c-example.html#a16">audio/filters/source/main.c</a>, and <a class="el" href="audio_2streaming_2source_2main_8c-example.html#a16">audio/streaming/source/main.c</a>.</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a054a58a102d00590a33101fe0de516e6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a054a58a102d00590a33101fe0de516e6">◆ </a></span>ndspChnWaveBufClear()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ndspChnWaveBufClear </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears the wave buffer queue of a channel and stops playback. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>ID of the channel (0..23). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</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>
|