src/mpdclient.h

   1 #ifndef MPDCLIENT_H
   2 #define MPDCLIENT_H
   3
   4 #include "playlist.h"
   5 #include "Compiler.h"
   6
   7 #include <mpd/client.h>
   8
   9 struct filelist;
  10
  11 struct mpdclient {
  12         /* playlist */
  13         struct mpdclient_playlist playlist;
  14
  15         struct mpd_connection *connection;
  16
  17         /**
  18          * This attribute is incremented whenever the connection changes
  19          * (i.e. on disconnection and (re-)connection).
  20          */
  21         unsigned connection_id;
  22
  23         /**
  24          * If this object is non-NULL, it tracks idle events.  It is
  25          * automatically called by mpdclient_get_connection() and
  26          * mpdclient_put_connection().  It is not created by the
  27          * mpdclient library; the user of this library has to
  28          * initialize it.  However, it is freed when the MPD
  29          * connection is closed.
  30          */
  31         struct mpd_glib_source *source;
  32
  33         /**
  34          * This attribute is true when the connection is currently in
  35          * "idle" mode, and the #mpd_glib_source waits for an event.
  36          */
  37         bool idle;
  38
  39         struct mpd_status *status;
  40         const struct mpd_song *song;
  41
  42         int volume;
  43         unsigned update_id;
  44
  45         /**
  46          * A bit mask of idle events occurred since the last update.
  47          */
  48         enum mpd_idle events;
  49 };
  50
  51 enum {
  52         /**
  53          * all idle events the version of libmpdclient, ncmpc is compiled
  54          * against, supports
  55          */
  56         MPD_IDLE_ALL = MPD_IDLE_DATABASE
  57                 | MPD_IDLE_STORED_PLAYLIST
  58                 | MPD_IDLE_QUEUE
  59                 | MPD_IDLE_PLAYER
  60                 | MPD_IDLE_MIXER
  61                 | MPD_IDLE_OUTPUT
  62                 | MPD_IDLE_OPTIONS
  63                 | MPD_IDLE_UPDATE
  64 #if LIBMPDCLIENT_CHECK_VERSION(2,5,0)
  65                 | MPD_IDLE_STICKER
  66                 | MPD_IDLE_SUBSCRIPTION
  67                 | MPD_IDLE_MESSAGE
  68 #endif
  69 };
  70
  71 /** functions ***************************************************************/
  72
  73 bool
  74 mpdclient_handle_error(struct mpdclient *c);
  75
  76 static inline bool
  77 mpdclient_finish_command(struct mpdclient *c)
  78 {
  79         return mpd_response_finish(c->connection)
  80                 ? true : mpdclient_handle_error(c);
  81 }
  82
  83 struct mpdclient *
  84 mpdclient_new(void);
  85
  86 void mpdclient_free(struct mpdclient *c);
  87
  88 gcc_pure
  89 static inline bool
  90 mpdclient_is_connected(const struct mpdclient *c)
  91 {
  92         return c->connection != NULL;
  93 }
  94
  95 gcc_pure
  96 static inline bool
  97 mpdclient_is_playing(const struct mpdclient *c)
  98 {
  99         return c->status != NULL &&
 100                 (mpd_status_get_state(c->status) == MPD_STATE_PLAY ||
 101                  mpd_status_get_state(c->status) == MPD_STATE_PAUSE);
 102 }
 103
 104 gcc_pure
 105 static inline const struct mpd_song *
 106 mpdclient_get_current_song(const struct mpdclient *c)
 107 {
 108         return c->song != NULL && mpdclient_is_playing(c)
 109                 ? c->song
 110                 : NULL;
 111 }
 112
 113 bool
 114 mpdclient_connect(struct mpdclient *c, const gchar *host, gint port,
 115                   unsigned timeout_ms, const gchar *password);
 116
 117 void
 118 mpdclient_disconnect(struct mpdclient *c);
 119
 120 bool
 121 mpdclient_update(struct mpdclient *c);
 122
 123 struct mpd_connection *
 124 mpdclient_get_connection(struct mpdclient *c);
 125
 126 void
 127 mpdclient_put_connection(struct mpdclient *c);
 128
 129 /**
 130  * To be implemented by the application: mpdclient.c calls this to
 131  * display an error message.
 132  */
 133 void
 134 mpdclient_ui_error(const char *message);
 135
 136 /*** MPD Commands  **********************************************************/
 137
 138 bool
 139 mpdclient_cmd_crop(struct mpdclient *c);
 140
 141 bool
 142 mpdclient_cmd_clear(struct mpdclient *c);
 143
 144 bool
 145 mpdclient_cmd_volume(struct mpdclient *c, gint value);
 146
 147 bool
 148 mpdclient_cmd_volume_up(struct mpdclient *c);
 149
 150 bool
 151 mpdclient_cmd_volume_down(struct mpdclient *c);
 152
 153 bool
 154 mpdclient_cmd_add_path(struct mpdclient *c, const gchar *path);
 155
 156 bool
 157 mpdclient_cmd_add(struct mpdclient *c, const struct mpd_song *song);
 158
 159 bool
 160 mpdclient_cmd_delete(struct mpdclient *c, gint index);
 161
 162 bool
 163 mpdclient_cmd_delete_range(struct mpdclient *c, unsigned start, unsigned end);
 164
 165 bool
 166 mpdclient_cmd_move(struct mpdclient *c, unsigned dest, unsigned src);
 167
 168 #if LIBMPDCLIENT_CHECK_VERSION(2,5,0)
 169 bool
 170 mpdclient_cmd_subscribe(struct mpdclient *c, const char *channel);
 171
 172 bool
 173 mpdclient_cmd_unsubscribe(struct mpdclient *c, const char *channel);
 174
 175 bool
 176 mpdclient_cmd_send_message(struct mpdclient *c, const char *channel,
 177                            const char *text);
 178
 179 bool
 180 mpdclient_send_read_messages(struct mpdclient *c);
 181
 182 struct mpd_message *
 183 mpdclient_recv_message(struct mpdclient *c);
 184 #endif
 185
 186 /*** playlist functions  **************************************************/
 187
 188 /* update the complete playlist */
 189 bool
 190 mpdclient_playlist_update(struct mpdclient *c);
 191
 192 /* get playlist changes */
 193 bool
 194 mpdclient_playlist_update_changes(struct mpdclient *c);
 195
 196 /* add all songs in filelist to the playlist */
 197 bool
 198 mpdclient_filelist_add_all(struct mpdclient *c, struct filelist *fl);
 199
 200 /* sort by song format */
 201 gcc_pure
 202 gint compare_filelistentry_format(gconstpointer filelist_entry1,
 203                                   gconstpointer filelist_entry2,
 204                                   const char *song_format);
 205
 206 #endif