src/modipulate/modipulate.h

Go to the documentation of this file.

#ifndef MODIPULATE_H
#define MODIPULATE_H

#ifdef __cplusplus
extern "C" {
#endif 

#define MODIPULATE_ERROR_NONE                   0
#define MODIPULATE_ERROR_GENERAL                1
#define MODIPULATE_ERROR_INVALID_PARAMETERS     2
#define MODIPULATE_ERROR_NOT_IMPLEMENTED        3

#define MODIPULATE_OK(err) (err == MODIPULATE_ERROR_NONE)

typedef unsigned ModipulateErr;

typedef void* ModipulateSong;


typedef void (*modipulate_song_pattern_change_cb) (ModipulateSong song, int pattern_number,
    void* user_data);

typedef void (*modipulate_song_note_cb) (ModipulateSong song, unsigned channel, int note,
    int instrument, int sample, int volume_command, int volume_value,
    int effect_command, int effect_value, void* user_data);

typedef void (*modipulate_song_row_change_cb) (ModipulateSong song, int row, void* user_data);

typedef struct {
    char** instrument_names; 
    char** sample_names;  
    int* rows_per_pattern;  
    char* title;  
    char* message;  
    int default_tempo;  
    int num_channels;  
    int num_instruments;  
    int num_samples;  
    int num_patterns; 
} ModipulateSongInfo;


ModipulateErr modipulate_global_init(void);


ModipulateErr modipulate_global_deinit(void);


char* modipulate_global_get_last_error_string(void);


ModipulateErr modipulate_global_update(void);


float modipulate_global_get_volume(void);

void modipulate_global_set_volume(float vol);

ModipulateErr modipulate_song_load(const char* filename, ModipulateSong* song);

ModipulateErr modipulate_song_unload(ModipulateSong song);


ModipulateErr modipulate_song_play(ModipulateSong song, int play);


ModipulateErr modipulate_song_get_info(ModipulateSong song, ModipulateSongInfo** song_info);

ModipulateErr modipulate_song_info_free(ModipulateSongInfo* song_info);

ModipulateErr modipulate_song_volume_command(ModipulateSong song, unsigned channel,
    int volume_command, int volume_value);

ModipulateErr modipulate_song_enable_volume(ModipulateSong song, unsigned channel,
    int volume_command, int enable);

ModipulateErr modipulate_song_effect_command(ModipulateSong song, unsigned channel,
    int effect_command, int effect_value);


ModipulateErr modipulate_song_enable_effect(ModipulateSong song, unsigned channel,
    int effect_command, int enable);

ModipulateErr modipulate_song_set_transposition(ModipulateSong song, unsigned channel,
    int offset);

ModipulateErr modipulate_song_get_transposition(ModipulateSong song, unsigned channel,
    int* offset);

void modipulate_song_set_channel_enabled(ModipulateSong song, unsigned channel, int enabled);

int modipulate_song_get_channel_enabled(ModipulateSong song, unsigned channel);

ModipulateErr modipulate_song_on_pattern_change(ModipulateSong song,
    modipulate_song_pattern_change_cb cb, void* user_data);

ModipulateErr modipulate_song_on_row_change(ModipulateSong song,
    modipulate_song_row_change_cb cb, void* user_data);

ModipulateErr modipulate_song_on_note(ModipulateSong song,
    modipulate_song_note_cb cb, void* user_data);

#ifdef __cplusplus
}
#endif 

#endif /* MODIPULATE_H */