/usr/share/doc/speex-doc/html/structSpeexHeader.html is in speex-doc 1.2~rc1.1-1ubuntu1.
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 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 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 | <!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Speex: SpeexHeader Struct 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="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 style="padding-left: 0.5em;">
<div id="projectname">Speex
 <span id="projectnumber">1.2~beta4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> |
<a href="structSpeexHeader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SpeexHeader Struct Reference<div class="ingroups"><a class="el" href="group__SpeexHeader.html">SpeexHeader: Makes it easy to write/parse an Ogg/Speex header</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="speex__header_8h_source.html">speex_header.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ae02198bf166bb0835c2bbcf71afedeb1"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpeexHeader.html#ae02198bf166bb0835c2bbcf71afedeb1">speex_string</a> [<a class="el" href="group__SpeexHeader.html#gad8c43b1b12ddd4ee9463ee01a1608844">SPEEX_HEADER_STRING_LENGTH</a>]</td></tr>
<tr class="separator:ae02198bf166bb0835c2bbcf71afedeb1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a585a15435dc55b8c785f9c52e913efc5"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpeexHeader.html#a585a15435dc55b8c785f9c52e913efc5">speex_version</a> [<a class="el" href="group__SpeexHeader.html#ga7489d3196d916c12260a12ceb8717bd6">SPEEX_HEADER_VERSION_LENGTH</a>]</td></tr>
<tr class="separator:a585a15435dc55b8c785f9c52e913efc5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae28aca2dc58f399a3caaca5b26aacf85"><td class="memItemLeft" align="right" valign="top">spx_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpeexHeader.html#ae28aca2dc58f399a3caaca5b26aacf85">speex_version_id</a></td></tr>
<tr class="separator:ae28aca2dc58f399a3caaca5b26aacf85"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a591c946fb1beb45c61410089c2d6411f"><td class="memItemLeft" align="right" valign="top">spx_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpeexHeader.html#a591c946fb1beb45c61410089c2d6411f">header_size</a></td></tr>
<tr class="separator:a591c946fb1beb45c61410089c2d6411f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6157e9a625429578f62accb14dd39d3b"><td class="memItemLeft" align="right" valign="top">spx_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpeexHeader.html#a6157e9a625429578f62accb14dd39d3b">rate</a></td></tr>
<tr class="separator:a6157e9a625429578f62accb14dd39d3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd79add941519fc82017c447b49b8136"><td class="memItemLeft" align="right" valign="top">spx_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpeexHeader.html#acd79add941519fc82017c447b49b8136">mode</a></td></tr>
<tr class="separator:acd79add941519fc82017c447b49b8136"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a147a808b7c3039fc480c084c110e8bed"><td class="memItemLeft" align="right" valign="top">spx_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpeexHeader.html#a147a808b7c3039fc480c084c110e8bed">mode_bitstream_version</a></td></tr>
<tr class="separator:a147a808b7c3039fc480c084c110e8bed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1dae4c23ac3d70e6f1100fb1e3e6f4f"><td class="memItemLeft" align="right" valign="top">spx_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpeexHeader.html#ad1dae4c23ac3d70e6f1100fb1e3e6f4f">nb_channels</a></td></tr>
<tr class="separator:ad1dae4c23ac3d70e6f1100fb1e3e6f4f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af208fea6aeba679db3adf882e5be1063"><td class="memItemLeft" align="right" valign="top">spx_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpeexHeader.html#af208fea6aeba679db3adf882e5be1063">bitrate</a></td></tr>
<tr class="separator:af208fea6aeba679db3adf882e5be1063"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77c2fc92b3ad421d453516ffa82a552f"><td class="memItemLeft" align="right" valign="top">spx_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpeexHeader.html#a77c2fc92b3ad421d453516ffa82a552f">frame_size</a></td></tr>
<tr class="separator:a77c2fc92b3ad421d453516ffa82a552f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a29870c83179a12f12c0408af4ad481c5"><td class="memItemLeft" align="right" valign="top">spx_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpeexHeader.html#a29870c83179a12f12c0408af4ad481c5">vbr</a></td></tr>
<tr class="separator:a29870c83179a12f12c0408af4ad481c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0bd79784e6c954c0d1eced25b047ea7"><td class="memItemLeft" align="right" valign="top">spx_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpeexHeader.html#af0bd79784e6c954c0d1eced25b047ea7">frames_per_packet</a></td></tr>
<tr class="separator:af0bd79784e6c954c0d1eced25b047ea7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0884b5d0be761c2ddd27e51e91615856"><td class="memItemLeft" align="right" valign="top">spx_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpeexHeader.html#a0884b5d0be761c2ddd27e51e91615856">extra_headers</a></td></tr>
<tr class="separator:a0884b5d0be761c2ddd27e51e91615856"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4ac8287a9ea7c4bb084b720e4e36228"><td class="memItemLeft" align="right" valign="top">spx_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpeexHeader.html#ae4ac8287a9ea7c4bb084b720e4e36228">reserved1</a></td></tr>
<tr class="separator:ae4ac8287a9ea7c4bb084b720e4e36228"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aecf3ab6d15af2fb2d3cb9b14e8e0478e"><td class="memItemLeft" align="right" valign="top">spx_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structSpeexHeader.html#aecf3ab6d15af2fb2d3cb9b14e8e0478e">reserved2</a></td></tr>
<tr class="separator:aecf3ab6d15af2fb2d3cb9b14e8e0478e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Speex header info for file-based formats </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="af208fea6aeba679db3adf882e5be1063"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">spx_int32_t SpeexHeader::bitrate</td>
</tr>
</table>
</div><div class="memdoc">
<p>Bit-rate used </p>
</div>
</div>
<a class="anchor" id="a0884b5d0be761c2ddd27e51e91615856"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">spx_int32_t SpeexHeader::extra_headers</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of additional headers after the comments </p>
</div>
</div>
<a class="anchor" id="a77c2fc92b3ad421d453516ffa82a552f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">spx_int32_t SpeexHeader::frame_size</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of frames </p>
</div>
</div>
<a class="anchor" id="af0bd79784e6c954c0d1eced25b047ea7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">spx_int32_t SpeexHeader::frames_per_packet</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of frames stored per Ogg packet </p>
</div>
</div>
<a class="anchor" id="a591c946fb1beb45c61410089c2d6411f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">spx_int32_t SpeexHeader::header_size</td>
</tr>
</table>
</div><div class="memdoc">
<p>Total size of the header ( sizeof(SpeexHeader) ) </p>
</div>
</div>
<a class="anchor" id="acd79add941519fc82017c447b49b8136"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">spx_int32_t SpeexHeader::mode</td>
</tr>
</table>
</div><div class="memdoc">
<p>Mode used (0 for narrowband, 1 for wideband) </p>
</div>
</div>
<a class="anchor" id="a147a808b7c3039fc480c084c110e8bed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">spx_int32_t SpeexHeader::mode_bitstream_version</td>
</tr>
</table>
</div><div class="memdoc">
<p>Version ID of the bit-stream </p>
</div>
</div>
<a class="anchor" id="ad1dae4c23ac3d70e6f1100fb1e3e6f4f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">spx_int32_t SpeexHeader::nb_channels</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of channels encoded </p>
</div>
</div>
<a class="anchor" id="a6157e9a625429578f62accb14dd39d3b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">spx_int32_t SpeexHeader::rate</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sampling rate used </p>
</div>
</div>
<a class="anchor" id="ae4ac8287a9ea7c4bb084b720e4e36228"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">spx_int32_t SpeexHeader::reserved1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reserved for future use, must be zero </p>
</div>
</div>
<a class="anchor" id="aecf3ab6d15af2fb2d3cb9b14e8e0478e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">spx_int32_t SpeexHeader::reserved2</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reserved for future use, must be zero </p>
</div>
</div>
<a class="anchor" id="ae02198bf166bb0835c2bbcf71afedeb1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char SpeexHeader::speex_string[<a class="el" href="group__SpeexHeader.html#gad8c43b1b12ddd4ee9463ee01a1608844">SPEEX_HEADER_STRING_LENGTH</a>]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Identifies a Speex bit-stream, always set to "Speex " </p>
</div>
</div>
<a class="anchor" id="a585a15435dc55b8c785f9c52e913efc5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char SpeexHeader::speex_version[<a class="el" href="group__SpeexHeader.html#ga7489d3196d916c12260a12ceb8717bd6">SPEEX_HEADER_VERSION_LENGTH</a>]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Speex version </p>
</div>
</div>
<a class="anchor" id="ae28aca2dc58f399a3caaca5b26aacf85"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">spx_int32_t SpeexHeader::speex_version_id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Version for Speex (for checking compatibility) </p>
</div>
</div>
<a class="anchor" id="a29870c83179a12f12c0408af4ad481c5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">spx_int32_t SpeexHeader::vbr</td>
</tr>
</table>
</div><div class="memdoc">
<p>1 for a VBR encoding, 0 otherwise </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="speex__header_8h_source.html">speex_header.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jan 26 2014 12:24:47 for Speex by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|