| 1 | /* |
| 2 | * This file is part of DisOrder. |
| 3 | * Copyright (C) 2006-2008 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 3 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, |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | * GNU 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, see <http://www.gnu.org/licenses/>. |
| 17 | */ |
| 18 | /** @file lib/eclient.h |
| 19 | * @brief Client code for event-driven programs |
| 20 | */ |
| 21 | |
| 22 | #ifndef ECLIENT_H |
| 23 | #define ECLIENT_H |
| 24 | |
| 25 | #include "rights.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 occurs. |
| 46 | * @param u from disorder_eclient_new() |
| 47 | * @param msg error message |
| 48 | * |
| 49 | * This might be called at any time, and indicates a low-level error, |
| 50 | * e.g. connection refused by the server. It does not mean that any requests |
| 51 | * made of the owning eclient will not be fulfilled at some point. |
| 52 | */ |
| 53 | void (*comms_error)(void *u, const char *msg); |
| 54 | |
| 55 | /** @brief Called when a command fails (including initial authorization). |
| 56 | * @param u from disorder_eclient_new() |
| 57 | * @param v from failed command, or NULL if during setup |
| 58 | * @param msg error message |
| 59 | * |
| 60 | * This call is obsolete at least in its current form, in which it is used to |
| 61 | * report most errors from most requests. Ultimately requests-specific |
| 62 | * errors will be reported in a request-specific way rather than via this |
| 63 | * generic callback. |
| 64 | */ |
| 65 | void (*protocol_error)(void *u, void *v, int code, const char *msg); |
| 66 | |
| 67 | /** @brief Set poll/select flags |
| 68 | * @param u from disorder_eclient_new() |
| 69 | * @param c handle |
| 70 | * @param fd file descriptor |
| 71 | * @param mode bitmap (@ref DISORDER_POLL_READ and/or @ref DISORDER_POLL_WRITE) |
| 72 | * |
| 73 | * Before @p fd is closed you will always get a call with @p mode = 0. |
| 74 | */ |
| 75 | void (*poll)(void *u, disorder_eclient *c, int fd, unsigned mode); |
| 76 | |
| 77 | /** @brief Report current activity |
| 78 | * @param u from disorder_eclient_new() |
| 79 | * @param msg Current activity or NULL |
| 80 | * |
| 81 | * Called with @p msg = NULL when there's nothing going on. |
| 82 | */ |
| 83 | void (*report)(void *u, const char *msg); |
| 84 | } disorder_eclient_callbacks; |
| 85 | |
| 86 | /** @brief Callbacks for log clients |
| 87 | * |
| 88 | * All of these are allowed to be a null pointers in which case you don't get |
| 89 | * told about that log event. |
| 90 | * |
| 91 | * See disorder_protocol(5) for full documentation. |
| 92 | */ |
| 93 | typedef struct disorder_eclient_log_callbacks { |
| 94 | /** @brief Called on (re-)connection */ |
| 95 | void (*connected)(void *v); |
| 96 | |
| 97 | /** @brief Called when @p track finished playing successfully */ |
| 98 | void (*completed)(void *v, const char *track); |
| 99 | |
| 100 | /** @brief Called when @p track fails for some reason */ |
| 101 | void (*failed)(void *v, const char *track, const char *status); |
| 102 | |
| 103 | /** @brief Called when @p user moves some track or tracks in the queue |
| 104 | * |
| 105 | * Fetch the queue again to find out what the new order is - the |
| 106 | * rearrangement could in principle be arbitrarily complicated. |
| 107 | */ |
| 108 | void (*moved)(void *v, const char *user); |
| 109 | |
| 110 | /** @brief Called when @p track starts playing |
| 111 | * |
| 112 | * @p user might be 0. |
| 113 | */ |
| 114 | void (*playing)(void *v, const char *track, const char *user/*maybe 0*/); |
| 115 | |
| 116 | /** @brief Called when @p q is added to the queue |
| 117 | * |
| 118 | * Fetch the queue again to find out where the in the queue it was added. |
| 119 | */ |
| 120 | void (*queue)(void *v, struct queue_entry *q); |
| 121 | |
| 122 | /** @brief Called when @p q is added to the recent list */ |
| 123 | void (*recent_added)(void *v, struct queue_entry *q); |
| 124 | |
| 125 | /** @brief Called when @p id is removed from the recent list */ |
| 126 | void (*recent_removed)(void *v, const char *id); |
| 127 | |
| 128 | /** @brief Called when @p id is removed from the queue |
| 129 | * |
| 130 | * @p user might be 0. |
| 131 | */ |
| 132 | void (*removed)(void *v, const char *id, const char *user/*maybe 0*/); |
| 133 | |
| 134 | /** @brief Called when @p track is scratched */ |
| 135 | void (*scratched)(void *v, const char *track, const char *user); |
| 136 | |
| 137 | /** @brief Called with the current state whenever it changes |
| 138 | * |
| 139 | * State bits are: |
| 140 | * - @ref DISORDER_PLAYING_ENABLED |
| 141 | * - @ref DISORDER_RANDOM_ENABLED |
| 142 | * - @ref DISORDER_TRACK_PAUSED |
| 143 | * - @ref DISORDER_PLAYING |
| 144 | * - @ref DISORDER_CONNECTED |
| 145 | */ |
| 146 | void (*state)(void *v, unsigned long state); |
| 147 | |
| 148 | /** @brief Called when the volume changes */ |
| 149 | void (*volume)(void *v, int left, int right); |
| 150 | |
| 151 | /** @brief Called when a rescan completes */ |
| 152 | void (*rescanned)(void *v); |
| 153 | |
| 154 | /** @brief Called when a user is created (admins only) */ |
| 155 | void (*user_add)(void *v, const char *user); |
| 156 | |
| 157 | /** @brief Called when a user is confirmed (admins only) */ |
| 158 | void (*user_confirm)(void *v, const char *user); |
| 159 | |
| 160 | /** @brief Called when a user is deleted (admins only) */ |
| 161 | void (*user_delete)(void *v, const char *user); |
| 162 | |
| 163 | /** @brief Called when a user is edited (admins only) */ |
| 164 | void (*user_edit)(void *v, const char *user, const char *property); |
| 165 | |
| 166 | /** @brief Called when your rights change */ |
| 167 | void (*rights_changed)(void *v, rights_type new_rights); |
| 168 | |
| 169 | /** @brief Called when a track is adopted */ |
| 170 | void (*adopted)(void *v, const char *id, const char *who); |
| 171 | |
| 172 | /** @brief Called when a new playlist is created */ |
| 173 | void (*playlist_created)(void *v, const char *playlist, const char *sharing); |
| 174 | |
| 175 | /** @brief Called when a playlist is modified */ |
| 176 | void (*playlist_modified)(void *v, const char *playlist, const char *sharing); |
| 177 | |
| 178 | /** @brief Called when a new playlist is deleted */ |
| 179 | void (*playlist_deleted)(void *v, const char *playlist); |
| 180 | } disorder_eclient_log_callbacks; |
| 181 | |
| 182 | /* State bits */ |
| 183 | |
| 184 | /** @brief Play is enabled */ |
| 185 | #define DISORDER_PLAYING_ENABLED 0x00000001 |
| 186 | |
| 187 | /** @brief Random play is enabled */ |
| 188 | #define DISORDER_RANDOM_ENABLED 0x00000002 |
| 189 | |
| 190 | /** @brief Track is paused |
| 191 | * |
| 192 | * This is only meaningful if @ref DISORDER_PLAYING is set |
| 193 | */ |
| 194 | #define DISORDER_TRACK_PAUSED 0x00000004 |
| 195 | |
| 196 | /** @brief Track is playing |
| 197 | * |
| 198 | * This can be set even if the current track is paused (in which case @ref |
| 199 | * DISORDER_TRACK_PAUSED) will also be set. |
| 200 | */ |
| 201 | #define DISORDER_PLAYING 0x00000008 |
| 202 | |
| 203 | /** @brief Connected to server |
| 204 | * |
| 205 | * By connected it is meant that commands have a reasonable chance of being |
| 206 | * processed soon, not merely that a TCP connection exists - for instance if |
| 207 | * the client is still authenticating then that does not count as connected. |
| 208 | */ |
| 209 | #define DISORDER_CONNECTED 0x00000010 |
| 210 | |
| 211 | char *disorder_eclient_interpret_state(unsigned long statebits); |
| 212 | |
| 213 | struct queue_entry; |
| 214 | struct kvp; |
| 215 | struct sink; |
| 216 | |
| 217 | /* Completion callbacks. These provide the result of operations to the caller. |
| 218 | * Unlike in earlier releases, these are not allowed to be NULL. */ |
| 219 | |
| 220 | /** @brief Trivial completion callback |
| 221 | * @param v User data |
| 222 | * @param err Error string or NULL on succes |
| 223 | */ |
| 224 | typedef void disorder_eclient_no_response(void *v, |
| 225 | const char *err); |
| 226 | |
| 227 | /** @brief String result completion callback |
| 228 | * @param v User data |
| 229 | * @param err Error string or NULL on succes |
| 230 | * @param value Result or NULL |
| 231 | * |
| 232 | * @p error will be NULL on success. In this case @p value will be the result |
| 233 | * (which might be NULL for disorder_eclient_get(), |
| 234 | * disorder_eclient_get_global(), disorder_eclient_userinfo() and |
| 235 | * disorder_eclient_playlist_get_share()). |
| 236 | * |
| 237 | * @p error will be non-NULL on failure. In this case @p value is always NULL. |
| 238 | */ |
| 239 | typedef void disorder_eclient_string_response(void *v, |
| 240 | const char *err, |
| 241 | const char *value); |
| 242 | |
| 243 | /** @brief String result completion callback |
| 244 | * @param v User data |
| 245 | * @param err Error string or NULL on succes |
| 246 | * @param value Result or 0 |
| 247 | * |
| 248 | * @p error will be NULL on success. In this case @p value will be the result. |
| 249 | * |
| 250 | * @p error will be non-NULL on failure. In this case @p value is always 0. |
| 251 | */ |
| 252 | typedef void disorder_eclient_integer_response(void *v, |
| 253 | const char *err, |
| 254 | long value); |
| 255 | /** @brief Volume completion callback |
| 256 | * @param v User data |
| 257 | * @param err Error string or NULL on success |
| 258 | * @param l Left channel volume |
| 259 | * @param r Right channel volume |
| 260 | * |
| 261 | * @p error will be NULL on success. In this case @p l and @p r will be the |
| 262 | * result. |
| 263 | * |
| 264 | * @p error will be non-NULL on failure. In this case @p l and @p r are always |
| 265 | * 0. |
| 266 | */ |
| 267 | typedef void disorder_eclient_volume_response(void *v, |
| 268 | const char *err, |
| 269 | int l, int r); |
| 270 | |
| 271 | /** @brief Queue request completion callback |
| 272 | * @param v User data |
| 273 | * @param err Error string or NULL on success |
| 274 | * @param q Head of queue data list |
| 275 | * |
| 276 | * @p error will be NULL on success. In this case @p q will be the (head of |
| 277 | * the) result. |
| 278 | * |
| 279 | * @p error will be non-NULL on failure. In this case @p q may be NULL but |
| 280 | * MIGHT also be some subset of the queue. For consistent behavior it should |
| 281 | * be ignored in the error case. |
| 282 | */ |
| 283 | typedef void disorder_eclient_queue_response(void *v, |
| 284 | const char *err, |
| 285 | struct queue_entry *q); |
| 286 | |
| 287 | /** @brief List request completion callback |
| 288 | * @param v User data |
| 289 | * @param err Error string or NULL on success |
| 290 | * @param nvec Number of elements in response list |
| 291 | * @param vec Pointer to response list |
| 292 | * |
| 293 | * @p error will be NULL on success. In this case @p nvec and @p vec will give |
| 294 | * the result, or be -1 and NULL respectively e.g. from |
| 295 | * disorder_eclient_playlist_get() if there is no such playlist. |
| 296 | * |
| 297 | * @p error will be non-NULL on failure. In this case @p nvec and @p vec will |
| 298 | * be 0 and NULL. |
| 299 | */ |
| 300 | typedef void disorder_eclient_list_response(void *v, |
| 301 | const char *err, |
| 302 | int nvec, char **vec); |
| 303 | |
| 304 | disorder_eclient *disorder_eclient_new(const disorder_eclient_callbacks *cb, |
| 305 | void *u); |
| 306 | /* Create a new client */ |
| 307 | |
| 308 | void disorder_eclient_close(disorder_eclient *c); |
| 309 | /* Close C */ |
| 310 | |
| 311 | unsigned long disorder_eclient_state(const disorder_eclient *c); |
| 312 | |
| 313 | void disorder_eclient_polled(disorder_eclient *c, unsigned mode); |
| 314 | /* Should be called when c's FD is readable and/or writable, and in any case |
| 315 | * from time to time (so that retries work). */ |
| 316 | |
| 317 | int disorder_eclient_version(disorder_eclient *c, |
| 318 | disorder_eclient_string_response *completed, |
| 319 | void *v); |
| 320 | /* fetch the server version */ |
| 321 | |
| 322 | int disorder_eclient_play(disorder_eclient *c, |
| 323 | const char *track, |
| 324 | disorder_eclient_no_response *completed, |
| 325 | void *v); |
| 326 | /* add a track to the queue */ |
| 327 | |
| 328 | int disorder_eclient_playafter(disorder_eclient *c, |
| 329 | const char *target, |
| 330 | int ntracks, |
| 331 | const char **tracks, |
| 332 | disorder_eclient_no_response *completed, |
| 333 | void *v); |
| 334 | /* insert multiple tracks to an arbitrary point in the queue */ |
| 335 | |
| 336 | int disorder_eclient_pause(disorder_eclient *c, |
| 337 | disorder_eclient_no_response *completed, |
| 338 | void *v); |
| 339 | /* add a track to the queue */ |
| 340 | |
| 341 | int disorder_eclient_resume(disorder_eclient *c, |
| 342 | disorder_eclient_no_response *completed, |
| 343 | void *v); |
| 344 | /* add a track to the queue */ |
| 345 | |
| 346 | int disorder_eclient_scratch(disorder_eclient *c, |
| 347 | const char *id, |
| 348 | disorder_eclient_no_response *completed, |
| 349 | void *v); |
| 350 | /* scratch a track by ID */ |
| 351 | |
| 352 | int disorder_eclient_scratch_playing(disorder_eclient *c, |
| 353 | disorder_eclient_no_response *completed, |
| 354 | void *v); |
| 355 | /* scratch the playing track whatever it is */ |
| 356 | |
| 357 | int disorder_eclient_remove(disorder_eclient *c, |
| 358 | const char *id, |
| 359 | disorder_eclient_no_response *completed, |
| 360 | void *v); |
| 361 | /* remove a track from the queue */ |
| 362 | |
| 363 | int disorder_eclient_moveafter(disorder_eclient *c, |
| 364 | const char *target, |
| 365 | int nids, |
| 366 | const char **ids, |
| 367 | disorder_eclient_no_response *completed, |
| 368 | void *v); |
| 369 | /* move tracks within the queue */ |
| 370 | |
| 371 | int disorder_eclient_playing(disorder_eclient *c, |
| 372 | disorder_eclient_queue_response *completed, |
| 373 | void *v); |
| 374 | /* find the currently playing track (0 for none) */ |
| 375 | |
| 376 | int disorder_eclient_queue(disorder_eclient *c, |
| 377 | disorder_eclient_queue_response *completed, |
| 378 | void *v); |
| 379 | /* list recently played tracks */ |
| 380 | |
| 381 | int disorder_eclient_recent(disorder_eclient *c, |
| 382 | disorder_eclient_queue_response *completed, |
| 383 | void *v); |
| 384 | /* list recently played tracks */ |
| 385 | |
| 386 | int disorder_eclient_files(disorder_eclient *c, |
| 387 | disorder_eclient_list_response *completed, |
| 388 | const char *dir, |
| 389 | const char *re, |
| 390 | void *v); |
| 391 | /* list files in a directory, matching RE if not a null pointer */ |
| 392 | |
| 393 | int disorder_eclient_dirs(disorder_eclient *c, |
| 394 | disorder_eclient_list_response *completed, |
| 395 | const char *dir, |
| 396 | const char *re, |
| 397 | void *v); |
| 398 | /* list directories in a directory, matching RE if not a null pointer */ |
| 399 | |
| 400 | int disorder_eclient_namepart(disorder_eclient *c, |
| 401 | disorder_eclient_string_response *completed, |
| 402 | const char *track, |
| 403 | const char *context, |
| 404 | const char *part, |
| 405 | void *v); |
| 406 | /* look up a track name part */ |
| 407 | |
| 408 | int disorder_eclient_length(disorder_eclient *c, |
| 409 | disorder_eclient_integer_response *completed, |
| 410 | const char *track, |
| 411 | void *v); |
| 412 | /* look up a track name length */ |
| 413 | |
| 414 | int disorder_eclient_volume(disorder_eclient *c, |
| 415 | disorder_eclient_volume_response *callback, |
| 416 | int l, int r, |
| 417 | void *v); |
| 418 | /* If L and R are both -ve gets the volume. |
| 419 | * If neither are -ve then sets the volume. |
| 420 | * Otherwise asserts! |
| 421 | */ |
| 422 | |
| 423 | int disorder_eclient_enable(disorder_eclient *c, |
| 424 | disorder_eclient_no_response *callback, |
| 425 | void *v); |
| 426 | int disorder_eclient_disable(disorder_eclient *c, |
| 427 | disorder_eclient_no_response *callback, |
| 428 | void *v); |
| 429 | int disorder_eclient_random_enable(disorder_eclient *c, |
| 430 | disorder_eclient_no_response *callback, |
| 431 | void *v); |
| 432 | int disorder_eclient_random_disable(disorder_eclient *c, |
| 433 | disorder_eclient_no_response *callback, |
| 434 | void *v); |
| 435 | /* Enable/disable play/random play */ |
| 436 | |
| 437 | int disorder_eclient_resolve(disorder_eclient *c, |
| 438 | disorder_eclient_string_response *completed, |
| 439 | const char *track, |
| 440 | void *v); |
| 441 | /* Resolve aliases */ |
| 442 | |
| 443 | int disorder_eclient_log(disorder_eclient *c, |
| 444 | const disorder_eclient_log_callbacks *callbacks, |
| 445 | void *v); |
| 446 | /* Make this a log client (forever - it automatically becomes one again upon |
| 447 | * reconnection) */ |
| 448 | |
| 449 | int disorder_eclient_get(disorder_eclient *c, |
| 450 | disorder_eclient_string_response *completed, |
| 451 | const char *track, const char *pref, |
| 452 | void *v); |
| 453 | int disorder_eclient_set(disorder_eclient *c, |
| 454 | disorder_eclient_no_response *completed, |
| 455 | const char *track, const char *pref, |
| 456 | const char *value, |
| 457 | void *v); |
| 458 | int disorder_eclient_unset(disorder_eclient *c, |
| 459 | disorder_eclient_no_response *completed, |
| 460 | const char *track, const char *pref, |
| 461 | void *v); |
| 462 | /* Get/set preference values */ |
| 463 | |
| 464 | int disorder_eclient_search(disorder_eclient *c, |
| 465 | disorder_eclient_list_response *completed, |
| 466 | const char *terms, |
| 467 | void *v); |
| 468 | |
| 469 | int disorder_eclient_nop(disorder_eclient *c, |
| 470 | disorder_eclient_no_response *completed, |
| 471 | void *v); |
| 472 | |
| 473 | int disorder_eclient_new_tracks(disorder_eclient *c, |
| 474 | disorder_eclient_list_response *completed, |
| 475 | int max, |
| 476 | void *v); |
| 477 | |
| 478 | int disorder_eclient_rtp_address(disorder_eclient *c, |
| 479 | disorder_eclient_list_response *completed, |
| 480 | void *v); |
| 481 | |
| 482 | int disorder_eclient_users(disorder_eclient *c, |
| 483 | disorder_eclient_list_response *completed, |
| 484 | void *v); |
| 485 | int disorder_eclient_deluser(disorder_eclient *c, |
| 486 | disorder_eclient_no_response *completed, |
| 487 | const char *user, |
| 488 | void *v); |
| 489 | int disorder_eclient_userinfo(disorder_eclient *c, |
| 490 | disorder_eclient_string_response *completed, |
| 491 | const char *user, |
| 492 | const char *property, |
| 493 | void *v); |
| 494 | int disorder_eclient_edituser(disorder_eclient *c, |
| 495 | disorder_eclient_no_response *completed, |
| 496 | const char *user, |
| 497 | const char *property, |
| 498 | const char *value, |
| 499 | void *v); |
| 500 | int disorder_eclient_adduser(disorder_eclient *c, |
| 501 | disorder_eclient_no_response *completed, |
| 502 | const char *user, |
| 503 | const char *password, |
| 504 | const char *rights, |
| 505 | void *v); |
| 506 | void disorder_eclient_enable_connect(disorder_eclient *c); |
| 507 | void disorder_eclient_disable_connect(disorder_eclient *c); |
| 508 | int disorder_eclient_adopt(disorder_eclient *c, |
| 509 | disorder_eclient_no_response *completed, |
| 510 | const char *id, |
| 511 | void *v); |
| 512 | int disorder_eclient_playlists(disorder_eclient *c, |
| 513 | disorder_eclient_list_response *completed, |
| 514 | void *v); |
| 515 | int disorder_eclient_playlist_delete(disorder_eclient *c, |
| 516 | disorder_eclient_no_response *completed, |
| 517 | const char *playlist, |
| 518 | void *v); |
| 519 | int disorder_eclient_playlist_lock(disorder_eclient *c, |
| 520 | disorder_eclient_no_response *completed, |
| 521 | const char *playlist, |
| 522 | void *v); |
| 523 | int disorder_eclient_playlist_unlock(disorder_eclient *c, |
| 524 | disorder_eclient_no_response *completed, |
| 525 | void *v); |
| 526 | int disorder_eclient_playlist_set_share(disorder_eclient *c, |
| 527 | disorder_eclient_no_response *completed, |
| 528 | const char *playlist, |
| 529 | const char *sharing, |
| 530 | void *v); |
| 531 | int disorder_eclient_playlist_get_share(disorder_eclient *c, |
| 532 | disorder_eclient_string_response *completed, |
| 533 | const char *playlist, |
| 534 | void *v); |
| 535 | int disorder_eclient_playlist_set(disorder_eclient *c, |
| 536 | disorder_eclient_no_response *completed, |
| 537 | const char *playlist, |
| 538 | char **tracks, |
| 539 | int ntracks, |
| 540 | void *v); |
| 541 | int disorder_eclient_playlist_get(disorder_eclient *c, |
| 542 | disorder_eclient_list_response *completed, |
| 543 | const char *playlist, |
| 544 | void *v); |
| 545 | |
| 546 | #endif |
| 547 | |
| 548 | /* |
| 549 | Local Variables: |
| 550 | c-basic-offset:2 |
| 551 | comment-column:40 |
| 552 | fill-column:79 |
| 553 | indent-tabs-mode:nil |
| 554 | End: |
| 555 | */ |