src/mpdclient.h

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