chiark / gitweb /
Memory management for hands-off reader
[disorder] / lib / client.h
1 /*
2  * This file is part of DisOrder.
3  * Copyright (C) 2004-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/client.h
19  * @brief Simple C client
20  *
21  * See @ref lib/eclient.h for an asynchronous-capable client
22  * implementation.
23  */
24
25 #ifndef CLIENT_H
26 #define CLIENT_H
27
28 #include <time.h>
29 #include "configuration.h"
30
31 /** @brief Client data */
32 typedef struct disorder_client disorder_client;
33
34 struct queue_entry;
35 struct kvp;
36 struct sink;
37
38 disorder_client *disorder_new(int verbose);
39 int disorder_connect(disorder_client *c);
40 int disorder_connect_user(disorder_client *c,
41                           const char *username,
42                           const char *password);
43 int disorder_connect_cookie(disorder_client *c, const char *cookie);
44 int disorder_connect_generic(struct config *conf,
45                              disorder_client *c,
46                              const char *username,
47                              const char *password,
48                              const char *cookie);
49 int disorder_close(disorder_client *c);
50 int disorder_version(disorder_client *c, char **versionp);
51 int disorder_play(disorder_client *c, const char *track);
52 int disorder_remove(disorder_client *c, const char *track);
53 int disorder_move(disorder_client *c, const char *track, int delta);
54 int disorder_enable(disorder_client *c);
55 int disorder_disable(disorder_client *c);
56 int disorder_scratch(disorder_client *c, const char *id);
57 int disorder_shutdown(disorder_client *c);
58 int disorder_reconfigure(disorder_client *c);
59 int disorder_rescan(disorder_client *c);
60 int disorder_playing(disorder_client *c, struct queue_entry **qp);
61 int disorder_recent(disorder_client *c, struct queue_entry **qp);
62 int disorder_queue(disorder_client *c, struct queue_entry **qp);
63 int disorder_directories(disorder_client *c, const char *dir, const char *re,
64                          char ***vecp, int *nvecp);
65 int disorder_files(disorder_client *c, const char *dir, const char *re,
66                    char ***vecp, int *nvecp);
67 int disorder_allfiles(disorder_client *c, const char *dir, const char *re,
68                       char ***vecp, int *nvecp);
69 char *disorder_user(disorder_client *c);
70 int disorder_exists(disorder_client *c, const char *track, int *existsp);
71 int disorder_enabled(disorder_client *c, int *enabledp);
72 int disorder_set(disorder_client *c, const char *track,
73                  const char *key, const char *value);
74 int disorder_unset(disorder_client *c, const char *track,
75                    const char *key);
76 int disorder_get(disorder_client *c, const char *track, const char *key,
77                  char **valuep);
78 int disorder_prefs(disorder_client *c, const char *track,
79                    struct kvp **kp);
80 int disorder_length(disorder_client *c, const char *track,
81                     long *valuep);
82 int disorder_search(disorder_client *c, const char *terms,
83                     char ***vecp, int *nvecp);
84 int disorder_random_enable(disorder_client *c);
85 int disorder_random_disable(disorder_client *c);
86 int disorder_random_enabled(disorder_client *c, int *enabledp);
87 int disorder_stats(disorder_client *c,
88                    char ***vecp, int *nvecp);
89 int disorder_set_volume(disorder_client *c, int left, int right);
90 int disorder_get_volume(disorder_client *c, int *left, int *right);
91 int disorder_log(disorder_client *c, struct sink *s);
92 int disorder_part(disorder_client *c, char **partp,
93                   const char *track, const char *context, const char *part);
94 int disorder_resolve(disorder_client *c, char **trackp, const char *track);
95 int disorder_pause(disorder_client *c);
96 int disorder_resume(disorder_client *c);
97 int disorder_tags(disorder_client *c,
98                    char ***vecp, int *nvecp);
99 int disorder_set_global(disorder_client *c,
100                         const char *key, const char *value);
101 int disorder_unset_global(disorder_client *c, const char *key);
102 int disorder_get_global(disorder_client *c, const char *key, char **valuep);
103 int disorder_new_tracks(disorder_client *c,
104                         char ***vecp, int *nvecp,
105                         int max);
106 int disorder_rtp_address(disorder_client *c, char **addressp, char **portp);
107 int disorder_adduser(disorder_client *c,
108                      const char *user, const char *password,
109                      const char *rights);
110 int disorder_deluser(disorder_client *c, const char *user);
111 int disorder_userinfo(disorder_client *c, const char *user, const char *key,
112                       char **valuep);
113 int disorder_edituser(disorder_client *c, const char *user,
114                       const char *key, const char *value);
115 int disorder_users(disorder_client *c,
116                    char ***vecp, int *nvecp);
117 int disorder_register(disorder_client *c, const char *user,
118                       const char *password, const char *email,
119                       char **confirmp);
120 int disorder_confirm(disorder_client *c, const char *confirm);
121 int disorder_make_cookie(disorder_client *c, char **cookiep);
122 const char *disorder_last(disorder_client *c);
123 int disorder_revoke(disorder_client *c);
124 int disorder_reminder(disorder_client *c, const char *user);
125 int disorder_schedule_list(disorder_client *c, char ***idsp, int *nidsp);
126 int disorder_schedule_del(disorder_client *c, const char *id);
127 int disorder_schedule_get(disorder_client *c, const char *id,
128                           struct kvp **actiondatap);
129 int disorder_schedule_add(disorder_client *c,
130                           time_t when,
131                           const char *priority,
132                           const char *action,
133                           ...);
134 int disorder_adopt(disorder_client *c, const char *id);
135 int disorder_playlist_delete(disorder_client *c,
136                              const char *playlist);
137 int disorder_playlist_get(disorder_client *c, const char *playlist,
138                           char ***tracksp, int *ntracksp);
139 int disorder_playlists(disorder_client *c,
140                        char ***playlistsp, int *nplaylists);
141 int disorder_playlist_get_share(disorder_client *c, const char *playlist,
142                                 char **sharep);
143 int disorder_playlist_set_share(disorder_client *c, const char *playlist,
144                                 const char *share);
145 int disorder_playlist_lock(disorder_client *c, const char *playlist);
146 int disorder_playlist_unlock(disorder_client *c);
147 int disorder_playlist_set(disorder_client *c,
148                           const char *playlist,
149                           char **tracks,
150                           int ntracks);
151
152 #endif /* CLIENT_H */
153
154 /*
155 Local Variables:
156 c-basic-offset:2
157 comment-column:40
158 End:
159 */