This file is indexed.

/usr/share/qt5/doc/qtmultimedia/qtmultimedia-spectrum-app-spectrum-h.html is in qtmultimedia5-doc-html 5.2.1-0ubuntu5.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
<?xml version="1.0" encoding="UTF-8"?>
<!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" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <title>spectrum.h Example File (spectrum/app/spectrum.h) | QtMultimedia 5.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
    <div class="main">
    <div class="main-rounded">
        <div class="navigationbar">
        <ul>
<li>Qt 5.2</li>
<li><a href="qtmultimedia-index.html">Qt Multimedia</a></li>
<li>spectrum.h Example File (spectrum/app/spectrum.h)</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
    </ul>
    </div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<h1 class="title">spectrum.h Example File</h1>
<span class="small-subtitle">spectrum/app/spectrum.h</span>
<!-- $$$spectrum/app/spectrum.h-description -->
<div class="descr"> <a name="details"></a>
<pre class="cpp"><span class="comment">/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the examples of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** &quot;Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
**   * Redistributions of source code must retain the above copyright
**     notice, this list of conditions and the following disclaimer.
**   * Redistributions in binary form must reproduce the above copyright
**     notice, this list of conditions and the following disclaimer in
**     the documentation and/or other materials provided with the
**     distribution.
**   * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
**     of its contributors may be used to endorse or promote products derived
**     from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.&quot;
**
** $QT_END_LICENSE$
**
****************************************************************************/</span>

<span class="preprocessor">#ifndef SPECTRUM_H</span>
<span class="preprocessor">#define SPECTRUM_H</span>

<span class="preprocessor">#include &lt;qglobal.h&gt;</span>
<span class="preprocessor">#include &quot;utils.h&quot;</span>
<span class="preprocessor">#include &quot;fftreal_wrapper.h&quot; // For FFTLengthPowerOfTwo</span>

<span class="comment">//-----------------------------------------------------------------------------</span>
<span class="comment">// Constants</span>
<span class="comment">//-----------------------------------------------------------------------------</span>

<span class="comment">// Number of audio samples used to calculate the frequency spectrum</span>
<span class="keyword">const</span> <span class="type">int</span>    SpectrumLengthSamples  <span class="operator">=</span> PowerOfTwo<span class="operator">&lt;</span>FFTLengthPowerOfTwo<span class="operator">&gt;</span><span class="operator">::</span>Result;

<span class="comment">// Number of bands in the frequency spectrum</span>
<span class="keyword">const</span> <span class="type">int</span>    SpectrumNumBands       <span class="operator">=</span> <span class="number">10</span>;

<span class="comment">// Lower bound of first band in the spectrum</span>
<span class="keyword">const</span> <span class="type">qreal</span>  SpectrumLowFreq        <span class="operator">=</span> <span class="number">0.0</span>; <span class="comment">// Hz</span>

<span class="comment">// Upper band of last band in the spectrum</span>
<span class="keyword">const</span> <span class="type">qreal</span>  SpectrumHighFreq       <span class="operator">=</span> <span class="number">1000.0</span>; <span class="comment">// Hz</span>

<span class="comment">// Waveform window size in microseconds</span>
<span class="keyword">const</span> <span class="type">qint64</span> WaveformWindowDuration <span class="operator">=</span> <span class="number">500</span> <span class="operator">*</span> <span class="number">1000</span>;

<span class="comment">// Length of waveform tiles in bytes</span>
<span class="comment">// Ideally, these would match the QAudio*::bufferSize(), but that isn't</span>
<span class="comment">// available until some time after QAudio*::start() has been called, and we</span>
<span class="comment">// need this value in order to initialize the waveform display.</span>
<span class="comment">// We therefore just choose a sensible value.</span>
<span class="keyword">const</span> <span class="type">int</span>   WaveformTileLength      <span class="operator">=</span> <span class="number">4096</span>;

<span class="comment">// Fudge factor used to calculate the spectrum bar heights</span>
<span class="keyword">const</span> <span class="type">qreal</span> SpectrumAnalyserMultiplier <span class="operator">=</span> <span class="number">0.15</span>;

