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
f53092c9419c23941c845940125d0d3b580f415b
libaaruformat/docs/html/structImageInfo.html

476 lines
30 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: ImageInfo 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('structImageInfo.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">ImageInfo Struct Reference<div class="ingroups"><a class="el" href="group__MediaTypes.html">Media type classification</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>High-level summary of an opened Aaru image containing metadata and media characteristics.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="aaru_8h_source.html">aaru.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:a5f4e71687378856611c72604f63c2835" id="r_a5f4e71687378856611c72604f63c2835"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5f4e71687378856611c72604f63c2835">HasPartitions</a></td></tr>
<tr class="memdesc:a5f4e71687378856611c72604f63c2835"><td class="mdescLeft">&#160;</td><td class="mdescRight">Image contains partitions (or tracks for optical media); 0=no, non-zero=yes. <br /></td></tr>
<tr class="memitem:aaeb20c53439a89baaf21944b3c97f676" id="r_aaeb20c53439a89baaf21944b3c97f676"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaeb20c53439a89baaf21944b3c97f676">HasSessions</a></td></tr>
<tr class="memdesc:aaeb20c53439a89baaf21944b3c97f676"><td class="mdescLeft">&#160;</td><td class="mdescRight">Image contains multiple sessions (optical media); 0=single/none, non-zero=multi. <br /></td></tr>
<tr class="memitem:abca8e73a9655d810e6d30d36c3ab54d7" id="r_abca8e73a9655d810e6d30d36c3ab54d7"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abca8e73a9655d810e6d30d36c3ab54d7">ImageSize</a></td></tr>
<tr class="memdesc:abca8e73a9655d810e6d30d36c3ab54d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the image payload in bytes (excludes headers/metadata) <br /></td></tr>
<tr class="memitem:ae3e1b9cde1c51152b00eb1b59e199906" id="r_ae3e1b9cde1c51152b00eb1b59e199906"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae3e1b9cde1c51152b00eb1b59e199906">Sectors</a></td></tr>
<tr class="memdesc:ae3e1b9cde1c51152b00eb1b59e199906"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total count of addressable logical sectors/blocks. <br /></td></tr>
<tr class="memitem:aac1ac48f57afd415467cd6f13f01644b" id="r_aac1ac48f57afd415467cd6f13f01644b"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aac1ac48f57afd415467cd6f13f01644b">SectorSize</a></td></tr>
<tr class="memdesc:aac1ac48f57afd415467cd6f13f01644b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of each logical sector in bytes (512, 2048, 2352, 4096, etc.) <br /></td></tr>
<tr class="memitem:adce978941d9900c8c05e620df67f8c5c" id="r_adce978941d9900c8c05e620df67f8c5c"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adce978941d9900c8c05e620df67f8c5c">Version</a> [32]</td></tr>
<tr class="memdesc:adce978941d9900c8c05e620df67f8c5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Image format version string (NUL-terminated, e.g., "6.0") <br /></td></tr>
<tr class="memitem:aaea8b3a14fc03f9a4b045318160b7f54" id="r_aaea8b3a14fc03f9a4b045318160b7f54"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaea8b3a14fc03f9a4b045318160b7f54">Application</a> [64]</td></tr>
<tr class="memdesc:aaea8b3a14fc03f9a4b045318160b7f54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Name of application that created the image (NUL-terminated) <br /></td></tr>
<tr class="memitem:aebf7783c46e640a8e7d0192ba2843e9a" id="r_aebf7783c46e640a8e7d0192ba2843e9a"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aebf7783c46e640a8e7d0192ba2843e9a">ApplicationVersion</a> [32]</td></tr>
<tr class="memdesc:aebf7783c46e640a8e7d0192ba2843e9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Version of the creating application (NUL-terminated) <br /></td></tr>
<tr class="memitem:acbccd97dbc139ed2f81d9997560725bb" id="r_acbccd97dbc139ed2f81d9997560725bb"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acbccd97dbc139ed2f81d9997560725bb">CreationTime</a></td></tr>
<tr class="memdesc:acbccd97dbc139ed2f81d9997560725bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Image creation timestamp (Windows FILETIME: 100ns since 1601-01-01 UTC) <br /></td></tr>
<tr class="memitem:ada8567fee9fbe636cb10f788b3705e3a" id="r_ada8567fee9fbe636cb10f788b3705e3a"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ada8567fee9fbe636cb10f788b3705e3a">LastModificationTime</a></td></tr>
<tr class="memdesc:ada8567fee9fbe636cb10f788b3705e3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Last modification timestamp (Windows FILETIME format) <br /></td></tr>
<tr class="memitem:a76611d5087e0a9fd4d329fac7c9ec3f3" id="r_a76611d5087e0a9fd4d329fac7c9ec3f3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a76611d5087e0a9fd4d329fac7c9ec3f3">MediaType</a></td></tr>
<tr class="memdesc:a76611d5087e0a9fd4d329fac7c9ec3f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Media type identifier (see <a class="el" href="#a76611d5087e0a9fd4d329fac7c9ec3f3">MediaType</a> enum; 0=Unknown) <br /></td></tr>
<tr class="memitem:a7ed25efcf8cec55d6609b83bcd17b2d0" id="r_a7ed25efcf8cec55d6609b83bcd17b2d0"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7ed25efcf8cec55d6609b83bcd17b2d0">MetadataMediaType</a></td></tr>
<tr class="memdesc:a7ed25efcf8cec55d6609b83bcd17b2d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Media type for sidecar generation (internal archival use) <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>High-level summary of an opened Aaru image containing metadata and media characteristics. </p>
<p>This structure aggregates essential information extracted from an Aaru format image file, providing callers with a comprehensive view of the imaged media without requiring access to internal image structures. All fields are read-only from the caller's perspective and reflect the state at the time the image was created or last modified.</p>
<dl class="section user"><dt>Field Semantics:</dt><dd></dd></dl>
<p><b>HasPartitions</b> (uint8_t):</p><ul>
<li>Non-zero (typically 1) if the image contains partition table metadata (MBR, GPT, APM, etc.) or, for optical media, track information structures.</li>
<li>Zero if no partition/track structures were detected or if the media is unpartitioned.</li>
<li>Usage: Check this before attempting to enumerate partitions/tracks via dedicated APIs.</li>
</ul>
<p><b>HasSessions</b> (uint8_t):</p><ul>
<li>Non-zero (typically 1) if multiple recording sessions are present (primarily optical media).</li>
<li>Zero for single-session media or media types that don't support sessions (e.g., floppy, HDD).</li>
<li>Usage: Multi-session handling may require session-specific TOC/track enumeration.</li>
</ul>
<p><b>ImageSize</b> (uint64_t):</p><ul>
<li>Total size in bytes of image payload data, excluding format headers, metadata, and container overhead.</li>
<li>May not reflect current file size due to compression, sparse allocation, or incremental updates.</li>
<li>Usage: For informational/statistical purposes; not reliable for disk space calculations.</li>
</ul>
<p><b>Sectors</b> (uint64_t):</p><ul>
<li>Total count of addressable logical blocks (sectors) in the image.</li>
<li>Range: [1, 2^64-1] for valid images; 0 indicates corruption or initialization failure.</li>
<li>Usage: Multiply by SectorSize to determine total addressable capacity.</li>
</ul>
<p><b>SectorSize</b> (uint32_t):</p><ul>
<li>Size of each logical sector in bytes. Common values: 512, 2048, 2352, 4096.</li>
<li>Guaranteed to be non-zero for valid images; may vary by media type (CD: 2352, HDD: 512/4096).</li>
<li>Usage: Required for LBA-to-byte offset calculations and buffer allocation.</li>
</ul>
<p><b>Version</b>[32] (char array):</p><ul>
<li>NUL-terminated string identifying the Aaru image format version (e.g., "6.0", "5.3").</li>
<li>Not necessarily the application version; reflects on-disk format compatibility level.</li>
<li>Empty string if version information is unavailable or unrecognized.</li>
</ul>
<p><b>Application</b>[64] (char array):</p><ul>
<li>NUL-terminated string naming the application that created the image (e.g., "Aaru", "DiscImageChef").</li>
<li>May contain vendor/project identifiers; not guaranteed to match executable name.</li>
<li>Empty string if creator information was not stored or is unavailable.</li>
</ul>
<p><b>ApplicationVersion</b>[32] (char array):</p><ul>
<li>NUL-terminated string specifying the version of the creating application (e.g., "6.0.0-alpha1").</li>
<li>Semantic versioning format recommended but not enforced.</li>
<li>Empty string if version metadata is absent.</li>
</ul>
<p><b>CreationTime</b> (int64_t):</p><ul>
<li>Image creation timestamp as Windows FILETIME: 100-nanosecond intervals since January 1, 1601 00:00:00 UTC.</li>
<li>Zero (0) may represent epoch or absence of creation time; check for &lt; 0 for explicit invalidity.</li>
<li>Usage: Convert to UNIX timestamp via: (CreationTime / 10000000) - 11644473600.</li>
</ul>
<p><b>LastModificationTime</b> (int64_t):</p><ul>
<li>Last modification timestamp in Windows FILETIME format (same encoding as CreationTime).</li>
<li>Updated when image data or metadata is altered; not filesystem modification time.</li>
<li>May equal CreationTime for unmodified images.</li>
<li>Negative values indicate missing/invalid metadata.</li>
</ul>
<p><b><a class="el" href="group__MediaTypes.html#ga1499e9f8a76cb81b43b7a4b0dbe7e44a" title="Enumerates every recognized media / cartridge / optical / tape / card / disk format.">MediaType</a></b> (uint32_t):</p><ul>
<li>Numeric identifier from the <a class="el" href="#a76611d5087e0a9fd4d329fac7c9ec3f3">MediaType</a> enumeration representing the physical/logical media.</li>
Update doxygen documentation.
2025-10-11 12:43:39 +01:00
<li>Value 0 (Unknown) when automatic detection failed or media is unrecognized/exotic.</li>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
<li>Stable across versions; safe to persist and compare.</li>
<li>Usage: Cast to <code><a class="el" href="group__MediaTypes.html#ga1499e9f8a76cb81b43b7a4b0dbe7e44a" title="Enumerates every recognized media / cartridge / optical / tape / card / disk format.">MediaType</a></code> enum for switch/case logic; always include default/Unknown handling.</li>
</ul>
<p><b>MetadataMediaType</b> (uint8_t):</p><ul>
<li>Internal identifier used for sidecar/metadata generation (METS/CICM/ALTO compatibility).</li>
<li>Not directly useful for most callers; primarily for serialization/archival workflows.</li>
</ul>
<dl class="section user"><dt>Invariants and Constraints:</dt><dd><ul>
<li>All pointer-like char arrays are guaranteed NUL-terminated and safe for string functions.</li>
<li>Sectors &gt; 0 and SectorSize &gt; 0 for structurally valid images.</li>
<li>Timestamps may be 0 or negative; consumers must validate before using.</li>
<li><a class="el" href="group__MediaTypes.html#ga1499e9f8a76cb81b43b7a4b0dbe7e44a" title="Enumerates every recognized media / cartridge / optical / tape / card / disk format.">MediaType</a> range corresponds to <a class="el" href="#a76611d5087e0a9fd4d329fac7c9ec3f3">MediaType</a> enum; out-of-range values are possible for future extensions.</li>
</ul>
</dd></dl>
<dl class="section user"><dt>Thread Safety:</dt><dd><ul>
<li>Struct contents are stable after retrieval; safe for concurrent reads.</li>
<li>Do not cache <a class="el" href="structImageInfo.html" title="High-level summary of an opened Aaru image containing metadata and media characteristics.">ImageInfo</a> across context operations that may invalidate it (e.g., re-opening).</li>
</ul>
</dd></dl>
<dl class="section user"><dt>ABI Stability:</dt><dd><ul>
<li>Field layout is ABI-stable; new fields append to end in future versions.</li>
<li>Reordering or removing fields constitutes a major version break.</li>
<li>Linter suppressions acknowledge intentionally large field count for completeness. </li>
</ul>
</dd></dl>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00869">869</a> of file <a class="el" href="aaru_8h_source.html">aaru.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="aaea8b3a14fc03f9a4b045318160b7f54" name="aaea8b3a14fc03f9a4b045318160b7f54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaea8b3a14fc03f9a4b045318160b7f54">&#9670;&#160;</a></span>Application</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char ImageInfo::Application[64]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Name of application that created the image (NUL-terminated) </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00877">877</a> of file <a class="el" href="aaru_8h_source.html">aaru.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="open_8c_source.html#l00125">aaruf_open()</a>.</p>
</div>
</div>
<a id="aebf7783c46e640a8e7d0192ba2843e9a" name="aebf7783c46e640a8e7d0192ba2843e9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebf7783c46e640a8e7d0192ba2843e9a">&#9670;&#160;</a></span>ApplicationVersion</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char ImageInfo::ApplicationVersion[32]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Version of the creating application (NUL-terminated) </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00878">878</a> of file <a class="el" href="aaru_8h_source.html">aaru.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="open_8c_source.html#l00125">aaruf_open()</a>.</p>
</div>
</div>
<a id="acbccd97dbc139ed2f81d9997560725bb" name="acbccd97dbc139ed2f81d9997560725bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbccd97dbc139ed2f81d9997560725bb">&#9670;&#160;</a></span>CreationTime</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t ImageInfo::CreationTime</td>
</tr>
</table>
</div><div class="memdoc">
<p>Image creation timestamp (Windows FILETIME: 100ns since 1601-01-01 UTC) </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00879">879</a> of file <a class="el" href="aaru_8h_source.html">aaru.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="open_8c_source.html#l00125">aaruf_open()</a>.</p>
</div>
</div>
<a id="a5f4e71687378856611c72604f63c2835" name="a5f4e71687378856611c72604f63c2835"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f4e71687378856611c72604f63c2835">&#9670;&#160;</a></span>HasPartitions</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t ImageInfo::HasPartitions</td>
</tr>
</table>
</div><div class="memdoc">
<p>Image contains partitions (or tracks for optical media); 0=no, non-zero=yes. </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00871">871</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="optical_8c_source.html#l00392">aaruf_set_tracks()</a>, and <a class="el" href="optical_8c_source.html#l00111">process_tracks_block()</a>.</p>
</div>
</div>
<a id="aaeb20c53439a89baaf21944b3c97f676" name="aaeb20c53439a89baaf21944b3c97f676"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaeb20c53439a89baaf21944b3c97f676">&#9670;&#160;</a></span>HasSessions</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t ImageInfo::HasSessions</td>
</tr>
</table>
</div><div class="memdoc">
<p>Image contains multiple sessions (optical media); 0=single/none, non-zero=multi. </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00872">872</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="optical_8c_source.html#l00392">aaruf_set_tracks()</a>, and <a class="el" href="optical_8c_source.html#l00111">process_tracks_block()</a>.</p>
</div>
</div>
<a id="abca8e73a9655d810e6d30d36c3ab54d7" name="abca8e73a9655d810e6d30d36c3ab54d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abca8e73a9655d810e6d30d36c3ab54d7">&#9670;&#160;</a></span>ImageSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t ImageInfo::ImageSize</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of the image payload in bytes (excludes headers/metadata) </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00873">873</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
<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#l00125">aaruf_open()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00470">process_aaru_metadata_json_block()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00306">process_cicm_block()</a>, <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>, <a class="el" href="ddt__v1_8c_source.html#l00085">process_ddt_v1()</a>, <a class="el" href="ddt__v2_8c_source.html#l00096">process_ddt_v2()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00246">process_geometry_block()</a>, <a class="el" href="blocks_2metadata_8c_source.html#l00035">process_metadata_block()</a>, <a class="el" href="tape_8c_source.html#l00126">process_tape_files_block()</a>, <a class="el" href="tape_8c_source.html#l00346">process_tape_partitions_block()</a>, and <a class="el" href="optical_8c_source.html#l00111">process_tracks_block()</a>.</p>
</div>
</div>
<a id="ada8567fee9fbe636cb10f788b3705e3a" name="ada8567fee9fbe636cb10f788b3705e3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ada8567fee9fbe636cb10f788b3705e3a">&#9670;&#160;</a></span>LastModificationTime</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t ImageInfo::LastModificationTime</td>
</tr>
</table>
</div><div class="memdoc">
<p>Last modification timestamp (Windows FILETIME format) </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00880">880</a> of file <a class="el" href="aaru_8h_source.html">aaru.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="open_8c_source.html#l00125">aaruf_open()</a>.</p>
</div>
</div>
<a id="a76611d5087e0a9fd4d329fac7c9ec3f3" name="a76611d5087e0a9fd4d329fac7c9ec3f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76611d5087e0a9fd4d329fac7c9ec3f3">&#9670;&#160;</a></span>MediaType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ImageInfo::MediaType</td>
</tr>
</table>
</div><div class="memdoc">
<p>Media type identifier (see <a class="el" href="#a76611d5087e0a9fd4d329fac7c9ec3f3">MediaType</a> enum; 0=Unknown) </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00881">881</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
Update doxygen documentation.
2025-10-11 12:43:39 +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#l00125">aaruf_open()</a>, <a class="el" href="read_8c_source.html#l00826">aaruf_read_sector_long()</a>, <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, <a class="el" href="write_8c_source.html#l00532">aaruf_write_sector_long()</a>, and <a class="el" href="close_8c_source.html#l01508">write_sector_subchannel()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a7ed25efcf8cec55d6609b83bcd17b2d0" name="a7ed25efcf8cec55d6609b83bcd17b2d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ed25efcf8cec55d6609b83bcd17b2d0">&#9670;&#160;</a></span>MetadataMediaType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t ImageInfo::MetadataMediaType</td>
</tr>
</table>
</div><div class="memdoc">
<p>Media type for sidecar generation (internal archival use) </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00882">882</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
Update doxygen documentation.
2025-10-11 12:43:39 +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#l00125">aaruf_open()</a>, <a class="el" href="read_8c_source.html#l00826">aaruf_read_sector_long()</a>, <a class="el" href="read_8c_source.html#l01474">aaruf_read_sector_tag()</a>, <a class="el" href="read_8c_source.html#l00670">aaruf_read_track_sector()</a>, <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, <a class="el" href="write_8c_source.html#l00532">aaruf_write_sector_long()</a>, <a class="el" href="write_8c_source.html#l02059">aaruf_write_sector_tag()</a>, and <a class="el" href="close_8c_source.html#l01508">write_sector_subchannel()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="ae3e1b9cde1c51152b00eb1b59e199906" name="ae3e1b9cde1c51152b00eb1b59e199906"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae3e1b9cde1c51152b00eb1b59e199906">&#9670;&#160;</a></span>Sectors</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t ImageInfo::Sectors</td>
</tr>
</table>
</div><div class="memdoc">
<p>Total count of addressable logical sectors/blocks. </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00874">874</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
Update doxygen documentation.
2025-10-11 12:43:39 +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#l00125">aaruf_open()</a>, <a class="el" href="read_8c_source.html#l00253">aaruf_read_sector()</a>, <a class="el" href="read_8c_source.html#l00826">aaruf_read_sector_long()</a>, <a class="el" href="read_8c_source.html#l01474">aaruf_read_sector_tag()</a>, <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, <a class="el" href="write_8c_source.html#l00532">aaruf_write_sector_long()</a>, <a class="el" href="write_8c_source.html#l02059">aaruf_write_sector_tag()</a>, <a class="el" href="ddt__v1_8c_source.html#l00085">process_ddt_v1()</a>, <a class="el" href="ddt__v2_8c_source.html#l00096">process_ddt_v2()</a>, <a class="el" href="close_8c_source.html#l01808">write_dvd_long_sector_blocks()</a>, <a class="el" href="close_8c_source.html#l02245">write_dvd_title_key_decrypted_block()</a>, <a class="el" href="close_8c_source.html#l00850">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l01206">write_sector_prefix_ddt()</a>, <a class="el" href="close_8c_source.html#l01508">write_sector_subchannel()</a>, and <a class="el" href="close_8c_source.html#l01350">write_sector_suffix_ddt()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="aac1ac48f57afd415467cd6f13f01644b" name="aac1ac48f57afd415467cd6f13f01644b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac1ac48f57afd415467cd6f13f01644b">&#9670;&#160;</a></span>SectorSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t ImageInfo::SectorSize</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of each logical sector in bytes (512, 2048, 2352, 4096, etc.) </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00875">875</a> of file <a class="el" href="aaru_8h_source.html">aaru.h</a>.</p>
Update doxygen documentation.
2025-10-11 12:43:39 +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#l00125">aaruf_open()</a>, <a class="el" href="read_8c_source.html#l00253">aaruf_read_sector()</a>, and <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="adce978941d9900c8c05e620df67f8c5c" name="adce978941d9900c8c05e620df67f8c5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adce978941d9900c8c05e620df67f8c5c">&#9670;&#160;</a></span>Version</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char ImageInfo::Version[32]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Image format version string (NUL-terminated, e.g., "6.0") </p>
<p class="definition">Definition at line <a class="el" href="aaru_8h_source.html#l00876">876</a> of file <a class="el" href="aaru_8h_source.html">aaru.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="open_8c_source.html#l00125">aaruf_open()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/<a class="el" href="aaru_8h_source.html">aaru.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="structImageInfo.html">ImageInfo</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