chiark - git - mdw - disorder/blob - lib/eclient.h

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2006 Richard Kettlewell
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  18  * USA
  19  */
  20 /** @file lib/eclient.h
  21  * @brief Client code for event-driven programs
  22  */
  23
  24 #ifndef ECLIENT_H
  25 #define ECLIENT_H
  26
  27 /* Asynchronous client interface */
  28
  29 /** @brief Handle type */
  30 typedef struct disorder_eclient disorder_eclient;
  31
  32 struct queue_entry;
  33
  34 /** @brief Set to read from the FD */
  35 #define DISORDER_POLL_READ 1u
  36
  37 /** @brief Set to write to the FD */
  38 #define DISORDER_POLL_WRITE 2u
  39
  40 /** @brief Callbacks for all clients
  41  *
  42  * These must all be valid.
  43  */
  44 typedef struct disorder_eclient_callbacks {
  45   /** @brief Called when a communication error (e.g. connected refused) occurs.
  46    * @param u from disorder_eclient_new()
  47    * @param msg error message
  48    */
  49   void (*comms_error)(void *u, const char *msg);
  50
  51   /** @brief Called when a command fails (including initial authorization).
  52    * @param u from disorder_eclient_new()
  53    * @param v from failed command, or NULL if during setup
  54    * @param msg error message
  55    */
  56   void (*protocol_error)(void *u, void *v, int code, const char *msg);
  57
  58   /** @brief Set poll/select flags
  59    * @param u from disorder_eclient_new()
  60    * @param c handle
  61    * @param fd file descriptor
  62    * @param mode bitmap (@ref DISORDER_POLL_READ and/or @ref DISORDER_POLL_WRITE)
  63    *
  64    * Before @p fd is closed you will always get a call with @p mode = 0.
  65    */
  66   void (*poll)(void *u, disorder_eclient *c, int fd, unsigned mode);
  67
  68   /** @brief Report current activity
  69    * @param u from disorder_eclient_new()
  70    * @param msg Current activity or NULL
  71    *
  72    * Called with @p msg = NULL when there's nothing going on.
  73    */
  74   void (*report)(void *u, const char *msg);
  75 } disorder_eclient_callbacks;
  76
  77 /** @brief Callbacks for log clients
  78  *
  79  * All of these are allowed to be a null pointers in which case you don't get
  80  * told about that log event.
  81  *
  82  * See disorder_protocol(5) for full documentation.
  83  */
  84 typedef struct disorder_eclient_log_callbacks {
  85   /** @brief Called on (re-)connection */
  86   void (*connected)(void *v);
  87
  88   void (*completed)(void *v, const char *track);
  89   void (*failed)(void *v, const char *track, const char *status);
  90   void (*moved)(void *v, const char *user);
  91   void (*playing)(void *v, const char *track, const char *user/*maybe 0*/);
  92   void (*queue)(void *v, struct queue_entry *q);
  93   void (*recent_added)(void *v, struct queue_entry *q);
  94   void (*recent_removed)(void *v, const char *id);
  95   void (*removed)(void *v, const char *id, const char *user/*maybe 0*/);
  96   void (*scratched)(void *v, const char *track, const char *user);
  97   void (*state)(void *v, unsigned long state);
  98   void (*volume)(void *v, int left, int right);
  99 } disorder_eclient_log_callbacks;
 100
 101 /* State bits */
 102
 103 /** @brief Play is enabled */
 104 #define DISORDER_PLAYING_ENABLED  0x00000001
 105
 106 /** @brief Random play is enabled */
 107 #define DISORDER_RANDOM_ENABLED   0x00000002
 108
 109 /** @brief Track is paused
 110  *
 111  * This is only meaningful if @ref DISORDER_PLAYING is set
 112  */
 113 #define DISORDER_TRACK_PAUSED     0x00000004
 114
 115 /** @brief Track is playing
 116  *
 117  * This can be set even if the current track is paused (in which case @ref
 118  * DISORDER_TRACK_PAUSED) will also be set.
 119  */
 120 #define DISORDER_PLAYING    0x00000008
 121
 122 /** @brief Connected to server
 123  *
 124  * By connected it is meant that commands have a reasonable chance of being
 125  * processed soon, not merely that a TCP connection exists - for instance if
 126  * the client is still authenticating then that does not count as connected.
 127  */
 128 #define DISORDER_CONNECTED        0x00000010
 129
 130 char *disorder_eclient_interpret_state(unsigned long statebits);
 131
 132 struct queue_entry;
 133 struct kvp;
 134 struct sink;
 135
 136 /* Completion callbacks.  These provide the result of operations to the caller.
 137  * It is always allowed for these to be null pointers if you don't care about
 138  * the result. */
 139
 140 typedef void disorder_eclient_no_response(void *v);
 141 /* completion callback with no data */
 142
 143 typedef void disorder_eclient_string_response(void *v, const char *value);
 144 /* completion callback with a string result */
 145
 146 typedef void disorder_eclient_integer_response(void *v, long value);
 147 /* completion callback with a integer result */
 148
 149 typedef void disorder_eclient_volume_response(void *v, int l, int r);
 150 /* completion callback with a pair of integer results */
 151
 152 typedef void disorder_eclient_queue_response(void *v, struct queue_entry *q);
 153 /* completion callback for queue/recent listing */
 154
 155 typedef void disorder_eclient_list_response(void *v, int nvec, char **vec);
 156 /* completion callback for file listing etc */
 157
 158 disorder_eclient *disorder_eclient_new(const disorder_eclient_callbacks *cb,
 159                                        void *u);
 160 /* Create a new client */
 161
 162 void disorder_eclient_close(disorder_eclient *c);
 163 /* Close C */
 164
 165 unsigned long disorder_eclient_state(const disorder_eclient *c);
 166
 167 void disorder_eclient_polled(disorder_eclient *c, unsigned mode);
 168 /* Should be called when c's FD is readable and/or writable, and in any case
 169  * from time to time (so that retries work). */
 170
 171 int disorder_eclient_version(disorder_eclient *c,
 172                              disorder_eclient_string_response *completed,
 173                              void *v);
 174 /* fetch the server version */
 175
 176 int disorder_eclient_play(disorder_eclient *c,
 177                           const char *track,
 178                           disorder_eclient_no_response *completed,
 179                           void *v);
 180 /* add a track to the queue */
 181
 182 int disorder_eclient_pause(disorder_eclient *c,
 183                            disorder_eclient_no_response *completed,
 184                            void *v);
 185 /* add a track to the queue */
 186
 187 int disorder_eclient_resume(disorder_eclient *c,
 188                             disorder_eclient_no_response *completed,
 189                             void *v);
 190 /* add a track to the queue */
 191
 192 int disorder_eclient_scratch(disorder_eclient *c,
 193                              const char *id,
 194                              disorder_eclient_no_response *completed,
 195                              void *v);
 196 /* scratch a track by ID */
 197
 198 int disorder_eclient_scratch_playing(disorder_eclient *c,
 199                                      disorder_eclient_no_response *completed,
 200                                      void *v);
 201 /* scratch the playing track whatever it is */
 202
 203 int disorder_eclient_remove(disorder_eclient *c,
 204                             const char *id,
 205                             disorder_eclient_no_response *completed,
 206                             void *v);
 207 /* remove a track from the queue */
 208
 209 int disorder_eclient_moveafter(disorder_eclient *c,
 210                                const char *target,
 211                                int nids,
 212                                const char **ids,
 213                                disorder_eclient_no_response *completed,
 214                                void *v);
 215 /* move tracks within the queue */
 216
 217 int disorder_eclient_playing(disorder_eclient *c,
 218                              disorder_eclient_queue_response *completed,
 219                              void *v);
 220 /* find the currently playing track (0 for none) */
 221
 222 int disorder_eclient_queue(disorder_eclient *c,
 223                            disorder_eclient_queue_response *completed,
 224                            void *v);
 225 /* list recently played tracks */
 226
 227 int disorder_eclient_recent(disorder_eclient *c,
 228                             disorder_eclient_queue_response *completed,
 229                             void *v);
 230 /* list recently played tracks */
 231
 232 int disorder_eclient_files(disorder_eclient *c,
 233                            disorder_eclient_list_response *completed,
 234                            const char *dir,
 235                            const char *re,
 236                            void *v);
 237 /* list files in a directory, matching RE if not a null pointer */
 238
 239 int disorder_eclient_dirs(disorder_eclient *c,
 240                           disorder_eclient_list_response *completed,
 241                           const char *dir,
 242                           const char *re,
 243                           void *v);
 244 /* list directories in a directory, matching RE if not a null pointer */
 245
 246 int disorder_eclient_namepart(disorder_eclient *c,
 247                               disorder_eclient_string_response *completed,
 248                               const char *track,
 249                               const char *context,
 250                               const char *part,
 251                               void *v);
 252 /* look up a track name part */
 253
 254 int disorder_eclient_length(disorder_eclient *c,
 255                             disorder_eclient_integer_response *completed,
 256                             const char *track,
 257                             void *v);
 258 /* look up a track name length */
 259
 260 int disorder_eclient_volume(disorder_eclient *c,
 261                             disorder_eclient_volume_response *callback,
 262                             int l, int r,
 263                             void *v);
 264 /* If L and R are both -ve gets the volume.
 265  * If neither are -ve then sets the volume.
 266  * Otherwise asserts!
 267  */
 268
 269 int disorder_eclient_enable(disorder_eclient *c,
 270                             disorder_eclient_no_response *callback,
 271                             void *v);
 272 int disorder_eclient_disable(disorder_eclient *c,
 273                              disorder_eclient_no_response *callback,
 274                              void *v);
 275 int disorder_eclient_random_enable(disorder_eclient *c,
 276                                    disorder_eclient_no_response *callback,
 277                                    void *v);
 278 int disorder_eclient_random_disable(disorder_eclient *c,
 279                                     disorder_eclient_no_response *callback,
 280                                     void *v);
 281 /* Enable/disable play/random play */
 282
 283 int disorder_eclient_resolve(disorder_eclient *c,
 284                              disorder_eclient_string_response *completed,
 285                              const char *track,
 286                              void *v);
 287 /* Resolve aliases */
 288
 289 int disorder_eclient_log(disorder_eclient *c,
 290                          const disorder_eclient_log_callbacks *callbacks,
 291                          void *v);
 292 /* Make this a log client (forever - it automatically becomes one again upon
 293  * reconnection) */
 294
 295 int disorder_eclient_get(disorder_eclient *c,
 296                          disorder_eclient_string_response *completed,
 297                          const char *track, const char *pref,
 298                          void *v);
 299 int disorder_eclient_set(disorder_eclient *c,
 300                          disorder_eclient_no_response *completed,
 301                          const char *track, const char *pref,
 302                          const char *value,
 303                          void *v);
 304 int disorder_eclient_unset(disorder_eclient *c,
 305                            disorder_eclient_no_response *completed,
 306                            const char *track, const char *pref,
 307                            void *v);
 308 /* Get/set preference values */
 309
 310 int disorder_eclient_search(disorder_eclient *c,
 311                             disorder_eclient_list_response *completed,
 312                             const char *terms,
 313                             void *v);
 314
 315 int disorder_eclient_nop(disorder_eclient *c,
 316                          disorder_eclient_no_response *completed,
 317                          void *v);
 318
 319 #endif
 320
 321 /*
 322 Local Variables:
 323 c-basic-offset:2
 324 comment-column:40
 325 fill-column:79
 326 indent-tabs-mode:nil
 327 End:
 328 */