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          * Tracks idle events.  It is automatically called by
  19          * mpdclient_get_connection() and mpdclient_put_connection().
  20          */
  21         struct mpd_glib_source *source;
  22
  23         struct mpd_status *status;
  24         const struct mpd_song *song;
  25
  26         /**
  27          * This attribute is incremented whenever the connection changes
  28          * (i.e. on disconnection and (re-)connection).
  29          */
  30         unsigned connection_id;
  31
  32         int volume;
  33
  34         /**
  35          * A bit mask of idle events occurred since the last update.
  36          */
  37         enum mpd_idle events;
  38
  39         /**
  40          * This attribute is true when the connection is currently in
  41          * "idle" mode, and the #mpd_glib_source waits for an event.
  42          */
  43         bool idle;
  44
  45         /**
  46          * Is MPD currently playing?
  47          */
  48         bool playing;
  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                 | MPD_IDLE_STICKER
  65                 | MPD_IDLE_SUBSCRIPTION
  66                 | MPD_IDLE_MESSAGE
  67 };
  68
  69 /** functions ***************************************************************/
  70
  71 bool
  72 mpdclient_handle_error(struct mpdclient *c);
  73
  74 static inline bool
  75 mpdclient_finish_command(struct mpdclient *c)
  76 {
  77         return mpd_response_finish(c->connection)
  78                 ? true : mpdclient_handle_error(c);
  79 }
  80
  81 struct mpdclient *
  82 mpdclient_new(void);
  83
  84 void mpdclient_free(struct mpdclient *c);
  85
  86 gcc_pure
  87 static inline bool
  88 mpdclient_is_connected(const struct mpdclient *c)
  89 {
  90         return c->connection != NULL;
  91 }
  92
  93 gcc_pure
  94 static inline bool
  95 mpdclient_is_playing(const struct mpdclient *c)
  96 {
  97         return c->status != NULL &&
  98                 (mpd_status_get_state(c->status) == MPD_STATE_PLAY ||
  99                  mpd_status_get_state(c->status) == MPD_STATE_PAUSE);
 100 }
 101
 102 gcc_pure
 103 static inline const struct mpd_song *
 104 mpdclient_get_current_song(const struct mpdclient *c)
 105 {
 106         return c->song != NULL && mpdclient_is_playing(c)
 107                 ? c->song
 108                 : NULL;
 109 }
 110
 111 bool
 112 mpdclient_connect(struct mpdclient *c, const gchar *host, gint port,
 113                   unsigned timeout_ms, const gchar *password);
 114
 115 void
 116 mpdclient_disconnect(struct mpdclient *c);
 117
 118 bool
 119 mpdclient_update(struct mpdclient *c);
 120
 121 struct mpd_connection *
 122 mpdclient_get_connection(struct mpdclient *c);
 123
 124 void
 125 mpdclient_put_connection(struct mpdclient *c);
 126
 127 /*** MPD Commands  **********************************************************/
 128
 129 bool
 130 mpdclient_cmd_crop(struct mpdclient *c);
 131
 132 bool
 133 mpdclient_cmd_clear(struct mpdclient *c);
 134
 135 bool
 136 mpdclient_cmd_volume(struct mpdclient *c, gint value);
 137
 138 bool
 139 mpdclient_cmd_volume_up(struct mpdclient *c);
 140
 141 bool
 142 mpdclient_cmd_volume_down(struct mpdclient *c);
 143
 144 bool
 145 mpdclient_cmd_add_path(struct mpdclient *c, const gchar *path);
 146
 147 bool
 148 mpdclient_cmd_add(struct mpdclient *c, const struct mpd_song *song);
 149
 150 bool
 151 mpdclient_cmd_delete(struct mpdclient *c, gint index);
 152
 153 bool
 154 mpdclient_cmd_delete_range(struct mpdclient *c, unsigned start, unsigned end);
 155
 156 bool
 157 mpdclient_cmd_move(struct mpdclient *c, unsigned dest, unsigned src);
 158
 159 bool
 160 mpdclient_cmd_subscribe(struct mpdclient *c, const char *channel);
 161
 162 bool
 163 mpdclient_cmd_unsubscribe(struct mpdclient *c, const char *channel);
 164
 165 bool
 166 mpdclient_cmd_send_message(struct mpdclient *c, const char *channel,
 167                            const char *text);
 168
 169 bool
 170 mpdclient_send_read_messages(struct mpdclient *c);
 171
 172 struct mpd_message *
 173 mpdclient_recv_message(struct mpdclient *c);
 174
 175 /*** playlist functions  **************************************************/
 176
 177 /* update the complete playlist */
 178 bool
 179 mpdclient_playlist_update(struct mpdclient *c);
 180
 181 /* get playlist changes */
 182 bool
 183 mpdclient_playlist_update_changes(struct mpdclient *c);
 184
 185 /* add all songs in filelist to the playlist */
 186 bool
 187 mpdclient_filelist_add_all(struct mpdclient *c, struct filelist *fl);
 188
 189 #endif