libopenmpt 0.7.8+release
cross-platform C++ and C library to decode tracked music files
libopenmpt_ext.h
Go to the documentation of this file.
1/*
2 * libopenmpt_ext.h
3 * ----------------
4 * Purpose: libopenmpt public c interface for libopenmpt extensions
5 * Notes :
6 * Authors: OpenMPT Devs
7 * The OpenMPT source code is released under the BSD license. Read LICENSE for more details.
8 */
9
10#ifndef LIBOPENMPT_EXT_H
11#define LIBOPENMPT_EXT_H
12
13#include "libopenmpt_config.h"
14#include "libopenmpt.h"
15
16#ifdef __cplusplus
17extern "C" {
18#endif
19
40
58LIBOPENMPT_API 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 );
59
76LIBOPENMPT_API 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 );
77
82LIBOPENMPT_API void openmpt_module_ext_destroy( openmpt_module_ext * mod_ext );
83
91
101LIBOPENMPT_API int openmpt_module_ext_get_interface( openmpt_module_ext * mod_ext, const char * interface_id, void * interface, size_t interface_size );
102
103
104
105#ifndef LIBOPENMPT_EXT_C_INTERFACE_PATTERN_VIS
106#define LIBOPENMPT_EXT_C_INTERFACE_PATTERN_VIS "pattern_vis"
107#endif
108
110#define OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_UNKNOWN 0
111#define OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_GENERAL 1
112#define OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_GLOBAL 2
113#define OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_VOLUME 3
114#define OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_PANNING 4
115#define OPENMPT_MODULE_EXT_INTERFACE_PATTERN_VIS_EFFECT_TYPE_PITCH 5
116
127 int ( * get_pattern_row_channel_volume_effect_type ) ( openmpt_module_ext * mod_ext, int32_t pattern, int32_t row, int32_t channel );
128
138 int ( * get_pattern_row_channel_effect_type ) ( openmpt_module_ext * mod_ext, int32_t pattern, int32_t row, int32_t channel );
140
141
142
143#ifndef LIBOPENMPT_EXT_C_INTERFACE_INTERACTIVE
144#define LIBOPENMPT_EXT_C_INTERFACE_INTERACTIVE "interactive"
145#endif
146
156 int ( * set_current_speed ) ( openmpt_module_ext * mod_ext, int32_t speed );
157
167 LIBOPENMPT_DEPRECATED int ( * set_current_tempo ) ( openmpt_module_ext * mod_ext, int32_t tempo );
168
177 int ( * set_tempo_factor ) ( openmpt_module_ext * mod_ext, double factor );
178
185 double ( * get_tempo_factor ) ( openmpt_module_ext * mod_ext );
186
196 int ( * set_pitch_factor ) ( openmpt_module_ext * mod_ext, double factor );
197
204 double ( * get_pitch_factor ) ( openmpt_module_ext * mod_ext );
205
214 int ( * set_global_volume ) ( openmpt_module_ext * mod_ext, double volume );
215
222 double ( * get_global_volume ) ( openmpt_module_ext * mod_ext );
223
233 int ( * set_channel_volume ) ( openmpt_module_ext * mod_ext, int32_t channel, double volume );
234
242 double ( * get_channel_volume ) ( openmpt_module_ext * mod_ext, int32_t channel );
243
252 int ( * set_channel_mute_status ) ( openmpt_module_ext * mod_ext, int32_t channel, int mute );
253
261 int ( * get_channel_mute_status ) ( openmpt_module_ext * mod_ext, int32_t channel );
262
271 int ( * set_instrument_mute_status ) ( openmpt_module_ext * mod_ext, int32_t instrument, int mute );
272
280 int ( * get_instrument_mute_status ) ( openmpt_module_ext * mod_ext, int32_t instrument );
281
294 int32_t ( * play_note ) ( openmpt_module_ext * mod_ext, int32_t instrument, int32_t note, double volume, double panning );
295
305 int ( * stop_note ) ( openmpt_module_ext * mod_ext, int32_t channel );
306
308
309
310
311#ifndef LIBOPENMPT_EXT_C_INTERFACE_INTERACTIVE2
312#define LIBOPENMPT_EXT_C_INTERFACE_INTERACTIVE2 "interactive2"
313#endif
314
317
327 int ( *note_off ) ( openmpt_module_ext * mod_ext, int32_t channel );
328
330
340 int ( *note_fade ) ( openmpt_module_ext * mod_ext, int32_t channel );
341
343
352 int ( *set_channel_panning) ( openmpt_module_ext * mod_ext, int32_t channel, double panning );
353
355
362 double (*get_channel_panning) ( openmpt_module_ext * mod_ext, int32_t channel );
363
365
375 int ( *set_note_finetune) ( openmpt_module_ext * mod_ext, int32_t channel, double finetune );
376
378
387 double (*get_note_finetune) ( openmpt_module_ext * mod_ext, int32_t channel );
388
390
391
392
393#ifndef LIBOPENMPT_EXT_C_INTERFACE_INTERACTIVE3
394#define LIBOPENMPT_EXT_C_INTERFACE_INTERACTIVE3 "interactive3"
395#endif
396
398
407 int ( * set_current_tempo2 ) ( openmpt_module_ext * mod_ext, double tempo );
408
410
411
412
413/* add stuff here */
414
415
416
417#ifdef __cplusplus
418}
419#endif
420
425#endif /* LIBOPENMPT_EXT_H */
426
int(* openmpt_error_func)(int error, void *user)
Error function.
Definition: libopenmpt.h:435
struct openmpt_module openmpt_module
Opaque type representing a libopenmpt module.
Definition: libopenmpt.h:660
void(* openmpt_log_func)(const char *message, void *user)
Logging function.
Definition: libopenmpt.h:329
struct openmpt_module_ext_interface_pattern_vis openmpt_module_ext_interface_pattern_vis
int openmpt_module_ext_get_interface(openmpt_module_ext *mod_ext, const char *interface_id, void *interface, size_t interface_size)
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.
struct openmpt_module_ext_interface_interactive2 openmpt_module_ext_interface_interactive2
void openmpt_module_ext_destroy(openmpt_module_ext *mod_ext)
Unload a previously created openmpt_module_ext from memory.
openmpt_module * openmpt_module_ext_get_module(openmpt_module_ext *mod_ext)
Retrieve the openmpt_module handle from an openmpt_module_ext handle.
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.
struct openmpt_module_ext_interface_interactive3 openmpt_module_ext_interface_interactive3
struct openmpt_module_ext openmpt_module_ext
Opaque type representing a libopenmpt extension module.
Definition: libopenmpt_ext.h:39
struct openmpt_module_ext_interface_interactive openmpt_module_ext_interface_interactive
#define LIBOPENMPT_DEPRECATED
Definition: libopenmpt_config.h:315
Definition: libopenmpt_ext.h:315
int(* note_off)(openmpt_module_ext *mod_ext, int32_t channel)
Sends a key-off command for the note playing on the specified channel.
Definition: libopenmpt_ext.h:327
double(* get_channel_panning)(openmpt_module_ext *mod_ext, int32_t channel)
Get the current panning position for a channel.
Definition: libopenmpt_ext.h:362
int(* note_fade)(openmpt_module_ext *mod_ext, int32_t channel)
Sends a note fade command for the note playing on the specified channel.
Definition: libopenmpt_ext.h:340
double(* get_note_finetune)(openmpt_module_ext *mod_ext, int32_t channel)
Get the finetune for the currently playing note on a channel.
Definition: libopenmpt_ext.h:387
int(* set_channel_panning)(openmpt_module_ext *mod_ext, int32_t channel, double panning)
Set the current panning for a channel.
Definition: libopenmpt_ext.h:352
int(* set_note_finetune)(openmpt_module_ext *mod_ext, int32_t channel, double finetune)
Set the finetune for the currently playing note on a channel.
Definition: libopenmpt_ext.h:375
Definition: libopenmpt_ext.h:397
int(* set_current_tempo2)(openmpt_module_ext *mod_ext, double tempo)
Definition: libopenmpt_ext.h:407
Definition: libopenmpt_ext.h:147
int(* set_tempo_factor)(openmpt_module_ext *mod_ext, double factor)
Definition: libopenmpt_ext.h:177
int(* set_pitch_factor)(openmpt_module_ext *mod_ext, double factor)
Definition: libopenmpt_ext.h:196
int(* get_instrument_mute_status)(openmpt_module_ext *mod_ext, int32_t instrument)
Definition: libopenmpt_ext.h:280
int(* stop_note)(openmpt_module_ext *mod_ext, int32_t channel)
Definition: libopenmpt_ext.h:305
int(* get_channel_mute_status)(openmpt_module_ext *mod_ext, int32_t channel)
Definition: libopenmpt_ext.h:261
double(* get_pitch_factor)(openmpt_module_ext *mod_ext)
Definition: libopenmpt_ext.h:204
int(* set_channel_volume)(openmpt_module_ext *mod_ext, int32_t channel, double volume)
Definition: libopenmpt_ext.h:233
double(* get_global_volume)(openmpt_module_ext *mod_ext)
Definition: libopenmpt_ext.h:222
double(* get_tempo_factor)(openmpt_module_ext *mod_ext)
Definition: libopenmpt_ext.h:185
int(* set_instrument_mute_status)(openmpt_module_ext *mod_ext, int32_t instrument, int mute)
Definition: libopenmpt_ext.h:271
int32_t(* play_note)(openmpt_module_ext *mod_ext, int32_t instrument, int32_t note, double volume, double panning)
Definition: libopenmpt_ext.h:294
int(* set_global_volume)(openmpt_module_ext *mod_ext, double volume)
Definition: libopenmpt_ext.h:214
double(* get_channel_volume)(openmpt_module_ext *mod_ext, int32_t channel)
Definition: libopenmpt_ext.h:242
int(* set_channel_mute_status)(openmpt_module_ext *mod_ext, int32_t channel, int mute)
Definition: libopenmpt_ext.h:252
int(* set_current_tempo)(openmpt_module_ext *mod_ext, int32_t tempo)
Definition: libopenmpt_ext.h:167
int(* set_current_speed)(openmpt_module_ext *mod_ext, int32_t speed)
Definition: libopenmpt_ext.h:156
Definition: libopenmpt_ext.h:117
int(* get_pattern_row_channel_effect_type)(openmpt_module_ext *mod_ext, int32_t pattern, int32_t row, int32_t channel)
Definition: libopenmpt_ext.h:138
int(* get_pattern_row_channel_volume_effect_type)(openmpt_module_ext *mod_ext, int32_t pattern, int32_t row, int32_t channel)
Definition: libopenmpt_ext.h:127
Definition: libopenmpt.h:662
Stream callbacks.
Definition: libopenmpt.h:300