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