aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2026-09-16 20:04:15 +00:00
Code Issues 3 Packages Projects Releases Wiki Activity

Update doxygen documentation.

Browse Source
This commit is contained in:
Natalia Portillo
2026-04-11 23:17:09 +01:00
parent 7af6e613ab
commit a94f388238
658 changed files with 65760 additions and 36437 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/html/structDataStreamPayloadHeader.html
View File

@@ -3,7 +3,7 @@
<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.15.0"/>
<meta name="generator" content="Doxygen 1.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: DataStreamPayloadHeader Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -35,7 +35,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.15.0 -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
@@ -100,19 +100,19 @@ $(function(){initNavTree('structDataStreamPayloadHeader.html','',''); });
<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:aade6939bd84d33e4869785d7d412d3c7" id="r_aade6939bd84d33e4869785d7d412d3c7"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aade6939bd84d33e4869785d7d412d3c7">identifier</a></td></tr>
<tr class="memitem:aade6939bd84d33e4869785d7d412d3c7" id="r_aade6939bd84d33e4869785d7d412d3c7"><td class="memItemLeft">uint32_t&#160;</td><td class="memItemRight"><a class="el" href="#aade6939bd84d33e4869785d7d412d3c7">identifier</a></td></tr>
<tr class="memdesc:aade6939bd84d33e4869785d7d412d3c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block identifier, must be BlockType::DataStreamPayloadBlock (0x4C505344, "DSPL"). <br /></td></tr>
<tr class="memitem:a1b7498a80a254f1203bb8705221261f8" id="r_a1b7498a80a254f1203bb8705221261f8"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1b7498a80a254f1203bb8705221261f8">dataType</a></td></tr>
<tr class="memdesc:a1b7498a80a254f1203bb8705221261f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data type classification (value from <a class="el" href="enums_8h.html#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a>), e.g., FluxData or BitstreamData. <br /></td></tr>
<tr class="memitem:acb6524ee97c11cbd9934dddcf791478a" id="r_acb6524ee97c11cbd9934dddcf791478a"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acb6524ee97c11cbd9934dddcf791478a">compression</a></td></tr>
<tr class="memitem:a1b7498a80a254f1203bb8705221261f8" id="r_a1b7498a80a254f1203bb8705221261f8"><td class="memItemLeft">uint16_t&#160;</td><td class="memItemRight"><a class="el" href="#a1b7498a80a254f1203bb8705221261f8">dataType</a></td></tr>
<tr class="memdesc:a1b7498a80a254f1203bb8705221261f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data type classification (value from <a class="el" href="enums_8h.html#ad8ed01ff3ff33333d8e19db4d2818bb6" title="DataType">DataType</a>), e.g., FluxData or BitstreamData. <br /></td></tr>
<tr class="memitem:acb6524ee97c11cbd9934dddcf791478a" id="r_acb6524ee97c11cbd9934dddcf791478a"><td class="memItemLeft">uint16_t&#160;</td><td class="memItemRight"><a class="el" href="#acb6524ee97c11cbd9934dddcf791478a">compression</a></td></tr>
<tr class="memdesc:acb6524ee97c11cbd9934dddcf791478a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compression type: 0 = None, 1 = Lzma. <br /></td></tr>
<tr class="memitem:a55c9590fb1c3d87a9cce3b389826c1a5" id="r_a55c9590fb1c3d87a9cce3b389826c1a5"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a55c9590fb1c3d87a9cce3b389826c1a5">cmpLength</a></td></tr>
<tr class="memitem:a55c9590fb1c3d87a9cce3b389826c1a5" id="r_a55c9590fb1c3d87a9cce3b389826c1a5"><td class="memItemLeft">uint32_t&#160;</td><td class="memItemRight"><a class="el" href="#a55c9590fb1c3d87a9cce3b389826c1a5">cmpLength</a></td></tr>
<tr class="memdesc:a55c9590fb1c3d87a9cce3b389826c1a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compressed length in bytes (includes LZMA properties if compression = Lzma). <br /></td></tr>
<tr class="memitem:ad36cd6ef72854188450049c99b731273" id="r_ad36cd6ef72854188450049c99b731273"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad36cd6ef72854188450049c99b731273">length</a></td></tr>
<tr class="memitem:ad36cd6ef72854188450049c99b731273" id="r_ad36cd6ef72854188450049c99b731273"><td class="memItemLeft">uint32_t&#160;</td><td class="memItemRight"><a class="el" href="#ad36cd6ef72854188450049c99b731273">length</a></td></tr>
<tr class="memdesc:ad36cd6ef72854188450049c99b731273"><td class="mdescLeft">&#160;</td><td class="mdescRight">Uncompressed length in bytes. <br /></td></tr>
<tr class="memitem:a6b72345551c540a0c36c971f4374eb0e" id="r_a6b72345551c540a0c36c971f4374eb0e"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6b72345551c540a0c36c971f4374eb0e">cmpCrc64</a></td></tr>
<tr class="memitem:a6b72345551c540a0c36c971f4374eb0e" id="r_a6b72345551c540a0c36c971f4374eb0e"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#a6b72345551c540a0c36c971f4374eb0e">cmpCrc64</a></td></tr>
<tr class="memdesc:a6b72345551c540a0c36c971f4374eb0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRC64-ECMA checksum of the compressed payload (or same as crc64 if uncompressed). <br /></td></tr>
<tr class="memitem:aea3724bf5786add9715363dbc67671a8" id="r_aea3724bf5786add9715363dbc67671a8"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aea3724bf5786add9715363dbc67671a8">crc64</a></td></tr>
<tr class="memitem:aea3724bf5786add9715363dbc67671a8" id="r_aea3724bf5786add9715363dbc67671a8"><td class="memItemLeft">uint64_t&#160;</td><td class="memItemRight"><a class="el" href="#aea3724bf5786add9715363dbc67671a8">crc64</a></td></tr>
<tr class="memdesc:aea3724bf5786add9715363dbc67671a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">CRC64-ECMA checksum of the uncompressed payload. <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
@@ -154,7 +154,7 @@ If compression is Lzma, cmpLength includes the 5-byte LZMA properties header. </
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00249">249</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l01201">aaruf_read_flux_capture()</a>, and <a class="el" href="close_8c_source.html#l04371">write_flux_capture_payload()</a>.</p>
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l01258">aaruf_read_flux_capture()</a>, and <a class="el" href="close__write_8c_source.html#l04609">write_flux_capture_payload()</a>.</p>
</div>
</div>
@@ -174,7 +174,7 @@ If compression is Lzma, cmpLength includes the 5-byte LZMA properties header. </
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00247">247</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l01201">aaruf_read_flux_capture()</a>, and <a class="el" href="close_8c_source.html#l04371">write_flux_capture_payload()</a>.</p>
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l01258">aaruf_read_flux_capture()</a>, and <a class="el" href="close__write_8c_source.html#l04609">write_flux_capture_payload()</a>.</p>
</div>
</div>
@@ -194,7 +194,7 @@ If compression is Lzma, cmpLength includes the 5-byte LZMA properties header. </
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00246">246</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l01201">aaruf_read_flux_capture()</a>, and <a class="el" href="close_8c_source.html#l04371">write_flux_capture_payload()</a>.</p>
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l01258">aaruf_read_flux_capture()</a>, and <a class="el" href="close__write_8c_source.html#l04609">write_flux_capture_payload()</a>.</p>
</div>
</div>
@@ -214,7 +214,7 @@ If compression is Lzma, cmpLength includes the 5-byte LZMA properties header. </
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00250">250</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l01201">aaruf_read_flux_capture()</a>, and <a class="el" href="close_8c_source.html#l04371">write_flux_capture_payload()</a>.</p>
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l01258">aaruf_read_flux_capture()</a>, and <a class="el" href="close__write_8c_source.html#l04609">write_flux_capture_payload()</a>.</p>
</div>
</div>
@@ -230,11 +230,11 @@ If compression is Lzma, cmpLength includes the 5-byte LZMA properties header. </
</table>
</div><div class="memdoc">
<p>Data type classification (value from <a class="el" href="enums_8h.html#ad8ed01ff3ff33333d8e19db4d2818bb6">DataType</a>), e.g., FluxData or BitstreamData. </p>
<p>Data type classification (value from <a class="el" href="enums_8h.html#ad8ed01ff3ff33333d8e19db4d2818bb6" title="DataType">DataType</a>), e.g., FluxData or BitstreamData. </p>
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00245">245</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l00865">read_flux_payload_header()</a>, and <a class="el" href="close_8c_source.html#l04371">write_flux_capture_payload()</a>.</p>
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l00851">read_flux_payload_header()</a>, and <a class="el" href="close__write_8c_source.html#l04609">write_flux_capture_payload()</a>.</p>
</div>
</div>
@@ -254,7 +254,7 @@ If compression is Lzma, cmpLength includes the 5-byte LZMA properties header. </
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00244">244</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l00865">read_flux_payload_header()</a>, and <a class="el" href="close_8c_source.html#l04371">write_flux_capture_payload()</a>.</p>
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l00851">read_flux_payload_header()</a>, and <a class="el" href="close__write_8c_source.html#l04609">write_flux_capture_payload()</a>.</p>
</div>
</div>
@@ -274,7 +274,7 @@ If compression is Lzma, cmpLength includes the 5-byte LZMA properties header. </
<p class="definition">Definition at line <a class="el" href="flux_8h_source.html#l00248">248</a> of file <a class="el" href="flux_8h_source.html">flux.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l01201">aaruf_read_flux_capture()</a>, and <a class="el" href="close_8c_source.html#l04371">write_flux_capture_payload()</a>.</p>
<p class="reference">Referenced by <a class="el" href="flux_8c_source.html#l01258">aaruf_read_flux_capture()</a>, and <a class="el" href="close__write_8c_source.html#l04609">write_flux_capture_payload()</a>.</p>
</div>
</div>
@@ -295,7 +295,7 @@ If compression is Lzma, cmpLength includes the 5-byte LZMA properties header. </
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="structDataStreamPayloadHeader.html">DataStreamPayloadHeader</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.15.0 </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.16.1 </li>
</ul>
</div>
</body>