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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="schroedinger-schrounpack">
<refmeta>
<refentrytitle role="top_of_page" id="schroedinger-schrounpack.top_of_page">schrounpack</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
SCHROEDINGER Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>schrounpack</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv id="schroedinger-schrounpack.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>struct <link linkend="SchroUnpack">SchroUnpack</link>;
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="schro-unpack-byte-sync">schro_unpack_byte_sync</link> (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="schro-unpack-copy">schro_unpack_copy</link> (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *dest</parameter>,
<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *src</parameter>);
unsigned <link linkend="int"><returnvalue>int</returnvalue></link> <link linkend="schro-unpack-decode-bit">schro_unpack_decode_bit</link> (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>);
unsigned <link linkend="int"><returnvalue>int</returnvalue></link> <link linkend="schro-unpack-decode-bits">schro_unpack_decode_bits</link> (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>,
<parameter><link linkend="int"><type>int</type></link> n</parameter>);
<link linkend="int"><returnvalue>int</returnvalue></link> <link linkend="schro-unpack-decode-sint">schro_unpack_decode_sint</link> (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="schro-unpack-decode-sint-s16">schro_unpack_decode_sint_s16</link> (<parameter><link linkend="int16-t"><type>int16_t</type></link> *dest</parameter>,
<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>,
<parameter><link linkend="int"><type>int</type></link> n</parameter>);
<link linkend="int"><returnvalue>int</returnvalue></link> <link linkend="schro-unpack-decode-sint-slow">schro_unpack_decode_sint_slow</link> (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>);
unsigned <link linkend="int"><returnvalue>int</returnvalue></link> <link linkend="schro-unpack-decode-uint">schro_unpack_decode_uint</link> (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>);
<link linkend="int"><returnvalue>int</returnvalue></link> <link linkend="schro-unpack-get-bits-read">schro_unpack_get_bits_read</link> (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>);
<link linkend="int"><returnvalue>int</returnvalue></link> <link linkend="schro-unpack-get-bits-remaining">schro_unpack_get_bits_remaining</link> (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="schro-unpack-init-with-data">schro_unpack_init_with_data</link> (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>,
<parameter><link linkend="uint8-t"><type>uint8_t</type></link> *data</parameter>,
<parameter><link linkend="int"><type>int</type></link> n_bytes</parameter>,
<parameter>unsigned <link linkend="int"><type>int</type></link> guard_bit</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="schro-unpack-limit-bits-remaining">schro_unpack_limit_bits_remaining</link> (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>,
<parameter><link linkend="int"><type>int</type></link> n_bits</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="schro-unpack-skip-bits">schro_unpack_skip_bits</link> (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>,
<parameter><link linkend="int"><type>int</type></link> n_bits</parameter>);
</synopsis>
</refsynopsisdiv>
<refsect1 id="schroedinger-schrounpack.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="schroedinger-schrounpack.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="SchroUnpack" role="struct">
<title>struct SchroUnpack</title>
<indexterm zone="SchroUnpack"><primary>SchroUnpack</primary></indexterm>
<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;
};
</programlisting>
<para>
</para></refsect2>
<refsect2 id="schro-unpack-byte-sync" role="function">
<title>schro_unpack_byte_sync ()</title>
<indexterm zone="schro-unpack-byte-sync"><primary>schro_unpack_byte_sync</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> schro_unpack_byte_sync (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>);</programlisting>
<para>
</para></refsect2>
<refsect2 id="schro-unpack-copy" role="function">
<title>schro_unpack_copy ()</title>
<indexterm zone="schro-unpack-copy"><primary>schro_unpack_copy</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> schro_unpack_copy (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *dest</parameter>,
<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *src</parameter>);</programlisting>
<para>
</para></refsect2>
<refsect2 id="schro-unpack-decode-bit" role="function">
<title>schro_unpack_decode_bit ()</title>
<indexterm zone="schro-unpack-decode-bit"><primary>schro_unpack_decode_bit</primary></indexterm>
<programlisting>unsigned <link linkend="int"><returnvalue>int</returnvalue></link> schro_unpack_decode_bit (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>);</programlisting>
<para>
</para></refsect2>
<refsect2 id="schro-unpack-decode-bits" role="function">
<title>schro_unpack_decode_bits ()</title>
<indexterm zone="schro-unpack-decode-bits"><primary>schro_unpack_decode_bits</primary></indexterm>
<programlisting>unsigned <link linkend="int"><returnvalue>int</returnvalue></link> schro_unpack_decode_bits (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>,
<parameter><link linkend="int"><type>int</type></link> n</parameter>);</programlisting>
<para>
</para></refsect2>
<refsect2 id="schro-unpack-decode-sint" role="function">
<title>schro_unpack_decode_sint ()</title>
<indexterm zone="schro-unpack-decode-sint"><primary>schro_unpack_decode_sint</primary></indexterm>
<programlisting><link linkend="int"><returnvalue>int</returnvalue></link> schro_unpack_decode_sint (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>);</programlisting>
<para>
</para></refsect2>
<refsect2 id="schro-unpack-decode-sint-s16" role="function">
<title>schro_unpack_decode_sint_s16 ()</title>
<indexterm zone="schro-unpack-decode-sint-s16"><primary>schro_unpack_decode_sint_s16</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> schro_unpack_decode_sint_s16 (<parameter><link linkend="int16-t"><type>int16_t</type></link> *dest</parameter>,
<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>,
<parameter><link linkend="int"><type>int</type></link> n</parameter>);</programlisting>
<para>
</para></refsect2>
<refsect2 id="schro-unpack-decode-sint-slow" role="function">
<title>schro_unpack_decode_sint_slow ()</title>
<indexterm zone="schro-unpack-decode-sint-slow"><primary>schro_unpack_decode_sint_slow</primary></indexterm>
<programlisting><link linkend="int"><returnvalue>int</returnvalue></link> schro_unpack_decode_sint_slow (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>);</programlisting>
<para>
</para></refsect2>
<refsect2 id="schro-unpack-decode-uint" role="function">
<title>schro_unpack_decode_uint ()</title>
<indexterm zone="schro-unpack-decode-uint"><primary>schro_unpack_decode_uint</primary></indexterm>
<programlisting>unsigned <link linkend="int"><returnvalue>int</returnvalue></link> schro_unpack_decode_uint (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>);</programlisting>
<para>
</para></refsect2>
<refsect2 id="schro-unpack-get-bits-read" role="function">
<title>schro_unpack_get_bits_read ()</title>
<indexterm zone="schro-unpack-get-bits-read"><primary>schro_unpack_get_bits_read</primary></indexterm>
<programlisting><link linkend="int"><returnvalue>int</returnvalue></link> schro_unpack_get_bits_read (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>);</programlisting>
<para>
</para></refsect2>
<refsect2 id="schro-unpack-get-bits-remaining" role="function">
<title>schro_unpack_get_bits_remaining ()</title>
<indexterm zone="schro-unpack-get-bits-remaining"><primary>schro_unpack_get_bits_remaining</primary></indexterm>
<programlisting><link linkend="int"><returnvalue>int</returnvalue></link> schro_unpack_get_bits_remaining (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>);</programlisting>
<para>
</para></refsect2>
<refsect2 id="schro-unpack-init-with-data" role="function">
<title>schro_unpack_init_with_data ()</title>
<indexterm zone="schro-unpack-init-with-data"><primary>schro_unpack_init_with_data</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> schro_unpack_init_with_data (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>,
<parameter><link linkend="uint8-t"><type>uint8_t</type></link> *data</parameter>,
<parameter><link linkend="int"><type>int</type></link> n_bytes</parameter>,
<parameter>unsigned <link linkend="int"><type>int</type></link> guard_bit</parameter>);</programlisting>
<para>
</para></refsect2>
<refsect2 id="schro-unpack-limit-bits-remaining" role="function">
<title>schro_unpack_limit_bits_remaining ()</title>
<indexterm zone="schro-unpack-limit-bits-remaining"><primary>schro_unpack_limit_bits_remaining</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> schro_unpack_limit_bits_remaining (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>,
<parameter><link linkend="int"><type>int</type></link> n_bits</parameter>);</programlisting>
<para>
</para></refsect2>
<refsect2 id="schro-unpack-skip-bits" role="function">
<title>schro_unpack_skip_bits ()</title>
<indexterm zone="schro-unpack-skip-bits"><primary>schro_unpack_skip_bits</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> schro_unpack_skip_bits (<parameter><link linkend="SchroUnpack"><type>SchroUnpack</type></link> *unpack</parameter>,
<parameter><link linkend="int"><type>int</type></link> n_bits</parameter>);</programlisting>
<para>
</para></refsect2>
</refsect1>
</refentry>
|
