libopenmpt 0.8.0-pre.12+r22464
cross-platform C++ and C library to decode tracked music files
|
Macros | |
#define | LIBOPENMPT_EXT_C_INTERFACE_PATTERN_VIS "pattern_vis" |
#define | OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_UNKNOWN 0 |
#define | OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_GENERAL 1 |
#define | OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_GLOBAL 2 |
#define | OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_VOLUME 3 |
#define | OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_PANNING 4 |
#define | OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_PITCH 5 |
#define | LIBOPENMPT_EXT_C_INTERFACE_INTERACTIVE "interactive" |
#define | LIBOPENMPT_EXT_C_INTERFACE_INTERACTIVE2 "interactive2" |
#define | LIBOPENMPT_EXT_C_INTERFACE_INTERACTIVE3 "interactive3" |
Typedefs | |
typedef struct openmpt_module_ext | openmpt_module_ext |
Opaque type representing a libopenmpt extension module. More... | |
typedef struct openmpt_module_ext_interface_pattern_vis | openmpt_module_ext_interface_pattern_vis |
typedef struct openmpt_module_ext_interface_interactive | openmpt_module_ext_interface_interactive |
typedef struct openmpt_module_ext_interface_interactive2 | openmpt_module_ext_interface_interactive2 |
typedef struct openmpt_module_ext_interface_interactive3 | openmpt_module_ext_interface_interactive3 |
Functions | |
openmpt_module_ext * | openmpt_module_ext_create (openmpt_stream_callbacks stream_callbacks, void *stream, openmpt_log_func logfunc, void *loguser, openmpt_error_func errfunc, void *erruser, int *error, const char **error_message, const openmpt_module_initial_ctl *ctls) |
Construct an openmpt_module_ext. More... | |
openmpt_module_ext * | openmpt_module_ext_create_from_memory (const void *filedata, size_t filesize, openmpt_log_func logfunc, void *loguser, openmpt_error_func errfunc, void *erruser, int *error, const char **error_message, const openmpt_module_initial_ctl *ctls) |
Construct an openmpt_module_ext. More... | |
void | openmpt_module_ext_destroy (openmpt_module_ext *mod_ext) |
Unload a previously created openmpt_module_ext from memory. More... | |
openmpt_module * | openmpt_module_ext_get_module (openmpt_module_ext *mod_ext) |
Retrieve the openmpt_module handle from an openmpt_module_ext handle. More... | |
int | openmpt_module_ext_get_interface (openmpt_module_ext *mod_ext, const char *interface_id, void *interface, size_t interface_size) |
#define LIBOPENMPT_EXT_C_INTERFACE_INTERACTIVE "interactive" |
#define LIBOPENMPT_EXT_C_INTERFACE_INTERACTIVE2 "interactive2" |
#define LIBOPENMPT_EXT_C_INTERFACE_INTERACTIVE3 "interactive3" |
#define LIBOPENMPT_EXT_C_INTERFACE_PATTERN_VIS "pattern_vis" |
#define OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_GENERAL 1 |
#define OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_GLOBAL 2 |
#define OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_PANNING 4 |
#define OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_PITCH 5 |
#define OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_UNKNOWN 0 |
Pattern command type
#define OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_VOLUME 3 |
typedef struct openmpt_module_ext openmpt_module_ext |
Opaque type representing a libopenmpt extension module.
openmpt_module_ext * openmpt_module_ext_create | ( | openmpt_stream_callbacks | stream_callbacks, |
void * | stream, | ||
openmpt_log_func | logfunc, | ||
void * | loguser, | ||
openmpt_error_func | errfunc, | ||
void * | erruser, | ||
int * | error, | ||
const char ** | error_message, | ||
const openmpt_module_initial_ctl * | ctls | ||
) |
Construct an openmpt_module_ext.
stream_callbacks | Input stream callback operations. |
stream | Input stream to load the module from. |
logfunc | Logging function where warning and errors are written. The logging function may be called throughout the lifetime of openmpt_module_ext. May be NULL. |
loguser | User-defined data associated with this module. This value will be passed to the logging callback function (logfunc) |
errfunc | Error function to define error behaviour. May be NULL. |
erruser | Error function user context. Used to pass any user-defined data associated with this module to the logging function. |
error | Pointer to an integer where an error may get stored. May be NULL. |
error_message | Pointer to a string pointer where an error message may get stored. May be NULL. |
ctls | A map of initial ctl values, see openmpt_module_get_ctls. |
openmpt_module_ext * openmpt_module_ext_create_from_memory | ( | const void * | filedata, |
size_t | filesize, | ||
openmpt_log_func | logfunc, | ||
void * | loguser, | ||
openmpt_error_func | errfunc, | ||
void * | erruser, | ||
int * | error, | ||
const char ** | error_message, | ||
const openmpt_module_initial_ctl * | ctls | ||
) |
Construct an openmpt_module_ext.
filedata | Data to load the module from. |
filesize | Amount of data available. |
logfunc | Logging function where warning and errors are written. The logging function may be called throughout the lifetime of openmpt_module_ext. |
loguser | User-defined data associated with this module. This value will be passed to the logging callback function (logfunc) |
errfunc | Error function to define error behaviour. May be NULL. |
erruser | Error function user context. Used to pass any user-defined data associated with this module to the logging function. |
error | Pointer to an integer where an error may get stored. May be NULL. |
error_message | Pointer to a string pointer where an error message may get stored. May be NULL. |
ctls | A map of initial ctl values, see openmpt_module_get_ctls. |
void openmpt_module_ext_destroy | ( | openmpt_module_ext * | mod_ext | ) |
Unload a previously created openmpt_module_ext from memory.
mod_ext | The module to unload. |
int openmpt_module_ext_get_interface | ( | openmpt_module_ext * | mod_ext, |
const char * | interface_id, | ||
void * | interface, | ||
size_t | interface_size | ||
) |
Retrieve a libopenmpt extension.
mod_ext | The module handle to work on. |
interface_id | The name of the extension interface to retrieve (e.g. LIBOPENMPT_EXT_C_INTERFACE_PATTERN_VIS). |
interface | Appropriate structure of interface function pointers which is to be filled by this function (e.g. a pointer to a openmpt_module_ext_interface_pattern_vis structure). |
interface_size | Size of the interface's structure of function pointers (e.g. sizeof(openmpt_module_ext_interface_pattern_vis)). |
openmpt_module * openmpt_module_ext_get_module | ( | openmpt_module_ext * | mod_ext | ) |
Retrieve the openmpt_module handle from an openmpt_module_ext handle.
mod_ext | The extension module handle to convert |