sdk-world v2026.11.05
PS2 SDK - world tier (copyleft-allowed, non-essential packages)
Loading...
Searching...
No Matches
ftstream.h
Go to the documentation of this file.
1/****************************************************************************
2 *
3 * ftstream.h
4 *
5 * Stream handling (specification).
6 *
7 * Copyright (C) 1996-2025 by
8 * David Turner, Robert Wilhelm, and Werner Lemberg.
9 *
10 * This file is part of the FreeType project, and may only be used,
11 * modified, and distributed under the terms of the FreeType project
12 * license, LICENSE.TXT. By continuing to use, modify, or distribute
13 * this file you indicate that you have read the license and
14 * understand and accept it fully.
15 *
16 */
17
18
23#ifndef FTSTREAM_H_
24#define FTSTREAM_H_
25
26
27#include <ft2build.h>
28#include <freetype/ftsystem.h>
29#include <freetype/internal/ftobjs.h>
30
31
32FT_BEGIN_HEADER
33
34
35 /* format of an 8-bit frame_op value: */
36 /* */
37 /* bit 76543210 */
38 /* xxxxxxes */
39 /* */
40 /* s is set to 1 if the value is signed. */
41 /* e is set to 1 if the value is little-endian. */
42 /* xxx is a command. */
43
44#define FT_FRAME_OP_SHIFT 2
45#define FT_FRAME_OP_SIGNED 1
46#define FT_FRAME_OP_LITTLE 2
47#define FT_FRAME_OP_COMMAND( x ) ( x >> FT_FRAME_OP_SHIFT )
48
49#define FT_MAKE_FRAME_OP( command, little, sign ) \
50 ( ( command << FT_FRAME_OP_SHIFT ) | ( little << 1 ) | sign )
51
52#define FT_FRAME_OP_END 0
53#define FT_FRAME_OP_START 1 /* start a new frame */
54#define FT_FRAME_OP_BYTE 2 /* read 1-byte value */
55#define FT_FRAME_OP_SHORT 3 /* read 2-byte value */
56#define FT_FRAME_OP_LONG 4 /* read 4-byte value */
57#define FT_FRAME_OP_OFF3 5 /* read 3-byte value */
58#define FT_FRAME_OP_BYTES 6 /* read a bytes sequence */
59
60
61 typedef enum FT_Frame_Op_
62 {
63 ft_frame_end = 0,
64 ft_frame_start = FT_MAKE_FRAME_OP( FT_FRAME_OP_START, 0, 0 ),
65
66 ft_frame_byte = FT_MAKE_FRAME_OP( FT_FRAME_OP_BYTE, 0, 0 ),
67 ft_frame_schar = FT_MAKE_FRAME_OP( FT_FRAME_OP_BYTE, 0, 1 ),
68
69 ft_frame_ushort_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_SHORT, 0, 0 ),
70 ft_frame_short_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_SHORT, 0, 1 ),
71 ft_frame_ushort_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_SHORT, 1, 0 ),
72 ft_frame_short_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_SHORT, 1, 1 ),
73
74 ft_frame_ulong_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_LONG, 0, 0 ),
75 ft_frame_long_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_LONG, 0, 1 ),
76 ft_frame_ulong_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_LONG, 1, 0 ),
77 ft_frame_long_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_LONG, 1, 1 ),
78
79 ft_frame_uoff3_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_OFF3, 0, 0 ),
80 ft_frame_off3_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_OFF3, 0, 1 ),
81 ft_frame_uoff3_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_OFF3, 1, 0 ),
82 ft_frame_off3_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_OFF3, 1, 1 ),
83
84 ft_frame_bytes = FT_MAKE_FRAME_OP( FT_FRAME_OP_BYTES, 0, 0 ),
85 ft_frame_skip = FT_MAKE_FRAME_OP( FT_FRAME_OP_BYTES, 0, 1 )
86
87 } FT_Frame_Op;
88
89
90 typedef struct FT_Frame_Field_
91 {
92 FT_Byte value;
93 FT_Byte size;
94 FT_UShort offset;
95
96 } FT_Frame_Field;
97
98
99 /* Construct an FT_Frame_Field out of a structure type and a field name. */
100 /* The structure type must be set in the FT_STRUCTURE macro before */
101 /* calling the FT_FRAME_START() macro. */
102 /* */
103#define FT_FIELD_SIZE( f ) \
104 (FT_Byte)sizeof ( ((FT_STRUCTURE*)0)->f )
105
106#define FT_FIELD_SIZE_DELTA( f ) \
107 (FT_Byte)sizeof ( ((FT_STRUCTURE*)0)->f[0] )
108
109#define FT_FIELD_OFFSET( f ) \
110 (FT_UShort)( offsetof( FT_STRUCTURE, f ) )
111
112#define FT_FRAME_FIELD( frame_op, field ) \
113 { \
114 frame_op, \
115 FT_FIELD_SIZE( field ), \
116 FT_FIELD_OFFSET( field ) \
117 }
118
119#define FT_MAKE_EMPTY_FIELD( frame_op ) { frame_op, 0, 0 }
120
121#define FT_FRAME_START( size ) { ft_frame_start, 0, size }
122#define FT_FRAME_END { ft_frame_end, 0, 0 }
123
124#define FT_FRAME_LONG( f ) FT_FRAME_FIELD( ft_frame_long_be, f )
125#define FT_FRAME_ULONG( f ) FT_FRAME_FIELD( ft_frame_ulong_be, f )
126#define FT_FRAME_SHORT( f ) FT_FRAME_FIELD( ft_frame_short_be, f )
127#define FT_FRAME_USHORT( f ) FT_FRAME_FIELD( ft_frame_ushort_be, f )
128#define FT_FRAME_OFF3( f ) FT_FRAME_FIELD( ft_frame_off3_be, f )
129#define FT_FRAME_UOFF3( f ) FT_FRAME_FIELD( ft_frame_uoff3_be, f )
130#define FT_FRAME_BYTE( f ) FT_FRAME_FIELD( ft_frame_byte, f )
131#define FT_FRAME_CHAR( f ) FT_FRAME_FIELD( ft_frame_schar, f )
132
133#define FT_FRAME_LONG_LE( f ) FT_FRAME_FIELD( ft_frame_long_le, f )
134#define FT_FRAME_ULONG_LE( f ) FT_FRAME_FIELD( ft_frame_ulong_le, f )
135#define FT_FRAME_SHORT_LE( f ) FT_FRAME_FIELD( ft_frame_short_le, f )
136#define FT_FRAME_USHORT_LE( f ) FT_FRAME_FIELD( ft_frame_ushort_le, f )
137#define FT_FRAME_OFF3_LE( f ) FT_FRAME_FIELD( ft_frame_off3_le, f )
138#define FT_FRAME_UOFF3_LE( f ) FT_FRAME_FIELD( ft_frame_uoff3_le, f )
139
140#define FT_FRAME_SKIP_LONG { ft_frame_long_be, 0, 0 }
141#define FT_FRAME_SKIP_SHORT { ft_frame_short_be, 0, 0 }
142#define FT_FRAME_SKIP_BYTE { ft_frame_byte, 0, 0 }
143
144#define FT_FRAME_BYTES( field, count ) \
145 { \
146 ft_frame_bytes, \
147 count, \
148 FT_FIELD_OFFSET( field ) \
149 }
150
151#define FT_FRAME_SKIP_BYTES( count ) { ft_frame_skip, count, 0 }
152
153
154 /**************************************************************************
155 *
156 * Integer extraction macros -- the 'buffer' parameter must ALWAYS be of
157 * type 'char*' or equivalent (1-byte elements).
158 */
159
160#define FT_BYTE_( p, i ) ( ((const FT_Byte*)(p))[(i)] )
161
162#define FT_INT16( x ) ( (FT_Int16)(x) )
163#define FT_UINT16( x ) ( (FT_UInt16)(x) )
164#define FT_INT32( x ) ( (FT_Int32)(x) )
165#define FT_UINT32( x ) ( (FT_UInt32)(x) )
166
167
168#define FT_BYTE_U16( p, i, s ) ( FT_UINT16( FT_BYTE_( p, i ) ) << (s) )
169#define FT_BYTE_U32( p, i, s ) ( FT_UINT32( FT_BYTE_( p, i ) ) << (s) )
170
171
172 /*
173 * function acts on increases does range for emits
174 * pointer checking frames error
175 * -------------------------------------------------------------------
176 * FT_PEEK_XXX buffer pointer no no no no
177 * FT_NEXT_XXX buffer pointer yes no no no
178 * FT_GET_XXX stream->cursor yes yes yes no
179 * FT_READ_XXX stream->pos yes yes no yes
180 */
181
182
183 /*
184 * `FT_PEEK_XXX' are generic macros to get data from a buffer position. No
185 * safety checks are performed.
186 */
187#define FT_PEEK_SHORT( p ) FT_INT16( FT_BYTE_U16( p, 0, 8 ) | \
188 FT_BYTE_U16( p, 1, 0 ) )
189
190#define FT_PEEK_USHORT( p ) FT_UINT16( FT_BYTE_U16( p, 0, 8 ) | \
191 FT_BYTE_U16( p, 1, 0 ) )
192
193#define FT_PEEK_LONG( p ) FT_INT32( FT_BYTE_U32( p, 0, 24 ) | \
194 FT_BYTE_U32( p, 1, 16 ) | \
195 FT_BYTE_U32( p, 2, 8 ) | \
196 FT_BYTE_U32( p, 3, 0 ) )
197
198#define FT_PEEK_ULONG( p ) FT_UINT32( FT_BYTE_U32( p, 0, 24 ) | \
199 FT_BYTE_U32( p, 1, 16 ) | \
200 FT_BYTE_U32( p, 2, 8 ) | \
201 FT_BYTE_U32( p, 3, 0 ) )
202
203#define FT_PEEK_OFF3( p ) ( FT_INT32( FT_BYTE_U32( p, 0, 24 ) | \
204 FT_BYTE_U32( p, 1, 16 ) | \
205 FT_BYTE_U32( p, 2, 8 ) ) >> 8 )
206
207#define FT_PEEK_UOFF3( p ) FT_UINT32( FT_BYTE_U32( p, 0, 16 ) | \
208 FT_BYTE_U32( p, 1, 8 ) | \
209 FT_BYTE_U32( p, 2, 0 ) )
210
211#define FT_PEEK_SHORT_LE( p ) FT_INT16( FT_BYTE_U16( p, 1, 8 ) | \
212 FT_BYTE_U16( p, 0, 0 ) )
213
214#define FT_PEEK_USHORT_LE( p ) FT_UINT16( FT_BYTE_U16( p, 1, 8 ) | \
215 FT_BYTE_U16( p, 0, 0 ) )
216
217#define FT_PEEK_LONG_LE( p ) FT_INT32( FT_BYTE_U32( p, 3, 24 ) | \
218 FT_BYTE_U32( p, 2, 16 ) | \
219 FT_BYTE_U32( p, 1, 8 ) | \
220 FT_BYTE_U32( p, 0, 0 ) )
221
222#define FT_PEEK_ULONG_LE( p ) FT_UINT32( FT_BYTE_U32( p, 3, 24 ) | \
223 FT_BYTE_U32( p, 2, 16 ) | \
224 FT_BYTE_U32( p, 1, 8 ) | \
225 FT_BYTE_U32( p, 0, 0 ) )
226
227#define FT_PEEK_OFF3_LE( p ) ( FT_INT32( FT_BYTE_U32( p, 2, 24 ) | \
228 FT_BYTE_U32( p, 1, 16 ) | \
229 FT_BYTE_U32( p, 0, 8 ) ) >> 8 )
230
231#define FT_PEEK_UOFF3_LE( p ) FT_UINT32( FT_BYTE_U32( p, 2, 16 ) | \
232 FT_BYTE_U32( p, 1, 8 ) | \
233 FT_BYTE_U32( p, 0, 0 ) )
234
235 /*
236 * `FT_NEXT_XXX' are generic macros to get data from a buffer position
237 * which is then increased appropriately. No safety checks are performed.
238 */
239#define FT_NEXT_CHAR( buffer ) \
240 ( (signed char)*buffer++ )
241
242#define FT_NEXT_BYTE( buffer ) \
243 ( (unsigned char)*buffer++ )
244
245#define FT_NEXT_SHORT( buffer ) \
246 ( buffer += 2, FT_PEEK_SHORT( buffer - 2 ) )
247
248#define FT_NEXT_USHORT( buffer ) \
249 ( buffer += 2, FT_PEEK_USHORT( buffer - 2 ) )
250
251#define FT_NEXT_OFF3( buffer ) \
252 ( buffer += 3, FT_PEEK_OFF3( buffer - 3 ) )
253
254#define FT_NEXT_UOFF3( buffer ) \
255 ( buffer += 3, FT_PEEK_UOFF3( buffer - 3 ) )
256
257#define FT_NEXT_LONG( buffer ) \
258 ( buffer += 4, FT_PEEK_LONG( buffer - 4 ) )
259
260#define FT_NEXT_ULONG( buffer ) \
261 ( buffer += 4, FT_PEEK_ULONG( buffer - 4 ) )
262
263
264#define FT_NEXT_SHORT_LE( buffer ) \
265 ( buffer += 2, FT_PEEK_SHORT_LE( buffer - 2 ) )
266
267#define FT_NEXT_USHORT_LE( buffer ) \
268 ( buffer += 2, FT_PEEK_USHORT_LE( buffer - 2 ) )
269
270#define FT_NEXT_OFF3_LE( buffer ) \
271 ( buffer += 3, FT_PEEK_OFF3_LE( buffer - 3 ) )
272
273#define FT_NEXT_UOFF3_LE( buffer ) \
274 ( buffer += 3, FT_PEEK_UOFF3_LE( buffer - 3 ) )
275
276#define FT_NEXT_LONG_LE( buffer ) \
277 ( buffer += 4, FT_PEEK_LONG_LE( buffer - 4 ) )
278
279#define FT_NEXT_ULONG_LE( buffer ) \
280 ( buffer += 4, FT_PEEK_ULONG_LE( buffer - 4 ) )
281
282
283 /**************************************************************************
284 *
285 * The `FT_GET_XXX` macros use an implicit 'stream' variable.
286 *
287 * Note that a call to `FT_STREAM_SEEK` or `FT_STREAM_POS` has **no**
288 * effect on `FT_GET_XXX`! They operate on `stream->pos`, while
289 * `FT_GET_XXX` use `stream->cursor`.
290 */
291#if 0
292#define FT_GET_MACRO( type ) FT_NEXT_ ## type ( stream->cursor )
293
294#define FT_GET_CHAR() FT_GET_MACRO( CHAR )
295#define FT_GET_BYTE() FT_GET_MACRO( BYTE )
296#define FT_GET_SHORT() FT_GET_MACRO( SHORT )
297#define FT_GET_USHORT() FT_GET_MACRO( USHORT )
298#define FT_GET_OFF3() FT_GET_MACRO( OFF3 )
299#define FT_GET_UOFF3() FT_GET_MACRO( UOFF3 )
300#define FT_GET_LONG() FT_GET_MACRO( LONG )
301#define FT_GET_ULONG() FT_GET_MACRO( ULONG )
302#define FT_GET_TAG4() FT_GET_MACRO( ULONG )
303
304#define FT_GET_SHORT_LE() FT_GET_MACRO( SHORT_LE )
305#define FT_GET_USHORT_LE() FT_GET_MACRO( USHORT_LE )
306#define FT_GET_LONG_LE() FT_GET_MACRO( LONG_LE )
307#define FT_GET_ULONG_LE() FT_GET_MACRO( ULONG_LE )
308
309#else
310#define FT_GET_MACRO( func, type ) ( (type)func( stream ) )
311
312#define FT_GET_CHAR() FT_GET_MACRO( FT_Stream_GetByte, FT_Char )
313#define FT_GET_BYTE() FT_GET_MACRO( FT_Stream_GetByte, FT_Byte )
314#define FT_GET_SHORT() FT_GET_MACRO( FT_Stream_GetUShort, FT_Int16 )
315#define FT_GET_USHORT() FT_GET_MACRO( FT_Stream_GetUShort, FT_UInt16 )
316#define FT_GET_UOFF3() FT_GET_MACRO( FT_Stream_GetUOffset, FT_UInt32 )
317#define FT_GET_LONG() FT_GET_MACRO( FT_Stream_GetULong, FT_Int32 )
318#define FT_GET_ULONG() FT_GET_MACRO( FT_Stream_GetULong, FT_UInt32 )
319#define FT_GET_TAG4() FT_GET_MACRO( FT_Stream_GetULong, FT_UInt32 )
320
321#define FT_GET_SHORT_LE() FT_GET_MACRO( FT_Stream_GetUShortLE, FT_Int16 )
322#define FT_GET_USHORT_LE() FT_GET_MACRO( FT_Stream_GetUShortLE, FT_UInt16 )
323#define FT_GET_LONG_LE() FT_GET_MACRO( FT_Stream_GetULongLE, FT_Int32 )
324#define FT_GET_ULONG_LE() FT_GET_MACRO( FT_Stream_GetULongLE, FT_UInt32 )
325#endif
326
327
328#define FT_READ_MACRO( func, type, var ) \
329 ( var = (type)func( stream, &error ), \
330 error != FT_Err_Ok )
331
332 /*
333 * The `FT_READ_XXX' macros use implicit `stream' and `error' variables.
334 *
335 * `FT_READ_XXX' can be controlled with `FT_STREAM_SEEK' and
336 * `FT_STREAM_POS'. They use the full machinery to check whether a read is
337 * valid.
338 */
339#define FT_READ_BYTE( var ) FT_READ_MACRO( FT_Stream_ReadByte, FT_Byte, var )
340#define FT_READ_CHAR( var ) FT_READ_MACRO( FT_Stream_ReadByte, FT_Char, var )
341#define FT_READ_SHORT( var ) FT_READ_MACRO( FT_Stream_ReadUShort, FT_Int16, var )
342#define FT_READ_USHORT( var ) FT_READ_MACRO( FT_Stream_ReadUShort, FT_UInt16, var )
343#define FT_READ_UOFF3( var ) FT_READ_MACRO( FT_Stream_ReadUOffset, FT_UInt32, var )
344#define FT_READ_LONG( var ) FT_READ_MACRO( FT_Stream_ReadULong, FT_Int32, var )
345#define FT_READ_ULONG( var ) FT_READ_MACRO( FT_Stream_ReadULong, FT_UInt32, var )
346
347#define FT_READ_SHORT_LE( var ) FT_READ_MACRO( FT_Stream_ReadUShortLE, FT_Int16, var )
348#define FT_READ_USHORT_LE( var ) FT_READ_MACRO( FT_Stream_ReadUShortLE, FT_UInt16, var )
349#define FT_READ_LONG_LE( var ) FT_READ_MACRO( FT_Stream_ReadULongLE, FT_Int32, var )
350#define FT_READ_ULONG_LE( var ) FT_READ_MACRO( FT_Stream_ReadULongLE, FT_UInt32, var )
351
352
353#ifndef FT_CONFIG_OPTION_NO_DEFAULT_SYSTEM
354
355 /* initialize a stream for reading a regular system stream */
356 FT_BASE( FT_Error )
357 FT_Stream_Open( FT_Stream stream,
358 const char* filepathname );
359
360#endif /* FT_CONFIG_OPTION_NO_DEFAULT_SYSTEM */
361
362
363 /* create a new (input) stream from an FT_Open_Args structure */
364 FT_BASE( FT_Error )
365 FT_Stream_New( FT_Library library,
366 const FT_Open_Args* args,
367 FT_Stream *astream );
368
369 /* free a stream */
370 FT_BASE( void )
371 FT_Stream_Free( FT_Stream stream,
372 FT_Int external );
373
374 /* initialize a stream for reading in-memory data */
375 FT_BASE( void )
376 FT_Stream_OpenMemory( FT_Stream stream,
377 const FT_Byte* base,
378 FT_ULong size );
379
380 /* close a stream (does not destroy the stream structure) */
381 FT_BASE( void )
382 FT_Stream_Close( FT_Stream stream );
383
384
385 /* seek within a stream. position is relative to start of stream */
386 FT_BASE( FT_Error )
387 FT_Stream_Seek( FT_Stream stream,
388 FT_ULong pos );
389
390 /* skip bytes in a stream */
391 FT_BASE( FT_Error )
392 FT_Stream_Skip( FT_Stream stream,
393 FT_Long distance );
394
395 /* return current stream position */
396 FT_BASE( FT_ULong )
397 FT_Stream_Pos( FT_Stream stream );
398
399 /* read bytes from a stream into a user-allocated buffer, returns an */
400 /* error if not all bytes could be read. */
401 FT_BASE( FT_Error )
402 FT_Stream_Read( FT_Stream stream,
403 FT_Byte* buffer,
404 FT_ULong count );
405
406 /* read bytes from a stream at a given position */
407 FT_BASE( FT_Error )
408 FT_Stream_ReadAt( FT_Stream stream,
409 FT_ULong pos,
410 FT_Byte* buffer,
411 FT_ULong count );
412
413 /* try to read bytes at the end of a stream; return number of bytes */
414 /* really available */
415 FT_BASE( FT_ULong )
416 FT_Stream_TryRead( FT_Stream stream,
417 FT_Byte* buffer,
418 FT_ULong count );
419
420 /* Enter a frame of `count' consecutive bytes in a stream. Returns an */
421 /* error if the frame could not be read/accessed. The caller can use */
422 /* the `FT_Stream_GetXXX' functions to retrieve frame data without */
423 /* error checks. */
424 /* */
425 /* You must _always_ call `FT_Stream_ExitFrame' once you have entered */
426 /* a stream frame! */
427 /* */
428 /* Nested frames are not permitted. */
429 /* */
430 FT_BASE( FT_Error )
431 FT_Stream_EnterFrame( FT_Stream stream,
432 FT_ULong count );
433
434 /* exit a stream frame */
435 FT_BASE( void )
436 FT_Stream_ExitFrame( FT_Stream stream );
437
438
439 /* Extract a stream frame. If the stream is disk-based, a heap block */
440 /* is allocated and the frame bytes are read into it. If the stream */
441 /* is memory-based, this function simply sets a pointer to the data. */
442 /* */
443 /* Useful to optimize access to memory-based streams transparently. */
444 /* */
445 /* `FT_Stream_GetXXX' functions can't be used. */
446 /* */
447 /* An extracted frame must be `freed' with a call to the function */
448 /* `FT_Stream_ReleaseFrame'. */
449 /* */
450 FT_BASE( FT_Error )
451 FT_Stream_ExtractFrame( FT_Stream stream,
452 FT_ULong count,
453 FT_Byte** pbytes );
454
455 /* release an extract frame (see `FT_Stream_ExtractFrame') */
456 FT_BASE( void )
457 FT_Stream_ReleaseFrame( FT_Stream stream,
458 FT_Byte** pbytes );
459
460
461 /* read a byte from an entered frame */
462 FT_BASE( FT_Byte )
463 FT_Stream_GetByte( FT_Stream stream );
464
465 /* read a 16-bit big-endian unsigned integer from an entered frame */
466 FT_BASE( FT_UInt16 )
467 FT_Stream_GetUShort( FT_Stream stream );
468
469 /* read a 24-bit big-endian unsigned integer from an entered frame */
470 FT_BASE( FT_UInt32 )
471 FT_Stream_GetUOffset( FT_Stream stream );
472
473 /* read a 32-bit big-endian unsigned integer from an entered frame */
474 FT_BASE( FT_UInt32 )
475 FT_Stream_GetULong( FT_Stream stream );
476
477 /* read a 16-bit little-endian unsigned integer from an entered frame */
478 FT_BASE( FT_UInt16 )
479 FT_Stream_GetUShortLE( FT_Stream stream );
480
481 /* read a 32-bit little-endian unsigned integer from an entered frame */
482 FT_BASE( FT_UInt32 )
483 FT_Stream_GetULongLE( FT_Stream stream );
484
485
486 /* read a byte from a stream */
487 FT_BASE( FT_Byte )
488 FT_Stream_ReadByte( FT_Stream stream,
489 FT_Error* error );
490
491 /* read a 16-bit big-endian unsigned integer from a stream */
492 FT_BASE( FT_UInt16 )
493 FT_Stream_ReadUShort( FT_Stream stream,
494 FT_Error* error );
495
496 /* read a 24-bit big-endian unsigned integer from a stream */
497 FT_BASE( FT_ULong )
498 FT_Stream_ReadUOffset( FT_Stream stream,
499 FT_Error* error );
500
501 /* read a 32-bit big-endian integer from a stream */
502 FT_BASE( FT_UInt32 )
503 FT_Stream_ReadULong( FT_Stream stream,
504 FT_Error* error );
505
506 /* read a 16-bit little-endian unsigned integer from a stream */
507 FT_BASE( FT_UInt16 )
508 FT_Stream_ReadUShortLE( FT_Stream stream,
509 FT_Error* error );
510
511 /* read a 32-bit little-endian unsigned integer from a stream */
512 FT_BASE( FT_UInt32 )
513 FT_Stream_ReadULongLE( FT_Stream stream,
514 FT_Error* error );
515
516 /* Read a structure from a stream. The structure must be described */
517 /* by an array of FT_Frame_Field records. */
518 FT_BASE( FT_Error )
519 FT_Stream_ReadFields( FT_Stream stream,
520 const FT_Frame_Field* fields,
521 void* structure );
522
523
524#define FT_STREAM_POS() \
525 FT_Stream_Pos( stream )
526
527#define FT_STREAM_SEEK( position ) \
528 FT_SET_ERROR( FT_Stream_Seek( stream, \
529 (FT_ULong)(position) ) )
530
531#define FT_STREAM_SKIP( distance ) \
532 FT_SET_ERROR( FT_Stream_Skip( stream, \
533 (FT_Long)(distance) ) )
534
535#define FT_STREAM_READ( buffer, count ) \
536 FT_SET_ERROR( FT_Stream_Read( stream, \
537 (FT_Byte*)(buffer), \
538 (FT_ULong)(count) ) )
539
540#define FT_STREAM_READ_AT( position, buffer, count ) \
541 FT_SET_ERROR( FT_Stream_ReadAt( stream, \
542 (FT_ULong)(position), \
543 (FT_Byte*)(buffer), \
544 (FT_ULong)(count) ) )
545
546#define FT_STREAM_READ_FIELDS( fields, object ) \
547 FT_SET_ERROR( FT_Stream_ReadFields( stream, fields, object ) )
548
549
550#define FT_FRAME_ENTER( size ) \
551 FT_SET_ERROR( \
552 FT_DEBUG_INNER( FT_Stream_EnterFrame( stream, \
553 (FT_ULong)(size) ) ) )
554
555#define FT_FRAME_EXIT() \
556 FT_DEBUG_INNER( FT_Stream_ExitFrame( stream ) )
557
558#define FT_FRAME_EXTRACT( size, bytes ) \
559 FT_SET_ERROR( \
560 FT_DEBUG_INNER( FT_Stream_ExtractFrame( stream, \
561 (FT_ULong)(size), \
562 (FT_Byte**)&(bytes) ) ) )
563
564#define FT_FRAME_RELEASE( bytes ) \
565 FT_DEBUG_INNER( FT_Stream_ReleaseFrame( stream, \
566 (FT_Byte**)&(bytes) ) )
567
568
569FT_END_HEADER
570
571#endif /* FTSTREAM_H_ */
572
573
574/* END */
FT_Frame_Field_
Definition ftstream.h:91