/usr/share/doc/liblzma-doc/html/lzma__encoder_8c.html is in liblzma-doc 5.2.2-1.3.
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 206 207 208 209 210 211 212 213 | <!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>XZ Utils: liblzma/lzma/lzma_encoder.c 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="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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">XZ Utils
 <span id="projectnumber">5.2.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_2e0898c272e1f0f93c8ef15f5da2a912.html">liblzma</a></li><li class="navelem"><a class="el" href="dir_ac7229a575da173bd8a390f0921c5810.html">lzma</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">lzma_encoder.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>LZMA encoder.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="lzma2__encoder_8h.html">lzma2_encoder.h</a>"</code><br />
<code>#include "<a class="el" href="lzma__encoder__private_8h.html">lzma_encoder_private.h</a>"</code><br />
<code>#include "<a class="el" href="fastpos_8h.html">fastpos.h</a>"</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a25303b6c550125f26a297dc0847e72a9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="lzma__encoder_8c.html#a25303b6c550125f26a297dc0847e72a9">LOOP_INPUT_MAX</a>   (OPTS + 1)</td></tr>
<tr class="separator:a25303b6c550125f26a297dc0847e72a9"><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:a276c6d863c72ad4e56fa1034142fcb85"><td class="memItemLeft" align="right" valign="top"><a id="a276c6d863c72ad4e56fa1034142fcb85"></a>
static void </td><td class="memItemRight" valign="bottom"><b>literal_matched</b> (<a class="el" href="structlzma__range__encoder.html">lzma_range_encoder</a> *rc, <a class="el" href="range__common_8h.html#a34c0f9a451832941a8aa04aa8e085efa">probability</a> *subcoder, uint32_t match_byte, uint32_t symbol)</td></tr>
<tr class="separator:a276c6d863c72ad4e56fa1034142fcb85"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac7b07aedbbdef4cf918d0a0270267105"><td class="memItemLeft" align="right" valign="top"><a id="ac7b07aedbbdef4cf918d0a0270267105"></a>
static void </td><td class="memItemRight" valign="bottom"><b>literal</b> (<a class="el" href="common_8h.html#a4fd16c96358c705abab5da65940aa1b1">lzma_coder</a> *coder, <a class="el" href="structlzma__mf__s.html">lzma_mf</a> *mf, uint32_t position)</td></tr>
<tr class="separator:ac7b07aedbbdef4cf918d0a0270267105"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7b06ec5cf3bb55193e2e3bcc236ee23"><td class="memItemLeft" align="right" valign="top"><a id="af7b06ec5cf3bb55193e2e3bcc236ee23"></a>
static void </td><td class="memItemRight" valign="bottom"><b>length_update_prices</b> (<a class="el" href="structlzma__length__encoder.html">lzma_length_encoder</a> *lc, const uint32_t pos_state)</td></tr>
<tr class="separator:af7b06ec5cf3bb55193e2e3bcc236ee23"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3df350e3a724f22844bcfaca65620695"><td class="memItemLeft" align="right" valign="top"><a id="a3df350e3a724f22844bcfaca65620695"></a>
static void </td><td class="memItemRight" valign="bottom"><b>length</b> (<a class="el" href="structlzma__range__encoder.html">lzma_range_encoder</a> *rc, <a class="el" href="structlzma__length__encoder.html">lzma_length_encoder</a> *lc, const uint32_t pos_state, uint32_t len, const bool fast_mode)</td></tr>
<tr class="separator:a3df350e3a724f22844bcfaca65620695"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8b0bd8be0664f851345d198cc5d887f"><td class="memItemLeft" align="right" valign="top"><a id="af8b0bd8be0664f851345d198cc5d887f"></a>
static void </td><td class="memItemRight" valign="bottom"><b>match</b> (<a class="el" href="common_8h.html#a4fd16c96358c705abab5da65940aa1b1">lzma_coder</a> *coder, const uint32_t pos_state, const uint32_t distance, const uint32_t len)</td></tr>
<tr class="separator:af8b0bd8be0664f851345d198cc5d887f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6481b2e38e7c89b4fb6d9d725b31bd3c"><td class="memItemLeft" align="right" valign="top"><a id="a6481b2e38e7c89b4fb6d9d725b31bd3c"></a>
static void </td><td class="memItemRight" valign="bottom"><b>rep_match</b> (<a class="el" href="common_8h.html#a4fd16c96358c705abab5da65940aa1b1">lzma_coder</a> *coder, const uint32_t pos_state, const uint32_t rep, const uint32_t len)</td></tr>
<tr class="separator:a6481b2e38e7c89b4fb6d9d725b31bd3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99fb9c71de556f4306586821f25fa371"><td class="memItemLeft" align="right" valign="top"><a id="a99fb9c71de556f4306586821f25fa371"></a>
static void </td><td class="memItemRight" valign="bottom"><b>encode_symbol</b> (<a class="el" href="common_8h.html#a4fd16c96358c705abab5da65940aa1b1">lzma_coder</a> *coder, <a class="el" href="structlzma__mf__s.html">lzma_mf</a> *mf, uint32_t back, uint32_t len, uint32_t position)</td></tr>
<tr class="separator:a99fb9c71de556f4306586821f25fa371"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab39b61691c6378000fe473bd62f48840"><td class="memItemLeft" align="right" valign="top"><a id="ab39b61691c6378000fe473bd62f48840"></a>
static bool </td><td class="memItemRight" valign="bottom"><b>encode_init</b> (<a class="el" href="common_8h.html#a4fd16c96358c705abab5da65940aa1b1">lzma_coder</a> *coder, <a class="el" href="structlzma__mf__s.html">lzma_mf</a> *mf)</td></tr>
<tr class="separator:ab39b61691c6378000fe473bd62f48840"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1faf6e3c3c9f322e5e35981b03bfefda"><td class="memItemLeft" align="right" valign="top"><a id="a1faf6e3c3c9f322e5e35981b03bfefda"></a>
static void </td><td class="memItemRight" valign="bottom"><b>encode_eopm</b> (<a class="el" href="common_8h.html#a4fd16c96358c705abab5da65940aa1b1">lzma_coder</a> *coder, uint32_t position)</td></tr>
<tr class="separator:a1faf6e3c3c9f322e5e35981b03bfefda"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16770d92face441bd618da718f406aff"><td class="memItemLeft" align="right" valign="top"><a id="a16770d92face441bd618da718f406aff"></a>
<a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> </td><td class="memItemRight" valign="bottom"><b>lzma_lzma_encode</b> (<a class="el" href="common_8h.html#a4fd16c96358c705abab5da65940aa1b1">lzma_coder</a> *restrict coder, <a class="el" href="structlzma__mf__s.html">lzma_mf</a> *restrict mf, uint8_t *restrict out, size_t *restrict out_pos, size_t out_size, uint32_t limit)</td></tr>
<tr class="separator:a16770d92face441bd618da718f406aff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac22de190d666e52c21a0f813e51d23dd"><td class="memItemLeft" align="right" valign="top"><a id="ac22de190d666e52c21a0f813e51d23dd"></a>
static <a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> </td><td class="memItemRight" valign="bottom"><b>lzma_encode</b> (<a class="el" href="common_8h.html#a4fd16c96358c705abab5da65940aa1b1">lzma_coder</a> *restrict coder, <a class="el" href="structlzma__mf__s.html">lzma_mf</a> *restrict mf, uint8_t *restrict out, size_t *restrict out_pos, size_t out_size)</td></tr>
<tr class="separator:ac22de190d666e52c21a0f813e51d23dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1426dd8519ffbb53ea746985452a9228"><td class="memItemLeft" align="right" valign="top"><a id="a1426dd8519ffbb53ea746985452a9228"></a>
static bool </td><td class="memItemRight" valign="bottom"><b>is_options_valid</b> (const <a class="el" href="structlzma__options__lzma.html">lzma_options_lzma</a> *options)</td></tr>
<tr class="separator:a1426dd8519ffbb53ea746985452a9228"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a320e15eb89bf06c7d0bc3475ad7f799f"><td class="memItemLeft" align="right" valign="top"><a id="a320e15eb89bf06c7d0bc3475ad7f799f"></a>
static void </td><td class="memItemRight" valign="bottom"><b>set_lz_options</b> (<a class="el" href="structlzma__lz__options.html">lzma_lz_options</a> *lz_options, const <a class="el" href="structlzma__options__lzma.html">lzma_options_lzma</a> *options)</td></tr>
<tr class="separator:a320e15eb89bf06c7d0bc3475ad7f799f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5cf00161eefbc2d476682c93a50909b5"><td class="memItemLeft" align="right" valign="top"><a id="a5cf00161eefbc2d476682c93a50909b5"></a>
static void </td><td class="memItemRight" valign="bottom"><b>length_encoder_reset</b> (<a class="el" href="structlzma__length__encoder.html">lzma_length_encoder</a> *lencoder, const uint32_t num_pos_states, const bool fast_mode)</td></tr>
<tr class="separator:a5cf00161eefbc2d476682c93a50909b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad81c4d4e221c46e1bf7a28f88d573ee4"><td class="memItemLeft" align="right" valign="top"><a id="ad81c4d4e221c46e1bf7a28f88d573ee4"></a>
<a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> </td><td class="memItemRight" valign="bottom"><b>lzma_lzma_encoder_reset</b> (<a class="el" href="common_8h.html#a4fd16c96358c705abab5da65940aa1b1">lzma_coder</a> *coder, const <a class="el" href="structlzma__options__lzma.html">lzma_options_lzma</a> *options)</td></tr>
<tr class="separator:ad81c4d4e221c46e1bf7a28f88d573ee4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a018bcfe85361f13f3458b649bd86ebe9"><td class="memItemLeft" align="right" valign="top"><a id="a018bcfe85361f13f3458b649bd86ebe9"></a>
<a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> </td><td class="memItemRight" valign="bottom"><b>lzma_lzma_encoder_create</b> (<a class="el" href="common_8h.html#a4fd16c96358c705abab5da65940aa1b1">lzma_coder</a> **coder_ptr, const <a class="el" href="structlzma__allocator.html">lzma_allocator</a> *allocator, const <a class="el" href="structlzma__options__lzma.html">lzma_options_lzma</a> *options, <a class="el" href="structlzma__lz__options.html">lzma_lz_options</a> *lz_options)</td></tr>
<tr class="separator:a018bcfe85361f13f3458b649bd86ebe9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad00e82cc46428457f1c08bf70fe5e6c6"><td class="memItemLeft" align="right" valign="top"><a id="ad00e82cc46428457f1c08bf70fe5e6c6"></a>
static <a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> </td><td class="memItemRight" valign="bottom"><b>lzma_encoder_init</b> (<a class="el" href="structlzma__lz__encoder.html">lzma_lz_encoder</a> *lz, const <a class="el" href="structlzma__allocator.html">lzma_allocator</a> *allocator, const void *options, <a class="el" href="structlzma__lz__options.html">lzma_lz_options</a> *lz_options)</td></tr>
<tr class="separator:ad00e82cc46428457f1c08bf70fe5e6c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a077433cf89be07232e26627ff8e10831"><td class="memItemLeft" align="right" valign="top"><a id="a077433cf89be07232e26627ff8e10831"></a>
<a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> </td><td class="memItemRight" valign="bottom"><b>lzma_lzma_encoder_init</b> (<a class="el" href="structlzma__next__coder__s.html">lzma_next_coder</a> *next, const <a class="el" href="structlzma__allocator.html">lzma_allocator</a> *allocator, const <a class="el" href="structlzma__filter__info__s.html">lzma_filter_info</a> *<a class="el" href="coder_8c.html#a9325236d5759d4eaadcba08a6bb5c96f">filters</a>)</td></tr>
<tr class="separator:a077433cf89be07232e26627ff8e10831"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69751f4a64caf8d24a2f94b0301e04c2"><td class="memItemLeft" align="right" valign="top"><a id="a69751f4a64caf8d24a2f94b0301e04c2"></a>
uint64_t </td><td class="memItemRight" valign="bottom"><b>lzma_lzma_encoder_memusage</b> (const void *options)</td></tr>
<tr class="separator:a69751f4a64caf8d24a2f94b0301e04c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a24e42d27f537c4382fe298c9909b1a52"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="lzma__encoder_8c.html#a24e42d27f537c4382fe298c9909b1a52">lzma_lzma_lclppb_encode</a> (const <a class="el" href="structlzma__options__lzma.html">lzma_options_lzma</a> *options, uint8_t *byte)</td></tr>
<tr class="memdesc:a24e42d27f537c4382fe298c9909b1a52"><td class="mdescLeft"> </td><td class="mdescRight">Encodes lc/lp/pb into one byte. Returns false on success and true on error. <a href="#a24e42d27f537c4382fe298c9909b1a52">More...</a><br /></td></tr>
<tr class="separator:a24e42d27f537c4382fe298c9909b1a52"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1ec0561a8ed9889cb8c049d484c2c5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="base_8h.html#abbc819c74b484c846825ae1388a50a59">lzma_bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lzma__encoder_8c.html#ac1ec0561a8ed9889cb8c049d484c2c5c">lzma_mode_is_supported</a> (<a class="el" href="lzma12_8h.html#a1032316e3075c2c8086fb17104b91866">lzma_mode</a> mode)</td></tr>
<tr class="memdesc:ac1ec0561a8ed9889cb8c049d484c2c5c"><td class="mdescLeft"> </td><td class="mdescRight">Test if given compression mode is supported. <a href="#ac1ec0561a8ed9889cb8c049d484c2c5c">More...</a><br /></td></tr>
<tr class="separator:ac1ec0561a8ed9889cb8c049d484c2c5c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>LZMA encoder. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a25303b6c550125f26a297dc0847e72a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25303b6c550125f26a297dc0847e72a9">◆ </a></span>LOOP_INPUT_MAX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LOOP_INPUT_MAX   (OPTS + 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of bytes that a single encoding loop in lzma_lzma_encode() can consume from the dictionary. This limit comes from lzma_lzma_optimum() and may need to be updated if that function is significantly modified. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a24e42d27f537c4382fe298c9909b1a52"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a24e42d27f537c4382fe298c9909b1a52">◆ </a></span>lzma_lzma_lclppb_encode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lzma_lzma_lclppb_encode </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structlzma__options__lzma.html">lzma_options_lzma</a> * </td>
<td class="paramname"><em>options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t * </td>
<td class="paramname"><em>byte</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Encodes lc/lp/pb into one byte. Returns false on success and true on error. </p>
<p class="reference">References <a class="el" href="lzma__common_8h.html#aedd478d0358af2297a6cac1d73540e85">is_lclppb_valid()</a>, <a class="el" href="structlzma__options__lzma.html#a95f6188e5b5f05c50ec463a315df3585">lzma_options_lzma::lc</a>, <a class="el" href="structlzma__options__lzma.html#a0fe9c54e808fce3090b6994d95fe41fe">lzma_options_lzma::lp</a>, and <a class="el" href="structlzma__options__lzma.html#acae107b3d3e9d0d4fe16103be22f4408">lzma_options_lzma::pb</a>.</p>
</div>
</div>
<a id="ac1ec0561a8ed9889cb8c049d484c2c5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1ec0561a8ed9889cb8c049d484c2c5c">◆ </a></span>lzma_mode_is_supported()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="base_8h.html#abbc819c74b484c846825ae1388a50a59">lzma_bool</a> lzma_mode_is_supported </td>
<td>(</td>
<td class="paramtype"><a class="el" href="lzma12_8h.html#a1032316e3075c2c8086fb17104b91866">lzma_mode</a> </td>
<td class="paramname"><em>mode</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if given compression mode is supported. </p>
<p>Return true if the given compression mode is supported by this liblzma build. Otherwise false is returned. It is safe to call this with a value that isn't listed in lzma_mode enumeration; the return value will be false.</p>
<p>There is no way to list which modes are available in this particular liblzma version and build. It would be useless, because a new compression mode, which the application developer wasn't aware, could require giving additional options to the encoder that the older modes don't need. </p>
<p class="reference">References <a class="el" href="lzma12_8h.html#a1032316e3075c2c8086fb17104b91866ac8c0926a91b4f756e11121efd30648cc">LZMA_MODE_FAST</a>, and <a class="el" href="lzma12_8h.html#a1032316e3075c2c8086fb17104b91866ad37225f30d5cd21fc8bb3eaba283bbf9">LZMA_MODE_NORMAL</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|