src/mpdclient.h

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