2 Simple DirectMedia Layer
3 Copyright (C) 1997-2019 Sam Lantinga <slouken@libsdl.org>
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
25 * This file provides a general interface for SDL to read and write
26 * data streams. It can easily be extended to files, memory, etc.
32 #include "SDL_stdinc.h"
33 #include "SDL_error.h"
35 #include "begin_code.h"
36 /* Set up for C function definitions, even when using C++ */
42 #define SDL_RWOPS_UNKNOWN 0U /**< Unknown stream type */
43 #define SDL_RWOPS_WINFILE 1U /**< Win32 file */
44 #define SDL_RWOPS_STDFILE 2U /**< Stdio file */
45 #define SDL_RWOPS_JNIFILE 3U /**< Android asset */
46 #define SDL_RWOPS_MEMORY 4U /**< Memory stream */
47 #define SDL_RWOPS_MEMORY_RO 5U /**< Read-Only memory stream */
50 * This is the read/write operation structure -- very basic.
52 typedef struct SDL_RWops
55 * Return the size of the file in this rwops, or -1 if unknown
57 Sint64 (SDLCALL * size) (struct SDL_RWops * context);
60 * Seek to \c offset relative to \c whence, one of stdio's whence values:
61 * RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
63 * \return the final offset in the data stream, or -1 on error.
65 Sint64 (SDLCALL * seek) (struct SDL_RWops * context, Sint64 offset,
69 * Read up to \c maxnum objects each of size \c size from the data
70 * stream to the area pointed at by \c ptr.
72 * \return the number of objects read, or 0 at error or end of file.
74 size_t (SDLCALL * read) (struct SDL_RWops * context, void *ptr,
75 size_t size, size_t maxnum);
78 * Write exactly \c num objects each of size \c size from the area
79 * pointed at by \c ptr to data stream.
81 * \return the number of objects written, or 0 at error or end of file.
83 size_t (SDLCALL * write) (struct SDL_RWops * context, const void *ptr,
84 size_t size, size_t num);
87 * Close and free an allocated SDL_RWops structure.
89 * \return 0 if successful or -1 on write error when flushing data.
91 int (SDLCALL * close) (struct SDL_RWops * context);
96 #if defined(__ANDROID__)
100 void *inputStreamRef;
101 void *readableByteChannelRef;
103 void *assetFileDescriptorRef;
109 #elif defined(__WIN32__)
147 * \name RWFrom functions
149 * Functions to create SDL_RWops structures from various data streams.
153 extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromFile(const char *file,
157 extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromFP(FILE * fp,
160 extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromFP(void * fp,
164 extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromMem(void *mem, int size);
165 extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromConstMem(const void *mem,
168 /* @} *//* RWFrom functions */
171 extern DECLSPEC SDL_RWops *SDLCALL SDL_AllocRW(void);
172 extern DECLSPEC void SDLCALL SDL_FreeRW(SDL_RWops * area);
174 #define RW_SEEK_SET 0 /**< Seek from the beginning of data */
175 #define RW_SEEK_CUR 1 /**< Seek relative to current read point */
176 #define RW_SEEK_END 2 /**< Seek relative to the end of data */
179 * Return the size of the file in this rwops, or -1 if unknown
181 extern DECLSPEC Sint64 SDLCALL SDL_RWsize(SDL_RWops *context);
184 * Seek to \c offset relative to \c whence, one of stdio's whence values:
185 * RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
187 * \return the final offset in the data stream, or -1 on error.
189 extern DECLSPEC Sint64 SDLCALL SDL_RWseek(SDL_RWops *context,
190 Sint64 offset, int whence);
193 * Return the current offset in the data stream, or -1 on error.
195 extern DECLSPEC Sint64 SDLCALL SDL_RWtell(SDL_RWops *context);
198 * Read up to \c maxnum objects each of size \c size from the data
199 * stream to the area pointed at by \c ptr.
201 * \return the number of objects read, or 0 at error or end of file.
203 extern DECLSPEC size_t SDLCALL SDL_RWread(SDL_RWops *context,
204 void *ptr, size_t size, size_t maxnum);
207 * Write exactly \c num objects each of size \c size from the area
208 * pointed at by \c ptr to data stream.
210 * \return the number of objects written, or 0 at error or end of file.
212 extern DECLSPEC size_t SDLCALL SDL_RWwrite(SDL_RWops *context,
213 const void *ptr, size_t size, size_t num);
216 * Close and free an allocated SDL_RWops structure.
218 * \return 0 if successful or -1 on write error when flushing data.
220 extern DECLSPEC int SDLCALL SDL_RWclose(SDL_RWops *context);
223 * Load all the data from an SDL data stream.
225 * The data is allocated with a zero byte at the end (null terminated)
227 * If \c datasize is not NULL, it is filled with the size of the data read.
229 * If \c freesrc is non-zero, the stream will be closed after being read.
231 * The data should be freed with SDL_free().
233 * \return the data, or NULL if there was an error.
235 extern DECLSPEC void *SDLCALL SDL_LoadFile_RW(SDL_RWops * src, size_t *datasize,
239 * Load an entire file.
241 * The data is allocated with a zero byte at the end (null terminated)
243 * If \c datasize is not NULL, it is filled with the size of the data read.
245 * If \c freesrc is non-zero, the stream will be closed after being read.
247 * The data should be freed with SDL_free().
249 * \return the data, or NULL if there was an error.
251 extern DECLSPEC void *SDLCALL SDL_LoadFile(const char *file, size_t *datasize);
254 * \name Read endian functions
256 * Read an item of the specified endianness and return in native format.
259 extern DECLSPEC Uint8 SDLCALL SDL_ReadU8(SDL_RWops * src);
260 extern DECLSPEC Uint16 SDLCALL SDL_ReadLE16(SDL_RWops * src);
261 extern DECLSPEC Uint16 SDLCALL SDL_ReadBE16(SDL_RWops * src);
262 extern DECLSPEC Uint32 SDLCALL SDL_ReadLE32(SDL_RWops * src);
263 extern DECLSPEC Uint32 SDLCALL SDL_ReadBE32(SDL_RWops * src);
264 extern DECLSPEC Uint64 SDLCALL SDL_ReadLE64(SDL_RWops * src);
265 extern DECLSPEC Uint64 SDLCALL SDL_ReadBE64(SDL_RWops * src);
266 /* @} *//* Read endian functions */
269 * \name Write endian functions
271 * Write an item of native format to the specified endianness.
274 extern DECLSPEC size_t SDLCALL SDL_WriteU8(SDL_RWops * dst, Uint8 value);
275 extern DECLSPEC size_t SDLCALL SDL_WriteLE16(SDL_RWops * dst, Uint16 value);
276 extern DECLSPEC size_t SDLCALL SDL_WriteBE16(SDL_RWops * dst, Uint16 value);
277 extern DECLSPEC size_t SDLCALL SDL_WriteLE32(SDL_RWops * dst, Uint32 value);
278 extern DECLSPEC size_t SDLCALL SDL_WriteBE32(SDL_RWops * dst, Uint32 value);
279 extern DECLSPEC size_t SDLCALL SDL_WriteLE64(SDL_RWops * dst, Uint64 value);
280 extern DECLSPEC size_t SDLCALL SDL_WriteBE64(SDL_RWops * dst, Uint64 value);
281 /* @} *//* Write endian functions */
283 /* Ends C function definitions when using C++ */
287 #include "close_code.h"
289 #endif /* SDL_rwops_h_ */
291 /* vi: set ts=4 sw=4 expandtab: */