/usr/share/gtk-doc/html/schroedinger/schroedinger-schrounpack.html is in libschroedinger-doc 1.0.11-2ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>schrounpack</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Schroedinger Reference Manual">
<link rel="up" href="schrointernal.html" title="Schroedinger Internal API">
<link rel="prev" href="schroedinger-schrosubband.html" title="schrosubband">
<link rel="next" href="schroedinger-schroutils.html" title="schroutils">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="schroedinger-schrosubband.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="schrointernal.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Schroedinger Reference Manual</th>
<td><a accesskey="n" href="schroedinger-schroutils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#schroedinger-schrounpack.synopsis" class="shortcut">Top</a>
|
<a href="#schroedinger-schrounpack.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="schroedinger-schrounpack"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="schroedinger-schrounpack.top_of_page"></a>schrounpack</span></h2>
<p>schrounpack</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="schroedinger-schrounpack.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack">SchroUnpack</a>;
<span class="returnvalue">void</span> <a class="link" href="schroedinger-schrounpack.html#schro-unpack-byte-sync" title="schro_unpack_byte_sync ()">schro_unpack_byte_sync</a> (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>);
<span class="returnvalue">void</span> <a class="link" href="schroedinger-schrounpack.html#schro-unpack-copy" title="schro_unpack_copy ()">schro_unpack_copy</a> (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *dest</code></em>,
<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *src</code></em>);
unsigned <span class="returnvalue">int</span> <a class="link" href="schroedinger-schrounpack.html#schro-unpack-decode-bit" title="schro_unpack_decode_bit ()">schro_unpack_decode_bit</a> (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>);
unsigned <span class="returnvalue">int</span> <a class="link" href="schroedinger-schrounpack.html#schro-unpack-decode-bits" title="schro_unpack_decode_bits ()">schro_unpack_decode_bits</a> (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>,
<em class="parameter"><code><span class="type">int</span> n</code></em>);
<span class="returnvalue">int</span> <a class="link" href="schroedinger-schrounpack.html#schro-unpack-decode-sint" title="schro_unpack_decode_sint ()">schro_unpack_decode_sint</a> (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>);
<span class="returnvalue">void</span> <a class="link" href="schroedinger-schrounpack.html#schro-unpack-decode-sint-s16" title="schro_unpack_decode_sint_s16 ()">schro_unpack_decode_sint_s16</a> (<em class="parameter"><code><span class="type">int16_t</span> *dest</code></em>,
<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>,
<em class="parameter"><code><span class="type">int</span> n</code></em>);
<span class="returnvalue">int</span> <a class="link" href="schroedinger-schrounpack.html#schro-unpack-decode-sint-slow" title="schro_unpack_decode_sint_slow ()">schro_unpack_decode_sint_slow</a> (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>);
unsigned <span class="returnvalue">int</span> <a class="link" href="schroedinger-schrounpack.html#schro-unpack-decode-uint" title="schro_unpack_decode_uint ()">schro_unpack_decode_uint</a> (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>);
<span class="returnvalue">int</span> <a class="link" href="schroedinger-schrounpack.html#schro-unpack-get-bits-read" title="schro_unpack_get_bits_read ()">schro_unpack_get_bits_read</a> (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>);
<span class="returnvalue">int</span> <a class="link" href="schroedinger-schrounpack.html#schro-unpack-get-bits-remaining" title="schro_unpack_get_bits_remaining ()">schro_unpack_get_bits_remaining</a> (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>);
<span class="returnvalue">void</span> <a class="link" href="schroedinger-schrounpack.html#schro-unpack-init-with-data" title="schro_unpack_init_with_data ()">schro_unpack_init_with_data</a> (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>,
<em class="parameter"><code><span class="type">uint8_t</span> *data</code></em>,
<em class="parameter"><code><span class="type">int</span> n_bytes</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> guard_bit</code></em>);
<span class="returnvalue">void</span> <a class="link" href="schroedinger-schrounpack.html#schro-unpack-limit-bits-remaining" title="schro_unpack_limit_bits_remaining ()">schro_unpack_limit_bits_remaining</a> (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>,
<em class="parameter"><code><span class="type">int</span> n_bits</code></em>);
<span class="returnvalue">void</span> <a class="link" href="schroedinger-schrounpack.html#schro-unpack-skip-bits" title="schro_unpack_skip_bits ()">schro_unpack_skip_bits</a> (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>,
<em class="parameter"><code><span class="type">int</span> n_bits</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="schroedinger-schrounpack.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="schroedinger-schrounpack.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="SchroUnpack"></a><h3>struct SchroUnpack</h3>
<pre class="programlisting">struct SchroUnpack {
/* pointer to data that haven't been shifted into the shift register */
uint8_t *data;
/* number of bits remaining that haven't been shifted into the shift
* register */
int n_bits_left;
/* number of bits read by reader */
int n_bits_read;
/* chunk of bits we're currently frobbing, aligned to (1<<31) */
uint32_t shift_register;
int n_bits_in_shift_register;
/* bit pattern used after an error */
unsigned int guard_bit;
/* unpacking has overrun the end of the buffer */
int overrun;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-unpack-byte-sync"></a><h3>schro_unpack_byte_sync ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> schro_unpack_byte_sync (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-unpack-copy"></a><h3>schro_unpack_copy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> schro_unpack_copy (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *dest</code></em>,
<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *src</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-unpack-decode-bit"></a><h3>schro_unpack_decode_bit ()</h3>
<pre class="programlisting">unsigned <span class="returnvalue">int</span> schro_unpack_decode_bit (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-unpack-decode-bits"></a><h3>schro_unpack_decode_bits ()</h3>
<pre class="programlisting">unsigned <span class="returnvalue">int</span> schro_unpack_decode_bits (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>,
<em class="parameter"><code><span class="type">int</span> n</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-unpack-decode-sint"></a><h3>schro_unpack_decode_sint ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> schro_unpack_decode_sint (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-unpack-decode-sint-s16"></a><h3>schro_unpack_decode_sint_s16 ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> schro_unpack_decode_sint_s16 (<em class="parameter"><code><span class="type">int16_t</span> *dest</code></em>,
<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>,
<em class="parameter"><code><span class="type">int</span> n</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-unpack-decode-sint-slow"></a><h3>schro_unpack_decode_sint_slow ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> schro_unpack_decode_sint_slow (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-unpack-decode-uint"></a><h3>schro_unpack_decode_uint ()</h3>
<pre class="programlisting">unsigned <span class="returnvalue">int</span> schro_unpack_decode_uint (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-unpack-get-bits-read"></a><h3>schro_unpack_get_bits_read ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> schro_unpack_get_bits_read (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-unpack-get-bits-remaining"></a><h3>schro_unpack_get_bits_remaining ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> schro_unpack_get_bits_remaining (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-unpack-init-with-data"></a><h3>schro_unpack_init_with_data ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> schro_unpack_init_with_data (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>,
<em class="parameter"><code><span class="type">uint8_t</span> *data</code></em>,
<em class="parameter"><code><span class="type">int</span> n_bytes</code></em>,
<em class="parameter"><code>unsigned <span class="type">int</span> guard_bit</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-unpack-limit-bits-remaining"></a><h3>schro_unpack_limit_bits_remaining ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> schro_unpack_limit_bits_remaining (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>,
<em class="parameter"><code><span class="type">int</span> n_bits</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="schro-unpack-skip-bits"></a><h3>schro_unpack_skip_bits ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> schro_unpack_skip_bits (<em class="parameter"><code><a class="link" href="schroedinger-schrounpack.html#SchroUnpack" title="struct SchroUnpack"><span class="type">SchroUnpack</span></a> *unpack</code></em>,
<em class="parameter"><code><span class="type">int</span> n_bits</code></em>);</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|