This file is indexed.

/usr/share/doc/libucommon-dev/a00023.html is in libucommon-doc 3.2.0-0ubuntu1.

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
<!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>UCommon: ucc::audio Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00023.html">audio</a>
  </div>
</div>
<div class="contents">
<h1>ucc::audio Class Reference</h1><!-- doxytag: class="ucc::audio" -->
<p>Common audio class for GNU telephonic audio.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00187_source.html">audio.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ucc::audio:</div>
<div class="dynsection">
<div class="center"><img src="a00348.png" border="0" usemap="#ucc_1_1audio_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1audio_inherit__map" id="ucc_1_1audio_inherit__map">
<area shape="rect" id="node3" href="a00025.html" title="Generic audio buffering and transcoding for audio sources and sinks." alt="" coords="60,83,183,112"/><area shape="rect" id="node9" href="a00026.html" title="Convert audio media." alt="" coords="207,83,332,112"/><area shape="rect" id="node5" href="a00027.html" title="Basic audio file access class." alt="" coords="5,160,109,189"/><area shape="rect" id="node7" href="a00173.html" title="Tone generator class for producing convertable tones." alt="" coords="133,160,237,189"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00024.html">framer</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Common access to audio frames.  <a href="a00024.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeee0130d3c1caaf644b649b777659b9a"></a><!-- doxytag: member="ucc::audio::encoded_t" ref="aeee0130d3c1caaf644b649b777659b9a" args="" -->
typedef uint8_t *&nbsp;</td><td class="memItemRight" valign="bottom"><b>encoded_t</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c7749b66f6e38d4241067aec135d625"></a><!-- doxytag: member="ucc::audio::framer_t" ref="a5c7749b66f6e38d4241067aec135d625" args="" -->
typedef <a class="el" href="a00024.html">audio::framer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>framer_t</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a704f697eaa7afc45ca4526c541ede86b"></a><!-- doxytag: member="ucc::audio::linear_t" ref="a704f697eaa7afc45ca4526c541ede86b" args="" -->
typedef int16_t *&nbsp;</td><td class="memItemRight" valign="bottom"><b>linear_t</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>state_t</b> { <br/>
&nbsp;&nbsp;<b>IDLE</b> =  0, 
<b>ACTIVE</b>, 
<b>END</b>, 
<b>FAILED</b>, 
<br/>
&nbsp;&nbsp;<b>INVALID</b>, 
<b>INVFILE</b>, 
<b>INVIO</b> =  FAILED
<br/>
 }</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><b>type_t</b> { <br/>
&nbsp;&nbsp;<b>ULAW</b>, 
<b>ALAW</b>, 
<b>LINEAR</b>, 
<b>STREAM</b>, 
<br/>
&nbsp;&nbsp;<b>PACKET</b>, 
<b>FRAMED</b>, 
<b>NATIVE</b>
<br/>
 }</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abdab75af75197fdd4c5858bd05e60a5f"></a><!-- doxytag: member="ucc::audio::a2u" ref="abdab75af75197fdd4c5858bd05e60a5f" args="(encoded_t data, unsigned samples)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><b>a2u</b> (encoded_t data, unsigned samples)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab904685fb41f2e30e15e3fee60a9699e"></a><!-- doxytag: member="ucc::audio::dbm" ref="ab904685fb41f2e30e15e3fee60a9699e" args="(int16_t linear)" -->
static float&nbsp;</td><td class="memItemRight" valign="bottom"><b>dbm</b> (int16_t linear)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37c5a7e356e021910f414fe8ec661645"></a><!-- doxytag: member="ucc::audio::dbm" ref="a37c5a7e356e021910f414fe8ec661645" args="(float dbm)" -->
static int16_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>dbm</b> (float dbm)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c168899c453829f0a8560ba27baad91"></a><!-- doxytag: member="ucc::audio::expand" ref="a7c168899c453829f0a8560ba27baad91" args="(encoded_t ulaw, unsigned samples, linear_t target=((void *) 0))" -->
static linear_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>expand</b> (encoded_t ulaw, unsigned samples, linear_t target=((void *) 0))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00844fcf72ab350d696da40b4b90b27f"></a><!-- doxytag: member="ucc::audio::init" ref="a00844fcf72ab350d696da40b4b90b27f" args="(void)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><b>init</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a866c6d581fe1808361e598b9674880a3"></a><!-- doxytag: member="ucc::audio::release" ref="a866c6d581fe1808361e598b9674880a3" args="(framer_t buffer)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><b>release</b> (<a class="el" href="a00024.html">framer_t</a> buffer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adab27b04c2ba3e9868bd2f4e53a92a6a"></a><!-- doxytag: member="ucc::audio::repack" ref="adab27b04c2ba3e9868bd2f4e53a92a6a" args="(encoded_t ulaw, unsigned samples, linear_t source=((void *) 0))" -->
static encoded_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>repack</b> (encoded_t ulaw, unsigned samples, linear_t source=((void *) 0))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afd44923bcdd7b30ac8f7c22cfb119648"></a><!-- doxytag: member="ucc::audio::u2a" ref="afd44923bcdd7b30ac8f7c22cfb119648" args="(encoded_t data, unsigned samples)" -->
static void&nbsp;</td><td class="memItemRight" valign="bottom"><b>u2a</b> (encoded_t data, unsigned samples)</td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a437b4483f3f274044b0ae64295db5e05"></a><!-- doxytag: member="ucc::audio::global" ref="a437b4483f3f274044b0ae64295db5e05" args="" -->
static volatile <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>global</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Common audio class for GNU telephonic audio. </p>
<p>This holds many common and useful functions that can be inherited into other classes. This class also defines common data types and structures used in the remainder of GNU ccAudio. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="a00187_source.html#l00047">47</a> of file <a class="el" href="a00187_source.html">audio.h</a>.</p>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00187_source.html">audio.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:24 2010 for UCommon 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>