vl_stream.h

Go to the documentation of this file.

 
#ifndef VL_STREAM_H
#define VL_STREAM_H
 
#include <vl/vl_atomic.h>
#include <vl/vl_memory.h>
#include <vl/vl_mutex.h>
 
typedef enum vl_stream_origin_
{
    VL_STREAM_SEEK_SET = 0,
    VL_STREAM_SEEK_CUR = 1,
    VL_STREAM_SEEK_END = 2
} vl_stream_origin;
 
// Function Pointer Definitions
typedef vl_memsize_t (*vl_stream_func_read)(void* buffer, vl_memsize_t size, void* user);
typedef vl_memsize_t (*vl_stream_func_write)(const void* buffer, vl_memsize_t size, void* user);
typedef vl_bool_t (*vl_stream_func_seek)(vl_int64_t offset, vl_stream_origin origin, void* user);
typedef vl_int64_t (*vl_stream_func_tell)(void* user);
typedef void (*vl_stream_func_flush)(void* user);
typedef void (*vl_stream_func_close)(void* user);
 
typedef struct vl_stream_
{
    vl_stream_func_read read;
 
    vl_stream_func_write write;
 
    vl_stream_func_seek seek;
 
    vl_stream_func_tell tell;
 
    vl_stream_func_flush flush;
 
    vl_stream_func_close close;
 
    void* userData;
 
    vl_mutex lock;
 
    vl_atomic_ularge_t refCount;
 
    vl_atomic_ularge_t totalRead;
 
    vl_atomic_ularge_t totalWritten;
} vl_stream;
 
VL_API vl_stream* vlStreamNew(void* userData);
 
VL_API void vlStreamDelete(vl_stream* stream);
 
VL_API void vlStreamRetain(vl_stream* stream);
 
//-----------------------------------------------------------------------------
// V-Table Configuration (Setters)
//-----------------------------------------------------------------------------
 
VL_API void vlStreamSetRead(vl_stream* stream, vl_stream_func_read func);
VL_API void vlStreamSetWrite(vl_stream* stream, vl_stream_func_write func);
VL_API void vlStreamSetSeek(vl_stream* stream, vl_stream_func_seek func);
VL_API void vlStreamSetTell(vl_stream* stream, vl_stream_func_tell func);
VL_API void vlStreamSetFlush(vl_stream* stream, vl_stream_func_flush func);
VL_API void vlStreamSetClose(vl_stream* stream, vl_stream_func_close func);
 
//-----------------------------------------------------------------------------
// I/O Operations (Thread Safe)
//-----------------------------------------------------------------------------
 
VL_API vl_memsize_t vlStreamRead(vl_stream* stream, void* outBuffer, vl_memsize_t outLength);
 
VL_API vl_memsize_t vlStreamWrite(vl_stream* stream, const void* inBuffer, vl_memsize_t inLength);
 
VL_API vl_bool_t vlStreamSeek(vl_stream* stream, vl_int64_t offset, vl_stream_origin origin);
 
VL_API vl_int64_t vlStreamTell(vl_stream* stream);
 
VL_API void vlStreamFlush(vl_stream* stream);
 
#endif // VL_STREAM_H