X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fmpdclient.h;h=d51013fc8c4176b29b4b23e1b1ccf1a74c9a3573;hb=f1a456c2b13b8885bae41ddaa051447c3742e498;hp=4723acfea191a3e526d3a1472743c30c78bac48a;hpb=0fbb0f08787d0b3716b28232c9091512b2f0224b;p=ncmpc.git diff --git a/src/mpdclient.h b/src/mpdclient.h index 4723acf..d51013f 100644 --- a/src/mpdclient.h +++ b/src/mpdclient.h @@ -1,48 +1,163 @@ #ifndef MPDCLIENT_H #define MPDCLIENT_H +#include "config.h" #include "playlist.h" +#include "Compiler.h" #include struct filelist; struct mpdclient { +#ifdef ENABLE_ASYNC_CONNECT + struct mpd_settings *settings; +#else + const char *host; + unsigned port; +#endif + + unsigned timeout_ms; + + const char *password; + /* playlist */ struct mpdclient_playlist playlist; - /* Callbacks */ - GList *error_callbacks; - GList *playlist_callbacks; - GList *browse_callbacks; +#ifdef ENABLE_ASYNC_CONNECT + struct aconnect *async_connect; +#endif struct mpd_connection *connection; + + /** + * Tracks idle events. It is automatically called by + * mpdclient_get_connection(). + */ + struct mpd_glib_source *source; + struct mpd_status *status; const struct mpd_song *song; + /** + * The GLib source id which re-enters MPD idle mode before the + * next main loop interation. + */ + unsigned enter_idle_source_id; + + /** + * This attribute is incremented whenever the connection changes + * (i.e. on disconnection and (re-)connection). + */ + unsigned connection_id; + int volume; - unsigned update_id; + + /** + * A bit mask of idle events occurred since the last update. + */ + enum mpd_idle events; + + /** + * This attribute is true when the connection is currently in + * "idle" mode, and the #mpd_glib_source waits for an event. + */ + bool idle; + + /** + * Is MPD currently playing? + */ + bool playing; +}; + +enum { + /** + * all idle events the version of libmpdclient, ncmpc is compiled + * against, supports + */ + MPD_IDLE_ALL = MPD_IDLE_DATABASE + | MPD_IDLE_STORED_PLAYLIST + | MPD_IDLE_QUEUE + | MPD_IDLE_PLAYER + | MPD_IDLE_MIXER + | MPD_IDLE_OUTPUT + | MPD_IDLE_OPTIONS + | MPD_IDLE_UPDATE + | MPD_IDLE_STICKER + | MPD_IDLE_SUBSCRIPTION + | MPD_IDLE_MESSAGE }; /** functions ***************************************************************/ -gint +bool mpdclient_handle_error(struct mpdclient *c); +static inline bool +mpdclient_finish_command(struct mpdclient *c) +{ + return mpd_response_finish(c->connection) + ? true : mpdclient_handle_error(c); +} + struct mpdclient * -mpdclient_new(void); +mpdclient_new(const gchar *host, unsigned port, + unsigned timeout_ms, const gchar *password); void mpdclient_free(struct mpdclient *c); +/** + * Determine a human-readable "name" of the settings currently used to + * connect to MPD. + * + * @return an allocated string that needs to be freed (with g_free()) + * by the caller + */ +char * +mpdclient_settings_name(const struct mpdclient *c); + +gcc_pure static inline bool mpdclient_is_connected(const struct mpdclient *c) { return c->connection != NULL; } -bool -mpdclient_connect(struct mpdclient *c, const gchar *host, gint port, - gfloat timeout_, const gchar *password); +/** + * Is this object "dead"? i.e. not connected and not currently doing + * anything to connect. + */ +gcc_pure +static inline bool +mpdclient_is_dead(const struct mpdclient *c) +{ + return c->connection == NULL +#ifdef ENABLE_ASYNC_CONNECT + && c->async_connect == NULL +#endif + ; +} + +gcc_pure +static inline bool +mpdclient_is_playing(const struct mpdclient *c) +{ + return c->status != NULL && + (mpd_status_get_state(c->status) == MPD_STATE_PLAY || + mpd_status_get_state(c->status) == MPD_STATE_PAUSE); +} + +gcc_pure +static inline const struct mpd_song * +mpdclient_get_current_song(const struct mpdclient *c) +{ + return c->song != NULL && mpdclient_is_playing(c) + ? c->song + : NULL; +} + +void +mpdclient_connect(struct mpdclient *c); void mpdclient_disconnect(struct mpdclient *c); @@ -50,106 +165,69 @@ mpdclient_disconnect(struct mpdclient *c); bool mpdclient_update(struct mpdclient *c); +struct mpd_connection * +mpdclient_get_connection(struct mpdclient *c); /*** MPD Commands **********************************************************/ -gint mpdclient_cmd_play(struct mpdclient *c, gint index); -gint -mpdclient_cmd_crop(struct mpdclient *c); -gint mpdclient_cmd_shuffle_range(struct mpdclient *c, guint start, guint end); -gint mpdclient_cmd_clear(struct mpdclient *c); -gint mpdclient_cmd_volume(struct mpdclient *c, gint value); -gint mpdclient_cmd_volume_up(struct mpdclient *c); -gint mpdclient_cmd_volume_down(struct mpdclient *c); -gint mpdclient_cmd_add_path(struct mpdclient *c, const gchar *path); - -gint mpdclient_cmd_add(struct mpdclient *c, const struct mpd_song *song); -gint mpdclient_cmd_delete(struct mpdclient *c, gint index); -gint mpdclient_cmd_move(struct mpdclient *c, gint old_index, gint new_index); - -gint mpdclient_cmd_save_playlist(struct mpdclient *c, const gchar *filename); -gint mpdclient_cmd_load_playlist(struct mpdclient *c, const gchar *filename_utf8); -gint mpdclient_cmd_delete_playlist(struct mpdclient *c, const gchar *filename_utf8); - -/* list functions */ -GList *mpdclient_get_artists(struct mpdclient *c); -GList *mpdclient_get_albums(struct mpdclient *c, const gchar *artist_utf8); - -/*** error callbacks *****************************************************/ - -#define IS_ACK_ERROR(n) (n & MPD_ERROR_ACK) -#define GET_ACK_ERROR_CODE(n) ((n & 0xFF00) >> 8) - -typedef void (*mpdc_error_cb_t) (struct mpdclient *c, gint error, const gchar *msg); +bool +mpdclient_cmd_crop(struct mpdclient *c); -void mpdclient_install_error_callback(struct mpdclient *c, mpdc_error_cb_t cb); -void mpdclient_remove_error_callback(struct mpdclient *c, mpdc_error_cb_t cb); +bool +mpdclient_cmd_clear(struct mpdclient *c); -/*** playlist functions **************************************************/ +bool +mpdclient_cmd_volume(struct mpdclient *c, gint value); -/* update the complete playlist */ bool -mpdclient_playlist_update(struct mpdclient *c); +mpdclient_cmd_volume_up(struct mpdclient *c); -/* get playlist changes */ bool -mpdclient_playlist_update_changes(struct mpdclient *c); +mpdclient_cmd_volume_down(struct mpdclient *c); +bool +mpdclient_cmd_add_path(struct mpdclient *c, const gchar *path); -/*** mpdclient playlist callbacks *****************************************/ +bool +mpdclient_cmd_add(struct mpdclient *c, const struct mpd_song *song); -#define PLAYLIST_EVENT_UPDATED 0x01 -#define PLAYLIST_EVENT_CLEAR 0x02 -#define PLAYLIST_EVENT_DELETE 0x03 -#define PLAYLIST_EVENT_ADD 0x04 -#define PLAYLIST_EVENT_MOVE 0x05 +bool +mpdclient_cmd_delete(struct mpdclient *c, gint index); +bool +mpdclient_cmd_delete_range(struct mpdclient *c, unsigned start, unsigned end); -typedef void (*mpdc_list_cb_t) (struct mpdclient *c, int event, gpointer data); +bool +mpdclient_cmd_move(struct mpdclient *c, unsigned dest, unsigned src); -/* install a playlist callback function */ -void mpdclient_install_playlist_callback(struct mpdclient *c, mpdc_list_cb_t cb); +bool +mpdclient_cmd_subscribe(struct mpdclient *c, const char *channel); -/* remove a playlist callback function */ -void mpdclient_remove_playlist_callback(struct mpdclient *c, mpdc_list_cb_t cb); +bool +mpdclient_cmd_unsubscribe(struct mpdclient *c, const char *channel); +bool +mpdclient_cmd_send_message(struct mpdclient *c, const char *channel, + const char *text); -/* issue a playlist callback */ -void mpdclient_playlist_callback(struct mpdclient *c, int event, gpointer data); +bool +mpdclient_send_read_messages(struct mpdclient *c); +struct mpd_message * +mpdclient_recv_message(struct mpdclient *c); -/*** filelist functions ***************************************************/ +/*** playlist functions **************************************************/ -struct filelist * -mpdclient_filelist_get(struct mpdclient *c, const gchar *path); +/* update the complete playlist */ +bool +mpdclient_playlist_update(struct mpdclient *c); -struct filelist * -mpdclient_filelist_search(struct mpdclient *c, int exact_match, - enum mpd_tag_type tag, - gchar *filter_utf8); +/* get playlist changes */ +bool +mpdclient_playlist_update_changes(struct mpdclient *c); /* add all songs in filelist to the playlist */ -int +bool mpdclient_filelist_add_all(struct mpdclient *c, struct filelist *fl); -/*** mpdclient browse callbacks ********************************************/ - -#define BROWSE_DB_UPDATED 0x01 -#define BROWSE_PLAYLIST_SAVED 0x02 -#define BROWSE_PLAYLIST_DELETED 0x03 - - -/* install a playlist callback function */ -void mpdclient_install_browse_callback(struct mpdclient *c, mpdc_list_cb_t cb); - -/* remove a playlist callback function */ -void mpdclient_remove_browse_callback(struct mpdclient *c, mpdc_list_cb_t cb); - - -/* issue a playlist callback */ -void mpdclient_browse_callback(struct mpdclient *c, int event, gpointer data); - -/* sort by list-format */ -gint compare_filelistentry_format(gconstpointer filelist_entry1, gconstpointer filelist_entry2); - #endif