Code

mpdclient: moved browse callback invocation from screen.c
[ncmpc.git] / src / mpdclient.h
1 #ifndef MPDCLIENT_H
2 #define MPDCLIENT_H
4 #include "libmpdclient.h"
5 #include "playlist.h"
6 #include "filelist.h"
8 #define MPD_VERSION_EQ(c,x,y,z) (c->connection->version[0] == x && \
9                                  c->connection->version[1] == y && \
10                                  c->connection->version[2] == z )
12 #define MPD_VERSION_LT(c,x,y,z) ( c->connection->version[0]<x  || \
13  (c->connection->version[0]==x && c->connection->version[1]<y) || \
14  (c->connection->version[0]==x && c->connection->version[1]==y && \
15   c->connection->version[2]<z) )
17 typedef struct mpdclient {
18         /* playlist */
19         mpdclient_playlist_t playlist;
21         /* Callbacks */
22         GList *error_callbacks;
23         GList *playlist_callbacks;
24         GList *browse_callbacks;
26         mpd_Connection *connection;
27         mpd_Status     *status;
28         mpd_Song       *song;
30         gboolean       need_update;
32         int updatingdb;
33 } mpdclient_t;
35 /** functions ***************************************************************/
37 gint
38 mpdclient_finish_command(mpdclient_t *c);
40 mpdclient_t *mpdclient_new(void);
41 void mpdclient_free(mpdclient_t *c);
42 gint mpdclient_connect(mpdclient_t *c, gchar *host, gint port,
43                        gfloat timeout_, gchar *password);
44 gint mpdclient_disconnect(mpdclient_t *c);
45 gint mpdclient_update(mpdclient_t *c);
48 /*** MPD Commands  **********************************************************/
49 gint mpdclient_cmd_play(mpdclient_t *c, gint index);
50 gint mpdclient_cmd_pause(mpdclient_t *c, gint value);
51 gint
52 mpdclient_cmd_crop(mpdclient_t *c);
53 gint mpdclient_cmd_stop(mpdclient_t *c);
54 gint mpdclient_cmd_next(mpdclient_t *c);
55 gint mpdclient_cmd_prev(mpdclient_t *c);
56 gint mpdclient_cmd_seek(mpdclient_t *c, gint id, gint pos);
57 gint mpdclient_cmd_shuffle(mpdclient_t *c);
58 gint mpdclient_cmd_shuffle_range(mpdclient_t *c, guint start, guint end);
59 gint mpdclient_cmd_clear(mpdclient_t *c);
60 gint mpdclient_cmd_repeat(mpdclient_t *c, gint value);
61 gint mpdclient_cmd_random(mpdclient_t *c, gint value);
62 gint mpdclient_cmd_single(mpdclient_t *c, gint value);
63 gint mpdclient_cmd_consume(mpdclient_t *c, gint value);
64 gint mpdclient_cmd_crossfade(mpdclient_t *c, gint value);
65 gint mpdclient_cmd_db_update(mpdclient_t *c, gchar *path);
66 gint mpdclient_cmd_volume(mpdclient_t *c, gint value);
67 gint mpdclient_cmd_add_path(mpdclient_t *c, gchar *path);
69 gint mpdclient_cmd_add(mpdclient_t *c, struct mpd_song *song);
70 gint mpdclient_cmd_delete(mpdclient_t *c, gint index);
71 gint mpdclient_cmd_move(mpdclient_t *c, gint old_index, gint new_index);
73 gint mpdclient_cmd_save_playlist(mpdclient_t *c, gchar *filename);
74 gint mpdclient_cmd_load_playlist(mpdclient_t *c, gchar *filename_utf8);
75 gint mpdclient_cmd_delete_playlist(mpdclient_t *c, gchar *filename_utf8);
77 /* list functions */
78 GList *mpdclient_get_artists(mpdclient_t *c);
79 GList *mpdclient_get_albums(mpdclient_t *c, gchar *artist_utf8);
82 /*** error callbacks *****************************************************/
84 #define IS_ACK_ERROR(n)       (n & MPD_ERROR_ACK)
85 #define GET_ACK_ERROR_CODE(n) ((n & 0xFF00) >> 8)
87 typedef void (*mpdc_error_cb_t) (mpdclient_t *c, gint error, const gchar *msg);
89 void mpdclient_install_error_callback(mpdclient_t *c, mpdc_error_cb_t cb);
90 void mpdclient_remove_error_callback(mpdclient_t *c, mpdc_error_cb_t cb);
92 /*** playlist functions  **************************************************/
94 /* update the complete playlist */
95 gint mpdclient_playlist_update(struct mpdclient *c);
97 /* get playlist changes */
98 gint mpdclient_playlist_update_changes(struct mpdclient *c);
101 /*** mpdclient playlist callbacks *****************************************/
103 #define PLAYLIST_EVENT_UPDATED     0x01
104 #define PLAYLIST_EVENT_CLEAR       0x02
105 #define PLAYLIST_EVENT_DELETE      0x03
106 #define PLAYLIST_EVENT_ADD         0x04
107 #define PLAYLIST_EVENT_MOVE        0x05
110 typedef void (*mpdc_list_cb_t) (mpdclient_t *c, int event, gpointer data);
112 /* install a playlist callback function */
113 void mpdclient_install_playlist_callback(mpdclient_t *c, mpdc_list_cb_t cb);
115 /* remove a playlist callback function */
116 void mpdclient_remove_playlist_callback(mpdclient_t *c, mpdc_list_cb_t cb);
119 /* issue a playlist callback */
120 void mpdclient_playlist_callback(mpdclient_t *c, int event, gpointer data);
123 /*** filelist functions  ***************************************************/
125 mpdclient_filelist_t *mpdclient_filelist_get(mpdclient_t *c, const gchar *path);
126 mpdclient_filelist_t *mpdclient_filelist_search(mpdclient_t *c,
127                                                 int exact_match,
128                                                 int table,
129                                                 gchar *filter_utf8);
130 mpdclient_filelist_t *mpdclient_filelist_update(mpdclient_t *c,
131                                                 mpdclient_filelist_t *flist);
133 /* add all songs in filelist to the playlist */
134 int mpdclient_filelist_add_all(mpdclient_t *c, mpdclient_filelist_t *fl);
136 /*** mpdclient browse callbacks ********************************************/
138 #define BROWSE_DB_UPDATED          0x01
139 #define BROWSE_PLAYLIST_SAVED      0x02
140 #define BROWSE_PLAYLIST_DELETED    0x03
143 /* install a playlist callback function */
144 void mpdclient_install_browse_callback(mpdclient_t *c, mpdc_list_cb_t cb);
146 /* remove a playlist callback function */
147 void mpdclient_remove_browse_callback(mpdclient_t *c, mpdc_list_cb_t cb);
150 /* issue a playlist callback */
151 void mpdclient_browse_callback(mpdclient_t *c, int event, gpointer data);
153 /* sort by list-format */
154 gint compare_filelistentry_format(gconstpointer filelist_entry1, gconstpointer filelist_entry2);
156 #endif