src/mpdclient.h

   1 #ifndef MPDCLIENT_H
   2 #define MPDCLIENT_H
   3
   4 #include "libmpdclient.h"
   5
   6 #include <glib.h>
   7
   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 )
  11
  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) )
  16
  17
  18
  19 /****************************************************************************/
  20 /* Playlist */
  21 /****************************************************************************/
  22
  23 typedef struct
  24 {
  25   /* playlist id */
  26   long long id;
  27   /* true if the list is updated */
  28   gboolean updated;
  29   /* the list */
  30   GArray *list;
  31
  32 } mpdclient_playlist_t;
  33
  34
  35 typedef struct
  36 {
  37   guint flags;
  38   mpd_InfoEntity *entity;
  39 } filelist_entry_t;
  40
  41 typedef struct
  42 {
  43   /* path */
  44   gchar *path;
  45   /* list length */
  46   guint length;
  47   /* true if the list is updated */
  48   gboolean updated;
  49   /* the list */
  50   GList *list;
  51
  52 } mpdclient_filelist_t;
  53
  54 typedef struct
  55 {
  56   /* playlist */
  57   mpdclient_playlist_t playlist;
  58
  59   /* Callbacks */
  60   GList *error_callbacks;
  61   GList *playlist_callbacks;
  62   GList *browse_callbacks;
  63
  64   mpd_Connection *connection;
  65   mpd_Status     *status;
  66   mpd_Song       *song;
  67
  68   gboolean       need_update;
  69
  70 } mpdclient_t;
  71
  72 /** functions ***************************************************************/
  73
  74 gint
  75 mpdclient_finish_command(mpdclient_t *c);
  76
  77 mpdclient_t *mpdclient_new(void);
  78 mpdclient_t *mpdclient_free(mpdclient_t *c);
  79 gint mpdclient_connect(mpdclient_t *c, gchar *host, gint port,
  80                        gfloat timeout, gchar *password);
  81 gint mpdclient_disconnect(mpdclient_t *c);
  82 gint mpdclient_update(mpdclient_t *c);
  83
  84
  85 /*** MPD Commands  **********************************************************/
  86 gint mpdclient_cmd_play(mpdclient_t *c, gint index);
  87 gint mpdclient_cmd_pause(mpdclient_t *c, gint value);
  88 gint mpdclient_cmd_stop(mpdclient_t *c);
  89 gint mpdclient_cmd_next(mpdclient_t *c);
  90 gint mpdclient_cmd_prev(mpdclient_t *c);
  91 gint mpdclient_cmd_seek(mpdclient_t *c, gint id, gint pos);
  92 gint mpdclient_cmd_shuffle(mpdclient_t *c);
  93 gint mpdclient_cmd_clear(mpdclient_t *c);
  94 gint mpdclient_cmd_repeat(mpdclient_t *c, gint value);
  95 gint mpdclient_cmd_random(mpdclient_t *c, gint value);
  96 gint mpdclient_cmd_crossfade(mpdclient_t *c, gint value);
  97 gint mpdclient_cmd_db_update_utf8(mpdclient_t *c, gchar *path);
  98 gint mpdclient_cmd_volume(mpdclient_t *c, gint value);
  99 gint mpdclient_cmd_add_path(mpdclient_t *c, gchar *path);
 100 gint mpdclient_cmd_add_path_utf8(mpdclient_t *c, gchar *path);
 101
 102 gint mpdclient_cmd_add(mpdclient_t *c, mpd_Song *song);
 103 gint mpdclient_cmd_delete(mpdclient_t *c, gint index);
 104 gint mpdclient_cmd_move(mpdclient_t *c, gint old_index, gint new_index);
 105
 106 gint mpdclient_cmd_save_playlist(mpdclient_t *c, gchar *filename);
 107 gint mpdclient_cmd_save_playlist_utf8(mpdclient_t *c, gchar *filename);
 108 gint mpdclient_cmd_load_playlist_utf8(mpdclient_t *c, gchar *filename_utf8);
 109 gint mpdclient_cmd_delete_playlist(mpdclient_t *c, gchar *filename);
 110 gint mpdclient_cmd_delete_playlist_utf8(mpdclient_t *c, gchar *filename_utf8);
 111
 112 /* list functions */
 113 GList *mpdclient_get_artists_utf8(mpdclient_t *c);
 114 GList *mpdclient_get_albums_utf8(mpdclient_t *c, gchar *artist_utf8);
 115
 116
 117 /*** error callbacks *****************************************************/
 118
 119 #define IS_ACK_ERROR(n)       (n & MPD_ERROR_ACK)
 120 #define GET_ACK_ERROR_CODE(n) ((n & 0xFF00) >> 8)
 121
 122 typedef void (*mpdc_error_cb_t) (mpdclient_t *c, gint error, const gchar *msg);
 123
 124 void mpdclient_install_error_callback(mpdclient_t *c, mpdc_error_cb_t cb);
 125 void mpdclient_remove_error_callback(mpdclient_t *c, mpdc_error_cb_t cb);
 126
 127 /*** playlist functions  **************************************************/
 128
 129 /* free a playlist */
 130 gint mpdclient_playlist_free(mpdclient_playlist_t *playlist);
 131 /* update the complete playlist */
 132 gint mpdclient_playlist_update(mpdclient_t *c);
 133 /* get playlist changes */
 134 gint mpdclient_playlist_update_changes(mpdclient_t *c);
 135
 136 mpd_Song *playlist_lookup_song(mpdclient_t *c, gint id);
 137 mpd_Song *playlist_get_song(mpdclient_t *c, gint index);
 138 gint playlist_get_index(mpdclient_t *c, mpd_Song *song);
 139 gint playlist_get_index_from_id(mpdclient_t *c, gint id);
 140 gint playlist_get_index_from_file(mpdclient_t *c, gchar *filename);
 141
 142
 143
 144 /*** mpdclient playlist callbacks *****************************************/
 145
 146 #define PLAYLIST_EVENT_UPDATED     0x01
 147 #define PLAYLIST_EVENT_CLEAR       0x02
 148 #define PLAYLIST_EVENT_DELETE      0x03
 149 #define PLAYLIST_EVENT_ADD         0x04
 150 #define PLAYLIST_EVENT_MOVE        0x05
 151
 152
 153 typedef void (*mpdc_list_cb_t) (mpdclient_t *c, int event, gpointer data);
 154
 155 /* install a playlist callback function */
 156 void mpdclient_install_playlist_callback(mpdclient_t *c, mpdc_list_cb_t cb);
 157
 158 /* remove a playlist callback function */
 159 void mpdclient_remove_playlist_callback(mpdclient_t *c, mpdc_list_cb_t cb);
 160
 161
 162 /* issue a playlist callback */
 163 void mpdclient_playlist_callback(mpdclient_t *c, int event, gpointer data);
 164
 165
 166 /*** filelist functions  ***************************************************/
 167 mpdclient_filelist_t *mpdclient_filelist_free(mpdclient_filelist_t *filelist);
 168 mpdclient_filelist_t *mpdclient_filelist_get(mpdclient_t *c, const gchar *path);
 169 mpdclient_filelist_t *mpdclient_filelist_search(mpdclient_t *c,
 170                                                 int exact_match,
 171                                                 int table,
 172                                                 gchar *path);
 173 mpdclient_filelist_t *mpdclient_filelist_search_utf8(mpdclient_t *c,
 174                                                      int exact_match,
 175                                                      int table,
 176                                                      gchar *path);
 177 mpdclient_filelist_t *mpdclient_filelist_update(mpdclient_t *c,
 178                                                 mpdclient_filelist_t *flist);
 179
 180 #define HIGHLIGHT  (0x01)
 181 void mpdclient_filelist_set_flags(mpdclient_filelist_t *flist,
 182                                   mpd_Song *song,
 183                                   guint flags);
 184
 185 void mpdclient_filelist_clear_flags(mpdclient_filelist_t *flist);
 186 void mpdclient_filelist_clear_flags(mpdclient_filelist_t *flist);
 187 filelist_entry_t *mpdclient_filelist_find_song(mpdclient_filelist_t *flist,
 188                                                mpd_Song *song);
 189
 190 /* add all songs in filelist to the playlist */
 191 int mpdclient_filelist_add_all(mpdclient_t *c, mpdclient_filelist_t *fl);
 192
 193 /*** mpdclient browse callbacks ********************************************/
 194
 195 #define BROWSE_DB_UPDATED          0x01
 196 #define BROWSE_PLAYLIST_SAVED      0x02
 197 #define BROWSE_PLAYLIST_DELETED    0x03
 198
 199
 200 /* install a playlist callback function */
 201 void mpdclient_install_browse_callback(mpdclient_t *c, mpdc_list_cb_t cb);
 202
 203 /* remove a playlist callback function */
 204 void mpdclient_remove_browse_callback(mpdclient_t *c, mpdc_list_cb_t cb);
 205
 206
 207 /* issue a playlist callback */
 208 void mpdclient_browse_callback(mpdclient_t *c, int event, gpointer data);
 209
 210 /* sort by list-format */
 211 gint compare_filelistentry_format(gconstpointer filelist_entry1, gconstpointer filelist_entry2);
 212
 213 #endif