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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
|
<html>
<head>
<title>Camstream: CamStream API documentation</title>
<link rel="stylesheet" href="../../tech.css" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.3.7 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
<h1>CAdaptiveHuffman Class Reference</h1>An adaptive Huffman encoder in C++.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="_adaptive_huffman_8h-source.html">AdaptiveHuffman.h</a>></code>
<p>
<a href="class_c_adaptive_huffman-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>enum { <a class="el" href="class_c_adaptive_huffman.html#w3w0">ValueOutOfBounds</a> = -1,
<a class="el" href="class_c_adaptive_huffman.html#w3w1">BufferFull</a> = -2,
<a class="el" href="class_c_adaptive_huffman.html#w3w2">EndOfFile</a> = -3
}
</ul>
<h2>Public Member Functions</h2>
<ul>
<li><a class="el" href="class_c_adaptive_huffman.html#a0">CAdaptiveHuffman</a> (int max_value)
<li><a class="el" href="class_c_adaptive_huffman.html#a1">~CAdaptiveHuffman</a> ()
<li>void <a class="el" href="class_c_adaptive_huffman.html#a2">InitCompressor</a> (int buffer_size, char use_marks)
<li>int <a class="el" href="class_c_adaptive_huffman.html#a3">AddValue</a> (int v)
<li>void <a class="el" href="class_c_adaptive_huffman.html#a4">Mark</a> ()
<li>int <a class="el" href="class_c_adaptive_huffman.html#a5">GetBits</a> () const
<li>const char * <a class="el" href="class_c_adaptive_huffman.html#a6">GetBuffer</a> () const
<li>void <a class="el" href="class_c_adaptive_huffman.html#a7">InitDecompressor</a> (int bits, const char *buffer)
<li>int <a class="el" href="class_c_adaptive_huffman.html#a8">GetValue</a> ()
<li>void <a class="el" href="class_c_adaptive_huffman.html#a9">PrintTree</a> ()
<li>void <a class="el" href="class_c_adaptive_huffman.html#a10">PrintAncestors</a> ()
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An adaptive Huffman encoder in C++.
<p>
This probably isn't the fastest implementation around, but at least this code is (hopefully) a lot easier to understand than, for example, the JPEG Huffman encoder (which is static anyway).<p>
This class has an extra for the compressor: it allows you to set marks in the compressed bitstream. This is useful if you want to add a group of values that belong together, but you don't know a priori if they will fit in the remaining bufferspace. By setting a mark after each succesfull group you can be assured you don't end up with half groups (and you don't waste space in the buffer either).
<p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="w3" doxytag="CAdaptiveHuffman::@1" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> anonymous enum </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="w3w0" doxytag="ValueOutOfBounds" ></a>ValueOutOfBounds</em> </td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="w3w1" doxytag="BufferFull" ></a>BufferFull</em> </td><td>
</td></tr>
<tr><td valign=top><em><a class="anchor" name="w3w2" doxytag="EndOfFile" ></a>EndOfFile</em> </td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="CAdaptiveHuffman::CAdaptiveHuffman" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CAdaptiveHuffman::CAdaptiveHuffman </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>max_values</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
constructor
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>max_values</em> </td><td>The number of values being used for compression</td></tr>
</table>
</dl>
This initializes the encoder/decoder. With max_values you specify the maximum number of different symbols you want to encode. This number cannot be changed later! </td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="CAdaptiveHuffman::~CAdaptiveHuffman" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CAdaptiveHuffman::~<a class="el" href="class_c_adaptive_huffman.html">CAdaptiveHuffman</a> </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a3" doxytag="CAdaptiveHuffman::AddValue" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int CAdaptiveHuffman::AddValue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>v</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a5" doxytag="CAdaptiveHuffman::GetBits" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int CAdaptiveHuffman::GetBits </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return number of bits in (marked) buffer.
<p>
This returns the number of <b>bits</b> that are used in the buffer. In case of marks, returns the number in the buffer at the last call to <a class="el" href="class_c_adaptive_huffman.html#a4">Mark()</a>. </td>
</tr>
</table>
<a class="anchor" name="a6" doxytag="CAdaptiveHuffman::GetBuffer" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const char * CAdaptiveHuffman::GetBuffer </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a8" doxytag="CAdaptiveHuffman::GetValue" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int CAdaptiveHuffman::GetValue </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="CAdaptiveHuffman::InitCompressor" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void CAdaptiveHuffman::InitCompressor </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>buffer_size</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>char </td>
<td class="mdname" nowrap> <em>use_marks</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>buffer_size</em> </td><td>Size in <b>bytes</b> </td></tr>
<tr><td></td><td valign=top><em>use_marks</em> </td><td>flag: use marks in bitstream</td></tr>
</table>
</dl>
When the <b>use_marks</b> parameter is set to non-zero, the Compressor uses marks in the stream. Each time you call <a class="el" href="class_c_adaptive_huffman.html#a4">Mark</a>() the internal bitpointer is advanced to the current bit position. When <b>use_marks</b> is 0, no marking is done and the bitpointer is always at the end of the buffer. </td>
</tr>
</table>
<a class="anchor" name="a7" doxytag="CAdaptiveHuffman::InitDecompressor" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void CAdaptiveHuffman::InitDecompressor </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>bits</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>buffer</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a4" doxytag="CAdaptiveHuffman::Mark" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void CAdaptiveHuffman::Mark </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set bit position marker.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a10" doxytag="CAdaptiveHuffman::PrintAncestors" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void CAdaptiveHuffman::PrintAncestors </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="a9" doxytag="CAdaptiveHuffman::PrintTree" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void CAdaptiveHuffman::PrintTree </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_adaptive_huffman_8h-source.html">AdaptiveHuffman.h</a><li><a class="el" href="_adaptive_huffman_8cc.html">AdaptiveHuffman.cc</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 13 23:38:47 2006 for CamStream by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.7 </small></address>
</body>
</html>
|
