Files
libaaruformat/docs/html/structBlockHeader.html

318 lines
21 KiB
HTML
Raw Normal View History

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: BlockHeader 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('structBlockHeader.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">BlockHeader Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Header preceding the compressed data payload of a data block (BlockType::DataBlock).
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="data_8h_source.html">aaruformat/structs/data.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:a3b03f118fb2dc3dcef3f87a82238e358" id="r_a3b03f118fb2dc3dcef3f87a82238e358"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3b03f118fb2dc3dcef3f87a82238e358">identifier</a></td></tr>
<tr class="memdesc:a3b03f118fb2dc3dcef3f87a82238e358"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block identifier, must be BlockType::DataBlock. <br /></td></tr>
<tr class="memitem:ac31ad48f3362a43175c94ec2e30662ad" id="r_ac31ad48f3362a43175c94ec2e30662ad"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac31ad48f3362a43175c94ec2e30662ad">type</a></td></tr>
<tr class="memdesc:ac31ad48f3362a43175c94ec2e30662ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Logical data classification (value from <a class="el" href="enums_8h.html#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a>). <br /></td></tr>
<tr class="memitem:ad68963422fd2a5f6d0e0be751cbef559" id="r_ad68963422fd2a5f6d0e0be751cbef559"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad68963422fd2a5f6d0e0be751cbef559">compression</a></td></tr>
<tr class="memdesc:ad68963422fd2a5f6d0e0be751cbef559"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compression algorithm used (value from <a class="el" href="enums_8h.html#affec749ed88365143745313ae9168263">CompressionType</a>). <br /></td></tr>
<tr class="memitem:a5bd50f95c8c1f91e5013a1a154690beb" id="r_a5bd50f95c8c1f91e5013a1a154690beb"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5bd50f95c8c1f91e5013a1a154690beb">sectorSize</a></td></tr>
<tr class="memdesc:a5bd50f95c8c1f91e5013a1a154690beb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size in bytes of each logical sector represented in this block. <br /></td></tr>
<tr class="memitem:a0ee87beb4362823260f70a87ac17379f" id="r_a0ee87beb4362823260f70a87ac17379f"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ee87beb4362823260f70a87ac17379f">cmpLength</a></td></tr>
<tr class="memdesc:a0ee87beb4362823260f70a87ac17379f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size in bytes of the compressed payload immediately following this header. <br /></td></tr>
<tr class="memitem:a1f9f3204a10090709b28d0df4bb547e5" id="r_a1f9f3204a10090709b28d0df4bb547e5"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1f9f3204a10090709b28d0df4bb547e5">length</a></td></tr>
<tr class="memdesc:a1f9f3204a10090709b28d0df4bb547e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size in bytes of the uncompressed payload resulting after decompression. <br /></td></tr>
<tr class="memitem:a8ff40eae6c49f0d9b49825f75e1e2bf8" id="r_a8ff40eae6c49f0d9b49825f75e1e2bf8"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ff40eae6c49f0d9b49825f75e1e2bf8">cmpCrc64</a></td></tr>
<tr class="memdesc:a8ff40eae6c49f0d9b49825f75e1e2bf8"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRC64-ECMA of the compressed payload (cmpLength bytes). <br /></td></tr>
<tr class="memitem:ab4d9e3a871e0c7f12a881017dac4ca12" id="r_ab4d9e3a871e0c7f12a881017dac4ca12"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab4d9e3a871e0c7f12a881017dac4ca12">crc64</a></td></tr>
<tr class="memdesc:ab4d9e3a871e0c7f12a881017dac4ca12"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRC64-ECMA of the uncompressed payload (length bytes). <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Header preceding the compressed data payload of a data block (BlockType::DataBlock). </p>
<p>Invariants:</p><ul>
<li>cmpLength &gt; 0 unless length == 0 (empty block)</li>
<li>length == 0 implies cmpLength == 0</li>
<li>If compression == CompressionType::None then cmpLength == length</li>
<li>length % sectorSize == 0</li>
</ul>
<p>Validation strategy (recommended for readers):</p><ol type="1">
<li>Verify identifier == BlockType::DataBlock.</li>
<li>Verify sectorSize is non-zero and a power-of-two or a commonly used size (512/1024/2048/4096/2352).</li>
<li>Verify invariants above and CRCs after (de)compression. </li>
</ol>
<p class="definition">Definition at line <a class="el" href="data_8h_source.html#l00070">70</a> of file <a class="el" href="data_8h_source.html">data.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="a8ff40eae6c49f0d9b49825f75e1e2bf8" name="a8ff40eae6c49f0d9b49825f75e1e2bf8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ff40eae6c49f0d9b49825f75e1e2bf8">&#9670;&#160;</a></span>cmpCrc64</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t BlockHeader::cmpCrc64</td>
</tr>
</table>
</div><div class="memdoc">
<p>CRC64-ECMA of the compressed payload (cmpLength bytes). </p>
<p class="definition">Definition at line <a class="el" href="data_8h_source.html#l00078">78</a> of file <a class="el" href="data_8h_source.html">data.h</a>.</p>
2025-12-12 12:25:02 +00:00
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01427">aaruf_close_current_block()</a>, <a class="el" href="verify_8c_source.html#l00130">aaruf_verify_image()</a>, <a class="el" href="close_8c_source.html#l01851">write_dvd_long_sector_blocks()</a>, <a class="el" href="close_8c_source.html#l02296">write_dvd_title_key_decrypted_block()</a>, <a class="el" href="close_8c_source.html#l02462">write_media_tags()</a>, <a class="el" href="close_8c_source.html#l00879">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l00997">write_sector_prefix()</a>, <a class="el" href="close_8c_source.html#l01547">write_sector_subchannel()</a>, and <a class="el" href="close_8c_source.html#l01121">write_sector_suffix()</a>.</p>
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a0ee87beb4362823260f70a87ac17379f" name="a0ee87beb4362823260f70a87ac17379f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ee87beb4362823260f70a87ac17379f">&#9670;&#160;</a></span>cmpLength</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t BlockHeader::cmpLength</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size in bytes of the compressed payload immediately following this header. </p>
<p class="definition">Definition at line <a class="el" href="data_8h_source.html#l00076">76</a> of file <a class="el" href="data_8h_source.html">data.h</a>.</p>
2025-12-12 12:25:02 +00:00
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01427">aaruf_close_current_block()</a>, <a class="el" href="read_8c_source.html#l00253">aaruf_read_sector()</a>, <a class="el" href="verify_8c_source.html#l00130">aaruf_verify_image()</a>, <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>, <a class="el" href="close_8c_source.html#l01851">write_dvd_long_sector_blocks()</a>, <a class="el" href="close_8c_source.html#l02296">write_dvd_title_key_decrypted_block()</a>, <a class="el" href="close_8c_source.html#l02462">write_media_tags()</a>, <a class="el" href="close_8c_source.html#l00879">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l00997">write_sector_prefix()</a>, <a class="el" href="close_8c_source.html#l01547">write_sector_subchannel()</a>, and <a class="el" href="close_8c_source.html#l01121">write_sector_suffix()</a>.</p>
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="ad68963422fd2a5f6d0e0be751cbef559" name="ad68963422fd2a5f6d0e0be751cbef559"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad68963422fd2a5f6d0e0be751cbef559">&#9670;&#160;</a></span>compression</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t BlockHeader::compression</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compression algorithm used (value from <a class="el" href="enums_8h.html#affec749ed88365143745313ae9168263">CompressionType</a>). </p>
<p class="definition">Definition at line <a class="el" href="data_8h_source.html#l00074">74</a> of file <a class="el" href="data_8h_source.html">data.h</a>.</p>
2025-12-12 12:25:02 +00:00
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01427">aaruf_close_current_block()</a>, <a class="el" href="read_8c_source.html#l00253">aaruf_read_sector()</a>, <a class="el" href="verify_8c_source.html#l00130">aaruf_verify_image()</a>, <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>, <a class="el" href="close_8c_source.html#l01851">write_dvd_long_sector_blocks()</a>, <a class="el" href="close_8c_source.html#l02296">write_dvd_title_key_decrypted_block()</a>, <a class="el" href="close_8c_source.html#l02462">write_media_tags()</a>, <a class="el" href="close_8c_source.html#l00879">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l00997">write_sector_prefix()</a>, <a class="el" href="close_8c_source.html#l01547">write_sector_subchannel()</a>, and <a class="el" href="close_8c_source.html#l01121">write_sector_suffix()</a>.</p>
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="ab4d9e3a871e0c7f12a881017dac4ca12" name="ab4d9e3a871e0c7f12a881017dac4ca12"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4d9e3a871e0c7f12a881017dac4ca12">&#9670;&#160;</a></span>crc64</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t BlockHeader::crc64</td>
</tr>
</table>
</div><div class="memdoc">
<p>CRC64-ECMA of the uncompressed payload (length bytes). </p>
<p class="definition">Definition at line <a class="el" href="data_8h_source.html#l00079">79</a> of file <a class="el" href="data_8h_source.html">data.h</a>.</p>
2025-12-12 12:25:02 +00:00
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01427">aaruf_close_current_block()</a>, <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>, <a class="el" href="close_8c_source.html#l01851">write_dvd_long_sector_blocks()</a>, <a class="el" href="close_8c_source.html#l02296">write_dvd_title_key_decrypted_block()</a>, <a class="el" href="close_8c_source.html#l02462">write_media_tags()</a>, <a class="el" href="close_8c_source.html#l00879">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l00997">write_sector_prefix()</a>, <a class="el" href="close_8c_source.html#l01547">write_sector_subchannel()</a>, and <a class="el" href="close_8c_source.html#l01121">write_sector_suffix()</a>.</p>
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a3b03f118fb2dc3dcef3f87a82238e358" name="a3b03f118fb2dc3dcef3f87a82238e358"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b03f118fb2dc3dcef3f87a82238e358">&#9670;&#160;</a></span>identifier</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t BlockHeader::identifier</td>
</tr>
</table>
</div><div class="memdoc">
<p>Block identifier, must be BlockType::DataBlock. </p>
<p class="definition">Definition at line <a class="el" href="data_8h_source.html#l00072">72</a> of file <a class="el" href="data_8h_source.html">data.h</a>.</p>
2025-12-12 12:25:02 +00:00
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>, <a class="el" href="close_8c_source.html#l01851">write_dvd_long_sector_blocks()</a>, <a class="el" href="close_8c_source.html#l02296">write_dvd_title_key_decrypted_block()</a>, <a class="el" href="close_8c_source.html#l02462">write_media_tags()</a>, <a class="el" href="close_8c_source.html#l00879">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l00997">write_sector_prefix()</a>, <a class="el" href="close_8c_source.html#l01547">write_sector_subchannel()</a>, and <a class="el" href="close_8c_source.html#l01121">write_sector_suffix()</a>.</p>
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a1f9f3204a10090709b28d0df4bb547e5" name="a1f9f3204a10090709b28d0df4bb547e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f9f3204a10090709b28d0df4bb547e5">&#9670;&#160;</a></span>length</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t BlockHeader::length</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size in bytes of the uncompressed payload resulting after decompression. </p>
<p class="definition">Definition at line <a class="el" href="data_8h_source.html#l00077">77</a> of file <a class="el" href="data_8h_source.html">data.h</a>.</p>
2025-12-12 12:25:02 +00:00
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01427">aaruf_close_current_block()</a>, <a class="el" href="read_8c_source.html#l00253">aaruf_read_sector()</a>, <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>, <a class="el" href="close_8c_source.html#l01851">write_dvd_long_sector_blocks()</a>, <a class="el" href="close_8c_source.html#l02296">write_dvd_title_key_decrypted_block()</a>, <a class="el" href="close_8c_source.html#l02462">write_media_tags()</a>, <a class="el" href="close_8c_source.html#l00879">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l00997">write_sector_prefix()</a>, <a class="el" href="close_8c_source.html#l01547">write_sector_subchannel()</a>, and <a class="el" href="close_8c_source.html#l01121">write_sector_suffix()</a>.</p>
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="a5bd50f95c8c1f91e5013a1a154690beb" name="a5bd50f95c8c1f91e5013a1a154690beb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bd50f95c8c1f91e5013a1a154690beb">&#9670;&#160;</a></span>sectorSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t BlockHeader::sectorSize</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size in bytes of each logical sector represented in this block. </p>
<p class="definition">Definition at line <a class="el" href="data_8h_source.html#l00075">75</a> of file <a class="el" href="data_8h_source.html">data.h</a>.</p>
2025-12-12 12:25:02 +00:00
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l01427">aaruf_close_current_block()</a>, <a class="el" href="read_8c_source.html#l00253">aaruf_read_sector()</a>, <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, and <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>.</p>
2025-10-11 01:35:43 +01:00
</div>
</div>
<a id="ac31ad48f3362a43175c94ec2e30662ad" name="ac31ad48f3362a43175c94ec2e30662ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac31ad48f3362a43175c94ec2e30662ad">&#9670;&#160;</a></span>type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t BlockHeader::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Logical data classification (value from <a class="el" href="enums_8h.html#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a>). </p>
<p class="definition">Definition at line <a class="el" href="data_8h_source.html#l00073">73</a> of file <a class="el" href="data_8h_source.html">data.h</a>.</p>
2025-12-12 12:25:02 +00:00
<p class="reference">Referenced by <a class="el" href="write_8c_source.html#l00098">aaruf_write_sector()</a>, <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>, <a class="el" href="close_8c_source.html#l01851">write_dvd_long_sector_blocks()</a>, <a class="el" href="close_8c_source.html#l02296">write_dvd_title_key_decrypted_block()</a>, <a class="el" href="close_8c_source.html#l02462">write_media_tags()</a>, <a class="el" href="close_8c_source.html#l00879">write_mode2_subheaders_block()</a>, <a class="el" href="close_8c_source.html#l00997">write_sector_prefix()</a>, <a class="el" href="close_8c_source.html#l01547">write_sector_subchannel()</a>, and <a class="el" href="close_8c_source.html#l01121">write_sector_suffix()</a>.</p>
2025-10-11 01:35:43 +01:00
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/aaruformat/structs/<a class="el" href="data_8h_source.html">data.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="structBlockHeader.html">BlockHeader</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>