OggzIO provides a way of overriding the functions Oggz uses to access its raw input or output data. This is required in many situations where the raw stream cannot be accessed via stdio, but can be accessed by other means. This is typically useful within media frameworks, where accessing and moving around in the data is possible only using methods provided by the framework.
The functions you provide for overriding IO will be used by Oggz whenever you call oggz_read() or oggz_write(). They will also be used repeatedly by Oggz when you call oggz_seek().
Go to the source code of this file.
Typedefs | |
typedef size_t(* | OggzIORead )(void *user_handle, void *buf, size_t n) |
This is the signature of a function which you provide for Oggz to call when it needs to acquire raw input data. | |
typedef size_t(* | OggzIOWrite )(void *user_handle, void *buf, size_t n) |
This is the signature of a function which you provide for Oggz to call when it needs to output raw data. | |
typedef int(* | OggzIOSeek )(void *user_handle, long offset, int whence) |
This is the signature of a function which you provide for Oggz to call when it needs to seek on the raw input or output data. | |
typedef long(* | OggzIOTell )(void *user_handle) |
This is the signature of a function which you provide for Oggz to call when it needs to determine the current offset of the raw input or output data. | |
typedef int(* | OggzIOFlush )(void *user_handle) |
This is the signature of a function which you provide for Oggz to call when it needs to flush the output data. | |
Functions | |
int | oggz_io_set_read (OGGZ *oggz, OggzIORead read, void *user_handle) |
Set a function for Oggz to call when it needs to read input data. | |
void * | oggz_io_get_read_user_handle (OGGZ *oggz) |
Retrieve the user_handle associated with the function you have provided for reading input data. | |
int | oggz_io_set_write (OGGZ *oggz, OggzIOWrite write, void *user_handle) |
Set a function for Oggz to call when it needs to write output data. | |
void * | oggz_io_get_write_user_handle (OGGZ *oggz) |
Retrieve the user_handle associated with the function you have provided for writing output data. | |
int | oggz_io_set_seek (OGGZ *oggz, OggzIOSeek seek, void *user_handle) |
Set a function for Oggz to call when it needs to seek on its raw data. | |
void * | oggz_io_get_seek_user_handle (OGGZ *oggz) |
Retrieve the user_handle associated with the function you have provided for seeking on input or output data. | |
int | oggz_io_set_tell (OGGZ *oggz, OggzIOTell tell, void *user_handle) |
Set a function for Oggz to call when it needs to determine the offset within its input data (if OGGZ_READ) or output data (if OGGZ_WRITE). | |
void * | oggz_io_get_tell_user_handle (OGGZ *oggz) |
Retrieve the user_handle associated with the function you have provided for determining the current offset in input or output data. | |
int | oggz_io_set_flush (OGGZ *oggz, OggzIOFlush flush, void *user_handle) |
Set a function for Oggz to call when it needs to flush its output. | |
void * | oggz_io_get_flush_user_handle (OGGZ *oggz) |
Retrieve the user_handle associated with the function you have provided for flushing output. |
|
This is the signature of a function which you provide for Oggz to call when it needs to flush the output data. The behaviour of this function is similar to that of fflush() in stdio.
|
|
This is the signature of a function which you provide for Oggz to call when it needs to acquire raw input data.
|
|
This is the signature of a function which you provide for Oggz to call when it needs to seek on the raw input or output data.
|
|
This is the signature of a function which you provide for Oggz to call when it needs to determine the current offset of the raw input or output data.
|
|
This is the signature of a function which you provide for Oggz to call when it needs to output raw data.
|
|
Retrieve the user_handle associated with the function you have provided for flushing output.
|
|
Retrieve the user_handle associated with the function you have provided for reading input data.
|
|
Retrieve the user_handle associated with the function you have provided for seeking on input or output data.
|
|
Retrieve the user_handle associated with the function you have provided for determining the current offset in input or output data.
|
|
Retrieve the user_handle associated with the function you have provided for writing output data.
|
|
Set a function for Oggz to call when it needs to flush its output. The meaning of this is similar to that of fflush() in stdio.
|
|
Set a function for Oggz to call when it needs to read input data.
|
|
Set a function for Oggz to call when it needs to seek on its raw data.
|
|
Set a function for Oggz to call when it needs to determine the offset within its input data (if OGGZ_READ) or output data (if OGGZ_WRITE).
|
|
Set a function for Oggz to call when it needs to write output data.
|