<span class="comment">// Disable message timeout</span>
<span class="keyword">const</span> <span class="type">int</span>   NullMessageTimeout      <span class="operator">=</span> <span class="operator">-</span><span class="number">1</span>;

<span class="comment">//-----------------------------------------------------------------------------</span>
<span class="comment">// Types and data structures</span>
<span class="comment">//-----------------------------------------------------------------------------</span>

<span class="keyword">enum</span> WindowFunction {
    NoWindow<span class="operator">,</span>
    HannWindow
};

<span class="keyword">const</span> WindowFunction DefaultWindowFunction <span class="operator">=</span> HannWindow;

<span class="keyword">struct</span> Tone
{
    Tone(<span class="type">qreal</span> freq <span class="operator">=</span> <span class="number">0.0</span><span class="operator">,</span> <span class="type">qreal</span> amp <span class="operator">=</span> <span class="number">0.0</span>)
    :   frequency(freq)<span class="operator">,</span> amplitude(amp)
    { }

    <span class="comment">// Start and end frequencies for swept tone generation</span>
    <span class="type">qreal</span>   frequency;

    <span class="comment">// Amplitude in range [0.0, 1.0]</span>
    <span class="type">qreal</span>   amplitude;
};

<span class="keyword">struct</span> SweptTone
{
    SweptTone(<span class="type">qreal</span> start <span class="operator">=</span> <span class="number">0.0</span><span class="operator">,</span> <span class="type">qreal</span> end <span class="operator">=</span> <span class="number">0.0</span><span class="operator">,</span> <span class="type">qreal</span> amp <span class="operator">=</span> <span class="number">0.0</span>)
    :   startFreq(start)<span class="operator">,</span> endFreq(end)<span class="operator">,</span> amplitude(amp)
    { Q_ASSERT(end <span class="operator">&gt;</span><span class="operator">=</span> start); }

    SweptTone(<span class="keyword">const</span> Tone <span class="operator">&amp;</span>tone)
    :   startFreq(tone<span class="operator">.</span>frequency)<span class="operator">,</span> endFreq(tone<span class="operator">.</span>frequency)<span class="operator">,</span> amplitude(tone<span class="operator">.</span>amplitude)
    { }

    <span class="comment">// Start and end frequencies for swept tone generation</span>
    <span class="type">qreal</span>   startFreq;
    <span class="type">qreal</span>   endFreq;

    <span class="comment">// Amplitude in range [0.0, 1.0]</span>
    <span class="type">qreal</span>   amplitude;
};

<span class="comment">//-----------------------------------------------------------------------------</span>
<span class="comment">// Macros</span>
<span class="comment">//-----------------------------------------------------------------------------</span>

<span class="comment">// Macro which connects a signal to a slot, and which causes application to</span>
<span class="comment">// abort if the connection fails.  This is intended to catch programming errors</span>
<span class="comment">// such as mis-typing a signal or slot name.  It is necessary to write our own</span>
<span class="comment">// macro to do this - the following idiom</span>
<span class="comment">//     Q_ASSERT(connect(source, signal, receiver, slot));</span>
<span class="comment">// will not work because Q_ASSERT compiles to a no-op in release builds.</span>

<span class="preprocessor">#define CHECKED_CONNECT(source, signal, receiver, slot) \
    if (!connect(source, signal, receiver, slot)) \
        qt_assert_x(Q_FUNC_INFO, &quot;CHECKED_CONNECT failed&quot;, __FILE__, __LINE__);</span>

<span class="comment">// Handle some dependencies between macros defined in the .pro file</span>

<span class="preprocessor">#ifdef DISABLE_WAVEFORM</span>
<span class="preprocessor">#undef SUPERIMPOSE_PROGRESS_ON_WAVEFORM</span>
<span class="preprocessor">#endif</span>

<span class="preprocessor">#endif // SPECTRUM_H</span></pre>
</div>
<!-- @@@spectrum/app/spectrum.h -->
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2013 Digia Plc and/or its
   subsidiaries. Documentation contributions included herein are the copyrights of
   their respective owners.<br>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br>    Digia, Qt and their respective logos are trademarks of Digia Plc     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>