2 * This file is part of DisOrder
3 * Copyright (C) 2008 Richard Kettlewell
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.
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.
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/>.
19 #ifndef DISORDER_SERVER_H
20 #define DISORDER_SERVER_H
32 #include <netinet/in.h>
37 #include <sys/socket.h>
40 #include <sys/types.h>
51 #include "configuration.h"
60 #include "inputline.h"
73 #include "speaker-protocol.h"
77 #include "trackdb-int.h"
79 #include "trackname.h"
86 void daemonize(const char *tag, int fac, const char *pidfile);
87 /* Go into background. Send stdout/stderr to syslog.
88 * If @pri@ is non-null, it should be "facility.level"
89 * If @tag@ is non-null, it is used as a tag to each message
90 * If @pidfile@ is non-null, the PID is written to that file.
93 void quit(ev_source *ev) attribute((noreturn));
94 /* terminate the daemon */
96 int reconfigure(ev_source *ev, int reload);
97 /* reconfigure. If @reload@ is nonzero, update the configuration. */
99 extern struct queue_entry qhead;
100 /* queue of things yet to be played. the head will be played
103 extern struct queue_entry phead;
104 /* things that have been played in the past. the head is the oldest. */
108 void queue_read(void);
109 /* read the queue in. Calls @fatal@ on error. */
111 void queue_write(void);
112 /* write the queue out. Calls @fatal@ on error. */
114 void recent_read(void);
115 /* read the recently played list in. Calls @fatal@ on error. */
117 void recent_write(void);
118 /* write the recently played list out. Calls @fatal@ on error. */
120 struct queue_entry *queue_add(const char *track, const char *submitter,
122 #define WHERE_START 0 /* Add to head of queue */
123 #define WHERE_END 1 /* Add to end of queue */
124 #define WHERE_BEFORE_RANDOM 2 /* End, or before random track */
125 /* add an entry to the queue. Return a pointer to the new entry. */
127 void queue_remove(struct queue_entry *q, const char *who);
128 /* remove an from the queue */
130 struct queue_entry *queue_find(const char *key);
131 /* find a track in the queue by name or ID */
133 void queue_played(struct queue_entry *q);
134 /* add @q@ to the played list */
136 int queue_move(struct queue_entry *q, int delta, const char *who);
137 /* move element @q@ in the queue towards the front (@delta@ > 0) or towards the
138 * back (@delta@ < 0). The return value is the leftover delta once we've hit
139 * the end in whichever direction we were going. */
141 void queue_moveafter(struct queue_entry *target,
142 int nqs, struct queue_entry **qs, const char *who);
143 /* Move all the elements QS to just after TARGET, or to the head if
146 void queue_fix_sofar(struct queue_entry *q);
147 /* Fix up the sofar field for standalone players */
149 void schedule_init(ev_source *ev);
150 const char *schedule_add(ev_source *ev,
151 struct kvp *actiondata);
152 int schedule_del(const char *id);
153 struct kvp *schedule_get(const char *id);
154 char **schedule_list(int *neventsp);
156 extern struct queue_entry *playing; /* playing track or 0 */
157 extern int paused; /* non-0 if paused */
159 void play(ev_source *ev);
160 /* try to play something, if playing is enabled and nothing is playing
163 int playing_is_enabled(void);
164 /* return true iff playing is enabled */
166 void enable_playing(const char *who, ev_source *ev);
169 void disable_playing(const char *who);
170 /* disable playing. */
172 int random_is_enabled(void);
173 /* return true iff random play is enabled */
175 void enable_random(const char *who, ev_source *ev);
176 /* enable random play */
178 void disable_random(const char *who);
179 /* disable random play */
181 void scratch(const char *who, const char *id);
182 /* scratch the playing track. @who@ identifies the scratcher. @id@ is
183 * the ID or a null pointer. */
185 void quitting(ev_source *ev);
186 /* called to terminate current track and shut down speaker process
189 void speaker_setup(ev_source *ev);
190 /* set up the speaker subprocess */
192 void speaker_reload(void);
193 /* Tell the speaker process to reload its configuration. */
195 int pause_playing(const char *who);
196 /* Pause the current track. Return 0 on success, -1 on error. WHO
199 void resume_playing(const char *who);
200 /* Resume after a pause. WHO can be 0. */
202 int prepare(ev_source *ev,
203 struct queue_entry *q);
204 /* Prepare to play Q */
206 void abandon(ev_source *ev,
207 struct queue_entry *q);
208 /* Abandon a possibly-prepared track. */
210 void add_random_track(ev_source *ev);
211 /* If random play is enabled then try to add a track to the queue. */
213 int server_start(ev_source *ev, int pf,
214 size_t socklen, const struct sockaddr *sa,
216 /* start listening. Return the fd. */
218 int server_stop(ev_source *ev, int fd);
219 /* Stop listening on @fd@ */
221 extern int volume_left, volume_right; /* last known volume */
223 extern int wideopen; /* blindly accept all logins */
229 typedef void *plugin_handle;
230 typedef void function_t(void);
232 const struct plugin *open_plugin(const char *name,
234 #define PLUGIN_FATAL 0x0001 /* fatal() on error */
235 /* Open a plugin. Returns a null pointer on error or a handle to it
238 function_t *get_plugin_function(const struct plugin *handle,
240 const void *get_plugin_object(const struct plugin *handle,
242 /* Look up a function or an object in a plugin */
244 /* track length computation ***************************************************/
246 long tracklength(const char *plugin, const char *track, const char *path);
248 /* collection interface *******************************************************/
250 void scan(const char *module, const char *root);
251 /* write a list of path names below @root@ to standard output. */
253 int check(const char *module, const char *root, const char *path);
254 /* Recheck a track, given its root and path name. Return 1 if it
255 * exists, 0 if it does not exist and -1 if an error occurred. */
257 /* notification interface *****************************************************/
259 void notify_play(const char *track,
260 const char *submitter);
261 /* we're going to play @track@. It was submitted by @submitter@
262 * (might be a null pointer) */
264 void notify_scratch(const char *track,
265 const char *submitter,
266 const char *scratcher,
268 /* @scratcher@ scratched @track@ after @seconds@. It was submitted by
269 * @submitter@ (might be a null pointer) */
271 void notify_not_scratched(const char *track,
272 const char *submitter);
273 /* @track@ (submitted by @submitter@, which might be a null pointer)
274 * was not scratched. */
276 void notify_queue(const char *track,
277 const char *submitter);
278 /* @track@ was queued by @submitter@ */
280 void notify_queue_remove(const char *track,
281 const char *remover);
282 /* @track@ removed from the queue by @remover@ (never a null pointer) */
284 void notify_queue_move(const char *track,
286 /* @track@ moved in the queue by @mover@ (never a null pointer) */
288 void notify_pause(const char *track,
290 /* TRACK was paused by PAUSER (might be a null pointer) */
292 void notify_resume(const char *track,
293 const char *resumer);
294 /* TRACK was resumed by PAUSER (might be a null pointer) */
296 /* track playing **************************************************************/
298 unsigned long play_get_type(const struct plugin *pl);
299 /* Get the type word for this plugin */
301 void *play_prefork(const struct plugin *pl,
303 /* Call the prefork function for PL and return the user data */
305 void play_track(const struct plugin *pl,
306 const char *const *parameters,
310 /* play a track. Called inside a fork. */
312 void play_cleanup(const struct plugin *pl, void *data);
313 /* Call the cleanup function for PL if necessary */
315 int play_pause(const struct plugin *pl, long *playedp, void *data);
318 void play_resume(const struct plugin *pl, void *data);
321 #endif /* DISORDER_SERVER_H */