<!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.8"/>
<title>SphinxBase: include/sphinxbase/huff_code.h File 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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">SphinxBase
 <span id="projectnumber">0.6</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('huff__code_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">huff_code.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Huffman code and bitstream implementation.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <stdio.h></code><br />
<code>#include <sphinxbase/sphinxbase_export.h></code><br />
<code>#include <<a class="el" href="prim__type_8h_source.html">sphinxbase/prim_type.h</a>></code><br />
<code>#include <<a class="el" href="cmd__ln_8h_source.html">sphinxbase/cmd_ln.h</a>></code><br />
</div>
<p><a href="huff__code_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a99a5188e6a18682c96100cd5232af0f4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a99a5188e6a18682c96100cd5232af0f4"></a>
typedef struct <a class="el" href="structhuff__code__s.html">huff_code_s</a> </td><td class="memItemRight" valign="bottom"><b>huff_code_t</b></td></tr>
<tr class="separator:a99a5188e6a18682c96100cd5232af0f4"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a278b925caf4f2c93cbb63adc8f77bfa6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a278b925caf4f2c93cbb63adc8f77bfa6"></a>
SPHINXBASE_EXPORT <a class="el" href="structhuff__code__s.html">huff_code_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="huff__code_8h.html#a278b925caf4f2c93cbb63adc8f77bfa6">huff_code_build_int</a> (int32 const *values, int32 const *frequencies, int nvals)</td></tr>
<tr class="memdesc:a278b925caf4f2c93cbb63adc8f77bfa6"><td class="mdescLeft"> </td><td class="mdescRight">Create a codebook from 32-bit integer data. <br /></td></tr>
<tr class="separator:a278b925caf4f2c93cbb63adc8f77bfa6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af5d0c85a2ad206c277ecde2a085af790"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5d0c85a2ad206c277ecde2a085af790"></a>
SPHINXBASE_EXPORT <a class="el" href="structhuff__code__s.html">huff_code_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="huff__code_8h.html#af5d0c85a2ad206c277ecde2a085af790">huff_code_build_str</a> (char *const *values, int32 const *frequencies, int nvals)</td></tr>
<tr class="memdesc:af5d0c85a2ad206c277ecde2a085af790"><td class="mdescLeft"> </td><td class="mdescRight">Create a codebook from string data. <br /></td></tr>
<tr class="separator:af5d0c85a2ad206c277ecde2a085af790"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a873745b79dac884cbb1b5bdf12e069e6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a873745b79dac884cbb1b5bdf12e069e6"></a>
SPHINXBASE_EXPORT <a class="el" href="structhuff__code__s.html">huff_code_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="huff__code_8h.html#a873745b79dac884cbb1b5bdf12e069e6">huff_code_read</a> (FILE *infh)</td></tr>
<tr class="memdesc:a873745b79dac884cbb1b5bdf12e069e6"><td class="mdescLeft"> </td><td class="mdescRight">Read a codebook from a file. <br /></td></tr>
<tr class="separator:a873745b79dac884cbb1b5bdf12e069e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b91641e852a8eb4c4d32f40ff6dd055"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b91641e852a8eb4c4d32f40ff6dd055"></a>
SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="huff__code_8h.html#a6b91641e852a8eb4c4d32f40ff6dd055">huff_code_write</a> (<a class="el" href="structhuff__code__s.html">huff_code_t</a> *hc, FILE *outfh)</td></tr>
<tr class="memdesc:a6b91641e852a8eb4c4d32f40ff6dd055"><td class="mdescLeft"> </td><td class="mdescRight">Write a codebook to a file. <br /></td></tr>
<tr class="separator:a6b91641e852a8eb4c4d32f40ff6dd055"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a821658831cbe9b1199c756435d0ad4aa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a821658831cbe9b1199c756435d0ad4aa"></a>
SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="huff__code_8h.html#a821658831cbe9b1199c756435d0ad4aa">huff_code_dump</a> (<a class="el" href="structhuff__code__s.html">huff_code_t</a> *hc, FILE *dumpfh)</td></tr>
<tr class="memdesc:a821658831cbe9b1199c756435d0ad4aa"><td class="mdescLeft"> </td><td class="mdescRight">Print a codebook to a file as text (for debugging) <br /></td></tr>
<tr class="separator:a821658831cbe9b1199c756435d0ad4aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26a70d1b1704f1af985e67127e622a7b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26a70d1b1704f1af985e67127e622a7b"></a>
SPHINXBASE_EXPORT <a class="el" href="structhuff__code__s.html">huff_code_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="huff__code_8h.html#a26a70d1b1704f1af985e67127e622a7b">huff_code_retain</a> (<a class="el" href="structhuff__code__s.html">huff_code_t</a> *hc)</td></tr>
<tr class="memdesc:a26a70d1b1704f1af985e67127e622a7b"><td class="mdescLeft"> </td><td class="mdescRight">Retain a pointer to a Huffman codec object. <br /></td></tr>
<tr class="separator:a26a70d1b1704f1af985e67127e622a7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8678d07a65af1963cc0b3bd8b10d646"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8678d07a65af1963cc0b3bd8b10d646"></a>
SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="huff__code_8h.html#ac8678d07a65af1963cc0b3bd8b10d646">huff_code_free</a> (<a class="el" href="structhuff__code__s.html">huff_code_t</a> *hc)</td></tr>
<tr class="memdesc:ac8678d07a65af1963cc0b3bd8b10d646"><td class="mdescLeft"> </td><td class="mdescRight">Release a pointer to a Huffman codec object. <br /></td></tr>
<tr class="separator:ac8678d07a65af1963cc0b3bd8b10d646"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9698821197737e3e1be9533a3059c82c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9698821197737e3e1be9533a3059c82c"></a>
SPHINXBASE_EXPORT FILE * </td><td class="memItemRight" valign="bottom"><a class="el" href="huff__code_8h.html#a9698821197737e3e1be9533a3059c82c">huff_code_attach</a> (<a class="el" href="structhuff__code__s.html">huff_code_t</a> *hc, FILE *fh, char const *mode)</td></tr>
<tr class="memdesc:a9698821197737e3e1be9533a3059c82c"><td class="mdescLeft"> </td><td class="mdescRight">Attach a Huffman codec to a file handle for input/output. <br /></td></tr>
<tr class="separator:a9698821197737e3e1be9533a3059c82c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a403f575701c1d5fd2ddef1d001cf53e3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a403f575701c1d5fd2ddef1d001cf53e3"></a>
SPHINXBASE_EXPORT FILE * </td><td class="memItemRight" valign="bottom"><a class="el" href="huff__code_8h.html#a403f575701c1d5fd2ddef1d001cf53e3">huff_code_detach</a> (<a class="el" href="structhuff__code__s.html">huff_code_t</a> *hc)</td></tr>
<tr class="memdesc:a403f575701c1d5fd2ddef1d001cf53e3"><td class="mdescLeft"> </td><td class="mdescRight">Detach a Huffman codec from its file handle. <br /></td></tr>
<tr class="separator:a403f575701c1d5fd2ddef1d001cf53e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf369555b8784eee944f7ebc97b6b825"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf369555b8784eee944f7ebc97b6b825"></a>
SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="huff__code_8h.html#acf369555b8784eee944f7ebc97b6b825">huff_code_encode_int</a> (<a class="el" href="structhuff__code__s.html">huff_code_t</a> *hc, int32 sym, uint32 *outcw)</td></tr>
<tr class="memdesc:acf369555b8784eee944f7ebc97b6b825"><td class="mdescLeft"> </td><td class="mdescRight">Encode an integer, writing it to the file handle, if any. <br /></td></tr>
<tr class="separator:acf369555b8784eee944f7ebc97b6b825"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24fe76f501a7a0485f3e9485c60fae32"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a24fe76f501a7a0485f3e9485c60fae32"></a>
SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="huff__code_8h.html#a24fe76f501a7a0485f3e9485c60fae32">huff_code_encode_str</a> (<a class="el" href="structhuff__code__s.html">huff_code_t</a> *hc, char const *sym, uint32 *outcw)</td></tr>
<tr class="memdesc:a24fe76f501a7a0485f3e9485c60fae32"><td class="mdescLeft"> </td><td class="mdescRight">Encode a string, writing it to the file handle, if any. <br /></td></tr>
<tr class="separator:a24fe76f501a7a0485f3e9485c60fae32"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9155dd07a0a24393ef0e4e66cb314140"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9155dd07a0a24393ef0e4e66cb314140"></a>
SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="huff__code_8h.html#a9155dd07a0a24393ef0e4e66cb314140">huff_code_decode_int</a> (<a class="el" href="structhuff__code__s.html">huff_code_t</a> *hc, int *outval, char const **inout_data, size_t *inout_data_len, int *inout_offset)</td></tr>
<tr class="memdesc:a9155dd07a0a24393ef0e4e66cb314140"><td class="mdescLeft"> </td><td class="mdescRight">Decode an integer, reading it from the file if no data given. <br /></td></tr>
<tr class="separator:a9155dd07a0a24393ef0e4e66cb314140"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec0908ece3a695f8a3f6619d8d726e57"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec0908ece3a695f8a3f6619d8d726e57"></a>
SPHINXBASE_EXPORT char const * </td><td class="memItemRight" valign="bottom"><a class="el" href="huff__code_8h.html#aec0908ece3a695f8a3f6619d8d726e57">huff_code_decode_str</a> (<a class="el" href="structhuff__code__s.html">huff_code_t</a> *hc, char const **inout_data, size_t *inout_data_len, int *inout_offset)</td></tr>
<tr class="memdesc:aec0908ece3a695f8a3f6619d8d726e57"><td class="mdescLeft"> </td><td class="mdescRight">Decode a string, reading it from the file if no data given. <br /></td></tr>
<tr class="separator:aec0908ece3a695f8a3f6619d8d726e57"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Huffman code and bitstream implementation. </p>
<p>This interface supports building canonical Huffman codes from string and integer values. It also provides support for encoding and decoding from strings and files, and for reading and writing codebooks from files. </p>
<p>Definition in file <a class="el" href="huff__code_8h_source.html">huff_code.h</a>.</p>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e3d154c296a8e9be2797a4f81e9375b2.html">sphinxbase</a></li><li class="navelem"><a class="el" href="huff__code_8h.html">huff_code.h</a></li>
<li class="footer">Generated on Sat Oct 18 2014 15:21:17 for SphinxBase by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
</ul>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
b56c9eed3fa0f00740b6f09a2460a97f
>
files
>
301
