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, int reload);
103 /* reconfigure. If @reload@ is nonzero, update the configuration. */
105 void dbparams_check(void);
107 extern struct queue_entry qhead;
108 /* queue of things yet to be played. the head will be played
111 extern struct queue_entry phead;
112 /* things that have been played in the past. the head is the oldest. */
116 void queue_read(void);
117 /* read the queue in. Calls @fatal@ on error. */
119 void queue_write(void);
120 /* write the queue out. Calls @fatal@ on error. */
122 void recent_read(void);
123 /* read the recently played list in. Calls @fatal@ on error. */
125 void recent_write(void);
126 /* write the recently played list out. Calls @fatal@ on error. */
128 struct queue_entry *queue_add(const char *track, const char *submitter,
129 int where, enum track_origin origin);
130 #define WHERE_START 0 /* Add to head of queue */
131 #define WHERE_END 1 /* Add to end of queue */
132 #define WHERE_BEFORE_RANDOM 2 /* End, or before random track */
133 /* add an entry to the queue. Return a pointer to the new entry. */
135 void queue_remove(struct queue_entry *q, const char *who);
136 /* remove an from the queue */
138 struct queue_entry *queue_find(const char *key);
139 /* find a track in the queue by name or ID */
141 void queue_played(struct queue_entry *q);
142 /* add @q@ to the played list */
144 int queue_move(struct queue_entry *q, int delta, const char *who);
145 /* move element @q@ in the queue towards the front (@delta@ > 0) or towards the
146 * back (@delta@ < 0). The return value is the leftover delta once we've hit
147 * the end in whichever direction we were going. */
149 void queue_moveafter(struct queue_entry *target,
150 int nqs, struct queue_entry **qs, const char *who);
151 /* Move all the elements QS to just after TARGET, or to the head if
154 void queue_fix_sofar(struct queue_entry *q);
155 /* Fix up the sofar field for standalone players */
157 void schedule_init(ev_source *ev);
158 const char *schedule_add(ev_source *ev,
159 struct kvp *actiondata);
160 int schedule_del(const char *id);
161 struct kvp *schedule_get(const char *id);
162 char **schedule_list(int *neventsp);
164 extern struct queue_entry *playing; /* playing track or 0 */
165 extern int paused; /* non-0 if paused */
167 void play(ev_source *ev);
168 /* try to play something, if playing is enabled and nothing is playing
171 int playing_is_enabled(void);
172 /* return true iff playing is enabled */
174 void enable_playing(const char *who, ev_source *ev);
177 void disable_playing(const char *who);
178 /* disable playing. */
180 int random_is_enabled(void);
181 /* return true iff random play is enabled */
183 void enable_random(const char *who, ev_source *ev);
184 /* enable random play */
186 void disable_random(const char *who);
187 /* disable random play */
189 void scratch(const char *who, const char *id);
190 /* scratch the playing track. @who@ identifies the scratcher. @id@ is
191 * the ID or a null pointer. */
193 void quitting(ev_source *ev);
194 /* called to terminate current track and shut down speaker process
197 void speaker_setup(ev_source *ev);
198 /* set up the speaker subprocess */
200 void speaker_reload(void);
201 /* Tell the speaker process to reload its configuration. */
203 int pause_playing(const char *who);
204 /* Pause the current track. Return 0 on success, -1 on error. WHO
207 void resume_playing(const char *who);
208 /* Resume after a pause. WHO can be 0. */
210 int prepare(ev_source *ev,
211 struct queue_entry *q);
212 /* Prepare to play Q */
214 void abandon(ev_source *ev,
215 struct queue_entry *q);
216 /* Abandon a possibly-prepared track. */
218 void add_random_track(ev_source *ev);
219 /* If random play is enabled then try to add a track to the queue. */
221 int server_start(ev_source *ev, int pf,
222 size_t socklen, const struct sockaddr *sa,
224 /* start listening. Return the fd. */
226 int server_stop(ev_source *ev, int fd);
227 /* Stop listening on @fd@ */
229 extern int volume_left, volume_right; /* last known volume */
231 extern int wideopen; /* blindly accept all logins */
237 typedef void *plugin_handle;
238 typedef void function_t(void);
240 const struct plugin *open_plugin(const char *name,
242 #define PLUGIN_FATAL 0x0001 /* fatal() on error */
243 /* Open a plugin. Returns a null pointer on error or a handle to it
246 function_t *get_plugin_function(const struct plugin *handle,
248 const void *get_plugin_object(const struct plugin *handle,
250 /* Look up a function or an object in a plugin */
252 /* track length computation ***************************************************/
254 long tracklength(const char *plugin, const char *track, const char *path);
256 /* collection interface *******************************************************/
258 void scan(const char *module, const char *root);
259 /* write a list of path names below @root@ to standard output. */
261 int check(const char *module, const char *root, const char *path);
262 /* Recheck a track, given its root and path name. Return 1 if it
263 * exists, 0 if it does not exist and -1 if an error occurred. */
265 /* notification interface *****************************************************/
267 void notify_play(const char *track,
268 const char *submitter);
269 /* we're going to play @track@. It was submitted by @submitter@
270 * (might be a null pointer) */
272 void notify_scratch(const char *track,
273 const char *submitter,
274 const char *scratcher,
276 /* @scratcher@ scratched @track@ after @seconds@. It was submitted by
277 * @submitter@ (might be a null pointer) */
279 void notify_not_scratched(const char *track,
280 const char *submitter);
281 /* @track@ (submitted by @submitter@, which might be a null pointer)
282 * was not scratched. */
284 void notify_queue(const char *track,
285 const char *submitter);
286 /* @track@ was queued by @submitter@ */
288 void notify_queue_remove(const char *track,
289 const char *remover);
290 /* @track@ removed from the queue by @remover@ (never a null pointer) */
292 void notify_queue_move(const char *track,
294 /* @track@ moved in the queue by @mover@ (never a null pointer) */
296 void notify_pause(const char *track,
298 /* TRACK was paused by PAUSER (might be a null pointer) */
300 void notify_resume(const char *track,
301 const char *resumer);
302 /* TRACK was resumed by PAUSER (might be a null pointer) */
304 /* track playing **************************************************************/
306 unsigned long play_get_type(const struct plugin *pl);
307 /* Get the type word for this plugin */
309 void *play_prefork(const struct plugin *pl,
311 /* Call the prefork function for PL and return the user data */
313 void play_track(const struct plugin *pl,
314 const char *const *parameters,
318 /* play a track. Called inside a fork. */
320 void play_cleanup(const struct plugin *pl, void *data);
321 /* Call the cleanup function for PL if necessary */
323 int play_pause(const struct plugin *pl, long *playedp, void *data);
326 void play_resume(const struct plugin *pl, void *data);
329 /* background process support *************************************************/
331 /** @brief Child process parameters */
333 /** @brief Length of player command */
335 /** @brief Player command */
337 /** @brief Device to wait for or NULL */
338 const char *waitdevice;
339 /** @brief Raw track name */
343 /** @brief Callback to play or prepare a track
344 * @param q Track to play or decode
345 * @param bgdata User data pointer
348 typedef int play_background_child_fn(struct queue_entry *q,
349 const struct pbgc_params *params,
352 int play_background(ev_source *ev,
353 const struct stringlist *player,
354 struct queue_entry *q,
355 play_background_child_fn *child,
358 /* Return values from start(), prepare() and play_background() */
360 #define START_OK 0 /**< @brief Succeeded. */
361 #define START_HARDFAIL 1 /**< @brief Track is broken. */
362 #define START_SOFTFAIL 2 /**< @brief Track OK, system (temporarily?) broken */
364 #endif /* DISORDER_SERVER_H */