aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2026-02-16 13:35:20 +00:00
Code Issues 3 Packages Projects Releases Wiki Activity
Files
devel
libaaruformat/docs/html/annotated.html

168 lines
23 KiB
HTML
Raw Permalink 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"/>
Updated doxygen documentation.
2025-12-21 20:17:32 +00:00
<meta name="generator" content="Doxygen 1.15.0"/>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: Data Structures</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 -->
Updated doxygen documentation.
2025-12-21 20:17:32 +00:00
<!-- Generated by Doxygen 1.15.0 -->
Add doxygen documentation
2025-10-11 01:35:43 +01:00
<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('annotated.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">Data Structures</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the data structures with brief descriptions:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structaaru__flac__ctx.html" target="_self">aaru_flac_ctx</a></td><td class="desc"></td></tr>
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structaaru__options.html" target="_self">aaru_options</a></td><td class="desc">Parsed user-specified tunables controlling compression, deduplication, hashing and DDT geometry </td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structaaruformat__context.html" target="_self">aaruformat_context</a></td><td class="desc">Master context representing an open or in‑creation Aaru image </td></tr>
<tr id="row_3_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structAaruHeader.html" target="_self">AaruHeader</a></td><td class="desc">Version 1 container header placed at offset 0 for legacy / initial format </td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structAaruHeaderV2.html" target="_self">AaruHeaderV2</a></td><td class="desc">Version 2 container header with GUID, alignment shifts, and feature negotiation bitmaps </td></tr>
<tr id="row_5_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structAaruMetadataJsonBlockHeader.html" target="_self">AaruMetadataJsonBlockHeader</a></td><td class="desc">Header for an Aaru metadata JSON block (identifier == BlockType::AaruMetadataJsonBlock) </td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structblockhash__ctx.html" target="_self">blockhash_ctx</a></td><td class="desc"></td></tr>
<tr id="row_7_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structBlockHeader.html" target="_self">BlockHeader</a></td><td class="desc">Header preceding the compressed data payload of a data block (BlockType::DataBlock) </td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structCacheEntry.html" target="_self">CacheEntry</a></td><td class="desc">Single hash entry in the in-memory cache </td></tr>
<tr id="row_9_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structCacheHeader.html" target="_self">CacheHeader</a></td><td class="desc">Cache top-level descriptor encapsulating the hash table root and capacity limit </td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structCdEccContext.html" target="_self">CdEccContext</a></td><td class="desc">Lookup tables and state for Compact Disc EDC/ECC (P/Q) regeneration / verification </td></tr>
<tr id="row_11_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structChecksumEntry.html" target="_self">ChecksumEntry</a></td><td class="desc">Per-checksum metadata immediately followed by the digest / signature bytes </td></tr>
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structChecksumHeader.html" target="_self">ChecksumHeader</a></td><td class="desc">Header that precedes the sequence of checksum entries for a checksum block </td></tr>
<tr id="row_13_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structChecksums.html" target="_self">Checksums</a></td><td class="desc">Collected whole‑image checksums / hashes present in a checksum block </td></tr>
<tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structCicmMetadataBlock.html" target="_self">CicmMetadataBlock</a></td><td class="desc">Header for a CICM XML metadata block (identifier == BlockType::CicmBlock) </td></tr>
<tr id="row_15_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structcrc64__ctx.html" target="_self">crc64_ctx</a></td><td class="desc">Minimal ECMA-182 CRC64 incremental state container (running value only) </td></tr>
Update doxygen documentation.
2026-01-04 16:05:30 +00:00
<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structDataStreamPayloadHeader.html" target="_self">DataStreamPayloadHeader</a></td><td class="desc">Header structure for a DataStreamPayloadBlock containing data stream payload </td></tr>
<tr id="row_17_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structDdtHeader.html" target="_self">DdtHeader</a></td><td class="desc">Header preceding a version 1 (flat) deduplication table body </td></tr>
<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structDdtHeader2.html" target="_self">DdtHeader2</a></td><td class="desc">Header preceding a version 2 hierarchical deduplication table </td></tr>
<tr id="row_19_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structDumpExtent.html" target="_self">DumpExtent</a></td><td class="desc">Inclusive [start,end] logical sector range contributed by a single hardware environment </td></tr>
<tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structDumpHardwareEntriesWithData.html" target="_self">DumpHardwareEntriesWithData</a></td><td class="desc">In-memory representation of a dump hardware entry plus decoded variable-length fields &amp; extents </td></tr>
<tr id="row_21_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structDumpHardwareEntry.html" target="_self">DumpHardwareEntry</a></td><td class="desc">Per-environment length table describing subsequent UTF-8 strings and optional extent array </td></tr>
<tr id="row_22_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structDumpHardwareHeader.html" target="_self">DumpHardwareHeader</a></td><td class="desc">Header that precedes a sequence of dump hardware entries and their variable-length payload </td></tr>
<tr id="row_23_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structFluxCaptureKey.html" target="_self">FluxCaptureKey</a></td><td class="desc">Key structure for flux capture lookup map </td></tr>
<tr id="row_24_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structFluxCaptureMapEntry.html" target="_self">FluxCaptureMapEntry</a></td><td class="desc">Internal hash table entry for flux capture lookup </td></tr>
<tr id="row_25_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structFluxCaptureMeta.html" target="_self">FluxCaptureMeta</a></td><td class="desc">Metadata structure returned by <a class="el" href="decls_8h.html#a5f50a859c1849d13a6f4d26d904fb458" title="Retrieve metadata for all flux captures in the image.">aaruf_get_flux_captures()</a> </td></tr>
<tr id="row_26_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structFluxCaptureRecord.html" target="_self">FluxCaptureRecord</a></td><td class="desc">Internal structure for storing flux capture data during write mode </td></tr>
<tr id="row_27_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structFluxEntry.html" target="_self">FluxEntry</a></td><td class="desc">Metadata entry describing a single flux capture in the FluxDataBlock </td></tr>
<tr id="row_28_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structFluxHeader.html" target="_self">FluxHeader</a></td><td class="desc">Header structure for a FluxDataBlock containing flux capture metadata </td></tr>
<tr id="row_29_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structGeometryBlockHeader.html" target="_self">GeometryBlockHeader</a></td><td class="desc">Legacy CHS style logical geometry metadata (BlockType::GeometryBlock) </td></tr>
<tr id="row_30_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structhash__map__t.html" target="_self">hash_map_t</a></td><td class="desc">Minimal open-addressing hash map for 64-bit key/value pairs used in deduplication lookup </td></tr>
<tr id="row_31_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structImageInfo.html" target="_self">ImageInfo</a></td><td class="desc">High-level summary of an opened Aaru image containing metadata and media characteristics </td></tr>
<tr id="row_32_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structIndexEntry.html" target="_self">IndexEntry</a></td><td class="desc">Single index entry describing a block's type, (optional) data classification, and file offset </td></tr>
<tr id="row_33_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structIndexHeader.html" target="_self">IndexHeader</a></td><td class="desc">Index header (version 1) for legacy images (identifier == IndexBlock) </td></tr>
<tr id="row_34_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structIndexHeader2.html" target="_self">IndexHeader2</a></td><td class="desc">Index header (version 2) with 64‑bit entry counter (identifier == IndexBlock2) </td></tr>
<tr id="row_35_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structIndexHeader3.html" target="_self">IndexHeader3</a></td><td class="desc">Index header (version 3) adding hierarchical chaining (identifier == IndexBlock3) </td></tr>
<tr id="row_36_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structkv__pair__t.html" target="_self">kv_pair_t</a></td><td class="desc">Single key/value slot used internally by the open-addressing hash map </td></tr>
<tr id="row_37_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structlru__kv__pair__t.html" target="_self">lru_kv_pair_t</a></td><td class="desc">Single key/value slot with access tracking for the static LRU hash map </td></tr>
<tr id="row_38_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmd5__ctx.html" target="_self">md5_ctx</a></td><td class="desc"></td></tr>
<tr id="row_39_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmediaTagEntry.html" target="_self">mediaTagEntry</a></td><td class="desc">Hash table entry for an arbitrary media tag (e.g., proprietary drive/medium descriptor) </td></tr>
<tr id="row_40_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structMetadataBlockHeader.html" target="_self">MetadataBlockHeader</a></td><td class="desc">Header for a metadata block containing offsets and lengths to UTF-16LE descriptive strings </td></tr>
<tr id="row_41_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpriam__tag.html" target="_self">priam_tag</a></td><td class="desc"></td></tr>
<tr id="row_42_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structprofile__tag.html" target="_self">profile_tag</a></td><td class="desc"></td></tr>
<tr id="row_43_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structroll__state.html" target="_self">roll_state</a></td><td class="desc"></td></tr>
<tr id="row_44_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structsha1__ctx.html" target="_self">sha1_ctx</a></td><td class="desc"></td></tr>
<tr id="row_45_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structsha256__ctx.html" target="_self">sha256_ctx</a></td><td class="desc"></td></tr>
<tr id="row_46_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structsony__tag.html" target="_self">sony_tag</a></td><td class="desc"></td></tr>
<tr id="row_47_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structspamsum__ctx.html" target="_self">spamsum_ctx</a></td><td class="desc"></td></tr>
<tr id="row_48_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstatic__lru__hash__map__t.html" target="_self">static_lru_hash_map_t</a></td><td class="desc">Fixed-size hash map with LRU-like eviction for bounded memory usage </td></tr>
<tr id="row_49_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structTapeDdtHashEntry.html" target="_self">TapeDdtHashEntry</a></td><td class="desc"></td></tr>
<tr id="row_50_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structTapeFileEntry.html" target="_self">TapeFileEntry</a></td><td class="desc">Describes a single logical file on a tape medium </td></tr>
<tr id="row_51_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structTapeFileHashEntry.html" target="_self">TapeFileHashEntry</a></td><td class="desc"></td></tr>
<tr id="row_52_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structTapeFileHeader.html" target="_self">TapeFileHeader</a></td><td class="desc">Header for a tape file metadata block containing file layout information </td></tr>
<tr id="row_53_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structTapePartitionEntry.html" target="_self">TapePartitionEntry</a></td><td class="desc">Describes a single physical partition on a tape medium </td></tr>
<tr id="row_54_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structTapePartitionHashEntry.html" target="_self">TapePartitionHashEntry</a></td><td class="desc"></td></tr>
<tr id="row_55_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structTapePartitionHeader.html" target="_self">TapePartitionHeader</a></td><td class="desc">Header for a tape partition metadata block containing partition layout information </td></tr>
<tr id="row_56_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structTrackEntry.html" target="_self">TrackEntry</a></td><td class="desc">Single optical disc track descriptor (sequence, type, LBAs, session, ISRC, flags) </td></tr>
<tr id="row_57_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structTracksHeader.html" target="_self">TracksHeader</a></td><td class="desc">Header for an optical tracks block listing track entries </td></tr>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</table>
</div><!-- directory -->
</div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
Updated doxygen documentation.
2025-12-21 20:17:32 +00:00
<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.15.0 </li>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink