aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2025-12-16 19:24:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
55b688c5227965173f8cd40a12aa864f7e0a3bcc
libaaruformat/docs/html/structaaru__options.html

375 lines
20 KiB
HTML
Raw Normal View History

Add doxygen documentation
2025-10-11 01:35:43 +01:00
<!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: aaru_options 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>
<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">&#160;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('structaaru__options.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">aaru_options Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Parsed user-specified tunables controlling compression, deduplication, hashing and DDT geometry.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="options_8h_source.html">aaruformat/structs/options.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a4db2ac219f4d13ff2c35b8d62babaca2" id="r_a4db2ac219f4d13ff2c35b8d62babaca2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4db2ac219f4d13ff2c35b8d62babaca2">compress</a></td></tr>
<tr class="memdesc:a4db2ac219f4d13ff2c35b8d62babaca2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable adaptive compression (LZMA for data blocks, FLAC for audio). Default: true. <br /></td></tr>
<tr class="memitem:a2d62d4cd6f1e59c145e3c4bc621f7d43" id="r_a2d62d4cd6f1e59c145e3c4bc621f7d43"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2d62d4cd6f1e59c145e3c4bc621f7d43">deduplicate</a></td></tr>
<tr class="memdesc:a2d62d4cd6f1e59c145e3c4bc621f7d43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Storage dedup flag (DDT always exists). <br /></td></tr>
<tr class="memitem:a471cdd9988e95b36ee132cd047576237" id="r_a471cdd9988e95b36ee132cd047576237"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a471cdd9988e95b36ee132cd047576237">dictionary</a></td></tr>
<tr class="memdesc:a471cdd9988e95b36ee132cd047576237"><td class="mdescLeft">&#160;</td><td class="mdescRight">LZMA dictionary size in bytes (&gt;= 4096 recommended). Default: 33554432 (32 MiB). <br /></td></tr>
<tr class="memitem:a8b82ce71c52cc737f7b73334e094a795" id="r_a8b82ce71c52cc737f7b73334e094a795"><td class="memItemLeft" align="right" valign="top">int8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8b82ce71c52cc737f7b73334e094a795">table_shift</a></td></tr>
<tr class="memdesc:a8b82ce71c52cc737f7b73334e094a795"><td class="mdescLeft">&#160;</td><td class="mdescRight">DDT table shift (multi-level fan-out exponent). Default: heuristically calculated. <br /></td></tr>
<tr class="memitem:a3b6341d5cbd1ed2c4ff0686cd88de753" id="r_a3b6341d5cbd1ed2c4ff0686cd88de753"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3b6341d5cbd1ed2c4ff0686cd88de753">data_shift</a></td></tr>
<tr class="memdesc:a3b6341d5cbd1ed2c4ff0686cd88de753"><td class="mdescLeft">&#160;</td><td class="mdescRight">Global data shift: low bits encode sector offset inside a block (2^data_shift span). <br /></td></tr>
<tr class="memitem:aea2e536712f73ad12dcca704b47dc48c" id="r_aea2e536712f73ad12dcca704b47dc48c"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aea2e536712f73ad12dcca704b47dc48c">block_alignment</a></td></tr>
<tr class="memdesc:aea2e536712f73ad12dcca704b47dc48c"><td class="mdescLeft">&#160;</td><td class="mdescRight">log2 underlying block alignment (2^n bytes). Default: 9 (512 bytes). <br /></td></tr>
<tr class="memitem:a93c09eed5b0613fa25dd84c7d3c2a416" id="r_a93c09eed5b0613fa25dd84c7d3c2a416"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a93c09eed5b0613fa25dd84c7d3c2a416">md5</a></td></tr>
<tr class="memdesc:a93c09eed5b0613fa25dd84c7d3c2a416"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate MD5 checksum (ChecksumAlgorithm::Md5) when finalizing image. <br /></td></tr>
<tr class="memitem:ae3ff963481af06c7e097bdaa0c925bb6" id="r_ae3ff963481af06c7e097bdaa0c925bb6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae3ff963481af06c7e097bdaa0c925bb6">sha1</a></td></tr>
<tr class="memdesc:ae3ff963481af06c7e097bdaa0c925bb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate SHA-1 checksum (ChecksumAlgorithm::Sha1) when finalizing image. <br /></td></tr>
<tr class="memitem:a522d922c2ab6e04ce8e7051aaf953093" id="r_a522d922c2ab6e04ce8e7051aaf953093"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a522d922c2ab6e04ce8e7051aaf953093">sha256</a></td></tr>
<tr class="memdesc:a522d922c2ab6e04ce8e7051aaf953093"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate SHA-256 checksum (ChecksumAlgorithm::Sha256) when finalizing image. <br /></td></tr>
<tr class="memitem:abfbdc9267e6db5222e04ffd5a963b3a7" id="r_abfbdc9267e6db5222e04ffd5a963b3a7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abfbdc9267e6db5222e04ffd5a963b3a7">blake3</a></td></tr>
<tr class="memdesc:abfbdc9267e6db5222e04ffd5a963b3a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate BLAKE3 checksum if supported (not stored if algorithm unavailable). <br /></td></tr>
<tr class="memitem:a623a984dfec7abd375e7ef3d97333a4f" id="r_a623a984dfec7abd375e7ef3d97333a4f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a623a984dfec7abd375e7ef3d97333a4f">spamsum</a></td></tr>
<tr class="memdesc:a623a984dfec7abd375e7ef3d97333a4f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generate SpamSum fuzzy hash (ChecksumAlgorithm::SpamSum) if enabled. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Parsed user-specified tunables controlling compression, deduplication, hashing and DDT geometry. </p>
<p>All shifts are exponents of two. </p>
<p class="definition">Definition at line <a class="el" href="options_8h_source.html#l00216">216</a> of file <a class="el" href="options_8h_source.html">options.h</a>.</p>
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Field Documentation</h2>
<a id="abfbdc9267e6db5222e04ffd5a963b3a7" name="abfbdc9267e6db5222e04ffd5a963b3a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfbdc9267e6db5222e04ffd5a963b3a7">&#9670;&#160;</a></span>blake3</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool aaru_options::blake3</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate BLAKE3 checksum if supported (not stored if algorithm unavailable). </p>
<p class="definition">Definition at line <a class="el" href="options_8h_source.html#l00228">228</a> of file <a class="el" href="options_8h_source.html">options.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="options_8c_source.html#l00038">parse_options()</a>.</p>
</div>
</div>
<a id="aea2e536712f73ad12dcca704b47dc48c" name="aea2e536712f73ad12dcca704b47dc48c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea2e536712f73ad12dcca704b47dc48c">&#9670;&#160;</a></span>block_alignment</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t aaru_options::block_alignment</td>
</tr>
</table>
</div><div class="memdoc">
<p>log2 underlying block alignment (2^n bytes). Default: 9 (512 bytes). </p>
<p class="definition">Definition at line <a class="el" href="options_8h_source.html#l00224">224</a> of file <a class="el" href="options_8h_source.html">options.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="options_8c_source.html#l00038">parse_options()</a>.</p>
</div>
</div>
<a id="a4db2ac219f4d13ff2c35b8d62babaca2" name="a4db2ac219f4d13ff2c35b8d62babaca2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4db2ac219f4d13ff2c35b8d62babaca2">&#9670;&#160;</a></span>compress</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool aaru_options::compress</td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable adaptive compression (LZMA for data blocks, FLAC for audio). Default: true. </p>
<p class="definition">Definition at line <a class="el" href="options_8h_source.html#l00218">218</a> of file <a class="el" href="options_8h_source.html">options.h</a>.</p>
Update documentation.
2025-10-21 14:23:35 +01:00
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00223">aaruf_open()</a>, and <a class="el" href="options_8c_source.html#l00038">parse_options()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a3b6341d5cbd1ed2c4ff0686cd88de753" name="a3b6341d5cbd1ed2c4ff0686cd88de753"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b6341d5cbd1ed2c4ff0686cd88de753">&#9670;&#160;</a></span>data_shift</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t aaru_options::data_shift</td>
</tr>
</table>
</div><div class="memdoc">
<p>Global data shift: low bits encode sector offset inside a block (2^data_shift span). </p>
<p class="definition">Definition at line <a class="el" href="options_8h_source.html#l00223">223</a> of file <a class="el" href="options_8h_source.html">options.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="options_8c_source.html#l00038">parse_options()</a>.</p>
</div>
</div>
<a id="a2d62d4cd6f1e59c145e3c4bc621f7d43" name="a2d62d4cd6f1e59c145e3c4bc621f7d43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d62d4cd6f1e59c145e3c4bc621f7d43">&#9670;&#160;</a></span>deduplicate</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool aaru_options::deduplicate</td>
</tr>
</table>
</div><div class="memdoc">
<p>Storage dedup flag (DDT always exists). </p>
<p>true=share identical sector content, false=store each instance. </p>
<p class="definition">Definition at line <a class="el" href="options_8h_source.html#l00219">219</a> of file <a class="el" href="options_8h_source.html">options.h</a>.</p>
Update documentation.
2025-10-21 14:23:35 +01:00
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00223">aaruf_open()</a>, and <a class="el" href="options_8c_source.html#l00038">parse_options()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a471cdd9988e95b36ee132cd047576237" name="a471cdd9988e95b36ee132cd047576237"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a471cdd9988e95b36ee132cd047576237">&#9670;&#160;</a></span>dictionary</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t aaru_options::dictionary</td>
</tr>
</table>
</div><div class="memdoc">
<p>LZMA dictionary size in bytes (&gt;= 4096 recommended). Default: 33554432 (32 MiB). </p>
<p class="definition">Definition at line <a class="el" href="options_8h_source.html#l00221">221</a> of file <a class="el" href="options_8h_source.html">options.h</a>.</p>
Update documentation.
2025-10-21 14:23:35 +01:00
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, <a class="el" href="open_8c_source.html#l00223">aaruf_open()</a>, and <a class="el" href="options_8c_source.html#l00038">parse_options()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a93c09eed5b0613fa25dd84c7d3c2a416" name="a93c09eed5b0613fa25dd84c7d3c2a416"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a93c09eed5b0613fa25dd84c7d3c2a416">&#9670;&#160;</a></span>md5</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool aaru_options::md5</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate MD5 checksum (ChecksumAlgorithm::Md5) when finalizing image. </p>
<p class="definition">Definition at line <a class="el" href="options_8h_source.html#l00225">225</a> of file <a class="el" href="options_8h_source.html">options.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="options_8c_source.html#l00038">parse_options()</a>.</p>
</div>
</div>
<a id="ae3ff963481af06c7e097bdaa0c925bb6" name="ae3ff963481af06c7e097bdaa0c925bb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3ff963481af06c7e097bdaa0c925bb6">&#9670;&#160;</a></span>sha1</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool aaru_options::sha1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate SHA-1 checksum (ChecksumAlgorithm::Sha1) when finalizing image. </p>
<p class="definition">Definition at line <a class="el" href="options_8h_source.html#l00226">226</a> of file <a class="el" href="options_8h_source.html">options.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="options_8c_source.html#l00038">parse_options()</a>.</p>
</div>
</div>
<a id="a522d922c2ab6e04ce8e7051aaf953093" name="a522d922c2ab6e04ce8e7051aaf953093"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a522d922c2ab6e04ce8e7051aaf953093">&#9670;&#160;</a></span>sha256</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool aaru_options::sha256</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate SHA-256 checksum (ChecksumAlgorithm::Sha256) when finalizing image. </p>
<p class="definition">Definition at line <a class="el" href="options_8h_source.html#l00227">227</a> of file <a class="el" href="options_8h_source.html">options.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="options_8c_source.html#l00038">parse_options()</a>.</p>
</div>
</div>
<a id="a623a984dfec7abd375e7ef3d97333a4f" name="a623a984dfec7abd375e7ef3d97333a4f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a623a984dfec7abd375e7ef3d97333a4f">&#9670;&#160;</a></span>spamsum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool aaru_options::spamsum</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generate SpamSum fuzzy hash (ChecksumAlgorithm::SpamSum) if enabled. </p>
<p class="definition">Definition at line <a class="el" href="options_8h_source.html#l00229">229</a> of file <a class="el" href="options_8h_source.html">options.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="options_8c_source.html#l00038">parse_options()</a>.</p>
</div>
</div>
<a id="a8b82ce71c52cc737f7b73334e094a795" name="a8b82ce71c52cc737f7b73334e094a795"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b82ce71c52cc737f7b73334e094a795">&#9670;&#160;</a></span>table_shift</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t aaru_options::table_shift</td>
</tr>
</table>
</div><div class="memdoc">
<p>DDT table shift (multi-level fan-out exponent). Default: heuristically calculated. </p>
<p class="definition">Definition at line <a class="el" href="options_8h_source.html#l00222">222</a> of file <a class="el" href="options_8h_source.html">options.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="create_8c_source.html#l00279">aaruf_create()</a>, and <a class="el" href="options_8c_source.html#l00038">parse_options()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/aaruformat/structs/<a class="el" href="options_8h_source.html">options.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="structaaru__options.html">aaru_options</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 Copy Permalink