2 * This file is part of DisOrder
3 * Copyright (C) 2008, 2009 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/>.
18 /** @file server/disorder-server.h
19 * @brief Definitions for server and allied utilities
22 #ifndef DISORDER_SERVER_H
23 #define DISORDER_SERVER_H
35 #include <netinet/in.h>
40 #include <sys/socket.h>
43 #include <sys/types.h>
45 #include <sys/resource.h>
55 #include "configuration.h"
64 #include "inputline.h"
76 #include "speaker-protocol.h"
80 #include "trackdb-int.h"
82 #include "trackname.h"
90 extern const struct uaudio *api;
92 void daemonize(const char *tag, int fac, const char *pidfile);
93 /* Go into background. Send stdout/stderr to syslog.
94 * If @pri@ is non-null, it should be "facility.level"
95 * If @tag@ is non-null, it is used as a tag to each message
96 * If @pidfile@ is non-null, the PID is written to that file.
99 void quit(ev_source *ev) attribute((noreturn));
100 /* terminate the daemon */
102 int reconfigure(ev_source *ev, unsigned flags);
105 void reset_sockets(ev_source *ev);
107 /** @brief Set when starting server */
108 #define RECONFIGURE_FIRST 0x0001
110 /** @brief Set when reloading after SIGHUP etc */
111 #define RECONFIGURE_RELOADING 0x0002
113 void dbparams_check(void);
115 extern struct queue_entry qhead;
116 /* queue of things yet to be played. the head will be played
119 extern struct queue_entry phead;
120 /* things that have been played in the past. the head is the oldest. */
124 void queue_read(void);
125 /* read the queue in. Calls @fatal@ on error. */
127 void queue_write(void);
128 /* write the queue out. Calls @fatal@ on error. */
130 void recent_read(void);
131 /* read the recently played list in. Calls @fatal@ on error. */
133 void recent_write(void);
134 /* write the recently played list out. Calls @fatal@ on error. */
136 struct queue_entry *queue_add(const char *track, const char *submitter,
137 int where, enum track_origin origin);
138 #define WHERE_START 0 /* Add to head of queue */
139 #define WHERE_END 1 /* Add to end of queue */
140 #define WHERE_BEFORE_RANDOM 2 /* End, or before random track */
141 /* add an entry to the queue. Return a pointer to the new entry. */
143 void queue_remove(struct queue_entry *q, const char *who);
144 /* remove an from the queue */
146 struct queue_entry *queue_find(const char *key);
147 /* find a track in the queue by name or ID */
149 void queue_played(struct queue_entry *q);
150 /* add @q@ to the played list */
152 int queue_move(struct queue_entry *q, int delta, const char *who);
153 /* move element @q@ in the queue towards the front (@delta@ > 0) or towards the
154 * back (@delta@ < 0). The return value is the leftover delta once we've hit
155 * the end in whichever direction we were going. */
157 void queue_moveafter(struct queue_entry *target,
158 int nqs, struct queue_entry **qs, const char *who);
159 /* Move all the elements QS to just after TARGET, or to the head if
162 void queue_fix_sofar(struct queue_entry *q);
163 /* Fix up the sofar field for standalone players */
165 void schedule_init(ev_source *ev);
166 const char *schedule_add(ev_source *ev,
167 struct kvp *actiondata);
168 int schedule_del(const char *id);
169 struct kvp *schedule_get(const char *id);
170 char **schedule_list(int *neventsp);
172 extern struct queue_entry *playing; /* playing track or 0 */
173 extern int paused; /* non-0 if paused */
175 void play(ev_source *ev);
176 /* try to play something, if playing is enabled and nothing is playing
179 int playing_is_enabled(void);
180 /* return true iff playing is enabled */
182 void enable_playing(const char *who, ev_source *ev);
185 void disable_playing(const char *who);
186 /* disable playing. */
188 int random_is_enabled(void);
189 /* return true iff random play is enabled */
191 void enable_random(const char *who, ev_source *ev);
192 /* enable random play */
194 void disable_random(const char *who);
195 /* disable random play */
197 void scratch(const char *who, const char *id);
198 /* scratch the playing track. @who@ identifies the scratcher. @id@ is
199 * the ID or a null pointer. */
201 void quitting(ev_source *ev);
202 /* called to terminate current track and shut down speaker process
205 void speaker_setup(ev_source *ev);
206 /* set up the speaker subprocess */
208 void speaker_reload(void);
209 /* Tell the speaker process to reload its configuration. */
211 int pause_playing(const char *who);
212 /* Pause the current track. Return 0 on success, -1 on error. WHO
215 void resume_playing(const char *who);
216 /* Resume after a pause. WHO can be 0. */
218 int prepare(ev_source *ev,
219 struct queue_entry *q);
220 /* Prepare to play Q */
222 void abandon(ev_source *ev,
223 struct queue_entry *q);
224 /* Abandon a possibly-prepared track. */
226 void add_random_track(ev_source *ev);
227 /* If random play is enabled then try to add a track to the queue. */
229 int server_start(ev_source *ev, int pf,
230 size_t socklen, const struct sockaddr *sa,
232 /* start listening. Return the fd. */
234 int server_stop(ev_source *ev, int fd);
235 /* Stop listening on @fd@ */
237 extern int volume_left, volume_right; /* last known volume */
239 extern int wideopen; /* blindly accept all logins */
245 typedef void *plugin_handle;
246 typedef void function_t(void);
248 const struct plugin *open_plugin(const char *name,
250 #define PLUGIN_FATAL 0x0001 /* fatal() on error */
251 /* Open a plugin. Returns a null pointer on error or a handle to it
254 function_t *get_plugin_function(const struct plugin *handle,
256 const void *get_plugin_object(const struct plugin *handle,
258 /* Look up a function or an object in a plugin */
260 /* track length computation ***************************************************/
262 long tracklength(const char *plugin, const char *track, const char *path);
264 /* collection interface *******************************************************/
266 void scan(const char *module, const char *root);
267 /* write a list of path names below @root@ to standard output. */
269 int check(const char *module, const char *root, const char *path);
270 /* Recheck a track, given its root and path name. Return 1 if it
271 * exists, 0 if it does not exist and -1 if an error occurred. */
273 /* notification interface *****************************************************/
275 void notify_play(const char *track,
276 const char *submitter);
277 /* we're going to play @track@. It was submitted by @submitter@
278 * (might be a null pointer) */
280 void notify_scratch(const char *track,
281 const char *submitter,
282 const char *scratcher,
284 /* @scratcher@ scratched @track@ after @seconds@. It was submitted by
285 * @submitter@ (might be a null pointer) */
287 void notify_not_scratched(const char *track,
288 const char *submitter);
289 /* @track@ (submitted by @submitter@, which might be a null pointer)
290 * was not scratched. */
292 void notify_queue(const char *track,
293 const char *submitter);
294 /* @track@ was queued by @submitter@ */
296 void notify_queue_remove(const char *track,
297 const char *remover);
298 /* @track@ removed from the queue by @remover@ (never a null pointer) */
300 void notify_queue_move(const char *track,
302 /* @track@ moved in the queue by @mover@ (never a null pointer) */
304 void notify_pause(const char *track,
306 /* TRACK was paused by PAUSER (might be a null pointer) */
308 void notify_resume(const char *track,
309 const char *resumer);
310 /* TRACK was resumed by PAUSER (might be a null pointer) */
312 /* track playing **************************************************************/
314 unsigned long play_get_type(const struct plugin *pl);
315 /* Get the type word for this plugin */
317 void *play_prefork(const struct plugin *pl,
319 /* Call the prefork function for PL and return the user data */
321 void play_track(const struct plugin *pl,
322 const char *const *parameters,
326 /* play a track. Called inside a fork. */
328 void play_cleanup(const struct plugin *pl, void *data);
329 /* Call the cleanup function for PL if necessary */
331 int play_pause(const struct plugin *pl, long *playedp, void *data);
334 void play_resume(const struct plugin *pl, void *data);
337 /* background process support *************************************************/
339 /** @brief Child process parameters */
341 /** @brief Length of player command */
343 /** @brief Player command */
345 /** @brief Device to wait for or NULL */
346 const char *waitdevice;
347 /** @brief Raw track name */
351 /** @brief Callback to play or prepare a track
352 * @param q Track to play or decode
353 * @param bgdata User data pointer
356 typedef int play_background_child_fn(struct queue_entry *q,
357 const struct pbgc_params *params,
360 int play_background(ev_source *ev,
361 const struct stringlist *player,
362 struct queue_entry *q,
363 play_background_child_fn *child,
366 /* Return values from start(), prepare() and play_background() */
368 #define START_OK 0 /**< @brief Succeeded. */
369 #define START_HARDFAIL 1 /**< @brief Track is broken. */
370 #define START_SOFTFAIL 2 /**< @brief Track OK, system (temporarily?) broken */
372 #endif /* DISORDER_SERVER_H */