mirror of
https://github.com/aaru-dps/libaaruformat.git
synced 2025-12-16 19:24:40 +00:00
Add doxygen documentation
This commit is contained in:
161
docs/html/options_8h_source.html
Normal file
161
docs/html/options_8h_source.html
Normal file
@@ -0,0 +1,161 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen 1.14.0"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>libaaruformat: include/aaruformat/structs/options.h Source File</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>
|
||||
<script type="text/javascript" src="clipboard.js"></script>
|
||||
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript" src="cookie.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.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 id="projectrow">
|
||||
<td id="projectalign">
|
||||
<div id="projectname">libaaruformat<span id="projectnumber"> 1.0</span>
|
||||
</div>
|
||||
<div id="projectbrief">Aaru Data Preservation Suite - Format Library</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.14.0 -->
|
||||
<script type="text/javascript">
|
||||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
$(function() { codefold.init(); });
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search',true);
|
||||
$(function() { init_search(); });
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></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">
|
||||
$(function(){initNavTree('options_8h_source.html','',''); });
|
||||
</script>
|
||||
<div id="container">
|
||||
<div id="doc-content">
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<div id="MSearchResults">
|
||||
<div class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div id="SRResults"></div>
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="headertitle"><div class="title">options.h</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<a href="options_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
|
||||
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * This file is part of the Aaru Data Preservation Suite.</span></div>
|
||||
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright (c) 2019-2025 Natalia Portillo.</span></div>
|
||||
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * This library is free software; you can redistribute it and/or modify</span></div>
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * it under the terms of the GNU Lesser General Public License as</span></div>
|
||||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * published by the Free Software Foundation; either version 2.1 of the</span></div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * License, or (at your option) any later version.</span></div>
|
||||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * This library is distributed in the hope that it will be useful, but</span></div>
|
||||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * Lesser General Public License for more details.</span></div>
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> *</span></div>
|
||||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
|
||||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * License along with this library; if not, see <http://www.gnu.org/licenses/>.</span></div>
|
||||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> */</span></div>
|
||||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
|
||||
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#ifndef LIBAARUFORMAT_OPTIONS_H</span></div>
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#define LIBAARUFORMAT_OPTIONS_H</span></div>
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
|
||||
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include <stdbool.h></span> </div>
|
||||
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <stdint.h></span> </div>
|
||||
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span></div>
|
||||
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span></div>
|
||||
<div class="foldopen" id="foldopen00216" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"><a class="line" href="structaaru__options.html"> 216</a></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
||||
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span>{</div>
|
||||
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"><a class="line" href="structaaru__options.html#a4db2ac219f4d13ff2c35b8d62babaca2"> 218</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structaaru__options.html#a4db2ac219f4d13ff2c35b8d62babaca2">compress</a>; </div>
|
||||
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"><a class="line" href="structaaru__options.html#a2d62d4cd6f1e59c145e3c4bc621f7d43"> 219</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structaaru__options.html#a2d62d4cd6f1e59c145e3c4bc621f7d43">deduplicate</a>; </div>
|
||||
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"><a class="line" href="structaaru__options.html#a471cdd9988e95b36ee132cd047576237"> 221</a></span> uint32_t <a class="code hl_variable" href="structaaru__options.html#a471cdd9988e95b36ee132cd047576237">dictionary</a>; </div>
|
||||
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"><a class="line" href="structaaru__options.html#a8b82ce71c52cc737f7b73334e094a795"> 222</a></span> int8_t <a class="code hl_variable" href="structaaru__options.html#a8b82ce71c52cc737f7b73334e094a795">table_shift</a>; </div>
|
||||
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"><a class="line" href="structaaru__options.html#a3b6341d5cbd1ed2c4ff0686cd88de753"> 223</a></span> uint8_t <a class="code hl_variable" href="structaaru__options.html#a3b6341d5cbd1ed2c4ff0686cd88de753">data_shift</a>; </div>
|
||||
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"><a class="line" href="structaaru__options.html#aea2e536712f73ad12dcca704b47dc48c"> 224</a></span> uint8_t <a class="code hl_variable" href="structaaru__options.html#aea2e536712f73ad12dcca704b47dc48c">block_alignment</a>; </div>
|
||||
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"><a class="line" href="structaaru__options.html#a93c09eed5b0613fa25dd84c7d3c2a416"> 225</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structaaru__options.html#a93c09eed5b0613fa25dd84c7d3c2a416">md5</a>; </div>
|
||||
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"><a class="line" href="structaaru__options.html#ae3ff963481af06c7e097bdaa0c925bb6"> 226</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structaaru__options.html#ae3ff963481af06c7e097bdaa0c925bb6">sha1</a>; </div>
|
||||
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"><a class="line" href="structaaru__options.html#a522d922c2ab6e04ce8e7051aaf953093"> 227</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structaaru__options.html#a522d922c2ab6e04ce8e7051aaf953093">sha256</a>; </div>
|
||||
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"><a class="line" href="structaaru__options.html#abfbdc9267e6db5222e04ffd5a963b3a7"> 228</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structaaru__options.html#abfbdc9267e6db5222e04ffd5a963b3a7">blake3</a>; </div>
|
||||
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"><a class="line" href="structaaru__options.html#a623a984dfec7abd375e7ef3d97333a4f"> 229</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structaaru__options.html#a623a984dfec7abd375e7ef3d97333a4f">spamsum</a>; </div>
|
||||
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span>} <a class="code hl_struct" href="structaaru__options.html">aaru_options</a>;</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> </div>
|
||||
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_OPTIONS_H</span></div>
|
||||
<div class="ttc" id="astructaaru__options_html"><div class="ttname"><a href="structaaru__options.html">aaru_options</a></div><div class="ttdoc">Parsed user-specified tunables controlling compression, deduplication, hashing and DDT geometry.</div><div class="ttdef"><b>Definition</b> <a href="#l00216">options.h:217</a></div></div>
|
||||
<div class="ttc" id="astructaaru__options_html_a2d62d4cd6f1e59c145e3c4bc621f7d43"><div class="ttname"><a href="structaaru__options.html#a2d62d4cd6f1e59c145e3c4bc621f7d43">aaru_options::deduplicate</a></div><div class="ttdeci">bool deduplicate</div><div class="ttdoc">Storage dedup flag (DDT always exists).</div><div class="ttdef"><b>Definition</b> <a href="#l00219">options.h:219</a></div></div>
|
||||
<div class="ttc" id="astructaaru__options_html_a3b6341d5cbd1ed2c4ff0686cd88de753"><div class="ttname"><a href="structaaru__options.html#a3b6341d5cbd1ed2c4ff0686cd88de753">aaru_options::data_shift</a></div><div class="ttdeci">uint8_t data_shift</div><div class="ttdoc">Global data shift: low bits encode sector offset inside a block (2^data_shift span).</div><div class="ttdef"><b>Definition</b> <a href="#l00223">options.h:223</a></div></div>
|
||||
<div class="ttc" id="astructaaru__options_html_a471cdd9988e95b36ee132cd047576237"><div class="ttname"><a href="structaaru__options.html#a471cdd9988e95b36ee132cd047576237">aaru_options::dictionary</a></div><div class="ttdeci">uint32_t dictionary</div><div class="ttdoc">LZMA dictionary size in bytes (>= 4096 recommended). Default: 33554432 (32 MiB).</div><div class="ttdef"><b>Definition</b> <a href="#l00221">options.h:221</a></div></div>
|
||||
<div class="ttc" id="astructaaru__options_html_a4db2ac219f4d13ff2c35b8d62babaca2"><div class="ttname"><a href="structaaru__options.html#a4db2ac219f4d13ff2c35b8d62babaca2">aaru_options::compress</a></div><div class="ttdeci">bool compress</div><div class="ttdoc">Enable adaptive compression (LZMA for data blocks, FLAC for audio). Default: true.</div><div class="ttdef"><b>Definition</b> <a href="#l00218">options.h:218</a></div></div>
|
||||
<div class="ttc" id="astructaaru__options_html_a522d922c2ab6e04ce8e7051aaf953093"><div class="ttname"><a href="structaaru__options.html#a522d922c2ab6e04ce8e7051aaf953093">aaru_options::sha256</a></div><div class="ttdeci">bool sha256</div><div class="ttdoc">Generate SHA-256 checksum (ChecksumAlgorithm::Sha256) when finalizing image.</div><div class="ttdef"><b>Definition</b> <a href="#l00227">options.h:227</a></div></div>
|
||||
<div class="ttc" id="astructaaru__options_html_a623a984dfec7abd375e7ef3d97333a4f"><div class="ttname"><a href="structaaru__options.html#a623a984dfec7abd375e7ef3d97333a4f">aaru_options::spamsum</a></div><div class="ttdeci">bool spamsum</div><div class="ttdoc">Generate SpamSum fuzzy hash (ChecksumAlgorithm::SpamSum) if enabled.</div><div class="ttdef"><b>Definition</b> <a href="#l00229">options.h:229</a></div></div>
|
||||
<div class="ttc" id="astructaaru__options_html_a8b82ce71c52cc737f7b73334e094a795"><div class="ttname"><a href="structaaru__options.html#a8b82ce71c52cc737f7b73334e094a795">aaru_options::table_shift</a></div><div class="ttdeci">int8_t table_shift</div><div class="ttdoc">DDT table shift (multi-level fan-out exponent). Default: heuristically calculated.</div><div class="ttdef"><b>Definition</b> <a href="#l00222">options.h:222</a></div></div>
|
||||
<div class="ttc" id="astructaaru__options_html_a93c09eed5b0613fa25dd84c7d3c2a416"><div class="ttname"><a href="structaaru__options.html#a93c09eed5b0613fa25dd84c7d3c2a416">aaru_options::md5</a></div><div class="ttdeci">bool md5</div><div class="ttdoc">Generate MD5 checksum (ChecksumAlgorithm::Md5) when finalizing image.</div><div class="ttdef"><b>Definition</b> <a href="#l00225">options.h:225</a></div></div>
|
||||
<div class="ttc" id="astructaaru__options_html_abfbdc9267e6db5222e04ffd5a963b3a7"><div class="ttname"><a href="structaaru__options.html#abfbdc9267e6db5222e04ffd5a963b3a7">aaru_options::blake3</a></div><div class="ttdeci">bool blake3</div><div class="ttdoc">Generate BLAKE3 checksum if supported (not stored if algorithm unavailable).</div><div class="ttdef"><b>Definition</b> <a href="#l00228">options.h:228</a></div></div>
|
||||
<div class="ttc" id="astructaaru__options_html_ae3ff963481af06c7e097bdaa0c925bb6"><div class="ttname"><a href="structaaru__options.html#ae3ff963481af06c7e097bdaa0c925bb6">aaru_options::sha1</a></div><div class="ttdeci">bool sha1</div><div class="ttdoc">Generate SHA-1 checksum (ChecksumAlgorithm::Sha1) when finalizing image.</div><div class="ttdef"><b>Definition</b> <a href="#l00226">options.h:226</a></div></div>
|
||||
<div class="ttc" id="astructaaru__options_html_aea2e536712f73ad12dcca704b47dc48c"><div class="ttname"><a href="structaaru__options.html#aea2e536712f73ad12dcca704b47dc48c">aaru_options::block_alignment</a></div><div class="ttdeci">uint8_t block_alignment</div><div class="ttdoc">log2 underlying block alignment (2^n bytes). Default: 9 (512 bytes).</div><div class="ttdef"><b>Definition</b> <a href="#l00224">options.h:224</a></div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
</div><!-- container -->
|
||||
<!-- start footer part -->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
<li class="navelem"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="dir_aeff2545c9dfcfc842fe9d84b123cb31.html">aaruformat</a></li><li class="navelem"><a href="dir_6387aeb6e475a334d8dc12d69f21999e.html">structs</a></li><li class="navelem"><a href="options_8h.html">options.h</a></li>
|
||||
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
|
||||
</ul>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user