File: classAudioMask.html

package info (click to toggle)
libaudiomask 1.0-3
  • links: PTS
  • area: main
  • in suites: bullseye, buster, stretch
  • size: 17,668 kB
  • ctags: 636
  • sloc: cpp: 787; perl: 108; makefile: 67
file content (198 lines) | stat: -rw-r--r-- 11,130 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>libaudiomask: AudioMask Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <img id="MSearchSelect" src="search/search.png"
             onmouseover="return searchBox.OnSearchSelectShow()"
             onmouseout="return searchBox.OnSearchSelectHide()"
             alt=""/>
        <input type="text" id="MSearchField" value="Search" accesskey="S"
             onfocus="searchBox.OnSearchFieldFocus(true)" 
             onblur="searchBox.OnSearchFieldFocus(false)" 
             onkeyup="searchBox.OnSearchFieldChange(event)"/>
        <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
        </div>
      </li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>AudioMask Class Reference</h1><!-- doxytag: class="AudioMask" --><!-- doxytag: inherits="MooreSpread" -->
<p><code>#include &lt;<a class="el" href="AudioMask_8H_source.html">AudioMask.H</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for AudioMask:</div>
<div class="dynsection">
 <div class="center">
  <img src="classAudioMask.png" usemap="#AudioMask_map" alt=""/>
  <map id="AudioMask_map" name="AudioMask_map">
<area href="classMooreSpread.html" alt="MooreSpread" shape="rect" coords="0,0,90,24"/>
<area href="classAudioMasker.html" alt="AudioMasker" shape="rect" coords="0,112,90,136"/>
</map>
 </div>
</div>

<p><a href="classAudioMask-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMask.html#a58b689bab7c482f297439d95934d5307">AudioMask</a> (int sampFreq, int fBankCount)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82b875110695cb340ac863a3ba4d9c6a"></a><!-- doxytag: member="AudioMask::~AudioMask" ref="a82b875110695cb340ac863a3ba4d9c6a" args="(void)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMask.html#a82b875110695cb340ac863a3ba4d9c6a">~AudioMask</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Deconstructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMask.html#a3f35d4db7eb1618dea7235cf006b4831">setCFreq</a> (int which, double value)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMask.html#a0ef08d94e576137f85cb4e321a691d1e">exciteTerhardt</a> (double **filterBankOutput, int sampleCount)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a36ea69445e37f9896555017af6b9d737"></a><!-- doxytag: member="AudioMask::exciteBeerends" ref="a36ea69445e37f9896555017af6b9d737" args="(double **filterBankOutput, int sampleCount)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>exciteBeerends</b> (double **filterBankOutput, int sampleCount)</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8c88f5ec9efdeed95affa6c23d25417"></a><!-- doxytag: member="AudioMask::mask" ref="ad8c88f5ec9efdeed95affa6c23d25417" args="" -->
double *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMask.html#ad8c88f5ec9efdeed95affa6c23d25417">mask</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The audio mask. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94491634f0bfd9df471bd7ee545d30f9"></a><!-- doxytag: member="AudioMask::max" ref="a94491634f0bfd9df471bd7ee545d30f9" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMask.html#a94491634f0bfd9df471bd7ee545d30f9">max</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The maximum value of the mask. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac73249d7d6a8997311fcdc54baaed191"></a><!-- doxytag: member="AudioMask::fs" ref="ac73249d7d6a8997311fcdc54baaed191" args="" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMask.html#ac73249d7d6a8997311fcdc54baaed191">fs</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sample frequency. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Evaluates the Dr M.R. Flax (2000) hybrid simultaneous audio mask Handles the evaluation of the simultaneous audio mask given a filter bank sub-banded output and sample count </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a58b689bab7c482f297439d95934d5307"></a><!-- doxytag: member="AudioMask::AudioMask" ref="a58b689bab7c482f297439d95934d5307" args="(int sampFreq, int fBankCount)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">AudioMask::AudioMask </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>sampFreq</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>fBankCount</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructs the memory and factors for calculating the audio mask @ sampFreq The sample frequency @ fBankCount The number of filter sub-bands </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0ef08d94e576137f85cb4e321a691d1e"></a><!-- doxytag: member="AudioMask::exciteTerhardt" ref="a0ef08d94e576137f85cb4e321a691d1e" args="(double **filterBankOutput, int sampleCount)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void AudioMask::exciteTerhardt </td>
          <td>(</td>
          <td class="paramtype">double **&nbsp;</td>
          <td class="paramname"> <em>filterBankOutput</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>sampleCount</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Method for finding the Preceptual Audio Mask using the Terhardt model @ filterBankOutput The output of the filter bank @ sampleCount The number of samples </p>

</div>
</div>
<a class="anchor" id="a3f35d4db7eb1618dea7235cf006b4831"></a><!-- doxytag: member="AudioMask::setCFreq" ref="a3f35d4db7eb1618dea7235cf006b4831" args="(int which, double value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void AudioMask::setCFreq </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>which</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>value</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Method for setting the centre freqs @ which The sub-band @ value The correcponding central frequency </p>

<p>Reimplemented from <a class="el" href="classMooreSpread.html#a4ef2cfe6a5fa5a85fb33ed0bd425d510">MooreSpread</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="AudioMask_8H_source.html">AudioMask.H</a></li>
<li>AudioMask.cc</li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&nbsp;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&nbsp;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&nbsp;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&nbsp;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&nbsp;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<hr class="footer"/><address style="text-align: right;"><small>Generated on Sat Jun 19 15:23:29 2010 for libaudiomask by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>