Code

po: updated Dutch translation
[ncmpc.git] / src / mpdclient.h
index fa2f1b61dae81096377a5442dcb84cf2d378716d..a93db74baf135392acba5ff418bc3f18d2dffc6d 100644 (file)
@@ -3,7 +3,7 @@
 
 #include "playlist.h"
 
-#include <mpd/tag.h>
+#include <mpd/client.h>
 
 struct filelist;
 
@@ -11,22 +11,39 @@ struct mpdclient {
        /* playlist */
        struct mpdclient_playlist playlist;
 
-       /* Callbacks */
-       GList *error_callbacks;
-       GList *playlist_callbacks;
-       GList *browse_callbacks;
-
        struct mpd_connection *connection;
+
+       /**
+        * If this object is non-NULL, it tracks idle events.  It is
+        * automatically called by mpdclient_get_connection() and
+        * mpdclient_put_connection().  It is not created by the
+        * mpdclient library; the user of this library has to
+        * initialize it.  However, it is freed when the MPD
+        * connection is closed.
+        */
+       struct mpd_glib_source *source;
+
+       /**
+        * This attribute is true when the connection is currently in
+        * "idle" mode, and the #mpd_glib_source waits for an event.
+        */
+       bool idle;
+
        struct mpd_status *status;
        const struct mpd_song *song;
 
        int volume;
-       unsigned updatingdb;
+       unsigned update_id;
+
+       /**
+        * A bit mask of idle events occured since the last update.
+        */
+       enum mpd_idle events;
 };
 
 /** functions ***************************************************************/
 
-gint
+bool
 mpdclient_handle_error(struct mpdclient *c);
 
 struct mpdclient *
@@ -40,6 +57,23 @@ mpdclient_is_connected(const struct mpdclient *c)
        return c->connection != NULL;
 }
 
+G_GNUC_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);
+}
+
+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;
+}
+
 bool
 mpdclient_connect(struct mpdclient *c, const gchar *host, gint port,
                  gfloat timeout_, const gchar *password);
@@ -47,116 +81,68 @@ mpdclient_connect(struct mpdclient *c, const gchar *host, gint port,
 void
 mpdclient_disconnect(struct mpdclient *c);
 
-gint mpdclient_update(struct mpdclient *c);
-
+bool
+mpdclient_update(struct mpdclient *c);
 
-/*** MPD Commands  **********************************************************/
-gint mpdclient_cmd_play(struct mpdclient *c, gint index);
-gint mpdclient_cmd_pause(struct mpdclient *c, gint value);
-gint
-mpdclient_cmd_crop(struct mpdclient *c);
-gint mpdclient_cmd_stop(struct mpdclient *c);
-gint mpdclient_cmd_next(struct mpdclient *c);
-gint mpdclient_cmd_prev(struct mpdclient *c);
-gint mpdclient_cmd_seek(struct mpdclient *c, gint id, gint pos);
-gint mpdclient_cmd_shuffle(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_repeat(struct mpdclient *c, gint value);
-gint mpdclient_cmd_random(struct mpdclient *c, gint value);
-gint mpdclient_cmd_single(struct mpdclient *c, gint value);
-gint mpdclient_cmd_consume(struct mpdclient *c, gint value);
-gint mpdclient_cmd_crossfade(struct mpdclient *c, gint value);
-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);
-
-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);
+struct mpd_connection *
+mpdclient_get_connection(struct mpdclient *c);
 
-/*** playlist functions  **************************************************/
+void
+mpdclient_put_connection(struct mpdclient *c);
 
-/* update the complete playlist */
-gint mpdclient_playlist_update(struct mpdclient *c);
+/**
+ * To be implemented by the application: mpdclient.c calls this to
+ * display an error message.
+ */
+void
+mpdclient_ui_error(const char *message);
 
-/* get playlist changes */
-gint mpdclient_playlist_update_changes(struct mpdclient *c);
+/*** MPD Commands  **********************************************************/
 
+bool
+mpdclient_cmd_crop(struct mpdclient *c);
 
-/*** mpdclient playlist callbacks *****************************************/
+bool
+mpdclient_cmd_clear(struct mpdclient *c);
 
-#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_volume(struct mpdclient *c, gint value);
 
+bool
+mpdclient_cmd_volume_up(struct mpdclient *c);
 
-typedef void (*mpdc_list_cb_t) (struct mpdclient *c, int event, gpointer data);
+bool
+mpdclient_cmd_volume_down(struct mpdclient *c);
 
-/* install a playlist callback function */
-void mpdclient_install_playlist_callback(struct mpdclient *c, mpdc_list_cb_t cb);
+bool
+mpdclient_cmd_add_path(struct mpdclient *c, const gchar *path);
 
-/* remove a playlist callback function */
-void mpdclient_remove_playlist_callback(struct mpdclient *c, mpdc_list_cb_t cb);
+bool
+mpdclient_cmd_add(struct mpdclient *c, const struct mpd_song *song);
 
+bool
+mpdclient_cmd_delete(struct mpdclient *c, gint index);
 
-/* issue a playlist callback */
-void mpdclient_playlist_callback(struct mpdclient *c, int event, gpointer data);
+bool
+mpdclient_cmd_delete_range(struct mpdclient *c, unsigned start, unsigned end);
 
+bool
+mpdclient_cmd_move(struct mpdclient *c, unsigned dest, unsigned src);
 
-/*** 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);