src/mpdclient.h

   1 #ifndef MPDCLIENT_H
   2 #define MPDCLIENT_H
   3 #include "libmpdclient.h"
   4
   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 )
   8
   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) )
  13
  14
  15
  16 /****************************************************************************/
  17 /* Playlist */
  18 /****************************************************************************/
  19
  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;
  30
  31 } mpdclient_playlist_t;
  32
  33
  34 typedef struct
  35 {
  36   guint flags;
  37   mpd_InfoEntity *entity;
  38 } filelist_entry_t;
  39
  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;
  50
  51 } mpdclient_filelist_t;
  52
  53 typedef struct
  54 {
  55   /* playlist */
  56   mpdclient_playlist_t playlist;
  57
  58   /* Callbacks */
  59   GList *error_callbacks;
  60   GList *playlist_callbacks;
  61   GList *browse_callbacks;
  62
  63   mpd_Connection *connection;
  64   mpd_Status     *status;
  65   mpd_Song       *song;
  66
  67   gboolean       need_update;
  68
  69 } mpdclient_t;
  70
  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);
  78
  79
  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);
  96
  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);
 100
 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);
 106
 107 /* list functions */
 108 GList *mpdclient_get_artists_utf8(mpdclient_t *c);
 109 GList *mpdclient_get_albums_utf8(mpdclient_t *c, gchar *artist_utf8);
 110
 111
 112 /*** error callbacks *****************************************************/
 113
 114 #define IS_ACK_ERROR(n)       (n & MPD_ERROR_ACK)
 115 #define GET_ACK_ERROR_CODE(n) ((n & 0xFF00) >> 8)
 116
 117 typedef void (*mpdc_error_cb_t) (mpdclient_t *c, gint error, gchar *msg);
 118
 119 void mpdclient_install_error_callback(mpdclient_t *c, mpdc_error_cb_t cb);
 120 void mpdclient_remove_error_callback(mpdclient_t *c, mpdc_error_cb_t cb);
 121
 122 /*** playlist functions  **************************************************/
 123
 124 /* free a playlist */
 125 gint mpdclient_playlist_free(mpdclient_playlist_t *playlist);
 126 /* update the complete playlist */
 127 gint mpdclient_playlist_update(mpdclient_t *c);
 128 /* get playlist changes */
 129 gint mpdclient_playlist_update_changes(mpdclient_t *c);
 130
 131 GList *playlist_lookup(mpdclient_t *c, gint id);
 132 mpd_Song *playlist_lookup_song(mpdclient_t *c, gint id);
 133 mpd_Song *playlist_get_song(mpdclient_t *c, gint index);
 134 gint playlist_get_index(mpdclient_t *c, mpd_Song *song);
 135 gint playlist_get_index_from_id(mpdclient_t *c, gint id);
 136 gint playlist_get_index_from_file(mpdclient_t *c, gchar *filename);
 137
 138
 139
 140 /*** mpdclient playlist callbacks *****************************************/
 141
 142 #define PLAYLIST_EVENT_UPDATED     0x01
 143 #define PLAYLIST_EVENT_CLEAR       0x02
 144 #define PLAYLIST_EVENT_DELETE      0x03
 145 #define PLAYLIST_EVENT_ADD         0x04
 146 #define PLAYLIST_EVENT_MOVE        0x05
 147
 148
 149 typedef void (*mpdc_list_cb_t) (mpdclient_t *c, int event, gpointer data);
 150
 151 /* install a playlist callback function */
 152 void mpdclient_install_playlist_callback(mpdclient_t *c, mpdc_list_cb_t cb);
 153
 154 /* remove a playlist callback function */
 155 void mpdclient_remove_playlist_callback(mpdclient_t *c, mpdc_list_cb_t cb);
 156
 157
 158 /* issue a playlist callback */
 159 void mpdclient_playlist_callback(mpdclient_t *c, int event, gpointer data);
 160
 161
 162 /*** filelist functions  ***************************************************/
 163 mpdclient_filelist_t *mpdclient_filelist_free(mpdclient_filelist_t *filelist);
 164 mpdclient_filelist_t *mpdclient_filelist_get(mpdclient_t *c, gchar *path);
 165 mpdclient_filelist_t *mpdclient_filelist_search(mpdclient_t *c,
 166                                                 int exact_match,
 167                                                 int table,
 168                                                 gchar *path);
 169 mpdclient_filelist_t *mpdclient_filelist_search_utf8(mpdclient_t *c,
 170                                                      int exact_match,
 171                                                      int table,
 172                                                      gchar *path);
 173 mpdclient_filelist_t *mpdclient_filelist_update(mpdclient_t *c,
 174                                                 mpdclient_filelist_t *flist);
 175
 176 #define HIGHLIGHT  (0x01)
 177 void mpdclient_filelist_set_flags(mpdclient_filelist_t *flist,
 178                                   mpd_Song *song,
 179                                   guint flags);
 180
 181 void mpdclient_filelist_clear_flags(mpdclient_filelist_t *flist);
 182 void mpdclient_filelist_clear_flags(mpdclient_filelist_t *flist);
 183 filelist_entry_t *mpdclient_filelist_find_song(mpdclient_filelist_t *flist,
 184                                                mpd_Song *song);
 185
 186 /* add all songs in filelist to the playlist */
 187 int mpdclient_filelist_add_all(mpdclient_t *c, mpdclient_filelist_t *fl);
 188
 189 /*** mpdclient browse callbacks ********************************************/
 190
 191 #define BROWSE_DB_UPDATED          0x01
 192 #define BROWSE_PLAYLIST_SAVED      0x02
 193 #define BROWSE_PLAYLIST_DELETED    0x03
 194
 195
 196 /* install a playlist callback function */
 197 void mpdclient_install_browse_callback(mpdclient_t *c, mpdc_list_cb_t cb);
 198
 199 /* remove a playlist callback function */
 200 void mpdclient_remove_browse_callback(mpdclient_t *c, mpdc_list_cb_t cb);
 201
 202
 203 /* issue a playlist callback */
 204 void mpdclient_browse_callback(mpdclient_t *c, int event, gpointer data);
 205
 206 /* sort by list-format */
 207 gint compare_filelistentry_format(gconstpointer filelist_entry1, gconstpointer filelist_entry2);
 208
 209 #endif