aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2026-07-19 07:14:37 +00:00
Code Issues 3 Packages Projects Releases Wiki Activity
Files
devel
libaaruformat/docs/html/ngcw__junk_8h_source.html

186 lines
20 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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/ngcw_junk.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.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('ngcw__junk_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">ngcw_junk.h</div></div>
</div><!--header-->
<div class="contents">
<a href="ngcw__junk_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"> * &lt;https://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><span class="comment"> * Nintendo GameCube/Wii junk map: serialization, deserialization, regeneration.</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"> */</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#ifndef LIBAARUFORMAT_NGCW_JUNK_H</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#define LIBAARUFORMAT_NGCW_JUNK_H</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;stdbool.h&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &quot;<a class="code" href="lfg_8h.html">lfg.h</a>&quot;</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="comment">/* Forward declaration — guard against redefinition when aaruformat.h is also included */</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#ifndef AARUFORMAT_CONTEXT_DECLARED</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="ngcw__junk_8h.html#ad8587c84f30a3f328869e304138d3ad8"> 31</a></span><span class="preprocessor">#define AARUFORMAT_CONTEXT_DECLARED</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structaaruformat__context.html">aaruformat_context</a> <a class="code hl_struct" href="structaaruformat__context.html">aaruformat_context</a>;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span>{</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="ngcw__junk_8h.html#aca5694a8ac4a72ca048d30aa3e534a6b"> 40</a></span><span class="preprocessor">#define NGCW_JUNK_MAP_VERSION 1 </span><span class="preprocessor"></span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span></div>
<div class="foldopen" id="foldopen00047" data-start="{" data-end="};">
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="structNgcwJunkEntry.html"> 47</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structNgcwJunkEntry.html">NgcwJunkEntry</a></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> {</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="structNgcwJunkEntry.html#a80885eaf7c79a421d9565dbb7397fa2b"> 49</a></span> uint64_t <a class="code hl_variable" href="structNgcwJunkEntry.html#a80885eaf7c79a421d9565dbb7397fa2b">offset</a>; </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="structNgcwJunkEntry.html#a082ed622c7be36afb188f0c6f75e7127"> 50</a></span> uint64_t <a class="code hl_variable" href="structNgcwJunkEntry.html#a082ed622c7be36afb188f0c6f75e7127">length</a>; </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="structNgcwJunkEntry.html#a4ea4f27121829ac6b58029f5cea6845e"> 51</a></span> uint16_t <a class="code hl_variable" href="structNgcwJunkEntry.html#a4ea4f27121829ac6b58029f5cea6845e">partition_index</a>; </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="structNgcwJunkEntry.html#ae2c3941635f16c333685e0bd59ab7e41"> 52</a></span> uint32_t <a class="code hl_variable" href="structNgcwJunkEntry.html#ae2c3941635f16c333685e0bd59ab7e41">seed</a>[<a class="code hl_define" href="lfg_8h.html#a2c4db3d8d295f706dcacc8a4d039beed">NGC_LFG_SEED_SIZE</a>]; </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="ngcw__junk_8h.html#a745430b26784e92a2242c1010bf73340"> 53</a></span> } <a class="code hl_struct" href="structNgcwJunkEntry.html">NgcwJunkEntry</a>;</div>
</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> int32_t <a class="code hl_function" href="ngcw__junk_8h.html#a0db54dfda52f4a427fd159df3bc6dda0">ngcw_serialize_junk_map</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structNgcwJunkEntry.html">NgcwJunkEntry</a> *entries, uint32_t count, uint8_t **out_data,</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> uint32_t *out_len);</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> int32_t <a class="code hl_function" href="ngcw__junk_8h.html#a464c045db67240ae9c3e54fbf7d6d959">ngcw_deserialize_junk_map</a>(<span class="keyword">const</span> uint8_t *data, uint32_t data_len, <a class="code hl_struct" href="structNgcwJunkEntry.html">NgcwJunkEntry</a> **entries, uint32_t *count,</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> uint16_t *seed_size);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keywordtype">int</span> <a class="code hl_function" href="ngcw__junk_8h.html#af61bca5a962d01d631b0a7135be54f08">ngcw_regenerate_junk_sector</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structNgcwJunkEntry.html">NgcwJunkEntry</a> *entries, uint32_t entry_count, uint64_t disc_offset,</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> uint8_t *output, uint32_t length);</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keywordtype">void</span> <a class="code hl_function" href="ngcw__junk_8h.html#a8aae28231f89db161998f42c61b2e246">ngcw_junk_lazy_init</a>(<a class="code hl_struct" href="structaaruformat__context.html">aaruformat_context</a> *ctx);</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="preprocessor">#ifdef __cplusplus</span></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"> 118</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="preprocessor">#endif </span><span class="comment">/* LIBAARUFORMAT_NGCW_JUNK_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="alfg_8h_html"><div class="ttname"><a href="lfg_8h.html">lfg.h</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="lfg_8h_source.html#l00036">lfg.h:36</a></div></div>
<div class="ttc" id="angcw__junk_8h_html_a0db54dfda52f4a427fd159df3bc6dda0"><div class="ttname"><a href="ngcw__junk_8h.html#a0db54dfda52f4a427fd159df3bc6dda0">ngcw_serialize_junk_map</a></div><div class="ttdeci">int32_t ngcw_serialize_junk_map(const NgcwJunkEntry *entries, uint32_t count, uint8_t **out_data, uint32_t *out_len)</div><div class="ttdoc">Serialize a junk map for storage as a media tag.</div><div class="ttdef"><b>Definition</b> <a href="ngcw__junk_8c_source.html#l00075">ngcw_junk.c:75</a></div></div>
<div class="ttc" id="angcw__junk_8h_html_a464c045db67240ae9c3e54fbf7d6d959"><div class="ttname"><a href="ngcw__junk_8h.html#a464c045db67240ae9c3e54fbf7d6d959">ngcw_deserialize_junk_map</a></div><div class="ttdeci">int32_t ngcw_deserialize_junk_map(const uint8_t *data, uint32_t data_len, NgcwJunkEntry **entries, uint32_t *count, uint16_t *seed_size)</div><div class="ttdoc">Deserialize a junk map from a media tag buffer.</div><div class="ttdef"><b>Definition</b> <a href="ngcw__junk_8c_source.html#l00104">ngcw_junk.c:104</a></div></div>
<div class="ttc" id="angcw__junk_8h_html_a8aae28231f89db161998f42c61b2e246"><div class="ttname"><a href="ngcw__junk_8h.html#a8aae28231f89db161998f42c61b2e246">ngcw_junk_lazy_init</a></div><div class="ttdeci">void ngcw_junk_lazy_init(aaruformat_context *ctx)</div><div class="ttdoc">Lazy initialization: load junk map from media tags.</div><div class="ttdef"><b>Definition</b> <a href="ngcw__junk_8c_source.html#l00211">ngcw_junk.c:211</a></div></div>
<div class="ttc" id="angcw__junk_8h_html_af61bca5a962d01d631b0a7135be54f08"><div class="ttname"><a href="ngcw__junk_8h.html#af61bca5a962d01d631b0a7135be54f08">ngcw_regenerate_junk_sector</a></div><div class="ttdeci">int ngcw_regenerate_junk_sector(const NgcwJunkEntry *entries, uint32_t entry_count, uint64_t disc_offset, uint8_t *output, uint32_t length)</div><div class="ttdoc">Regenerate a junk sector from the junk map.</div><div class="ttdef"><b>Definition</b> <a href="ngcw__junk_8c_source.html#l00154">ngcw_junk.c:154</a></div></div>
<div class="ttc" id="astructNgcwJunkEntry_html"><div class="ttname"><a href="structNgcwJunkEntry.html">NgcwJunkEntry</a></div><div class="ttdoc">In-memory junk map entry.</div><div class="ttdef"><b>Definition</b> <a href="#l00047">ngcw_junk.h:48</a></div></div>
<div class="ttc" id="astructNgcwJunkEntry_html_a082ed622c7be36afb188f0c6f75e7127"><div class="ttname"><a href="structNgcwJunkEntry.html#a082ed622c7be36afb188f0c6f75e7127">NgcwJunkEntry::length</a></div><div class="ttdeci">uint64_t length</div><div class="ttdoc">Length of junk region in bytes.</div><div class="ttdef"><b>Definition</b> <a href="#l00050">ngcw_junk.h:50</a></div></div>
<div class="ttc" id="astructNgcwJunkEntry_html_a4ea4f27121829ac6b58029f5cea6845e"><div class="ttname"><a href="structNgcwJunkEntry.html#a4ea4f27121829ac6b58029f5cea6845e">NgcwJunkEntry::partition_index</a></div><div class="ttdeci">uint16_t partition_index</div><div class="ttdoc">Partition index (0xFFFF for GC / inter-partition).</div><div class="ttdef"><b>Definition</b> <a href="#l00051">ngcw_junk.h:51</a></div></div>
<div class="ttc" id="astructNgcwJunkEntry_html_a80885eaf7c79a421d9565dbb7397fa2b"><div class="ttname"><a href="structNgcwJunkEntry.html#a80885eaf7c79a421d9565dbb7397fa2b">NgcwJunkEntry::offset</a></div><div class="ttdeci">uint64_t offset</div><div class="ttdoc">Disc byte offset where junk starts.</div><div class="ttdef"><b>Definition</b> <a href="#l00049">ngcw_junk.h:49</a></div></div>
<div class="ttc" id="astructNgcwJunkEntry_html_ae2c3941635f16c333685e0bd59ab7e41"><div class="ttname"><a href="structNgcwJunkEntry.html#ae2c3941635f16c333685e0bd59ab7e41">NgcwJunkEntry::seed</a></div><div class="ttdeci">uint32_t seed[17]</div><div class="ttdoc">LFG seed (17 words, big-endian).</div><div class="ttdef"><b>Definition</b> <a href="#l00052">ngcw_junk.h:52</a></div></div>
<div class="ttc" id="astructaaruformat__context_html"><div class="ttname"><a href="structaaruformat__context.html">aaruformat_context</a></div><div class="ttdoc">Master context representing an open or in‑creation Aaru image.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00174">context.h:175</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="ngcw__junk_8h.html">ngcw_junk.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>
Reference in New Issue View Git Blame Copy Permalink