/usr/share/doc/liblzma-doc/html/filter__decoder_8c.html is in liblzma-doc 5.2.2-1.2.
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 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 | <!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>XZ Utils: liblzma/common/filter_decoder.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.12 -->
<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_db777975f8e21a5de5f283e04473bf67.html">common</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">filter_decoder.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Filter ID mapping to filter-specific functions.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "filter_decoder.h"</code><br />
<code>#include "filter_common.h"</code><br />
<code>#include "<a class="el" href="lzma__decoder_8h.html">lzma_decoder.h</a>"</code><br />
<code>#include "<a class="el" href="lzma2__decoder_8h.html">lzma2_decoder.h</a>"</code><br />
<code>#include "<a class="el" href="simple__decoder_8h.html">simple_decoder.h</a>"</code><br />
<code>#include "<a class="el" href="delta__decoder_8h.html">delta_decoder.h</a>"</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__filter__decoder.html">lzma_filter_decoder</a></td></tr>
<tr class="separator:"><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:afbf0bd59d92526737af9e077759de3ae"><td class="memItemLeft" align="right" valign="top"><a id="afbf0bd59d92526737af9e077759de3ae"></a>
static const <a class="el" href="structlzma__filter__decoder.html">lzma_filter_decoder</a> * </td><td class="memItemRight" valign="bottom"><b>decoder_find</b> (<a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> <a class="el" href="filter__common_8c.html#a3ee597b96b2ff619e515fac79a1ba1c5">id</a>)</td></tr>
<tr class="separator:afbf0bd59d92526737af9e077759de3ae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad930583b7cd35258f837218ed08ad519"><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="filter__decoder_8c.html#ad930583b7cd35258f837218ed08ad519">lzma_filter_decoder_is_supported</a> (<a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> <a class="el" href="filter__common_8c.html#a3ee597b96b2ff619e515fac79a1ba1c5">id</a>)</td></tr>
<tr class="memdesc:ad930583b7cd35258f837218ed08ad519"><td class="mdescLeft"> </td><td class="mdescRight">Test if the given Filter ID is supported for decoding. <a href="#ad930583b7cd35258f837218ed08ad519">More...</a><br /></td></tr>
<tr class="separator:ad930583b7cd35258f837218ed08ad519"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afb9c6de5af9b5ef81adad334376640d2"><td class="memItemLeft" align="right" valign="top"><a id="afb9c6de5af9b5ef81adad334376640d2"></a>
<a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> </td><td class="memItemRight" valign="bottom"><b>lzma_raw_decoder_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.html">lzma_filter</a> *options)</td></tr>
<tr class="separator:afb9c6de5af9b5ef81adad334376640d2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a387ecaa6c881a89021cf577d719490bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="filter__decoder_8c.html#a387ecaa6c881a89021cf577d719490bb">lzma_raw_decoder</a> (<a class="el" href="structlzma__stream.html">lzma_stream</a> *<a class="el" href="coder_8c.html#a048a6ae6a7da50de565b15d52ea9fafe">strm</a>, const <a class="el" href="structlzma__filter.html">lzma_filter</a> *options)</td></tr>
<tr class="memdesc:a387ecaa6c881a89021cf577d719490bb"><td class="mdescLeft"> </td><td class="mdescRight">Initialize raw decoder. <a href="#a387ecaa6c881a89021cf577d719490bb">More...</a><br /></td></tr>
<tr class="separator:a387ecaa6c881a89021cf577d719490bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeb9d987a56f532c873031a259933780a"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="filter__decoder_8c.html#aeb9d987a56f532c873031a259933780a">lzma_raw_decoder_memusage</a> (const <a class="el" href="structlzma__filter.html">lzma_filter</a> *<a class="el" href="coder_8c.html#a9325236d5759d4eaadcba08a6bb5c96f">filters</a>)</td></tr>
<tr class="memdesc:aeb9d987a56f532c873031a259933780a"><td class="mdescLeft"> </td><td class="mdescRight">Calculate approximate memory requirements for raw decoder. <a href="#aeb9d987a56f532c873031a259933780a">More...</a><br /></td></tr>
<tr class="separator:aeb9d987a56f532c873031a259933780a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a635078a694b22a3e5fc36b1fa643a704"><td class="memItemLeft" align="right" valign="top"><a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="filter__decoder_8c.html#a635078a694b22a3e5fc36b1fa643a704">lzma_properties_decode</a> (<a class="el" href="structlzma__filter.html">lzma_filter</a> *filter, const <a class="el" href="structlzma__allocator.html">lzma_allocator</a> *allocator, const uint8_t *props, size_t props_size)</td></tr>
<tr class="memdesc:a635078a694b22a3e5fc36b1fa643a704"><td class="mdescLeft"> </td><td class="mdescRight">Decode the Filter Properties field. <a href="#a635078a694b22a3e5fc36b1fa643a704">More...</a><br /></td></tr>
<tr class="separator:a635078a694b22a3e5fc36b1fa643a704"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a21d3250423ab7f69d47731bfede5e1c8"><td class="memItemLeft" align="right" valign="top"><a id="a21d3250423ab7f69d47731bfede5e1c8"></a>
static const <a class="el" href="structlzma__filter__decoder.html">lzma_filter_decoder</a> </td><td class="memItemRight" valign="bottom"><b>decoders</b> []</td></tr>
<tr class="separator:a21d3250423ab7f69d47731bfede5e1c8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Filter ID mapping to filter-specific functions. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ad930583b7cd35258f837218ed08ad519"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad930583b7cd35258f837218ed08ad519">§ </a></span>lzma_filter_decoder_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_filter_decoder_is_supported </td>
<td>(</td>
<td class="paramtype"><a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> </td>
<td class="paramname"><em>id</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if the given Filter ID is supported for decoding. </p>
<p>Return true if the give Filter ID is supported for decoding by this liblzma build. Otherwise false is returned. </p>
</div>
</div>
<a id="a387ecaa6c881a89021cf577d719490bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a387ecaa6c881a89021cf577d719490bb">§ </a></span>lzma_raw_decoder()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> lzma_raw_decoder </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlzma__stream.html">lzma_stream</a> * </td>
<td class="paramname"><em>strm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structlzma__filter.html">lzma_filter</a> * </td>
<td class="paramname"><em>filters</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize raw decoder. </p>
<p>The initialization of raw decoder goes similarly to raw encoder.</p>
<p>The `action' with <a class="el" href="base_8h.html#a28cc09bc422d5ba1e0187c9f2af5d957" title="Encode or decode data. ">lzma_code()</a> can be LZMA_RUN or LZMA_FINISH. Using LZMA_FINISH is not required, it is supported just for convenience.</p>
<dl class="section return"><dt>Returns</dt><dd>- LZMA_OK<ul>
<li>LZMA_MEM_ERROR</li>
<li>LZMA_OPTIONS_ERROR</li>
<li>LZMA_PROG_ERROR </li>
</ul>
</dd></dl>
<p>References <a class="el" href="common_8h.html#a844da62faaaf4c19a9a297129bc30a8c">lzma_next_strm_init</a>.</p>
</div>
</div>
<a id="aeb9d987a56f532c873031a259933780a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb9d987a56f532c873031a259933780a">§ </a></span>lzma_raw_decoder_memusage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t lzma_raw_decoder_memusage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structlzma__filter.html">lzma_filter</a> * </td>
<td class="paramname"><em>filters</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate approximate memory requirements for raw decoder. </p>
<p>This function can be used to calculate the memory requirements for Block and Stream decoders too because Block and Stream decoders don't need significantly more memory than raw decoder.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filters</td><td>Array of filters terminated with .id == LZMA_VLI_UNKNOWN.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Number of bytes of memory required for the given filter chain when decoding. If an error occurs, for example due to unsupported filter chain, UINT64_MAX is returned. </dd></dl>
</div>
</div>
<a id="a635078a694b22a3e5fc36b1fa643a704"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a635078a694b22a3e5fc36b1fa643a704">§ </a></span>lzma_properties_decode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="base_8h.html#a8494e0457e1463d6d2b6836018d87b6e">lzma_ret</a> lzma_properties_decode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structlzma__filter.html">lzma_filter</a> * </td>
<td class="paramname"><em>filter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structlzma__allocator.html">lzma_allocator</a> * </td>
<td class="paramname"><em>allocator</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>props</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>props_size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Decode the Filter Properties field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filter</td><td>filter->id must have been set to the correct Filter ID. filter->options doesn't need to be initialized (it's not freed by this function). The decoded options will be stored to filter->options. filter->options is set to NULL if there are no properties or if an error occurs. </td></tr>
<tr><td class="paramname">allocator</td><td>Custom memory allocator used to allocate the options. Set to NULL to use the default malloc(), and in case of an error, also free(). </td></tr>
<tr><td class="paramname">props</td><td>Input buffer containing the properties. </td></tr>
<tr><td class="paramname">props_size</td><td>Size of the properties. This must be the exact size; giving too much or too little input will return LZMA_OPTIONS_ERROR.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- LZMA_OK<ul>
<li>LZMA_OPTIONS_ERROR</li>
<li>LZMA_MEM_ERROR </li>
</ul>
</dd></dl>
<p>Referenced by <a class="el" href="coder_8c.html#a15b6ce144220e53107c642b3baefe9bc">is_format_lzma()</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.12
</small></address>
</body>
</html>
|