Autres/audacity
1
0
Fork 0
mirror of https://github.com/cookiengineer/audacity synced 2025-06-26 09:08:44 +02:00
Code Issues Releases Wiki Activity
6b9a63d4c8
audacity/lib-src/libflac/doc/html/api/group__flac__callbacks.html
Leland Lucius 4d08ed4287 Upgraded flac to 1.3.1
2015-05-01 03:33:07 -05:00

274 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>FLAC: FLAC/callback.h: I/O callback structures</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>
<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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FLAC
&#160;<span id="projectnumber">1.3.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">FLAC/callback.h: I/O callback structures<div class="ingroups"><a class="el" href="group__flac.html">FLAC C API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga4c329c3168dee6e352384c5e9306260d"><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a></td></tr>
<tr class="separator:ga4c329c3168dee6e352384c5e9306260d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5d75bd553bd041db0d30d869455bab38"><td class="memItemLeft" align="right" valign="top">typedef size_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga5d75bd553bd041db0d30d869455bab38">FLAC__IOCallback_Read</a> )(void *ptr, size_t size, size_t nmemb, <a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a> handle)</td></tr>
<tr class="separator:ga5d75bd553bd041db0d30d869455bab38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga473cbe45055fe15c967de13181d01e87"><td class="memItemLeft" align="right" valign="top">typedef size_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga473cbe45055fe15c967de13181d01e87">FLAC__IOCallback_Write</a> )(const void *ptr, size_t size, size_t nmemb, <a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a> handle)</td></tr>
<tr class="separator:ga473cbe45055fe15c967de13181d01e87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5090a35604829d8178f4f2d1a40a38d0"><td class="memItemLeft" align="right" valign="top">typedef int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga5090a35604829d8178f4f2d1a40a38d0">FLAC__IOCallback_Seek</a> )(<a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a> handle, FLAC__int64 offset, int whence)</td></tr>
<tr class="separator:ga5090a35604829d8178f4f2d1a40a38d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga016e3dd2d006975ea1031970dac232fb"><td class="memItemLeft" align="right" valign="top">typedef FLAC__int64(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga016e3dd2d006975ea1031970dac232fb">FLAC__IOCallback_Tell</a> )(<a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a> handle)</td></tr>
<tr class="separator:ga016e3dd2d006975ea1031970dac232fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac9fe1afad0426a8f1756d136b3442990"><td class="memItemLeft" align="right" valign="top">typedef int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#gac9fe1afad0426a8f1756d136b3442990">FLAC__IOCallback_Eof</a> )(<a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a> handle)</td></tr>
<tr class="separator:gac9fe1afad0426a8f1756d136b3442990"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3749f8621f43e937eb69a9536db3b19a"><td class="memItemLeft" align="right" valign="top">typedef int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga3749f8621f43e937eb69a9536db3b19a">FLAC__IOCallback_Close</a> )(<a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a> handle)</td></tr>
<tr class="separator:ga3749f8621f43e937eb69a9536db3b19a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>This module defines the structures for describing I/O callbacks to the other FLAC interfaces. </p>
<p>The purpose of the I/O callback functions is to create a common way for the metadata interfaces to handle I/O.</p>
<p>Originally the metadata interfaces required filenames as the way of specifying FLAC files to operate on. This is problematic in some environments so there is an additional option to specify a set of callbacks for doing I/O on the FLAC file, instead of the filename.</p>
<p>In addition to the callbacks, a FLAC__IOHandle type is defined as an opaque structure for a data source.</p>
<p>The callback function prototypes are similar (but not identical) to the stdio functions fread, fwrite, fseek, ftell, feof, and fclose. If you use stdio streams to implement the callbacks, you can pass fread, fwrite, and fclose anywhere a FLAC__IOCallback_Read, FLAC__IOCallback_Write, or FLAC__IOCallback_Close is required, and a FILE* anywhere a FLAC__IOHandle is required. </p><dl class="section warning"><dt>Warning</dt><dd>You generally CANNOT directly use fseek or ftell for FLAC__IOCallback_Seek or FLAC__IOCallback_Tell since on most systems these use 32-bit offsets and FLAC requires 64-bit offsets to deal with large files. You will have to find an equivalent function (e.g. ftello), or write a wrapper. The same is true for feof() since this is usually implemented as a macro, not as a function whose address can be taken. </dd></dl>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga4c329c3168dee6e352384c5e9306260d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>This is the opaque handle type used by the callbacks. Typically this is a <code>FILE*</code> or address of a file descriptor. </p>
</div>
</div>
<a class="anchor" id="ga5d75bd553bd041db0d30d869455bab38"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef size_t(* FLAC__IOCallback_Read)(void *ptr, size_t size, size_t nmemb, <a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a> handle)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for the read callback. The signature and semantics match POSIX fread() implementations and can generally be used interchangeably.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td>The address of the read buffer. </td></tr>
<tr><td class="paramname">size</td><td>The size of the records to be read. </td></tr>
<tr><td class="paramname">nmemb</td><td>The number of records to be read. </td></tr>
<tr><td class="paramname">handle</td><td>The handle to the data source. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">size_t</td><td>The number of records read. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga473cbe45055fe15c967de13181d01e87"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef size_t(* FLAC__IOCallback_Write)(const void *ptr, size_t size, size_t nmemb, <a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a> handle)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for the write callback. The signature and semantics match POSIX fwrite() implementations and can generally be used interchangeably.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ptr</td><td>The address of the write buffer. </td></tr>
<tr><td class="paramname">size</td><td>The size of the records to be written. </td></tr>
<tr><td class="paramname">nmemb</td><td>The number of records to be written. </td></tr>
<tr><td class="paramname">handle</td><td>The handle to the data source. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">size_t</td><td>The number of records written. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga5090a35604829d8178f4f2d1a40a38d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* FLAC__IOCallback_Seek)(<a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a> handle, FLAC__int64 offset, int whence)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for the seek callback. The signature and semantics mostly match POSIX fseek() WITH ONE IMPORTANT EXCEPTION: the offset is a 64-bit type whereas fseek() is generally 'long' and 32-bits wide.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The handle to the data source. </td></tr>
<tr><td class="paramname">offset</td><td>The new position, relative to <em>whence</em> </td></tr>
<tr><td class="paramname">whence</td><td><code>SEEK_SET</code>, <code>SEEK_CUR</code>, or <code>SEEK_END</code> </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">int</td><td><code>0</code> on success, <code>-1</code> on error. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga016e3dd2d006975ea1031970dac232fb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef FLAC__int64(* FLAC__IOCallback_Tell)(<a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a> handle)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for the tell callback. The signature and semantics mostly match POSIX ftell() WITH ONE IMPORTANT EXCEPTION: the offset is a 64-bit type whereas ftell() is generally 'long' and 32-bits wide.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The handle to the data source. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">FLAC__int64</td><td>The current position on success, <code>-1</code> on error. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gac9fe1afad0426a8f1756d136b3442990"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* FLAC__IOCallback_Eof)(<a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a> handle)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for the EOF callback. The signature and semantics mostly match POSIX feof() but WATCHOUT: on many systems, feof() is a macro, so in this case a wrapper function must be provided instead.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The handle to the data source. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">int</td><td><code>0</code> if not at end of file, nonzero if at end of file. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga3749f8621f43e937eb69a9536db3b19a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* FLAC__IOCallback_Close)(<a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a> handle)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Signature for the close callback. The signature and semantics match POSIX fclose() implementations and can generally be used interchangeably.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">handle</td><td>The handle to the data source. </td></tr>
</table>
</dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">int</td><td><code>0</code> on success, <code>EOF</code> on error. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<hr size="1">
<div class="copyright">
<!-- @@@ oh so hacky -->
<table>
<tr>
<td align="left">
Copyright (c) 2000-2009 Josh Coalson
Copyright (c) 2011-2014 Xiph.Org Foundation
</td>
<td width="1%" align="right">
<a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a>
</td>
</tr>
</table>
</div>
<!-- Copyright (c) 2000-2009 Josh Coalson -->
<!-- Copyright (c) 2011-2014 Xiph.Org Foundation -->
<!-- Permission is granted to copy, distribute and/or modify this document -->
<!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
<!-- or any later version published by the Free Software Foundation; -->
<!-- with no invariant sections. -->
<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink