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 2 of the License, or
8 * (at your option) any later version.
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.
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
21 #ifndef DISORDER_SERVER_H
22 #define DISORDER_SERVER_H
34 #include <netinet/in.h>
39 #include <sys/socket.h>
42 #include <sys/types.h>
53 #include "configuration.h"
62 #include "inputline.h"
75 #include "speaker-protocol.h"
79 #include "trackdb-int.h"
81 #include "trackname.h"
88 void daemonize(const char *tag, int fac, const char *pidfile);
89 /* Go into background. Send stdout/stderr to syslog.
90 * If @pri@ is non-null, it should be "facility.level"
91 * If @tag@ is non-null, it is used as a tag to each message
92 * If @pidfile@ is non-null, the PID is written to that file.
95 void quit(ev_source *ev) attribute((noreturn));
96 /* terminate the daemon */
98 int reconfigure(ev_source *ev, int reload);
99 /* reconfigure. If @reload@ is nonzero, update the configuration. */
101 extern struct queue_entry qhead;
102 /* queue of things yet to be played. the head will be played
105 extern struct queue_entry phead;
106 /* things that have been played in the past. the head is the oldest. */
110 void queue_read(void);
111 /* read the queue in. Calls @fatal@ on error. */
113 void queue_write(void);
114 /* write the queue out. Calls @fatal@ on error. */
116 void recent_read(void);
117 /* read the recently played list in. Calls @fatal@ on error. */
119 void recent_write(void);
120 /* write the recently played list out. Calls @fatal@ on error. */
122 struct queue_entry *queue_add(const char *track, const char *submitter,
124 #define WHERE_START 0 /* Add to head of queue */
125 #define WHERE_END 1 /* Add to end of queue */
126 #define WHERE_BEFORE_RANDOM 2 /* End, or before random track */
127 /* add an entry to the queue. Return a pointer to the new entry. */
129 void queue_remove(struct queue_entry *q, const char *who);
130 /* remove an from the queue */
132 struct queue_entry *queue_find(const char *key);
133 /* find a track in the queue by name or ID */
135 void queue_played(struct queue_entry *q);
136 /* add @q@ to the played list */
138 int queue_move(struct queue_entry *q, int delta, const char *who);
139 /* move element @q@ in the queue towards the front (@delta@ > 0) or towards the
140 * back (@delta@ < 0). The return value is the leftover delta once we've hit
141 * the end in whichever direction we were going. */
143 void queue_moveafter(struct queue_entry *target,
144 int nqs, struct queue_entry **qs, const char *who);
145 /* Move all the elements QS to just after TARGET, or to the head if
148 void queue_fix_sofar(struct queue_entry *q);
149 /* Fix up the sofar field for standalone players */
151 void schedule_init(ev_source *ev);
152 const char *schedule_add(ev_source *ev,
153 struct kvp *actiondata);
154 int schedule_del(const char *id);
155 struct kvp *schedule_get(const char *id);
156 char **schedule_list(int *neventsp);
158 extern struct queue_entry *playing; /* playing track or 0 */
159 extern int paused; /* non-0 if paused */
161 void play(ev_source *ev);
162 /* try to play something, if playing is enabled and nothing is playing
165 int playing_is_enabled(void);
166 /* return true iff playing is enabled */
168 void enable_playing(const char *who, ev_source *ev);
171 void disable_playing(const char *who);
172 /* disable playing. */
174 int random_is_enabled(void);
175 /* return true iff random play is enabled */
177 void enable_random(const char *who, ev_source *ev);
178 /* enable random play */
180 void disable_random(const char *who);
181 /* disable random play */
183 void scratch(const char *who, const char *id);
184 /* scratch the playing track. @who@ identifies the scratcher. @id@ is
185 * the ID or a null pointer. */
187 void quitting(ev_source *ev);
188 /* called to terminate current track and shut down speaker process
191 void speaker_setup(ev_source *ev);
192 /* set up the speaker subprocess */
194 void speaker_reload(void);
195 /* Tell the speaker process to reload its configuration. */
197 int pause_playing(const char *who);
198 /* Pause the current track. Return 0 on success, -1 on error. WHO
201 void resume_playing(const char *who);
202 /* Resume after a pause. WHO can be 0. */
204 int prepare(ev_source *ev,
205 struct queue_entry *q);
206 /* Prepare to play Q */
208 void abandon(ev_source *ev,
209 struct queue_entry *q);
210 /* Abandon a possibly-prepared track. */
212 void add_random_track(ev_source *ev);
213 /* If random play is enabled then try to add a track to the queue. */
215 int server_start(ev_source *ev, int pf,
216 size_t socklen, const struct sockaddr *sa,
218 /* start listening. Return the fd. */
220 int server_stop(ev_source *ev, int fd);
221 /* Stop listening on @fd@ */
223 extern int volume_left, volume_right; /* last known volume */
225 extern int wideopen; /* blindly accept all logins */
231 typedef void *plugin_handle;
232 typedef void function_t(void);
234 const struct plugin *open_plugin(const char *name,
236 #define PLUGIN_FATAL 0x0001 /* fatal() on error */
237 /* Open a plugin. Returns a null pointer on error or a handle to it
240 function_t *get_plugin_function(const struct plugin *handle,
242 const void *get_plugin_object(const struct plugin *handle,
244 /* Look up a function or an object in a plugin */
246 /* track length computation ***************************************************/
248 long tracklength(const char *plugin, const char *track, const char *path);
250 /* collection interface *******************************************************/
252 void scan(const char *module, const char *root);
253 /* write a list of path names below @root@ to standard output. */
255 int check(const char *module, const char *root, const char *path);
256 /* Recheck a track, given its root and path name. Return 1 if it
257 * exists, 0 if it does not exist and -1 if an error occurred. */
259 /* notification interface *****************************************************/
261 void notify_play(const char *track,
262 const char *submitter);
263 /* we're going to play @track@. It was submitted by @submitter@
264 * (might be a null pointer) */
266 void notify_scratch(const char *track,
267 const char *submitter,
268 const char *scratcher,
270 /* @scratcher@ scratched @track@ after @seconds@. It was submitted by
271 * @submitter@ (might be a null pointer) */
273 void notify_not_scratched(const char *track,
274 const char *submitter);
275 /* @track@ (submitted by @submitter@, which might be a null pointer)
276 * was not scratched. */
278 void notify_queue(const char *track,
279 const char *submitter);
280 /* @track@ was queued by @submitter@ */
282 void notify_queue_remove(const char *track,
283 const char *remover);
284 /* @track@ removed from the queue by @remover@ (never a null pointer) */
286 void notify_queue_move(const char *track,
288 /* @track@ moved in the queue by @mover@ (never a null pointer) */
290 void notify_pause(const char *track,
292 /* TRACK was paused by PAUSER (might be a null pointer) */
294 void notify_resume(const char *track,
295 const char *resumer);
296 /* TRACK was resumed by PAUSER (might be a null pointer) */
298 /* track playing **************************************************************/
300 unsigned long play_get_type(const struct plugin *pl);
301 /* Get the type word for this plugin */
303 void *play_prefork(const struct plugin *pl,
305 /* Call the prefork function for PL and return the user data */
307 void play_track(const struct plugin *pl,
308 const char *const *parameters,
312 /* play a track. Called inside a fork. */
314 void play_cleanup(const struct plugin *pl, void *data);
315 /* Call the cleanup function for PL if necessary */
317 int play_pause(const struct plugin *pl, long *playedp, void *data);
320 void play_resume(const struct plugin *pl, void *data);
323 #endif /* DISORDER_SERVER_H */