mirror of
https://github.com/aaru-dps/libaaruformat.git
synced 2026-07-09 02:16:24 +00:00
171 lines
16 KiB
HTML
171 lines
16 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.16.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libaaruformat: src/ngcw/lfg.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"> 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.16.1 -->
|
|
<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('lfg_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">lfg.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="lfg_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-2026 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; version 2.1 of the License.</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> *</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> * This library is distributed in the hope that it will be useful, but</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Lesser General Public License for more details.</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> *</span></div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * You should have received a copy of the GNU Lesser General Public</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * License along with this library; if not, see</span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * <https://www.gnu.org/licenses/>.</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><span class="comment"> * Lagged Fibonacci Generator for Nintendo GameCube/Wii junk fill.</span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> * Based on Dolphin emulator's LaggedFibonacciGenerator (CC0 licensed).</span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#ifndef LIBAARUFORMAT_NGCW_LFG_H</span></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#define LIBAARUFORMAT_NGCW_LFG_H</span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <stdbool.h></span></div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <stddef.h></span></div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include <stdint.h></span></div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword">extern</span> <span class="stringliteral">"C"</span></div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>{</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="lfg_8h.html#a16edb4e9c0a519cb423979b38d8f132a"> 34</a></span><span class="preprocessor">#define NGC_LFG_K 521 </span><span class="preprocessor"></span></div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="lfg_8h.html#a865dc66e4ab8ae46527b88c2c119807a"> 35</a></span><span class="preprocessor">#define NGC_LFG_J 32 </span><span class="preprocessor"></span></div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="lfg_8h.html#a2c4db3d8d295f706dcacc8a4d039beed"> 36</a></span><span class="preprocessor">#define NGC_LFG_SEED_SIZE 17 </span><span class="preprocessor"></span></div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span></div>
|
|
<div class="foldopen" id="foldopen00041" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="structngc__lfg__ctx.html"> 41</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structngc__lfg__ctx.html">ngc_lfg_ctx</a></div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> {</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="structngc__lfg__ctx.html#a9b5c7dbc3b197b77bef259cd8bbb408a"> 43</a></span> uint32_t <a class="code hl_variable" href="structngc__lfg__ctx.html#a9b5c7dbc3b197b77bef259cd8bbb408a">buffer</a>[<a class="code hl_define" href="lfg_8h.html#a16edb4e9c0a519cb423979b38d8f132a">NGC_LFG_K</a>];</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="structngc__lfg__ctx.html#a84958bcdb9e96a4231aa4f43d5415eea"> 44</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structngc__lfg__ctx.html#a84958bcdb9e96a4231aa4f43d5415eea">position_bytes</a>;</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> };</div>
|
|
</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span></div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordtype">void</span> <a class="code hl_function" href="lfg_8h.html#abc583da3bb66cab3eafc3496bc46e193">ngc_lfg_set_seed</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structngc__lfg__ctx.html">ngc_lfg_ctx</a> *ctx, <span class="keyword">const</span> uint32_t seed[<a class="code hl_define" href="lfg_8h.html#a2c4db3d8d295f706dcacc8a4d039beed">NGC_LFG_SEED_SIZE</a>]);</div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span></div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">void</span> <a class="code hl_function" href="lfg_8h.html#a25e6df5ee051a324d943185f193d3418">ngc_lfg_get_bytes</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="structngc__lfg__ctx.html">ngc_lfg_ctx</a> *ctx, uint8_t *out, <span class="keywordtype">size_t</span> count);</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span></div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="lfg_8h.html#aef1434f019902caf30f1d4fe577267ba">ngc_lfg_get_seed</a>(<span class="keyword">const</span> uint8_t *data, <span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> data_offset, uint32_t seed_out[<a class="code hl_define" href="lfg_8h.html#a2c4db3d8d295f706dcacc8a4d039beed">NGC_LFG_SEED_SIZE</a>]);</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span>}</div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="preprocessor">#endif </span><span class="comment">/* LIBAARUFORMAT_NGCW_LFG_H */</span><span class="preprocessor"></span></div>
|
|
<div class="ttc" id="alfg_8h_html_a16edb4e9c0a519cb423979b38d8f132a"><div class="ttname"><a href="lfg_8h.html#a16edb4e9c0a519cb423979b38d8f132a">NGC_LFG_K</a></div><div class="ttdeci">#define NGC_LFG_K</div><div class="ttdoc">LFG buffer size (number of uint32 words in state).</div><div class="ttdef"><b>Definition</b> <a href="#l00034">lfg.h:34</a></div></div>
|
|
<div class="ttc" id="alfg_8h_html_a25e6df5ee051a324d943185f193d3418"><div class="ttname"><a href="lfg_8h.html#a25e6df5ee051a324d943185f193d3418">ngc_lfg_get_bytes</a></div><div class="ttdeci">void ngc_lfg_get_bytes(struct ngc_lfg_ctx *ctx, uint8_t *out, size_t count)</div><div class="ttdoc">Generate count bytes of junk data into out.</div><div class="ttdef"><b>Definition</b> <a href="lfg_8c_source.html#l00082">lfg.c:82</a></div></div>
|
|
<div class="ttc" id="alfg_8h_html_a2c4db3d8d295f706dcacc8a4d039beed"><div class="ttname"><a href="lfg_8h.html#a2c4db3d8d295f706dcacc8a4d039beed">NGC_LFG_SEED_SIZE</a></div><div class="ttdeci">#define NGC_LFG_SEED_SIZE</div><div class="ttdoc">Number of uint32 words needed to seed the LFG.</div><div class="ttdef"><b>Definition</b> <a href="#l00036">lfg.h:36</a></div></div>
|
|
<div class="ttc" id="alfg_8h_html_abc583da3bb66cab3eafc3496bc46e193"><div class="ttname"><a href="lfg_8h.html#abc583da3bb66cab3eafc3496bc46e193">ngc_lfg_set_seed</a></div><div class="ttdeci">void ngc_lfg_set_seed(struct ngc_lfg_ctx *ctx, const uint32_t seed[17])</div><div class="ttdoc">Initialize the LFG from a 17-word big-endian seed.</div><div class="ttdef"><b>Definition</b> <a href="lfg_8c_source.html#l00073">lfg.c:73</a></div></div>
|
|
<div class="ttc" id="alfg_8h_html_aef1434f019902caf30f1d4fe577267ba"><div class="ttname"><a href="lfg_8h.html#aef1434f019902caf30f1d4fe577267ba">ngc_lfg_get_seed</a></div><div class="ttdeci">size_t ngc_lfg_get_seed(const uint8_t *data, size_t size, size_t data_offset, uint32_t seed_out[17])</div><div class="ttdoc">Try to extract the LFG seed from a chunk of data.</div><div class="ttdef"><b>Definition</b> <a href="lfg_8c_source.html#l00121">lfg.c:121</a></div></div>
|
|
<div class="ttc" id="astructngc__lfg__ctx_html"><div class="ttname"><a href="structngc__lfg__ctx.html">ngc_lfg_ctx</a></div><div class="ttdoc">LFG context holding the 521-word circular buffer and byte position.</div><div class="ttdef"><b>Definition</b> <a href="#l00041">lfg.h:42</a></div></div>
|
|
<div class="ttc" id="astructngc__lfg__ctx_html_a84958bcdb9e96a4231aa4f43d5415eea"><div class="ttname"><a href="structngc__lfg__ctx.html#a84958bcdb9e96a4231aa4f43d5415eea">ngc_lfg_ctx::position_bytes</a></div><div class="ttdeci">size_t position_bytes</div><div class="ttdef"><b>Definition</b> <a href="#l00044">lfg.h:44</a></div></div>
|
|
<div class="ttc" id="astructngc__lfg__ctx_html_a9b5c7dbc3b197b77bef259cd8bbb408a"><div class="ttname"><a href="structngc__lfg__ctx.html#a9b5c7dbc3b197b77bef259cd8bbb408a">ngc_lfg_ctx::buffer</a></div><div class="ttdeci">uint32_t buffer[521]</div><div class="ttdef"><b>Definition</b> <a href="#l00043">lfg.h:43</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a href="dir_366d6a3889b2c1ca7d50351540a67e4b.html">ngcw</a></li><li class="navelem"><a href="lfg_8h.html">lfg.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.16.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|