Code

Renamed mpd version macro
[ncmpc.git] / src / mpdclient.h
1 #ifndef MPDCLIENT_H
2 #define MPDCLIENT_H
3 #include "libmpdclient.h"
5 #define MPD_VERSION_EQ(c,x,y,z) (c->connection->version[0] == x && \
6                                  c->connection->version[1] == y && \
7                                  c->connection->version[2] == z )
9 #define MPD_VERSION_LT(c,x,y,z) ( c->connection->version[0]<x  || \
10  (c->connection->version[0]==x && c->connection->version[1]<y) || \
11  (c->connection->version[0]==x && c->connection->version[1]==y && \
12   c->connection->version[2]<z) )
16 /****************************************************************************/
17 /* Playlist */
18 /****************************************************************************/
20 typedef struct
21 {
22   /* playlist id */
23   long long id;
24   /* list length */
25   guint length;
26   /* true if the list is updated */
27   gboolean updated;
28   /* the list */
29   GList *list;
31 } mpdclient_playlist_t;
34 typedef struct
35 {
36   guint flags;
37   mpd_InfoEntity *entity;
38 } filelist_entry_t;
40 typedef struct
41 {
42   /* path */
43   gchar *path;
44   /* list length */
45   guint length;
46   /* true if the list is updated */
47   gboolean updated;
48   /* the list */
49   GList *list;
51 } mpdclient_filelist_t;
53 typedef struct
54 {
55   /* playlist */
56   mpdclient_playlist_t playlist;
58   /* Callbacks */
59   GList *error_callbacks;
60   GList *playlist_callbacks;
61   GList *browse_callbacks;
63   mpd_Connection *connection;
64   mpd_Status     *status;
65   mpd_Song       *song;
67   gboolean       need_update;
69 } mpdclient_t;
71 /** functions ***************************************************************/
72 mpdclient_t *mpdclient_new(void);
73 mpdclient_t *mpdclient_free(mpdclient_t *c);
74 gint mpdclient_connect(mpdclient_t *c, gchar *host, gint port,
75                        gfloat timeout, gchar *password);
76 gint mpdclient_disconnect(mpdclient_t *c);
77 gint mpdclient_update(mpdclient_t *c);
80 /*** MPD Commands  **********************************************************/
81 gint mpdclient_cmd_play(mpdclient_t *c, gint index);
82 gint mpdclient_cmd_pause(mpdclient_t *c, gint value);
83 gint mpdclient_cmd_stop(mpdclient_t *c);
84 gint mpdclient_cmd_next(mpdclient_t *c);
85 gint mpdclient_cmd_prev(mpdclient_t *c);
86 gint mpdclient_cmd_seek(mpdclient_t *c, gint id, gint pos);
87 gint mpdclient_cmd_shuffle(mpdclient_t *c);
88 gint mpdclient_cmd_clear(mpdclient_t *c);
89 gint mpdclient_cmd_repeat(mpdclient_t *c, gint value);
90 gint mpdclient_cmd_random(mpdclient_t *c, gint value);
91 gint mpdclient_cmd_crossfade(mpdclient_t *c, gint value);
92 gint mpdclient_cmd_db_update_utf8(mpdclient_t *c, gchar *path);
93 gint mpdclient_cmd_volume(mpdclient_t *c, gint value);
94 gint mpdclient_cmd_add_path(mpdclient_t *c, gchar *path);
95 gint mpdclient_cmd_add_path_utf8(mpdclient_t *c, gchar *path);
97 gint mpdclient_cmd_add(mpdclient_t *c, mpd_Song *song);
98 gint mpdclient_cmd_delete(mpdclient_t *c, gint index);
99 gint mpdclient_cmd_move(mpdclient_t *c, gint old_index, gint new_index);
101 gint mpdclient_cmd_save_playlist(mpdclient_t *c, gchar *filename);
102 gint mpdclient_cmd_save_playlist_utf8(mpdclient_t *c, gchar *filename);
103 gint mpdclient_cmd_load_playlist_utf8(mpdclient_t *c, gchar *filename_utf8);
104 gint mpdclient_cmd_delete_playlist(mpdclient_t *c, gchar *filename);
105 gint mpdclient_cmd_delete_playlist_utf8(mpdclient_t *c, gchar *filename_utf8);
108 /*** error callbacks *****************************************************/ 
110 #define IS_ACK_ERROR(n)       (n & MPD_ERROR_ACK)
111 #define GET_ACK_ERROR_CODE(n) ((n & 0xFF00) >> 8)
113 typedef void (*mpdc_error_cb_t) (mpdclient_t *c, gint error, gchar *msg);
115 void mpdclient_install_error_callback(mpdclient_t *c, mpdc_error_cb_t cb);
116 void mpdclient_remove_error_callback(mpdclient_t *c, mpdc_error_cb_t cb);
118 /*** playlist functions  **************************************************/
120 /* free a playlist */
121 gint mpdclient_playlist_free(mpdclient_playlist_t *playlist);
122 /* update the complete playlist */
123 gint mpdclient_playlist_update(mpdclient_t *c);
124 /* get playlist changes */
125 gint mpdclient_playlist_update_changes(mpdclient_t *c);
127 GList *playlist_lookup(mpdclient_t *c, gint id);
128 mpd_Song *playlist_lookup_song(mpdclient_t *c, gint id);
129 mpd_Song *playlist_get_song(mpdclient_t *c, gint index);
130 gint playlist_get_index(mpdclient_t *c, mpd_Song *song);
131 gint playlist_get_index_from_id(mpdclient_t *c, gint id);
132 gint playlist_get_index_from_file(mpdclient_t *c, gchar *filename);
136 /*** mpdclient playlist callbacks *****************************************/
138 #define PLAYLIST_EVENT_UPDATED     0x01
139 #define PLAYLIST_EVENT_CLEAR       0x02
140 #define PLAYLIST_EVENT_DELETE      0x03
141 #define PLAYLIST_EVENT_ADD         0x04
142 #define PLAYLIST_EVENT_MOVE        0x05
145 typedef void (*mpdc_list_cb_t) (mpdclient_t *c, int event, gpointer data);
147 /* install a playlist callback function */
148 void mpdclient_install_playlist_callback(mpdclient_t *c, mpdc_list_cb_t cb);
150 /* remove a playlist callback function */
151 void mpdclient_remove_playlist_callback(mpdclient_t *c, mpdc_list_cb_t cb);
154 /* issue a playlist callback */
155 void mpdclient_playlist_callback(mpdclient_t *c, int event, gpointer data);
158 /*** filelist functions  ***************************************************/
159 mpdclient_filelist_t *mpdclient_filelist_free(mpdclient_filelist_t *filelist);
160 mpdclient_filelist_t *mpdclient_filelist_get(mpdclient_t *c, gchar *path);
161 mpdclient_filelist_t *mpdclient_filelist_update(mpdclient_t *c, 
162                                                 mpdclient_filelist_t *flist);
164 #define HIGHLIGHT  (0x01)
165 void mpdclient_filelist_set_flags(mpdclient_filelist_t *flist, 
166                                   mpd_Song *song,
167                                   guint flags);
169 void mpdclient_filelist_clear_flags(mpdclient_filelist_t *flist);
170 void mpdclient_filelist_clear_flags(mpdclient_filelist_t *flist);
171 filelist_entry_t *mpdclient_filelist_find_song(mpdclient_filelist_t *flist,
172                                                mpd_Song *song);
174 /*** mpdclient browse callbacks ********************************************/
176 #define BROWSE_DB_UPDATED          0x01
177 #define BROWSE_PLAYLIST_SAVED      0x02
178 #define BROWSE_PLAYLIST_DELETED    0x03
181 /* install a playlist callback function */
182 void mpdclient_install_browse_callback(mpdclient_t *c, mpdc_list_cb_t cb);
184 /* remove a playlist callback function */
185 void mpdclient_remove_browse_callback(mpdclient_t *c, mpdc_list_cb_t cb);
188 /* issue a playlist callback */
189 void mpdclient_browse_callback(mpdclient_t *c, int event, gpointer data);
192 #endif