release/src/router/flac/doc/html/api/group__flac__callbacks.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>FLAC: FLAC/callback.h: I/O callback structures</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 </head><body>
   6 <!-- Generated by Doxygen 1.4.2 -->
   7 <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
   8 <h1>FLAC/callback.h: I/O callback structures<br>
   9 <small>
  10 [<a class="el" href="group__flac.html">FLAC C API</a>]</small>
  11 </h1><hr><a name="_details"></a><h2>Detailed Description</h2>
  12 This module defines the structures for describing I/O callbacks to the other FLAC interfaces.
  13 <p>
  14 The purpose of the I/O callback functions is to create a common way for the metadata interfaces to handle I/O.<p>
  15 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>
  16 In addition to the callbacks, a FLAC__IOHandle type is defined as an opaque structure for a data source.<p>
  17 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. <dl compact><dt><b>Warning:</b></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>
  18
  19 <p>
  20 <table border="0" cellpadding="0" cellspacing="0">
  21 <tr><td></td></tr>
  22 <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
  23 <tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a></td></tr>
  24
  25 <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
  26 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a></td></tr>
  27
  28 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef size_t(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga1">FLAC__IOCallback_Read</a> )(void *ptr, size_t size, size_t nmemb, <a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle)</td></tr>
  29
  30 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef size_t(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga2">FLAC__IOCallback_Write</a> )(const void *ptr, size_t size, size_t nmemb, <a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle)</td></tr>
  31
  32 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga3">FLAC__IOCallback_Seek</a> )(<a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle, FLAC__int64 offset, int whence)</td></tr>
  33
  34 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef FLAC__int64(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga4">FLAC__IOCallback_Tell</a> )(<a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle)</td></tr>
  35
  36 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga5">FLAC__IOCallback_Eof</a> )(<a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle)</td></tr>
  37
  38 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga6">FLAC__IOCallback_Close</a> )(<a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle)</td></tr>
  39
  40 </table>
  41 <hr><h2>Typedef Documentation</h2>
  42 <a class="anchor" name="ga0" doxytag="callback.h::FLAC__IOHandle"></a><p>
  43 <table class="mdTable" cellpadding="2" cellspacing="0">
  44   <tr>
  45     <td class="mdRow">
  46       <table cellpadding="0" cellspacing="0" border="0">
  47         <tr>
  48           <td class="md" nowrap valign="top">typedef void* <a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a>          </td>
  49         </tr>
  50       </table>
  51     </td>
  52   </tr>
  53 </table>
  54 <table cellspacing="5" cellpadding="0" border="0">
  55   <tr>
  56     <td>
  57       &nbsp;
  58     </td>
  59     <td>
  60
  61 <p>
  62 This is the opaque handle type used by the callbacks. Typically this is a <code>FILE*</code> or address of a file descriptor.     </td>
  63   </tr>
  64 </table>
  65 <a class="anchor" name="ga1" doxytag="callback.h::FLAC__IOCallback_Read"></a><p>
  66 <table class="mdTable" cellpadding="2" cellspacing="0">
  67   <tr>
  68     <td class="mdRow">
  69       <table cellpadding="0" cellspacing="0" border="0">
  70         <tr>
  71           <td class="md" nowrap valign="top">typedef size_t(* <a class="el" href="group__flac__callbacks.html#ga1">FLAC__IOCallback_Read</a>)(void *ptr, size_t size, size_t nmemb, <a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle)          </td>
  72         </tr>
  73       </table>
  74     </td>
  75   </tr>
  76 </table>
  77 <table cellspacing="5" cellpadding="0" border="0">
  78   <tr>
  79     <td>
  80       &nbsp;
  81     </td>
  82     <td>
  83
  84 <p>
  85 Signature for the read callback. The signature and semantics match POSIX fread() implementations and can generally be used interchangeably.<p>
  86 <dl compact><dt><b>Parameters:</b></dt><dd>
  87   <table border="0" cellspacing="2" cellpadding="0">
  88     <tr><td valign="top"></td><td valign="top"><em>ptr</em>&nbsp;</td><td>The address of the read buffer. </td></tr>
  89     <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>The size of the records to be read. </td></tr>
  90     <tr><td valign="top"></td><td valign="top"><em>nmemb</em>&nbsp;</td><td>The number of records to be read. </td></tr>
  91     <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>The handle to the data source. </td></tr>
  92   </table>
  93 </dl>
  94 <dl compact><dt><b>Return values:</b></dt><dd>
  95   <table border="0" cellspacing="2" cellpadding="0">
  96     <tr><td valign="top"></td><td valign="top"><em>size_t</em>&nbsp;</td><td>The number of records read. </td></tr>
  97   </table>
  98 </dl>
  99     </td>
 100   </tr>
 101 </table>
 102 <a class="anchor" name="ga2" doxytag="callback.h::FLAC__IOCallback_Write"></a><p>
 103 <table class="mdTable" cellpadding="2" cellspacing="0">
 104   <tr>
 105     <td class="mdRow">
 106       <table cellpadding="0" cellspacing="0" border="0">
 107         <tr>
 108           <td class="md" nowrap valign="top">typedef size_t(* <a class="el" href="group__flac__callbacks.html#ga2">FLAC__IOCallback_Write</a>)(const void *ptr, size_t size, size_t nmemb, <a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle)          </td>
 109         </tr>
 110       </table>
 111     </td>
 112   </tr>
 113 </table>
 114 <table cellspacing="5" cellpadding="0" border="0">
 115   <tr>
 116     <td>
 117       &nbsp;
 118     </td>
 119     <td>
 120
 121 <p>
 122 Signature for the write callback. The signature and semantics match POSIX fwrite() implementations and can generally be used interchangeably.<p>
 123 <dl compact><dt><b>Parameters:</b></dt><dd>
 124   <table border="0" cellspacing="2" cellpadding="0">
 125     <tr><td valign="top"></td><td valign="top"><em>ptr</em>&nbsp;</td><td>The address of the write buffer. </td></tr>
 126     <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>The size of the records to be written. </td></tr>
 127     <tr><td valign="top"></td><td valign="top"><em>nmemb</em>&nbsp;</td><td>The number of records to be written. </td></tr>
 128     <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>The handle to the data source. </td></tr>
 129   </table>
 130 </dl>
 131 <dl compact><dt><b>Return values:</b></dt><dd>
 132   <table border="0" cellspacing="2" cellpadding="0">
 133     <tr><td valign="top"></td><td valign="top"><em>size_t</em>&nbsp;</td><td>The number of records written. </td></tr>
 134   </table>
 135 </dl>
 136     </td>
 137   </tr>
 138 </table>
 139 <a class="anchor" name="ga3" doxytag="callback.h::FLAC__IOCallback_Seek"></a><p>
 140 <table class="mdTable" cellpadding="2" cellspacing="0">
 141   <tr>
 142     <td class="mdRow">
 143       <table cellpadding="0" cellspacing="0" border="0">
 144         <tr>
 145           <td class="md" nowrap valign="top">typedef int(* <a class="el" href="group__flac__callbacks.html#ga3">FLAC__IOCallback_Seek</a>)(<a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle, FLAC__int64 offset, int whence)          </td>
 146         </tr>
 147       </table>
 148     </td>
 149   </tr>
 150 </table>
 151 <table cellspacing="5" cellpadding="0" border="0">
 152   <tr>
 153     <td>
 154       &nbsp;
 155     </td>
 156     <td>
 157
 158 <p>
 159 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>
 160 <dl compact><dt><b>Parameters:</b></dt><dd>
 161   <table border="0" cellspacing="2" cellpadding="0">
 162     <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>The handle to the data source. </td></tr>
 163     <tr><td valign="top"></td><td valign="top"><em>offset</em>&nbsp;</td><td>The new position, relative to <em>whence</em> </td></tr>
 164     <tr><td valign="top"></td><td valign="top"><em>whence</em>&nbsp;</td><td><code>SEEK_SET</code>, <code>SEEK_CUR</code>, or <code>SEEK_END</code> </td></tr>
 165   </table>
 166 </dl>
 167 <dl compact><dt><b>Return values:</b></dt><dd>
 168   <table border="0" cellspacing="2" cellpadding="0">
 169     <tr><td valign="top"></td><td valign="top"><em>int</em>&nbsp;</td><td><code>0</code> on success, <code>-1</code> on error. </td></tr>
 170   </table>
 171 </dl>
 172     </td>
 173   </tr>
 174 </table>
 175 <a class="anchor" name="ga4" doxytag="callback.h::FLAC__IOCallback_Tell"></a><p>
 176 <table class="mdTable" cellpadding="2" cellspacing="0">
 177   <tr>
 178     <td class="mdRow">
 179       <table cellpadding="0" cellspacing="0" border="0">
 180         <tr>
 181           <td class="md" nowrap valign="top">typedef FLAC__int64(* <a class="el" href="group__flac__callbacks.html#ga4">FLAC__IOCallback_Tell</a>)(<a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle)          </td>
 182         </tr>
 183       </table>
 184     </td>
 185   </tr>
 186 </table>
 187 <table cellspacing="5" cellpadding="0" border="0">
 188   <tr>
 189     <td>
 190       &nbsp;
 191     </td>
 192     <td>
 193
 194 <p>
 195 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>
 196 <dl compact><dt><b>Parameters:</b></dt><dd>
 197   <table border="0" cellspacing="2" cellpadding="0">
 198     <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>The handle to the data source. </td></tr>
 199   </table>
 200 </dl>
 201 <dl compact><dt><b>Return values:</b></dt><dd>
 202   <table border="0" cellspacing="2" cellpadding="0">
 203     <tr><td valign="top"></td><td valign="top"><em>FLAC__int64</em>&nbsp;</td><td>The current position on success, <code>-1</code> on error. </td></tr>
 204   </table>
 205 </dl>
 206     </td>
 207   </tr>
 208 </table>
 209 <a class="anchor" name="ga5" doxytag="callback.h::FLAC__IOCallback_Eof"></a><p>
 210 <table class="mdTable" cellpadding="2" cellspacing="0">
 211   <tr>
 212     <td class="mdRow">
 213       <table cellpadding="0" cellspacing="0" border="0">
 214         <tr>
 215           <td class="md" nowrap valign="top">typedef int(* <a class="el" href="group__flac__callbacks.html#ga5">FLAC__IOCallback_Eof</a>)(<a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle)          </td>
 216         </tr>
 217       </table>
 218     </td>
 219   </tr>
 220 </table>
 221 <table cellspacing="5" cellpadding="0" border="0">
 222   <tr>
 223     <td>
 224       &nbsp;
 225     </td>
 226     <td>
 227
 228 <p>
 229 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>
 230 <dl compact><dt><b>Parameters:</b></dt><dd>
 231   <table border="0" cellspacing="2" cellpadding="0">
 232     <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>The handle to the data source. </td></tr>
 233   </table>
 234 </dl>
 235 <dl compact><dt><b>Return values:</b></dt><dd>
 236   <table border="0" cellspacing="2" cellpadding="0">
 237     <tr><td valign="top"></td><td valign="top"><em>int</em>&nbsp;</td><td><code>0</code> if not at end of file, nonzero if at end of file. </td></tr>
 238   </table>
 239 </dl>
 240     </td>
 241   </tr>
 242 </table>
 243 <a class="anchor" name="ga6" doxytag="callback.h::FLAC__IOCallback_Close"></a><p>
 244 <table class="mdTable" cellpadding="2" cellspacing="0">
 245   <tr>
 246     <td class="mdRow">
 247       <table cellpadding="0" cellspacing="0" border="0">
 248         <tr>
 249           <td class="md" nowrap valign="top">typedef int(* <a class="el" href="group__flac__callbacks.html#ga6">FLAC__IOCallback_Close</a>)(<a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle)          </td>
 250         </tr>
 251       </table>
 252     </td>
 253   </tr>
 254 </table>
 255 <table cellspacing="5" cellpadding="0" border="0">
 256   <tr>
 257     <td>
 258       &nbsp;
 259     </td>
 260     <td>
 261
 262 <p>
 263 Signature for the close callback. The signature and semantics match POSIX fclose() implementations and can generally be used interchangeably.<p>
 264 <dl compact><dt><b>Parameters:</b></dt><dd>
 265   <table border="0" cellspacing="2" cellpadding="0">
 266     <tr><td valign="top"></td><td valign="top"><em>handle</em>&nbsp;</td><td>The handle to the data source. </td></tr>
 267   </table>
 268 </dl>
 269 <dl compact><dt><b>Return values:</b></dt><dd>
 270   <table border="0" cellspacing="2" cellpadding="0">
 271     <tr><td valign="top"></td><td valign="top"><em>int</em>&nbsp;</td><td><code>0</code> on success, <code>EOF</code> on error. </td></tr>
 272   </table>
 273 </dl>
 274     </td>
 275   </tr>
 276 </table>
 277
 278 <hr size="1">
 279 <div class="copyright">
 280         <!-- @@@ oh so hacky -->
 281         <table>
 282                 <tr>
 283                         <td align="left">
 284                                 Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007  Josh Coalson
 285                         </td>
 286                         <td width="1%" align="right">
 287                                 <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>
 288                         </td>
 289                 </tr>
 290         </table>
 291 </div>
 292 <!-- Copyright (c)  2000,2001,2002,2003,2004,2005,2006,2007  Josh Coalson -->
 293 <!-- Permission is granted to copy, distribute and/or modify this document -->
 294 <!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
 295 <!-- or any later version published by the Free Software Foundation; -->
 296 <!-- with no invariant sections. -->
 297 <!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
 298 </body>
 299 </html>