1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FLAC
 <span id="projectnumber">1.3.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<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  </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"> </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 * </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"> </td></tr>
<tr class="memitem:ga49d95218a6c09b215cd92cc96de71bf9"><td class="memItemLeft" align="right" valign="top">typedef size_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga49d95218a6c09b215cd92cc96de71bf9">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:ga49d95218a6c09b215cd92cc96de71bf9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad991792235879aecae289b56a112e1b8"><td class="memItemLeft" align="right" valign="top">typedef size_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#gad991792235879aecae289b56a112e1b8">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:gad991792235879aecae289b56a112e1b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab3942bbbd6ae09bcefe7cb3a0060c49c"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#gab3942bbbd6ae09bcefe7cb3a0060c49c">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:gab3942bbbd6ae09bcefe7cb3a0060c49c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga45314930cabc2e9c04867eae6bca309f"><td class="memItemLeft" align="right" valign="top">typedef FLAC__int64(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga45314930cabc2e9c04867eae6bca309f">FLAC__IOCallback_Tell</a>) (<a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a> handle)</td></tr>
<tr class="separator:ga45314930cabc2e9c04867eae6bca309f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga00ae3b3d373e691908e9539ebf720675"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga00ae3b3d373e691908e9539ebf720675">FLAC__IOCallback_Eof</a>) (<a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a> handle)</td></tr>
<tr class="separator:ga00ae3b3d373e691908e9539ebf720675"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0032267fac38220689778833e08f7387"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__callbacks.html#ga0032267fac38220689778833e08f7387">FLAC__IOCallback_Close</a>) (<a class="el" href="group__flac__callbacks.html#ga4c329c3168dee6e352384c5e9306260d">FLAC__IOHandle</a> handle)</td></tr>
<tr class="separator:ga0032267fac38220689778833e08f7387"><td class="memSeparator" colspan="2"> </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 id="ga4c329c3168dee6e352384c5e9306260d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4c329c3168dee6e352384c5e9306260d">◆ </a></span>FLAC__IOHandle</h2>
<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 id="ga49d95218a6c09b215cd92cc96de71bf9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga49d95218a6c09b215cd92cc96de71bf9">◆ </a></span>FLAC__IOCallback_Read</h2>
<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 id="gad991792235879aecae289b56a112e1b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad991792235879aecae289b56a112e1b8">◆ </a></span>FLAC__IOCallback_Write</h2>
<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 id="gab3942bbbd6ae09bcefe7cb3a0060c49c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab3942bbbd6ae09bcefe7cb3a0060c49c">◆ </a></span>FLAC__IOCallback_Seek</h2>
<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 id="ga45314930cabc2e9c04867eae6bca309f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga45314930cabc2e9c04867eae6bca309f">◆ </a></span>FLAC__IOCallback_Tell</h2>
<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 id="ga00ae3b3d373e691908e9539ebf720675"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga00ae3b3d373e691908e9539ebf720675">◆ </a></span>FLAC__IOCallback_Eof</h2>
<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 id="ga0032267fac38220689778833e08f7387"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0032267fac38220689778833e08f7387">◆ </a></span>FLAC__IOCallback_Close</h2>
<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-2016 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&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-2016 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>
|
