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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
<!-- 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: AudioMasker 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 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 List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>AudioMasker Class Reference</h1><!-- doxytag: class="AudioMasker" --><!-- doxytag: inherits="AudioMask" -->
<p><code>#include <<a class="el" href="AudioMasker_8H_source.html">AudioMasker.H</a>></code></p>
<div class="dynheader">
Inheritance diagram for AudioMasker:</div>
<div class="dynsection">
<div class="center">
<img src="classAudioMasker.png" usemap="#AudioMasker_map" alt=""/>
<map id="AudioMasker_map" name="AudioMasker_map">
<area href="classAudioMask.html" alt="AudioMask" shape="rect" coords="0,56,90,80"/>
<area href="classMooreSpread.html" alt="MooreSpread" shape="rect" coords="0,0,90,24"/>
</map>
</div>
</div>
<p><a href="classAudioMasker-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMasker.html#a54e311385cd015faa21b7a73f1051696">AudioMasker</a> (int sampFreq, int fBankCount)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22714686a028b1f584a210ffeed4a0d8"></a><!-- doxytag: member="AudioMasker::AudioMasker" ref="a22714686a028b1f584a210ffeed4a0d8" args="(void)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMasker.html#a22714686a028b1f584a210ffeed4a0d8">AudioMasker</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Audio masker constructor - allowing specification of fs and sub-band count later. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adfe819949c5be7b05a6a70ecfd425178"></a><!-- doxytag: member="AudioMasker::~AudioMasker" ref="adfe819949c5be7b05a6a70ecfd425178" args="(void)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMasker.html#adfe819949c5be7b05a6a70ecfd425178">~AudioMasker</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Audio masker deconstructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMasker.html#ae7182941513eab5853dc65ebe03e0529">excite</a> (short int *Input, int sCount)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMasker.html#a98b3d9bdaccc0875f096f6924ddff37c">excite</a> (double *Input, int sCount)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMasker.html#a13dd56b43780b2e45199c449866f5616">findThreshold</a> (double freq)</td></tr>
<tr><td colspan="2"><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5fcc150b323bb9e75a99b4f81fc4d689"></a><!-- doxytag: member="AudioMasker::pfb" ref="a5fcc150b323bb9e75a99b4f81fc4d689" args="" -->
<a class="el" href="classDepUKFB.html">DepUKFB</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioMasker.html#a5fcc150b323bb9e75a99b4f81fc4d689">pfb</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">roex filters <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Audio masking class - top level Class to transform input audio in the time domain to a simultaneous audio mask in the frequency domain.</p>
<p>========================= HOWTO ===============================</p>
<p>// First find the masking threshold</p>
<p><a class="el" href="classAudioMasker.html">AudioMasker</a> masker(sampleFreq, count); // Create the audio masker class using fs=sampleFreq and count filters</p>
<p>masker.excite(input, sampleCount); // find the mask for the array of input data which has sampleCount time samples.</p>
<p>// Now do something with the masking threshold ...</p>
<p>// The frequency domain mask is now located here</p>
<p>for (int j=0; j<count;j++)</p>
<p>masker.mask[j]; // This is the mask at each of the count frequencies of interest</p>
<p>// A more sophisticated example - find the threshold for each Fourier bin</p>
<p>double fact=(double)sampleFreq/((double)sampleCount-1.0); // convert from an index to the equivalent Fourier bin frequency</p>
<p>for (int j=0; j<halfSampleCount;j++){</p>
<p>cout<<"finding for freq "<<j*fact<<''; // The frequency we are inspecting</p>
<p>double threshold=masker.findThreshold(j*fact); // The masking threshold</p>
<p>20*log10(threshold); // The threshold in decibels (dB)</p>
<p>} </p>
<dl><dt><b>Examples: </b></dt><dd>
<p><a class="el" href="AudioMaskerExample_8cc-example.html#_a0">AudioMaskerExample.cc</a>.</p>
</dd>
</dl><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a54e311385cd015faa21b7a73f1051696"></a><!-- doxytag: member="AudioMasker::AudioMasker" ref="a54e311385cd015faa21b7a73f1051696" args="(int sampFreq, int fBankCount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AudioMasker::AudioMasker </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sampFreq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>fBankCount</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The Audio masking constructor @ sampFreq The sample frequency of the time domain data @ fBankCount The number of filter banks </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a98b3d9bdaccc0875f096f6924ddff37c"></a><!-- doxytag: member="AudioMasker::excite" ref="a98b3d9bdaccc0875f096f6924ddff37c" args="(double *Input, int sCount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AudioMasker::excite </td>
<td>(</td>
<td class="paramtype">double * </td>
<td class="paramname"> <em>Input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sCount</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finds the excitation for input data @ Input Using double input data @ sCount samples </p>
</div>
</div>
<a class="anchor" id="ae7182941513eab5853dc65ebe03e0529"></a><!-- doxytag: member="AudioMasker::excite" ref="ae7182941513eab5853dc65ebe03e0529" args="(short int *Input, int sCount)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AudioMasker::excite </td>
<td>(</td>
<td class="paramtype">short int * </td>
<td class="paramname"> <em>Input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sCount</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finds the excitation for input data @ Input Using short int input data @ sCount samples</p>
<p>These should be implemented differently for different Input types </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="AudioMaskerExample_8cc-example.html#a1">AudioMaskerExample.cc</a>.</dd>
</dl>
</div>
</div>
<a class="anchor" id="a13dd56b43780b2e45199c449866f5616"></a><!-- doxytag: member="AudioMasker::findThreshold" ref="a13dd56b43780b2e45199c449866f5616" args="(double freq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double AudioMasker::findThreshold </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>freq</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the simultaneous masking threshold at a particular frequency @ freq The frequency of interest </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="AudioMaskerExample_8cc-example.html#a5">AudioMaskerExample.cc</a>.</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="AudioMasker_8H_source.html">AudioMasker.H</a></li>
<li>AudioMasker.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </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:30 2010 for libaudiomask by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|
