/* deadbeef.h -- plugin API of the DeaDBeeF audio player http://deadbeef.sourceforge.net Copyright (C) 2009 Alexey Yakovenko This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions: 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required. 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software. 3. This notice may not be removed or altered from any source distribution. Note: DeaDBeeF player itself uses different license */ #ifndef __DEADBEEF_H #define __DEADBEEF_H #include #include #ifdef __cplusplus extern "C" { #endif // every plugin must define following entry-point: // extern "C" DB_plugin_t* $MODULENAME_load (DB_functions_t *api); // where $MODULENAME is a name of module // e.g. if your plugin is called "myplugin.so", $MODULENAME is "myplugin" // this function should return pointer to DB_plugin_t structure // that is enough for both static and dynamic modules // add DB_PLUGIN_SET_API_VERSION macro when you define plugin structure // like this: // static DB_decoder_t plugin = { // DB_PLUGIN_SET_API_VERSION // ............ // } // this is required for versioning // if you don't do it -- no version checking will be done (usefull for // debugging/development) // DON'T release plugins without DB_PLUGIN_SET_API_VERSION // api version history: // 0.6 -- deadbeef-0.3.3 // 0.5 -- deadbeef-0.3.2 // 0.4 -- deadbeef-0.3.0 // 0.3 -- deadbeef-0.2.3.2 // 0.2 -- deadbeef-0.2.3 // 0.1 -- deadbeef-0.2.0 #define DB_API_VERSION_MAJOR 0 #define DB_API_VERSION_MINOR 6 #define DB_PLUGIN_SET_API_VERSION\ .plugin.api_vmajor = DB_API_VERSION_MAJOR,\ .plugin.api_vminor = DB_API_VERSION_MINOR, //////////////////////////// // playlist structures // iterators // that's a good candidate for redesign #define PL_MAIN 0 #define PL_SEARCH 1 // playlist item // these are "public" fields, available to plugins typedef struct { char *fname; // full pathname struct DB_decoder_s *decoder; // codec to use with this file int tracknum; // used for stuff like sid, nsf, cue (will be ignored by most codecs) int startsample; // start sample of track, or -1 for auto int endsample; // end sample of track, or -1 for auto int shufflerating; // sort order for shuffle mode float playtime; // total playtime time_t started_timestamp; // result of calling time(NULL) const char *filetype; // e.g. MP3 or OGG float replaygain_album_gain; float replaygain_album_peak; float replaygain_track_gain; float replaygain_track_peak; } DB_playItem_t; // plugin types enum { DB_PLUGIN_DECODER = 1, DB_PLUGIN_OUTPUT = 2, DB_PLUGIN_DSP = 3, DB_PLUGIN_MISC = 4, DB_PLUGIN_VFS = 5, }; // output plugin states enum output_state_t { OUTPUT_STATE_STOPPED = 0, OUTPUT_STATE_PLAYING = 1, OUTPUT_STATE_PAUSED = 2, }; // playback order enum playback_order_t { PLAYBACK_ORDER_LINEAR = 0, PLAYBACK_ORDER_SHUFFLE = 1, PLAYBACK_ORDER_RANDOM = 2, }; // playback modes enum playback_mode_t { PLAYBACK_MODE_LOOP_ALL = 0, // loop playlist PLAYBACK_MODE_NOLOOP = 1, // don't loop PLAYBACK_MODE_LOOP_SINGLE = 2, // loop single track }; typedef struct { int event; time_t time; } DB_event_t; typedef struct { DB_event_t ev; int index; DB_playItem_t *track; } DB_event_track_t; typedef struct { DB_event_t ev; int from; int to; } DB_event_trackchange_t; typedef struct { DB_event_t ev; int state; } DB_event_state_t; typedef struct DB_conf_item_s { char *key; char *value; struct DB_conf_item_s *next; } DB_conf_item_t; // event callback type typedef int (*DB_callback_t)(DB_event_t *, uintptr_t data); // events enum { DB_EV_FRAMEUPDATE = 0, // ticks around 20 times per second, but ticker may stop sometimes DB_EV_SONGCHANGED = 1, // triggers when song was just changed DB_EV_SONGSTARTED = 2, // triggers when song started playing (for scrobblers and such) DB_EV_SONGFINISHED = 3, // triggers when song finished playing (for scrobblers and such) DB_EV_TRACKDELETED = 4, // triggers when track is to be deleted from playlist DB_EV_CONFIGCHANGED = 5, // configuration option changed DB_EV_ACTIVATE = 6, // will be fired every time player is activated DB_EV_TRACKINFOCHANGED = 7, // notify plugins that trackinfo was changed DB_EV_PAUSED = 8, // player was paused or unpaused DB_EV_PLAYLISTCHANGED = 9, // playlist contents were changed DB_EV_VOLUMECHANGED = 10, // volume was changed DB_EV_OUTPUTCHANGED = 11, // sound output plugin changed DB_EV_ABORTREAD = 12, // tells plugins to stop reading operations, e.g. long-time http requests DB_EV_MAX }; // preset columns, working using IDs enum pl_column_t { DB_COLUMN_FILENUMBER = 0, DB_COLUMN_PLAYING = 1, DB_COLUMN_ARTIST_ALBUM = 2, DB_COLUMN_ARTIST = 3, DB_COLUMN_ALBUM = 4, DB_COLUMN_TITLE = 5, DB_COLUMN_DURATION = 6, DB_COLUMN_TRACK = 7, DB_COLUMN_ID_MAX }; // message ids for communicating with player enum { M_SONGFINISHED, M_NEXTSONG, M_PREVSONG, M_PLAYSONG, M_PLAYSONGNUM, M_STOPSONG, M_PAUSESONG, M_PLAYRANDOM, M_SONGCHANGED, // p1=from, p2=to M_TERMINATE, // must be sent to player thread to terminate M_PLAYLISTREFRESH, M_REINIT_SOUND, M_TRACKCHANGED, // p1=tracknumber M_CONFIGCHANGED, // no arguments }; // typecasting macros #define DB_PLUGIN(x) ((DB_plugin_t *)(x)) #define DB_CALLBACK(x) ((DB_callback_t)(x)) #define DB_EVENT(x) ((DB_event_t *)(x)) #define DB_PLAYITEM(x) ((DB_playItem_t *)(x)) // FILE object wrapper for vfs access typedef struct { struct DB_vfs_s *vfs; } DB_FILE; // forward decl for plugin struct struct DB_plugin_s; // player api definition typedef struct { // versioning int vmajor; int vminor; // event subscribing void (*ev_subscribe) (struct DB_plugin_s *plugin, int ev, DB_callback_t callback, uintptr_t data); void (*ev_unsubscribe) (struct DB_plugin_s *plugin, int ev, DB_callback_t callback, uintptr_t data); // md5sum calc void (*md5) (uint8_t sig[16], const char *in, int len); void (*md5_to_str) (char *str, const uint8_t sig[16]); // playback control struct DB_output_s* (*get_output) (void); void (*playback_next) (void); void (*playback_prev) (void); void (*playback_pause) (void); void (*playback_stop) (void); void (*playback_play) (void); void (*playback_random) (void); float (*playback_get_pos) (void); // [0..100] void (*playback_set_pos) (float pos); // [0..100] // streamer access // FIXME: needs to be thread-safe DB_playItem_t *(*streamer_get_playing_track) (void); DB_playItem_t *(*streamer_get_streaming_track) (void); float (*streamer_get_playpos) (void); void (*streamer_seek) (float time); int (*streamer_ok_to_read) (int len); void (*streamer_reset) (int full); int (*streamer_read) (char *bytes, int size); void (*streamer_set_bitrate) (int bitrate); int (*streamer_get_apx_bitrate) (void); // process control const char *(*get_config_dir) (void); void (*quit) (void); // threading intptr_t (*thread_start) (void (*fn)(void *ctx), void *ctx); int (*thread_join) (intptr_t tid); uintptr_t (*mutex_create) (void); void (*mutex_free) (uintptr_t mtx); int (*mutex_lock) (uintptr_t mtx); int (*mutex_unlock) (uintptr_t mtx); uintptr_t (*cond_create) (void); void (*cond_free) (uintptr_t cond); int (*cond_wait) (uintptr_t cond, uintptr_t mutex); int (*cond_signal) (uintptr_t cond); int (*cond_broadcast) (uintptr_t cond); // playlist access DB_playItem_t * (*pl_item_alloc) (void); void (*pl_item_free) (DB_playItem_t *it); void (*pl_item_copy) (DB_playItem_t *out, DB_playItem_t *in); int (*pl_add_file) (const char *fname, int (*cb)(DB_playItem_t *it, void *data), void *user_data); int (*pl_add_dir) (const char *dirname, int (*cb)(DB_playItem_t *it, void *data), void *user_data); DB_playItem_t *(*pl_insert_item) (DB_playItem_t *after, DB_playItem_t *it); DB_playItem_t *(*pl_insert_dir) (DB_playItem_t *after, const char *dirname, int *pabort, int (*cb)(DB_playItem_t *it, void *data), void *user_data); DB_playItem_t *(*pl_insert_file) (DB_playItem_t *after, const char *fname, int *pabort, int (*cb)(DB_playItem_t *it, void *data), void *user_data); int (*pl_get_idx_of) (DB_playItem_t *it); DB_playItem_t * (*pl_get_for_idx) (int idx); DB_playItem_t * (*pl_get_for_idx_and_iter) (int idx, int iter); float (*pl_get_totaltime) (void); int (*pl_getcount) (int iter); DB_playItem_t *(*pl_getcurrent) (void); int (*pl_delete_selected) (void); void (*pl_set_cursor) (int iter, int cursor); int (*pl_get_cursor) (int iter); void (*pl_set_selected) (DB_playItem_t *it, int sel); int (*pl_is_selected) (DB_playItem_t *it); void (*pl_free) (void); int (*pl_load) (const char *name); int (*pl_save) (const char *name); void (*pl_select_all) (void); void (*pl_crop_selected) (void); int (*pl_getselcount) (void); DB_playItem_t *(*pl_get_first) (int iter); DB_playItem_t *(*pl_get_last) (int iter); DB_playItem_t *(*pl_get_next) (DB_playItem_t *it, int iter); DB_playItem_t *(*pl_get_prev) (DB_playItem_t *it, int iter); /* this function formats line for display in playlist @it pointer to playlist item @idx number of that item in playlist (or -1) @s output buffer @size size of output buffer @id one of IDs defined in pl_column_id_t enum, can be -1 @fmt format string, used if id is -1 format is printf-alike. specification: %a artist %t title %b album %n track %l length (duration) %y year %g genre %c comment %r copyright more to come */ int (*pl_format_title) (DB_playItem_t *it, int idx, char *s, int size, int id, const char *fmt); void (*pl_format_item_display_name) (DB_playItem_t *it, char *str, int len); // void (*pl_set_next) (DB_playItem_t *it, DB_playItem_t *next, int iter); // void (*pl_set_prev) (DB_playItem_t *it, DB_playItem_t *prev, int iter); // void (*pl_set_head) (DB_playItem_t *it, int iter); // void (*pl_set_tail) (DB_playItem_t *it, int iter); // DB_playItem_t* (*pl_get_head) (void); // DB_playItem_t* (*pl_get_tail) (void); void (*pl_move_items) (int iter, DB_playItem_t *drop_before, uint32_t *indexes, int count); void (*pl_search_reset) (void); void (*pl_search_process) (const char *text); // metainfo void (*pl_add_meta) (DB_playItem_t *it, const char *key, const char *value); const char *(*pl_find_meta) (DB_playItem_t *song, const char *meta); void (*pl_delete_all_meta) (DB_playItem_t *it); void (*pl_set_item_duration) (DB_playItem_t *it, float duration); float (*pl_get_item_duration) (DB_playItem_t *it); void (*pl_sort) (int iter, int id, const char *format, int ascending); // playqueue support int (*pl_playqueue_push) (DB_playItem_t *it); void (*pl_playqueue_clear) (void); void (*pl_playqueue_pop) (void); void (*pl_playqueue_remove) (DB_playItem_t *it); int (*pl_playqueue_test) (DB_playItem_t *it); // cuesheet support DB_playItem_t *(*pl_insert_cue_from_buffer) (DB_playItem_t *after, DB_playItem_t *origin, const uint8_t *buffer, int buffersize, int numsamples, int samplerate); DB_playItem_t * (*pl_insert_cue) (DB_playItem_t *after, DB_playItem_t *origin, int numsamples, int samplerate); // volume control void (*volume_set_db) (float dB); float (*volume_get_db) (void); void (*volume_set_amp) (float amp); float (*volume_get_amp) (void); float (*volume_get_min_db) (void); // junk reading int (*junk_read_id3v1) (DB_playItem_t *it, DB_FILE *fp); int (*junk_read_id3v2) (DB_playItem_t *it, DB_FILE *fp); int (*junk_read_ape) (DB_playItem_t *it, DB_FILE *fp); int (*junk_get_leading_size) (DB_FILE *fp); void (*junk_copy) (DB_playItem_t *from, DB_playItem_t *first, DB_playItem_t *last); // vfs DB_FILE* (*fopen) (const char *fname); void (*fclose) (DB_FILE *f); size_t (*fread) (void *ptr, size_t size, size_t nmemb, DB_FILE *stream); int (*fseek) (DB_FILE *stream, int64_t offset, int whence); int64_t (*ftell) (DB_FILE *stream); void (*rewind) (DB_FILE *stream); int64_t (*fgetlength) (DB_FILE *stream); const char *(*fget_content_type) (DB_FILE *stream); const char *(*fget_content_name) (DB_FILE *stream); const char *(*fget_content_genre) (DB_FILE *stream); void (*fstop) (DB_FILE *stream); // message passing int (*sendmessage) (uint32_t id, uintptr_t ctx, uint32_t p1, uint32_t p2); // configuration access const char * (*conf_get_str) (const char *key, const char *def); float (*conf_get_float) (const char *key, float def); int (*conf_get_int) (const char *key, int def); void (*conf_set_str) (const char *key, const char *val); void (*conf_set_int) (const char *key, int val); DB_conf_item_t * (*conf_find) (const char *group, DB_conf_item_t *prev); void (*conf_remove_items) (const char *key); // plugin communication struct DB_decoder_s **(*plug_get_decoder_list) (void); struct DB_output_s **(*plug_get_output_list) (void); struct DB_plugin_s **(*plug_get_list) (void); int (*plug_activate) (struct DB_plugin_s *p, int activate); // exporting plugin conf options for gui // all exported options are grouped by plugin, and will be available to user // from gui // void (*export_plugin_option_string) (DB_plugin_t *plugin, const char *key); // void (*export_plugin_option_path) (DB_plugin_t *plugin, const char *key); // void (*export_plugin_option_check) (DB_plugin_t *plugin, const char *key); // void (*export_plugin_option_radio) (DB_plugin_t *plugin, const char *key); // void (*export_plugin_option_combo) (DB_plugin_t *plugin, const char *key); // void (*export_plugin_option_comboentry) (DB_plugin_t *plugin, const char *key); } DB_functions_t; // base plugin interface typedef struct DB_plugin_s { // type must be one of DB_PLUGIN_ types int32_t type; // api version int16_t api_vmajor; int16_t api_vminor; // plugin version int16_t version_major; int16_t version_minor; // may be deactivated on failures after load int inactive; // prevent plugin from being dynamically stopped int nostop; // any of those can be left NULL // though it's much better to fill them with something useful const char *name; const char *descr; const char *author; const char *email; const char *website; // start is called to start plugin; can be NULL int (*start) (void); // stop is called to deinit plugin; can be NULL int (*stop) (void); // exec_cmdline may be called at any moment when user sends commandline to player // can be NULL if plugin doesn't support commandline processing // cmdline is 0-separated list of strings, guaranteed to have 0 at the end // cmdline_size is number of bytes pointed by cmdline int (*exec_cmdline) (const char *cmdline, int cmdline_size); // plugin configuration dialog is constructed from this data // can be NULL const char *configdialog; } DB_plugin_t; typedef struct { int bps; int channels; int samplerate; float readpos; } DB_fileinfo_t; // decoder plugin typedef struct DB_decoder_s { DB_plugin_t plugin; DB_fileinfo_t info; // init is called to prepare song to be started int (*init) (DB_playItem_t *it); // free is called after decoding is finished void (*free) (void); // read is called by streamer to decode specified number of bytes // must return number of bytes that were successfully decoded (sample aligned) // read_int16 must always output 16 bit signed integer samples int (*read_int16) (char *buffer, int size); // read_float32 must always output 32 bit floating point samples int (*read_float32) (char *buffer, int size); int (*seek) (float seconds); // perform seeking in samples (if possible) // return -1 if failed, or 0 on success // if -1 is returned, that will mean that streamer must skip that song int (*seek_sample) (int sample); // 'insert' is called to insert new item to playlist // decoder is responsible to calculate duration, split it into subsongs, load cuesheet, etc // after==NULL means "prepend before 1st item in playlist" DB_playItem_t * (*insert) (DB_playItem_t *after, const char *fname); int (*numvoices) (void); void (*mutevoice) (int voice, int mute); // NULL terminated array of all supported extensions const char **exts; // NULL terminated array of all file type names const char **filetypes; // codec id used for playlist serialization const char *id; } DB_decoder_t; // output plugin typedef struct DB_output_s { DB_plugin_t plugin; // init is called once at plugin activation int (*init) (void); // free is called if output plugin was changed to another, or unload is about to happen int (*free) (void); // reconfigure output to another samplerate, if supported int (*change_rate) (int rate); // play, stop, pause, unpause are called by deadbeef in response to user // events, or as part of streaming process int (*play) (void); int (*stop) (void); int (*pause) (void); int (*unpause) (void); // one of output_state_t enum values int (*state) (void); // following functions must return output sampling rate, bits per sample and number // of channels int (*samplerate) (void); int (*bitspersample) (void); int (*channels) (void); // must return 0 for little endian output, or 1 for big endian int (*endianness) (void); // soundcard enumeration (can be NULL) void (*enum_soundcards) (void (*callback)(const char *name, const char *desc, void*), void *userdata); } DB_output_t; // dsp plugin typedef struct { DB_plugin_t plugin; // process gets called before SRC // stereo samples are stored in interleaved format // stereo sample is counted as 1 sample void (*process) (float *samples, int channels, int nsamples); } DB_dsp_t; // misc plugin // purpose is to provide extra services // e.g. scrobbling, converting, tagging, custom gui, etc. // misc plugins should be mostly event driven, so no special entry points in them typedef struct { DB_plugin_t plugin; } DB_misc_t; // vfs plugin // provides means for reading, seeking, etc // api is based on stdio typedef struct DB_vfs_s { DB_plugin_t plugin; DB_FILE* (*open) (const char *fname); void (*close) (DB_FILE *f); size_t (*read) (void *ptr, size_t size, size_t nmemb, DB_FILE *stream); int (*seek) (DB_FILE *stream, int64_t offset, int whence); int64_t (*tell) (DB_FILE *stream); void (*rewind) (DB_FILE *stream); int64_t (*getlength)(DB_FILE *stream); const char * (*get_content_type) (DB_FILE *stream); const char * (*get_content_name) (DB_FILE *stream); const char * (*get_content_genre) (DB_FILE *stream); const char **scheme_names; // NULL-terminated list of supported schemes, e.g. {"http", "ftp", NULL} unsigned streaming : 1; } DB_vfs_t; // gui plugin // implements pretty much anything it wants // works mostly like misc plugin, except we need separate type for that typedef struct DB_gui_s { DB_plugin_t plugin; } DB_gui_t; #ifdef __cplusplus } #endif #endif // __DEADBEEF_H