/usr/share/doc/liblzma-doc/html/structlzma__filter__encoder.html is in liblzma-doc 5.1.1alpha+20120614-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 | <!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"/>
<title>XZ Utils: lzma_filter_encoder Struct 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 style="padding-left: 0.5em;">
<div id="projectname">XZ Utils
 <span id="projectnumber">5.1.0alpha</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<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 class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">lzma_filter_encoder Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a419041594ea6c2a0e5a9797b7db0f4da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__filter__encoder.html#a419041594ea6c2a0e5a9797b7db0f4da">id</a></td></tr>
<tr class="memdesc:a419041594ea6c2a0e5a9797b7db0f4da"><td class="mdescLeft"> </td><td class="mdescRight">Filter ID. <a href="#a419041594ea6c2a0e5a9797b7db0f4da"></a><br/></td></tr>
<tr class="memitem:af1cf603cb718149fd04b3672a8205555"><td class="memItemLeft" align="right" valign="top"><a class="el" href="common_8h.html#a2897729ce4e6af56b4412222bdc4280f">lzma_init_function</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__filter__encoder.html#af1cf603cb718149fd04b3672a8205555">init</a></td></tr>
<tr class="memitem:ae3cfcdee71b8739e7adc2feed32e582c"><td class="memItemLeft" align="right" valign="top">uint64_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__filter__encoder.html#ae3cfcdee71b8739e7adc2feed32e582c">memusage</a> )(const void *options)</td></tr>
<tr class="memitem:aee12d626a914ce3216a4b801785a335b"><td class="memItemLeft" align="right" valign="top">uint64_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structlzma__filter__encoder.html#aee12d626a914ce3216a4b801785a335b">block_size</a> )(const void *options)</td></tr>
<tr class="memitem:a1546dc01c7ed513a1e62fc0b807214fc"><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="structlzma__filter__encoder.html#a1546dc01c7ed513a1e62fc0b807214fc">props_size_get</a> )(uint32_t *size, const void *options)</td></tr>
<tr class="memitem:ac9aac6677bf72c775bffe1b94d0bfc2b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9aac6677bf72c775bffe1b94d0bfc2b"></a>
uint32_t </td><td class="memItemRight" valign="bottom"><b>props_size_fixed</b></td></tr>
<tr class="memitem:adbaaf406e12224aab5430d857ba2655e"><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="structlzma__filter__encoder.html#adbaaf406e12224aab5430d857ba2655e">props_encode</a> )(const void *options, uint8_t *out)</td></tr>
</table>
<h2>Field Documentation</h2>
<a class="anchor" id="a419041594ea6c2a0e5a9797b7db0f4da"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="vli_8h.html#a1dbc0ffc3e72748f64df8f7f71898272">lzma_vli</a> lzma_filter_encoder::id</td>
</tr>
</table>
</div><div class="memdoc">
<p>Filter ID. </p>
</div>
</div>
<a class="anchor" id="af1cf603cb718149fd04b3672a8205555"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="common_8h.html#a2897729ce4e6af56b4412222bdc4280f">lzma_init_function</a> lzma_filter_encoder::init</td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the filter encoder and calls <a class="el" href="common_8h.html#a083a413c43195aed33e19b1d2c043f88">lzma_next_filter_init()</a> for filters + 1. </p>
</div>
</div>
<a class="anchor" id="ae3cfcdee71b8739e7adc2feed32e582c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t(* lzma_filter_encoder::memusage)(const void *options)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculates memory usage of the encoder. If the options are invalid, UINT64_MAX is returned. </p>
</div>
</div>
<a class="anchor" id="aee12d626a914ce3216a4b801785a335b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t(* lzma_filter_encoder::block_size)(const void *options)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculates the recommended Uncompressed Size for .xz Blocks to which the input data can be split to make multithreaded encoding possible. If this is NULL, it is assumed that the encoder is fast enough with single thread. </p>
</div>
</div>
<a class="anchor" id="a1546dc01c7ed513a1e62fc0b807214fc"></a>
<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_filter_encoder::props_size_get)(uint32_t *size, const void *options)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Tells the size of the Filter Properties field. If options are invalid, UINT32_MAX is returned. If this is NULL, props_size_fixed is used. </p>
<p>Referenced by <a class="el" href="filter__encoder_8c.html#a7ea8fcfdb19312ff323a78fb6d5ce908">lzma_properties_size()</a>.</p>
</div>
</div>
<a class="anchor" id="adbaaf406e12224aab5430d857ba2655e"></a>
<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_filter_encoder::props_encode)(const void *options, uint8_t *out)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Encodes Filter Properties.</p>
<dl class="section return"><dt>Returns</dt><dd>- LZMA_OK: Properties encoded successfully.<ul>
<li>LZMA_OPTIONS_ERROR: Unsupported options</li>
<li>LZMA_PROG_ERROR: Invalid options or not enough output space </li>
</ul>
</dd></dl>
<p>Referenced by <a class="el" href="filter__encoder_8c.html#a311b1198ed1c047fefc31071adb5600b">lzma_properties_encode()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>liblzma/common/<a class="el" href="filter__encoder_8c.html">filter_encoder.c</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Nov 18 2012 19:30:21 for XZ Utils by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>
|