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" / >
2025-12-21 20:17:32 +00:00
< meta name = "generator" content = "Doxygen 1.15.0" / >
2025-10-11 01:35:43 +01:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< title > libaaruformat: include/aaruformat.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 -->
2025-12-21 20:17:32 +00:00
<!-- Generated by Doxygen 1.15.0 -->
2025-10-11 01:35:43 +01:00
< 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('aaruformat_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" > aaruformat.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< a href = "aaruformat_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 >
2025-12-23 08:23:57 +00:00
< 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 >
2025-10-11 01:35:43 +01:00
< 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 < http://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 > < / div >
< div class = "line" > < a id = "l00019" name = "l00019" > < / a > < span class = "lineno" > 19< / span > < span class = "preprocessor" > #ifndef LIBAARUFORMAT_AARUFORMAT_H< / span > < / div >
< div class = "line" > < a id = "l00020" name = "l00020" > < / a > < span class = "lineno" > 20< / span > < span class = "preprocessor" > #define LIBAARUFORMAT_AARUFORMAT_H< / 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" > < a class = "line" href = "aaruformat_8h.html#a1341a1043d24b7d7e234fcbfe52dd907" > 22< / a > < / span > < span class = "preprocessor" > #define LIBAARUFORMAT_MAJOR_VERSION 1< / span > < / div >
< div class = "line" > < a id = "l00023" name = "l00023" > < / a > < span class = "lineno" > < a class = "line" href = "aaruformat_8h.html#a9258501500f40e275641fca951a3ce04" > 23< / a > < / span > < span class = "preprocessor" > #define LIBAARUFORMAT_MINOR_VERSION 0< / 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 " < a class = "code" href = "consts_8h.html" > aaruformat/consts.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00026" name = "l00026" > < / a > < span class = "lineno" > 26< / span > < span class = "preprocessor" > #include " < a class = "code" href = "context_8h.html" > aaruformat/context.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00027" name = "l00027" > < / a > < span class = "lineno" > 27< / span > < span class = "preprocessor" > #include " < a class = "code" href = "crc64_8h.html" > aaruformat/crc64.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00028" name = "l00028" > < / a > < span class = "lineno" > 28< / span > < span class = "preprocessor" > #include " < a class = "code" href = "decls_8h.html" > aaruformat/decls.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00029" name = "l00029" > < / a > < span class = "lineno" > 29< / span > < span class = "preprocessor" > #include " < a class = "code" href = "endian_8h.html" > aaruformat/endian.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00030" name = "l00030" > < / a > < span class = "lineno" > 30< / span > < span class = "preprocessor" > #include " < a class = "code" href = "enums_8h.html" > aaruformat/enums.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00031" name = "l00031" > < / a > < span class = "lineno" > 31< / span > < span class = "preprocessor" > #include " < a class = "code" href = "errors_8h.html" > aaruformat/errors.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00032" name = "l00032" > < / a > < span class = "lineno" > 32< / span > < span class = "preprocessor" > #include " < a class = "code" href = "lru_8h.html" > aaruformat/lru.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00033" name = "l00033" > < / a > < span class = "lineno" > 33< / span > < span class = "preprocessor" > #include " < a class = "code" href = "simd_8h.html" > aaruformat/simd.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00034" name = "l00034" > < / a > < span class = "lineno" > 34< / span > < span class = "preprocessor" > #include " < a class = "code" href = "spamsum_8h.html" > aaruformat/spamsum.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00035" name = "l00035" > < / a > < span class = "lineno" > 35< / span > < span class = "preprocessor" > #include " < a class = "code" href = "structs_8h.html" > aaruformat/structs.h< / a > " < / span > < / div >
< div class = "line" > < a id = "l00036" name = "l00036" > < / a > < span class = "lineno" > 36< / span > < / div >
< div class = "line" > < a id = "l00037" name = "l00037" > < / a > < span class = "lineno" > 37< / span > < span class = "preprocessor" > #endif < / span > < span class = "comment" > // LIBAARUFORMAT_AARUFORMAT_H< / span > < / div >
< div class = "ttc" id = "aconsts_8h_html" > < div class = "ttname" > < a href = "consts_8h.html" > consts.h< / a > < / div > < div class = "ttdoc" > Core public constants and compile‑ time limits for the Aaru container format implementation.< / div > < / div >
< div class = "ttc" id = "acontext_8h_html" > < div class = "ttname" > < a href = "context_8h.html" > context.h< / a > < / div > < div class = "ttdoc" > Central runtime context structures for libaaruformat (image state, caches, checksum buffers).< / div > < / div >
< div class = "ttc" id = "acrc64_8h_html" > < div class = "ttname" > < a href = "crc64_8h.html" > crc64.h< / a > < / div > < div class = "ttdoc" > CRC64 (ECMA-182) core context and precomputed slicing-by-4 tables.< / div > < / div >
< div class = "ttc" id = "adecls_8h_html" > < div class = "ttname" > < a href = "decls_8h.html" > decls.h< / a > < / div > < / div >
< div class = "ttc" id = "aendian_8h_html" > < div class = "ttname" > < a href = "endian_8h.html" > endian.h< / a > < / div > < / div >
< div class = "ttc" id = "aenums_8h_html" > < div class = "ttname" > < a href = "enums_8h.html" > enums.h< / a > < / div > < / div >
< div class = "ttc" id = "aerrors_8h_html" > < div class = "ttname" > < a href = "errors_8h.html" > errors.h< / a > < / div > < div class = "ttdoc" > Public error and status code definitions for libaaruformat.< / div > < / div >
< div class = "ttc" id = "alru_8h_html" > < div class = "ttname" > < a href = "lru_8h.html" > lru.h< / a > < / div > < / div >
< div class = "ttc" id = "asimd_8h_html" > < div class = "ttname" > < a href = "simd_8h.html" > simd.h< / a > < / div > < / div >
< div class = "ttc" id = "aspamsum_8h_html" > < div class = "ttname" > < a href = "spamsum_8h.html" > spamsum.h< / a > < / div > < / div >
< div class = "ttc" id = "astructs_8h_html" > < div class = "ttname" > < a href = "structs_8h.html" > structs.h< / 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 = "aaruformat_8h.html" > aaruformat.h< / a > < / li >
2025-12-21 20:17:32 +00:00
< 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 >
2025-10-11 01:35:43 +01:00
< / ul >
< / div >
< / body >
< / html >