Code

git-svn-id: https://svn.musicpd.org/ncmpc/trunk@1497 09075e82-0dd4-0310-85a5-a0d7c8717e4f
[ncmpc.git] / src / mpdclient.h
1 #ifndef MPDCLIENT_H
2 #define MPDCLIENT_H
3 #include "libmpdclient.h"
5 #define MPD_VERSION(c,x,y,z) (c->connection->version[0]*10000+c->connection->version[1]*100+c->connection->version[2] >= \
6                               x*10000+y*100+z)
8 /****************************************************************************/
9 /* Playlist */
10 /****************************************************************************/
12 typedef struct
13 {
14   /* playlist id */
15   long long id;
16   /* list length */
17   guint length;
18   /* true if the list is updated */
19   gboolean updated;
20   /* the list */
21   GList *list;
23 } mpdclient_playlist_t;
26 typedef struct
27 {
28   guint flags;
29   mpd_InfoEntity *entity;
30 } filelist_entry_t;
32 typedef struct
33 {
34   /* path */
35   gchar *path;
36   /* list length */
37   guint length;
38   /* true if the list is updated */
39   gboolean updated;
40   /* the list */
41   GList *list;
43 } mpdclient_filelist_t;
45 typedef struct
46 {
47   /* playlist */
48   mpdclient_playlist_t playlist;
50   /* Callbacks */
51   GList *error_callbacks;
52   GList *playlist_callbacks;
53   GList *browse_callbacks;
55   mpd_Connection *connection;
56   mpd_Status     *status;
57   mpd_Song       *song;
59   gboolean       need_update;
61 } mpdclient_t;
63 /** functions ***************************************************************/
64 mpdclient_t *mpdclient_new(void);
65 mpdclient_t *mpdclient_free(mpdclient_t *c);
66 gint mpdclient_connect(mpdclient_t *c, gchar *host, gint port,
67                        gfloat timeout, gchar *password);
68 gint mpdclient_disconnect(mpdclient_t *c);
69 gint mpdclient_update(mpdclient_t *c);
72 /*** MPD Commands  **********************************************************/
73 gint mpdclient_cmd_play(mpdclient_t *c, gint index);
74 gint mpdclient_cmd_pause(mpdclient_t *c, gint value);
75 gint mpdclient_cmd_stop(mpdclient_t *c);
76 gint mpdclient_cmd_next(mpdclient_t *c);
77 gint mpdclient_cmd_prev(mpdclient_t *c);
78 gint mpdclient_cmd_seek(mpdclient_t *c, gint id, gint pos);
79 gint mpdclient_cmd_shuffle(mpdclient_t *c);
80 gint mpdclient_cmd_clear(mpdclient_t *c);
81 gint mpdclient_cmd_repeat(mpdclient_t *c, gint value);
82 gint mpdclient_cmd_random(mpdclient_t *c, gint value);
83 gint mpdclient_cmd_crossfade(mpdclient_t *c, gint value);
84 gint mpdclient_cmd_db_update(mpdclient_t *c);
85 gint mpdclient_cmd_volume(mpdclient_t *c, gint value);
87 gint mpdclient_cmd_add(mpdclient_t *c, mpd_Song *song);
88 gint mpdclient_cmd_delete(mpdclient_t *c, gint index);
89 gint mpdclient_cmd_move(mpdclient_t *c, gint old_index, gint new_index);
91 gint mpdclient_cmd_save_playlist(mpdclient_t *c, gchar *filename);
92 gint mpdclient_cmd_load_playlist(mpdclient_t *c, gchar *filename_utf8);
93 gint mpdclient_cmd_delete_playlist(mpdclient_t *c, gchar *filename_utf8);
96 /*** error callbacks *****************************************************/ 
98 #define IS_ACK_ERROR(n)       (n & MPD_ERROR_ACK)
99 #define GET_ACK_ERROR_CODE(n) ((n & 0xFF00) >> 8)
101 typedef void (*mpdc_error_cb_t) (mpdclient_t *c, gint error, gchar *msg);
103 void mpdclient_install_error_callback(mpdclient_t *c, mpdc_error_cb_t cb);
104 void mpdclient_remove_error_callback(mpdclient_t *c, mpdc_error_cb_t cb);
106 /*** playlist functions  **************************************************/
108 /* free a playlist */
109 gint mpdclient_playlist_free(mpdclient_playlist_t *playlist);
110 /* update the complete playlist */
111 gint mpdclient_playlist_update(mpdclient_t *c);
112 /* get playlist changes */
113 gint mpdclient_playlist_update_changes(mpdclient_t *c);
115 GList *playlist_lookup(mpdclient_t *c, gint id);
116 mpd_Song *playlist_lookup_song(mpdclient_t *c, gint id);
117 mpd_Song *playlist_get_song(mpdclient_t *c, gint index);
118 gint playlist_get_index(mpdclient_t *c, mpd_Song *song);
119 gint playlist_get_index_from_id(mpdclient_t *c, gint id);
120 gint playlist_get_index_from_file(mpdclient_t *c, gchar *filename);
124 /*** mpdclient playlist callbacks *****************************************/
126 #define PLAYLIST_EVENT_UPDATED     0x01
127 #define PLAYLIST_EVENT_CLEAR       0x02
128 #define PLAYLIST_EVENT_DELETE      0x03
129 #define PLAYLIST_EVENT_ADD         0x04
130 #define PLAYLIST_EVENT_MOVE        0x05
133 typedef void (*mpdc_list_cb_t) (mpdclient_t *c, int event, gpointer data);
135 /* install a playlist callback function */
136 void mpdclient_install_playlist_callback(mpdclient_t *c, mpdc_list_cb_t cb);
138 /* remove a playlist callback function */
139 void mpdclient_remove_playlist_callback(mpdclient_t *c, mpdc_list_cb_t cb);
142 /* issue a playlist callback */
143 void mpdclient_playlist_callback(mpdclient_t *c, int event, gpointer data);
146 /*** filelist functions  ***************************************************/
147 mpdclient_filelist_t *mpdclient_filelist_free(mpdclient_filelist_t *filelist);
148 mpdclient_filelist_t *mpdclient_filelist_get(mpdclient_t *c, gchar *path);
149 mpdclient_filelist_t *mpdclient_filelist_update(mpdclient_t *c, 
150                                                 mpdclient_filelist_t *flist);
152 #define HIGHLIGHT  (0x01)
153 void mpdclient_filelist_set_flags(mpdclient_filelist_t *flist, 
154                                   mpd_Song *song,
155                                   guint flags);
157 void mpdclient_filelist_clear_flags(mpdclient_filelist_t *flist);
158 void mpdclient_filelist_clear_flags(mpdclient_filelist_t *flist);
159 filelist_entry_t *mpdclient_filelist_find_song(mpdclient_filelist_t *flist,
160                                                mpd_Song *song);
162 /*** mpdclient browse callbacks ********************************************/
164 #define BROWSE_DB_UPDATED          0x01
165 #define BROWSE_PLAYLIST_SAVED      0x02
166 #define BROWSE_PLAYLIST_DELETED    0x03
169 /* install a playlist callback function */
170 void mpdclient_install_browse_callback(mpdclient_t *c, mpdc_list_cb_t cb);
172 /* remove a playlist callback function */
173 void mpdclient_remove_browse_callback(mpdclient_t *c, mpdc_list_cb_t cb);
176 /* issue a playlist callback */
177 void mpdclient_browse_callback(mpdclient_t *c, int event, gpointer data);
180 #endif