aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2025-12-16 19:24:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
5e18870f01ed93072fbb013bbbb2b3affe9ce130
libaaruformat/docs/html/flac_8h_source.html

150 lines
13 KiB
HTML
Raw Normal View History

Add doxygen documentation
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"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: include/aaruformat/flac.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.14.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('flac_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">flac.h</div></div>
</div><!--header-->
<div class="contents">
<a href="flac_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="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#ifndef LIBAARUFORMAT_FLAC_H</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#define LIBAARUFORMAT_FLAC_H</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="foldopen" id="foldopen00022" data-start="{" data-end="};">
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="structaaru__flac__ctx.html"> 22</a></span><span class="keyword">typedef</span> <span class="keyword">struct</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"><a class="line" href="structaaru__flac__ctx.html#a41d284087a5b42585e9009e90aae5f45"> 24</a></span> <span class="keyword">const</span> uint8_t *<a class="code hl_variable" href="structaaru__flac__ctx.html#a41d284087a5b42585e9009e90aae5f45">src_buffer</a>;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="structaaru__flac__ctx.html#a86c4e3fc10363da913a2f0b820e247c2"> 25</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structaaru__flac__ctx.html#a86c4e3fc10363da913a2f0b820e247c2">src_len</a>;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="structaaru__flac__ctx.html#a5894510e7017a32406684b3d671081ce"> 26</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structaaru__flac__ctx.html#a5894510e7017a32406684b3d671081ce">src_pos</a>;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="structaaru__flac__ctx.html#aa6204407bc060dd3fb79a15d62400e4f"> 27</a></span> uint8_t *<a class="code hl_variable" href="structaaru__flac__ctx.html#aa6204407bc060dd3fb79a15d62400e4f">dst_buffer</a>;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="structaaru__flac__ctx.html#a22893942b9682a5a54e37f24c8fb72f9"> 28</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structaaru__flac__ctx.html#a22893942b9682a5a54e37f24c8fb72f9">dst_len</a>;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="structaaru__flac__ctx.html#a001fb0438c16ddce4a0f485600c0095b"> 29</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="structaaru__flac__ctx.html#a001fb0438c16ddce4a0f485600c0095b">dst_pos</a>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="structaaru__flac__ctx.html#a00ea4358e7738535296e7acdab63dd8b"> 30</a></span> uint8_t <a class="code hl_variable" href="structaaru__flac__ctx.html#a00ea4358e7738535296e7acdab63dd8b">error</a>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>} <a class="code hl_struct" href="structaaru__flac__ctx.html">aaru_flac_ctx</a>;</div>
</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_FLAC_H</span></div>
<div class="ttc" id="astructaaru__flac__ctx_html"><div class="ttname"><a href="structaaru__flac__ctx.html">aaru_flac_ctx</a></div><div class="ttdef"><b>Definition</b> <a href="#l00022">flac.h:23</a></div></div>
<div class="ttc" id="astructaaru__flac__ctx_html_a001fb0438c16ddce4a0f485600c0095b"><div class="ttname"><a href="structaaru__flac__ctx.html#a001fb0438c16ddce4a0f485600c0095b">aaru_flac_ctx::dst_pos</a></div><div class="ttdeci">size_t dst_pos</div><div class="ttdef"><b>Definition</b> <a href="#l00029">flac.h:29</a></div></div>
<div class="ttc" id="astructaaru__flac__ctx_html_a00ea4358e7738535296e7acdab63dd8b"><div class="ttname"><a href="structaaru__flac__ctx.html#a00ea4358e7738535296e7acdab63dd8b">aaru_flac_ctx::error</a></div><div class="ttdeci">uint8_t error</div><div class="ttdef"><b>Definition</b> <a href="#l00030">flac.h:30</a></div></div>
<div class="ttc" id="astructaaru__flac__ctx_html_a22893942b9682a5a54e37f24c8fb72f9"><div class="ttname"><a href="structaaru__flac__ctx.html#a22893942b9682a5a54e37f24c8fb72f9">aaru_flac_ctx::dst_len</a></div><div class="ttdeci">size_t dst_len</div><div class="ttdef"><b>Definition</b> <a href="#l00028">flac.h:28</a></div></div>
<div class="ttc" id="astructaaru__flac__ctx_html_a41d284087a5b42585e9009e90aae5f45"><div class="ttname"><a href="structaaru__flac__ctx.html#a41d284087a5b42585e9009e90aae5f45">aaru_flac_ctx::src_buffer</a></div><div class="ttdeci">const uint8_t * src_buffer</div><div class="ttdef"><b>Definition</b> <a href="#l00024">flac.h:24</a></div></div>
<div class="ttc" id="astructaaru__flac__ctx_html_a5894510e7017a32406684b3d671081ce"><div class="ttname"><a href="structaaru__flac__ctx.html#a5894510e7017a32406684b3d671081ce">aaru_flac_ctx::src_pos</a></div><div class="ttdeci">size_t src_pos</div><div class="ttdef"><b>Definition</b> <a href="#l00026">flac.h:26</a></div></div>
<div class="ttc" id="astructaaru__flac__ctx_html_a86c4e3fc10363da913a2f0b820e247c2"><div class="ttname"><a href="structaaru__flac__ctx.html#a86c4e3fc10363da913a2f0b820e247c2">aaru_flac_ctx::src_len</a></div><div class="ttdeci">size_t src_len</div><div class="ttdef"><b>Definition</b> <a href="#l00025">flac.h:25</a></div></div>
<div class="ttc" id="astructaaru__flac__ctx_html_aa6204407bc060dd3fb79a15d62400e4f"><div class="ttname"><a href="structaaru__flac__ctx.html#aa6204407bc060dd3fb79a15d62400e4f">aaru_flac_ctx::dst_buffer</a></div><div class="ttdeci">uint8_t * dst_buffer</div><div class="ttdef"><b>Definition</b> <a href="#l00027">flac.h:27</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="flac_8h.html">flac.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.14.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink