Files
libaaruformat/docs/html/flux_8h_source.html

249 lines
40 KiB
HTML

<!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.15.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: include/aaruformat/structs/flux.h Source File</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.15.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('flux_8h_source.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">flux.h</div></div>
</div><!--header-->
<div class="contents">
<a href="flux_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * This file is part of the Aaru Data Preservation Suite.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright (c) 2019-2025 Natalia Portillo.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * This library is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * it under the terms of the GNU Lesser General Public License as</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * published by the Free Software Foundation; either version 2.1 of the</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * License, or (at your option) any later version.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * This library is distributed in the hope that it will be useful, but</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * Lesser General Public License for more details.</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> *</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * License along with this library; if not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> */</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="preprocessor">#ifndef LIBAARUFORMAT_FLUX_H</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="preprocessor">#define LIBAARUFORMAT_FLUX_H</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="preprocessor">#pragma pack(push, 1)</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span></div>
<div class="foldopen" id="foldopen00116" data-start="{" data-end="};">
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="structFluxHeader.html"> 116</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structFluxHeader.html">FluxHeader</a></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span>{</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="structFluxHeader.html#a17794a3f0cc5b11a5169580cc510a71c"> 118</a></span> uint32_t <a class="code hl_variable" href="structFluxHeader.html#a17794a3f0cc5b11a5169580cc510a71c">identifier</a>; </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="structFluxHeader.html#a26f2a1be977dc973341e6952eba159dc"> 119</a></span> uint16_t <a class="code hl_variable" href="structFluxHeader.html#a26f2a1be977dc973341e6952eba159dc">entries</a>; </div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="structFluxHeader.html#a8e2f7fb0153155438629cda42cb6f329"> 120</a></span> uint8_t <a class="code hl_variable" href="structFluxHeader.html#a8e2f7fb0153155438629cda42cb6f329">blockAlignmentShift</a>; </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"><a class="line" href="structFluxHeader.html#a3980b9bf3db82de544c991cae4e6126a"> 121</a></span> uint64_t <a class="code hl_variable" href="structFluxHeader.html#a3980b9bf3db82de544c991cae4e6126a">crc64</a>; </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="flux_8h.html#a360dcd7eac2540e0979c10fb59fe3792"> 122</a></span>} <a class="code hl_struct" href="structFluxHeader.html">FluxHeader</a>;</div>
</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span></div>
<div class="foldopen" id="foldopen00155" data-start="{" data-end="};">
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"><a class="line" href="structFluxEntry.html"> 155</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structFluxEntry.html">FluxEntry</a></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span>{</div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"><a class="line" href="structFluxEntry.html#a31cafff6f54acc9e019da447e94ace4a"> 157</a></span> uint32_t <a class="code hl_variable" href="structFluxEntry.html#a31cafff6f54acc9e019da447e94ace4a">head</a>; </div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"><a class="line" href="structFluxEntry.html#a46108bba60946e7b7d4f41160e3dfd86"> 158</a></span> uint16_t <a class="code hl_variable" href="structFluxEntry.html#a46108bba60946e7b7d4f41160e3dfd86">track</a>; </div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"><a class="line" href="structFluxEntry.html#abd12c00010d82cd83820dd3405b7b860"> 159</a></span> uint8_t <a class="code hl_variable" href="structFluxEntry.html#abd12c00010d82cd83820dd3405b7b860">subtrack</a>; </div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"><a class="line" href="structFluxEntry.html#ae5af51709faf749501d44b242a57481c"> 160</a></span> uint32_t <a class="code hl_variable" href="structFluxEntry.html#ae5af51709faf749501d44b242a57481c">captureIndex</a>; </div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"><a class="line" href="structFluxEntry.html#a12f64e1c66187ebbbdcdf03916293c95"> 161</a></span> uint64_t <a class="code hl_variable" href="structFluxEntry.html#a12f64e1c66187ebbbdcdf03916293c95">indexResolution</a>; </div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"><a class="line" href="structFluxEntry.html#a27c590b581f2ea33306f89e609c28c95"> 162</a></span> uint64_t <a class="code hl_variable" href="structFluxEntry.html#a27c590b581f2ea33306f89e609c28c95">dataResolution</a>; </div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"><a class="line" href="structFluxEntry.html#aaaaaf686bec81c632f8de3131b540946"> 163</a></span> uint64_t <a class="code hl_variable" href="structFluxEntry.html#aaaaaf686bec81c632f8de3131b540946">indexOffset</a>; </div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"><a class="line" href="structFluxEntry.html#a3f5949d0feb9bdcf62afeb1acb1fa009"> 164</a></span> uint64_t <a class="code hl_variable" href="structFluxEntry.html#a3f5949d0feb9bdcf62afeb1acb1fa009">payloadOffset</a>; </div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"><a class="line" href="flux_8h.html#a8cdda65d99453768e84ec91140d481df"> 165</a></span>} <a class="code hl_struct" href="structFluxEntry.html">FluxEntry</a>;</div>
</div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span></div>
<div class="foldopen" id="foldopen00182" data-start="{" data-end="};">
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"><a class="line" href="structFluxCaptureMeta.html"> 182</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structFluxCaptureMeta.html">FluxCaptureMeta</a></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span>{</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"><a class="line" href="structFluxCaptureMeta.html#a0b227d050c7e82a606376fd3f0c2db02"> 184</a></span> uint32_t <a class="code hl_variable" href="structFluxCaptureMeta.html#a0b227d050c7e82a606376fd3f0c2db02">head</a>; </div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"><a class="line" href="structFluxCaptureMeta.html#aebee512e3f6ce8a4c1aa1b4cfbecdb33"> 185</a></span> uint16_t <a class="code hl_variable" href="structFluxCaptureMeta.html#aebee512e3f6ce8a4c1aa1b4cfbecdb33">track</a>; </div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"><a class="line" href="structFluxCaptureMeta.html#a9e7ceeae4845e8dcd87bd76e32d065d6"> 186</a></span> uint8_t <a class="code hl_variable" href="structFluxCaptureMeta.html#a9e7ceeae4845e8dcd87bd76e32d065d6">subtrack</a>; </div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"><a class="line" href="structFluxCaptureMeta.html#a6558bace422cf15c3f371ef437cc5610"> 187</a></span> uint32_t <a class="code hl_variable" href="structFluxCaptureMeta.html#a6558bace422cf15c3f371ef437cc5610">captureIndex</a>; </div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"><a class="line" href="structFluxCaptureMeta.html#a3df2812cbb33d5774ae4485eee96c4c9"> 188</a></span> uint64_t <a class="code hl_variable" href="structFluxCaptureMeta.html#a3df2812cbb33d5774ae4485eee96c4c9">indexResolution</a>; </div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"><a class="line" href="structFluxCaptureMeta.html#ae9699355343e04f88bfe25093774dfde"> 189</a></span> uint64_t <a class="code hl_variable" href="structFluxCaptureMeta.html#ae9699355343e04f88bfe25093774dfde">dataResolution</a>; </div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"><a class="line" href="flux_8h.html#a7276c29de57a7ddfd23097406c5c7d2a"> 190</a></span>} <a class="code hl_struct" href="structFluxCaptureMeta.html">FluxCaptureMeta</a>;</div>
</div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structFluxCaptureMapEntry.html">FluxCaptureMapEntry</a> <a class="code hl_struct" href="structFluxCaptureMapEntry.html">FluxCaptureMapEntry</a>;</div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span></div>
<div class="foldopen" id="foldopen00242" data-start="{" data-end="};">
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno"><a class="line" href="structDataStreamPayloadHeader.html"> 242</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structDataStreamPayloadHeader.html">DataStreamPayloadHeader</a></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno"> 243</span>{</div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno"><a class="line" href="structDataStreamPayloadHeader.html#aade6939bd84d33e4869785d7d412d3c7"> 244</a></span> uint32_t <a class="code hl_variable" href="structDataStreamPayloadHeader.html#aade6939bd84d33e4869785d7d412d3c7">identifier</a>; </div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno"><a class="line" href="structDataStreamPayloadHeader.html#a1b7498a80a254f1203bb8705221261f8"> 245</a></span> uint16_t <a class="code hl_variable" href="structDataStreamPayloadHeader.html#a1b7498a80a254f1203bb8705221261f8">dataType</a>; </div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"><a class="line" href="structDataStreamPayloadHeader.html#acb6524ee97c11cbd9934dddcf791478a"> 246</a></span> uint16_t <a class="code hl_variable" href="structDataStreamPayloadHeader.html#acb6524ee97c11cbd9934dddcf791478a">compression</a>; </div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno"><a class="line" href="structDataStreamPayloadHeader.html#a55c9590fb1c3d87a9cce3b389826c1a5"> 247</a></span> uint32_t <a class="code hl_variable" href="structDataStreamPayloadHeader.html#a55c9590fb1c3d87a9cce3b389826c1a5">cmpLength</a>; </div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno"><a class="line" href="structDataStreamPayloadHeader.html#ad36cd6ef72854188450049c99b731273"> 248</a></span> uint32_t <a class="code hl_variable" href="structDataStreamPayloadHeader.html#ad36cd6ef72854188450049c99b731273">length</a>; </div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno"><a class="line" href="structDataStreamPayloadHeader.html#a6b72345551c540a0c36c971f4374eb0e"> 249</a></span> uint64_t <a class="code hl_variable" href="structDataStreamPayloadHeader.html#a6b72345551c540a0c36c971f4374eb0e">cmpCrc64</a>; </div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno"><a class="line" href="structDataStreamPayloadHeader.html#aea3724bf5786add9715363dbc67671a8"> 250</a></span> uint64_t <a class="code hl_variable" href="structDataStreamPayloadHeader.html#aea3724bf5786add9715363dbc67671a8">crc64</a>; </div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno"><a class="line" href="flux_8h.html#a50fa327e8a58dfdff148b7c2f5d8c381"> 251</a></span>} <a class="code hl_struct" href="structDataStreamPayloadHeader.html">DataStreamPayloadHeader</a>;</div>
</div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"> 252</span></div>
<div class="foldopen" id="foldopen00270" data-start="{" data-end="};">
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno"><a class="line" href="structFluxCaptureRecord.html"> 270</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structFluxCaptureRecord.html">FluxCaptureRecord</a></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno"> 271</span>{</div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno"><a class="line" href="structFluxCaptureRecord.html#a002dbda89d68adac0d0a8281d34fc76a"> 272</a></span> <a class="code hl_struct" href="structFluxEntry.html">FluxEntry</a> <a class="code hl_variable" href="structFluxCaptureRecord.html#a002dbda89d68adac0d0a8281d34fc76a">entry</a>; </div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno"><a class="line" href="structFluxCaptureRecord.html#afd9cf94122b9f59c548cda29599f8047"> 273</a></span> uint8_t *<a class="code hl_variable" href="structFluxCaptureRecord.html#afd9cf94122b9f59c548cda29599f8047">data_buffer</a>; </div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno"><a class="line" href="structFluxCaptureRecord.html#a9563435372ecc4af506c4fae2ac2f617"> 274</a></span> uint32_t <a class="code hl_variable" href="structFluxCaptureRecord.html#a9563435372ecc4af506c4fae2ac2f617">data_length</a>; </div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno"><a class="line" href="structFluxCaptureRecord.html#af5bce1443f5112ce65f54c39ff873b57"> 275</a></span> uint8_t *<a class="code hl_variable" href="structFluxCaptureRecord.html#af5bce1443f5112ce65f54c39ff873b57">index_buffer</a>; </div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno"><a class="line" href="structFluxCaptureRecord.html#adcf7766ac4311fe79a1324f2eec6868d"> 276</a></span> uint32_t <a class="code hl_variable" href="structFluxCaptureRecord.html#adcf7766ac4311fe79a1324f2eec6868d">index_length</a>; </div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno"><a class="line" href="flux_8h.html#a1c0aec18cdb24ce2cda6012dace51280"> 277</a></span>} <a class="code hl_struct" href="structFluxCaptureRecord.html">FluxCaptureRecord</a>;</div>
</div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno"> 278</span></div>
<div class="foldopen" id="foldopen00296" data-start="{" data-end="};">
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno"><a class="line" href="structFluxCaptureKey.html"> 296</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structFluxCaptureKey.html">FluxCaptureKey</a></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno"> 297</span>{</div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno"><a class="line" href="structFluxCaptureKey.html#ac8945dce9e2b566546610d67bd729e64"> 298</a></span> uint32_t <a class="code hl_variable" href="structFluxCaptureKey.html#ac8945dce9e2b566546610d67bd729e64">head</a>; </div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno"><a class="line" href="structFluxCaptureKey.html#a1728ed3937674d667aec49213c454dc0"> 299</a></span> uint16_t <a class="code hl_variable" href="structFluxCaptureKey.html#a1728ed3937674d667aec49213c454dc0">track</a>; </div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno"><a class="line" href="structFluxCaptureKey.html#a8a1ff1cb573f89f004babec6b42b2edf"> 300</a></span> uint8_t <a class="code hl_variable" href="structFluxCaptureKey.html#a8a1ff1cb573f89f004babec6b42b2edf">subtrack</a>; </div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno"><a class="line" href="structFluxCaptureKey.html#afa1b8117c16006ec9f4ea99a573c12c2"> 301</a></span> uint32_t <a class="code hl_variable" href="structFluxCaptureKey.html#afa1b8117c16006ec9f4ea99a573c12c2">captureIndex</a>; </div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno"><a class="line" href="flux_8h.html#a7fb7328107aba7dd1f8face5eb2977b8"> 302</a></span>} <a class="code hl_struct" href="structFluxCaptureKey.html">FluxCaptureKey</a>;</div>
</div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno"> 303</span> </div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno"> 304</span><span class="preprocessor">#pragma pack(pop)</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno"> 305</span> </div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno"> 306</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_FLUX_H</span></div>
<div class="ttc" id="astructDataStreamPayloadHeader_html"><div class="ttname"><a href="structDataStreamPayloadHeader.html">DataStreamPayloadHeader</a></div><div class="ttdoc">Header structure for a DataStreamPayloadBlock containing data stream payload.</div><div class="ttdef"><b>Definition</b> <a href="#l00242">flux.h:243</a></div></div>
<div class="ttc" id="astructDataStreamPayloadHeader_html_a1b7498a80a254f1203bb8705221261f8"><div class="ttname"><a href="structDataStreamPayloadHeader.html#a1b7498a80a254f1203bb8705221261f8">DataStreamPayloadHeader::dataType</a></div><div class="ttdeci">uint16_t dataType</div><div class="ttdoc">Data type classification (value from DataType), e.g., FluxData or BitstreamData.</div><div class="ttdef"><b>Definition</b> <a href="#l00245">flux.h:245</a></div></div>
<div class="ttc" id="astructDataStreamPayloadHeader_html_a55c9590fb1c3d87a9cce3b389826c1a5"><div class="ttname"><a href="structDataStreamPayloadHeader.html#a55c9590fb1c3d87a9cce3b389826c1a5">DataStreamPayloadHeader::cmpLength</a></div><div class="ttdeci">uint32_t cmpLength</div><div class="ttdoc">Compressed length in bytes (includes LZMA properties if compression = Lzma).</div><div class="ttdef"><b>Definition</b> <a href="#l00247">flux.h:247</a></div></div>
<div class="ttc" id="astructDataStreamPayloadHeader_html_a6b72345551c540a0c36c971f4374eb0e"><div class="ttname"><a href="structDataStreamPayloadHeader.html#a6b72345551c540a0c36c971f4374eb0e">DataStreamPayloadHeader::cmpCrc64</a></div><div class="ttdeci">uint64_t cmpCrc64</div><div class="ttdoc">CRC64-ECMA checksum of the compressed payload (or same as crc64 if uncompressed).</div><div class="ttdef"><b>Definition</b> <a href="#l00249">flux.h:249</a></div></div>
<div class="ttc" id="astructDataStreamPayloadHeader_html_aade6939bd84d33e4869785d7d412d3c7"><div class="ttname"><a href="structDataStreamPayloadHeader.html#aade6939bd84d33e4869785d7d412d3c7">DataStreamPayloadHeader::identifier</a></div><div class="ttdeci">uint32_t identifier</div><div class="ttdoc">Block identifier, must be BlockType::DataStreamPayloadBlock (0x4C505344, &quot;DSPL&quot;).</div><div class="ttdef"><b>Definition</b> <a href="#l00244">flux.h:244</a></div></div>
<div class="ttc" id="astructDataStreamPayloadHeader_html_acb6524ee97c11cbd9934dddcf791478a"><div class="ttname"><a href="structDataStreamPayloadHeader.html#acb6524ee97c11cbd9934dddcf791478a">DataStreamPayloadHeader::compression</a></div><div class="ttdeci">uint16_t compression</div><div class="ttdoc">Compression type: 0 = None, 1 = Lzma.</div><div class="ttdef"><b>Definition</b> <a href="#l00246">flux.h:246</a></div></div>
<div class="ttc" id="astructDataStreamPayloadHeader_html_ad36cd6ef72854188450049c99b731273"><div class="ttname"><a href="structDataStreamPayloadHeader.html#ad36cd6ef72854188450049c99b731273">DataStreamPayloadHeader::length</a></div><div class="ttdeci">uint32_t length</div><div class="ttdoc">Uncompressed length in bytes.</div><div class="ttdef"><b>Definition</b> <a href="#l00248">flux.h:248</a></div></div>
<div class="ttc" id="astructDataStreamPayloadHeader_html_aea3724bf5786add9715363dbc67671a8"><div class="ttname"><a href="structDataStreamPayloadHeader.html#aea3724bf5786add9715363dbc67671a8">DataStreamPayloadHeader::crc64</a></div><div class="ttdeci">uint64_t crc64</div><div class="ttdoc">CRC64-ECMA checksum of the uncompressed payload.</div><div class="ttdef"><b>Definition</b> <a href="#l00250">flux.h:250</a></div></div>
<div class="ttc" id="astructFluxCaptureKey_html"><div class="ttname"><a href="structFluxCaptureKey.html">FluxCaptureKey</a></div><div class="ttdoc">Key structure for flux capture lookup map.</div><div class="ttdef"><b>Definition</b> <a href="#l00296">flux.h:297</a></div></div>
<div class="ttc" id="astructFluxCaptureKey_html_a1728ed3937674d667aec49213c454dc0"><div class="ttname"><a href="structFluxCaptureKey.html#a1728ed3937674d667aec49213c454dc0">FluxCaptureKey::track</a></div><div class="ttdeci">uint16_t track</div><div class="ttdoc">Track number identifying the capture location.</div><div class="ttdef"><b>Definition</b> <a href="#l00299">flux.h:299</a></div></div>
<div class="ttc" id="astructFluxCaptureKey_html_a8a1ff1cb573f89f004babec6b42b2edf"><div class="ttname"><a href="structFluxCaptureKey.html#a8a1ff1cb573f89f004babec6b42b2edf">FluxCaptureKey::subtrack</a></div><div class="ttdeci">uint8_t subtrack</div><div class="ttdoc">Subtrack number identifying the capture location.</div><div class="ttdef"><b>Definition</b> <a href="#l00300">flux.h:300</a></div></div>
<div class="ttc" id="astructFluxCaptureKey_html_ac8945dce9e2b566546610d67bd729e64"><div class="ttname"><a href="structFluxCaptureKey.html#ac8945dce9e2b566546610d67bd729e64">FluxCaptureKey::head</a></div><div class="ttdeci">uint32_t head</div><div class="ttdoc">Head number identifying the capture location.</div><div class="ttdef"><b>Definition</b> <a href="#l00298">flux.h:298</a></div></div>
<div class="ttc" id="astructFluxCaptureKey_html_afa1b8117c16006ec9f4ea99a573c12c2"><div class="ttname"><a href="structFluxCaptureKey.html#afa1b8117c16006ec9f4ea99a573c12c2">FluxCaptureKey::captureIndex</a></div><div class="ttdeci">uint32_t captureIndex</div><div class="ttdoc">Capture index, allowing multiple captures for the same location.</div><div class="ttdef"><b>Definition</b> <a href="#l00301">flux.h:301</a></div></div>
<div class="ttc" id="astructFluxCaptureMapEntry_html"><div class="ttname"><a href="structFluxCaptureMapEntry.html">FluxCaptureMapEntry</a></div><div class="ttdoc">Internal hash table entry for flux capture lookup.</div><div class="ttdef"><b>Definition</b> <a href="flux_8c_source.html#l00033">flux.c:34</a></div></div>
<div class="ttc" id="astructFluxCaptureMeta_html"><div class="ttname"><a href="structFluxCaptureMeta.html">FluxCaptureMeta</a></div><div class="ttdoc">Metadata structure returned by aaruf_get_flux_captures().</div><div class="ttdef"><b>Definition</b> <a href="#l00182">flux.h:183</a></div></div>
<div class="ttc" id="astructFluxCaptureMeta_html_a0b227d050c7e82a606376fd3f0c2db02"><div class="ttname"><a href="structFluxCaptureMeta.html#a0b227d050c7e82a606376fd3f0c2db02">FluxCaptureMeta::head</a></div><div class="ttdeci">uint32_t head</div><div class="ttdoc">Head number the flux capture corresponds to.</div><div class="ttdef"><b>Definition</b> <a href="#l00184">flux.h:184</a></div></div>
<div class="ttc" id="astructFluxCaptureMeta_html_a3df2812cbb33d5774ae4485eee96c4c9"><div class="ttname"><a href="structFluxCaptureMeta.html#a3df2812cbb33d5774ae4485eee96c4c9">FluxCaptureMeta::indexResolution</a></div><div class="ttdeci">uint64_t indexResolution</div><div class="ttdoc">Resolution in picoseconds at which the index stream was sampled.</div><div class="ttdef"><b>Definition</b> <a href="#l00188">flux.h:188</a></div></div>
<div class="ttc" id="astructFluxCaptureMeta_html_a6558bace422cf15c3f371ef437cc5610"><div class="ttname"><a href="structFluxCaptureMeta.html#a6558bace422cf15c3f371ef437cc5610">FluxCaptureMeta::captureIndex</a></div><div class="ttdeci">uint32_t captureIndex</div><div class="ttdoc">Capture index, allowing multiple captures for the same location.</div><div class="ttdef"><b>Definition</b> <a href="#l00187">flux.h:187</a></div></div>
<div class="ttc" id="astructFluxCaptureMeta_html_a9e7ceeae4845e8dcd87bd76e32d065d6"><div class="ttname"><a href="structFluxCaptureMeta.html#a9e7ceeae4845e8dcd87bd76e32d065d6">FluxCaptureMeta::subtrack</a></div><div class="ttdeci">uint8_t subtrack</div><div class="ttdoc">Subtrack number the flux capture corresponds to.</div><div class="ttdef"><b>Definition</b> <a href="#l00186">flux.h:186</a></div></div>
<div class="ttc" id="astructFluxCaptureMeta_html_ae9699355343e04f88bfe25093774dfde"><div class="ttname"><a href="structFluxCaptureMeta.html#ae9699355343e04f88bfe25093774dfde">FluxCaptureMeta::dataResolution</a></div><div class="ttdeci">uint64_t dataResolution</div><div class="ttdoc">Resolution in picoseconds at which the data stream was sampled.</div><div class="ttdef"><b>Definition</b> <a href="#l00189">flux.h:189</a></div></div>
<div class="ttc" id="astructFluxCaptureMeta_html_aebee512e3f6ce8a4c1aa1b4cfbecdb33"><div class="ttname"><a href="structFluxCaptureMeta.html#aebee512e3f6ce8a4c1aa1b4cfbecdb33">FluxCaptureMeta::track</a></div><div class="ttdeci">uint16_t track</div><div class="ttdoc">Track number the flux capture corresponds to.</div><div class="ttdef"><b>Definition</b> <a href="#l00185">flux.h:185</a></div></div>
<div class="ttc" id="astructFluxCaptureRecord_html"><div class="ttname"><a href="structFluxCaptureRecord.html">FluxCaptureRecord</a></div><div class="ttdoc">Internal structure for storing flux capture data during write mode.</div><div class="ttdef"><b>Definition</b> <a href="#l00270">flux.h:271</a></div></div>
<div class="ttc" id="astructFluxCaptureRecord_html_a002dbda89d68adac0d0a8281d34fc76a"><div class="ttname"><a href="structFluxCaptureRecord.html#a002dbda89d68adac0d0a8281d34fc76a">FluxCaptureRecord::entry</a></div><div class="ttdeci">FluxEntry entry</div><div class="ttdoc">Flux entry metadata describing this capture.</div><div class="ttdef"><b>Definition</b> <a href="#l00272">flux.h:272</a></div></div>
<div class="ttc" id="astructFluxCaptureRecord_html_a9563435372ecc4af506c4fae2ac2f617"><div class="ttname"><a href="structFluxCaptureRecord.html#a9563435372ecc4af506c4fae2ac2f617">FluxCaptureRecord::data_length</a></div><div class="ttdeci">uint32_t data_length</div><div class="ttdoc">Length of the data buffer in bytes.</div><div class="ttdef"><b>Definition</b> <a href="#l00274">flux.h:274</a></div></div>
<div class="ttc" id="astructFluxCaptureRecord_html_adcf7766ac4311fe79a1324f2eec6868d"><div class="ttname"><a href="structFluxCaptureRecord.html#adcf7766ac4311fe79a1324f2eec6868d">FluxCaptureRecord::index_length</a></div><div class="ttdeci">uint32_t index_length</div><div class="ttdoc">Length of the index buffer in bytes.</div><div class="ttdef"><b>Definition</b> <a href="#l00276">flux.h:276</a></div></div>
<div class="ttc" id="astructFluxCaptureRecord_html_af5bce1443f5112ce65f54c39ff873b57"><div class="ttname"><a href="structFluxCaptureRecord.html#af5bce1443f5112ce65f54c39ff873b57">FluxCaptureRecord::index_buffer</a></div><div class="ttdeci">uint8_t * index_buffer</div><div class="ttdoc">Pointer to the flux index buffer. Owned by the utarray, freed automatically.</div><div class="ttdef"><b>Definition</b> <a href="#l00275">flux.h:275</a></div></div>
<div class="ttc" id="astructFluxCaptureRecord_html_afd9cf94122b9f59c548cda29599f8047"><div class="ttname"><a href="structFluxCaptureRecord.html#afd9cf94122b9f59c548cda29599f8047">FluxCaptureRecord::data_buffer</a></div><div class="ttdeci">uint8_t * data_buffer</div><div class="ttdoc">Pointer to the flux data buffer. Owned by the utarray, freed automatically.</div><div class="ttdef"><b>Definition</b> <a href="#l00273">flux.h:273</a></div></div>
<div class="ttc" id="astructFluxEntry_html"><div class="ttname"><a href="structFluxEntry.html">FluxEntry</a></div><div class="ttdoc">Metadata entry describing a single flux capture in the FluxDataBlock.</div><div class="ttdef"><b>Definition</b> <a href="#l00155">flux.h:156</a></div></div>
<div class="ttc" id="astructFluxEntry_html_a12f64e1c66187ebbbdcdf03916293c95"><div class="ttname"><a href="structFluxEntry.html#a12f64e1c66187ebbbdcdf03916293c95">FluxEntry::indexResolution</a></div><div class="ttdeci">uint64_t indexResolution</div><div class="ttdoc">Resolution in picoseconds at which the index stream was sampled.</div><div class="ttdef"><b>Definition</b> <a href="#l00161">flux.h:161</a></div></div>
<div class="ttc" id="astructFluxEntry_html_a27c590b581f2ea33306f89e609c28c95"><div class="ttname"><a href="structFluxEntry.html#a27c590b581f2ea33306f89e609c28c95">FluxEntry::dataResolution</a></div><div class="ttdeci">uint64_t dataResolution</div><div class="ttdoc">Resolution in picoseconds at which the data stream was sampled.</div><div class="ttdef"><b>Definition</b> <a href="#l00162">flux.h:162</a></div></div>
<div class="ttc" id="astructFluxEntry_html_a31cafff6f54acc9e019da447e94ace4a"><div class="ttname"><a href="structFluxEntry.html#a31cafff6f54acc9e019da447e94ace4a">FluxEntry::head</a></div><div class="ttdeci">uint32_t head</div><div class="ttdoc">Head number the flux capture corresponds to. Typically 0 or 1 for double-sided media.</div><div class="ttdef"><b>Definition</b> <a href="#l00157">flux.h:157</a></div></div>
<div class="ttc" id="astructFluxEntry_html_a3f5949d0feb9bdcf62afeb1acb1fa009"><div class="ttname"><a href="structFluxEntry.html#a3f5949d0feb9bdcf62afeb1acb1fa009">FluxEntry::payloadOffset</a></div><div class="ttdeci">uint64_t payloadOffset</div><div class="ttdoc">Block-aligned file offset where the DataStreamPayloadBlock containing this capture&#39;s data is stored,...</div><div class="ttdef"><b>Definition</b> <a href="#l00164">flux.h:164</a></div></div>
<div class="ttc" id="astructFluxEntry_html_a46108bba60946e7b7d4f41160e3dfd86"><div class="ttname"><a href="structFluxEntry.html#a46108bba60946e7b7d4f41160e3dfd86">FluxEntry::track</a></div><div class="ttdeci">uint16_t track</div><div class="ttdoc">Track number the flux capture corresponds to. Track numbering is format-dependent.</div><div class="ttdef"><b>Definition</b> <a href="#l00158">flux.h:158</a></div></div>
<div class="ttc" id="astructFluxEntry_html_aaaaaf686bec81c632f8de3131b540946"><div class="ttname"><a href="structFluxEntry.html#aaaaaf686bec81c632f8de3131b540946">FluxEntry::indexOffset</a></div><div class="ttdeci">uint64_t indexOffset</div><div class="ttdoc">Byte offset within the payload where the index buffer starts (equals data_length).</div><div class="ttdef"><b>Definition</b> <a href="#l00163">flux.h:163</a></div></div>
<div class="ttc" id="astructFluxEntry_html_abd12c00010d82cd83820dd3405b7b860"><div class="ttname"><a href="structFluxEntry.html#abd12c00010d82cd83820dd3405b7b860">FluxEntry::subtrack</a></div><div class="ttdeci">uint8_t subtrack</div><div class="ttdoc">Subtrack number, allowing sub-stepping within a track. Used for fine positioning.</div><div class="ttdef"><b>Definition</b> <a href="#l00159">flux.h:159</a></div></div>
<div class="ttc" id="astructFluxEntry_html_ae5af51709faf749501d44b242a57481c"><div class="ttname"><a href="structFluxEntry.html#ae5af51709faf749501d44b242a57481c">FluxEntry::captureIndex</a></div><div class="ttdeci">uint32_t captureIndex</div><div class="ttdoc">Capture index, allowing multiple captures for the same location (e.g., multiple revolutions).</div><div class="ttdef"><b>Definition</b> <a href="#l00160">flux.h:160</a></div></div>
<div class="ttc" id="astructFluxHeader_html"><div class="ttname"><a href="structFluxHeader.html">FluxHeader</a></div><div class="ttdoc">Header structure for a FluxDataBlock containing flux capture metadata.</div><div class="ttdef"><b>Definition</b> <a href="#l00116">flux.h:117</a></div></div>
<div class="ttc" id="astructFluxHeader_html_a17794a3f0cc5b11a5169580cc510a71c"><div class="ttname"><a href="structFluxHeader.html#a17794a3f0cc5b11a5169580cc510a71c">FluxHeader::identifier</a></div><div class="ttdeci">uint32_t identifier</div><div class="ttdoc">Block identifier, must be BlockType::FluxDataBlock (0x58554C46, &quot;FLUX&quot;).</div><div class="ttdef"><b>Definition</b> <a href="#l00118">flux.h:118</a></div></div>
<div class="ttc" id="astructFluxHeader_html_a26f2a1be977dc973341e6952eba159dc"><div class="ttname"><a href="structFluxHeader.html#a26f2a1be977dc973341e6952eba159dc">FluxHeader::entries</a></div><div class="ttdeci">uint16_t entries</div><div class="ttdoc">Number of FluxEntry records following this header. Maximum value: 65535.</div><div class="ttdef"><b>Definition</b> <a href="#l00119">flux.h:119</a></div></div>
<div class="ttc" id="astructFluxHeader_html_a3980b9bf3db82de544c991cae4e6126a"><div class="ttname"><a href="structFluxHeader.html#a3980b9bf3db82de544c991cae4e6126a">FluxHeader::crc64</a></div><div class="ttdeci">uint64_t crc64</div><div class="ttdoc">CRC64-ECMA checksum of the FluxEntry array (header excluded).</div><div class="ttdef"><b>Definition</b> <a href="#l00121">flux.h:121</a></div></div>
<div class="ttc" id="astructFluxHeader_html_a8e2f7fb0153155438629cda42cb6f329"><div class="ttname"><a href="structFluxHeader.html#a8e2f7fb0153155438629cda42cb6f329">FluxHeader::blockAlignmentShift</a></div><div class="ttdeci">uint8_t blockAlignmentShift</div><div class="ttdoc">Block alignment shift: 2^blockAlignmentShift = block alignment boundary in bytes.</div><div class="ttdef"><b>Definition</b> <a href="#l00120">flux.h:120</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="dir_aeff2545c9dfcfc842fe9d84b123cb31.html">aaruformat</a></li><li class="navelem"><a href="dir_6387aeb6e475a334d8dc12d69f21999e.html">structs</a></li><li class="navelem"><a href="flux_8h.html">flux.h</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>
</ul>
</div>
</body>
</html>