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/>.
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"
77 #include "speaker-protocol.h"
81 #include "trackdb-int.h"
83 #include "trackname.h"
90 void daemonize(const char *tag, int fac, const char *pidfile);
91 /* Go into background. Send stdout/stderr to syslog.
92 * If @pri@ is non-null, it should be "facility.level"
93 * If @tag@ is non-null, it is used as a tag to each message
94 * If @pidfile@ is non-null, the PID is written to that file.
97 void quit(ev_source *ev) attribute((noreturn));
98 /* terminate the daemon */
100 int reconfigure(ev_source *ev, int reload);
101 /* reconfigure. If @reload@ is nonzero, update the configuration. */
103 extern struct queue_entry qhead;
104 /* queue of things yet to be played. the head will be played
107 extern struct queue_entry phead;
108 /* things that have been played in the past. the head is the oldest. */
112 void queue_read(void);
113 /* read the queue in. Calls @fatal@ on error. */
115 void queue_write(void);
116 /* write the queue out. Calls @fatal@ on error. */
118 void recent_read(void);
119 /* read the recently played list in. Calls @fatal@ on error. */
121 void recent_write(void);
122 /* write the recently played list out. Calls @fatal@ on error. */
124 struct queue_entry *queue_add(const char *track, const char *submitter,
125 int where, enum track_origin origin);
126 #define WHERE_START 0 /* Add to head of queue */
127 #define WHERE_END 1 /* Add to end of queue */
128 #define WHERE_BEFORE_RANDOM 2 /* End, or before random track */
129 /* add an entry to the queue. Return a pointer to the new entry. */
131 void queue_remove(struct queue_entry *q, const char *who);
132 /* remove an from the queue */
134 struct queue_entry *queue_find(const char *key);
135 /* find a track in the queue by name or ID */
137 void queue_played(struct queue_entry *q);
138 /* add @q@ to the played list */
140 int queue_move(struct queue_entry *q, int delta, const char *who);
141 /* move element @q@ in the queue towards the front (@delta@ > 0) or towards the
142 * back (@delta@ < 0). The return value is the leftover delta once we've hit
143 * the end in whichever direction we were going. */
145 void queue_moveafter(struct queue_entry *target,
146 int nqs, struct queue_entry **qs, const char *who);
147 /* Move all the elements QS to just after TARGET, or to the head if
150 void queue_fix_sofar(struct queue_entry *q);
151 /* Fix up the sofar field for standalone players */
153 void schedule_init(ev_source *ev);
154 const char *schedule_add(ev_source *ev,
155 struct kvp *actiondata);
156 int schedule_del(const char *id);
157 struct kvp *schedule_get(const char *id);
158 char **schedule_list(int *neventsp);
160 extern struct queue_entry *playing; /* playing track or 0 */
161 extern int paused; /* non-0 if paused */
163 void play(ev_source *ev);
164 /* try to play something, if playing is enabled and nothing is playing
167 int playing_is_enabled(void);
168 /* return true iff playing is enabled */
170 void enable_playing(const char *who, ev_source *ev);
173 void disable_playing(const char *who);
174 /* disable playing. */
176 int random_is_enabled(void);
177 /* return true iff random play is enabled */
179 void enable_random(const char *who, ev_source *ev);
180 /* enable random play */
182 void disable_random(const char *who);
183 /* disable random play */
185 void scratch(const char *who, const char *id);
186 /* scratch the playing track. @who@ identifies the scratcher. @id@ is
187 * the ID or a null pointer. */
189 void quitting(ev_source *ev);
190 /* called to terminate current track and shut down speaker process
193 void speaker_setup(ev_source *ev);
194 /* set up the speaker subprocess */
196 void speaker_reload(void);
197 /* Tell the speaker process to reload its configuration. */
199 int pause_playing(const char *who);
200 /* Pause the current track. Return 0 on success, -1 on error. WHO
203 void resume_playing(const char *who);
204 /* Resume after a pause. WHO can be 0. */
206 int prepare(ev_source *ev,
207 struct queue_entry *q);
208 /* Prepare to play Q */
210 void abandon(ev_source *ev,
211 struct queue_entry *q);
212 /* Abandon a possibly-prepared track. */
214 void add_random_track(ev_source *ev);
215 /* If random play is enabled then try to add a track to the queue. */
217 int server_start(ev_source *ev, int pf,
218 size_t socklen, const struct sockaddr *sa,
220 /* start listening. Return the fd. */
222 int server_stop(ev_source *ev, int fd);
223 /* Stop listening on @fd@ */
225 extern int volume_left, volume_right; /* last known volume */
227 extern int wideopen; /* blindly accept all logins */
233 typedef void *plugin_handle;
234 typedef void function_t(void);
236 const struct plugin *open_plugin(const char *name,
238 #define PLUGIN_FATAL 0x0001 /* fatal() on error */
239 /* Open a plugin. Returns a null pointer on error or a handle to it
242 function_t *get_plugin_function(const struct plugin *handle,
244 const void *get_plugin_object(const struct plugin *handle,
246 /* Look up a function or an object in a plugin */
248 /* track length computation ***************************************************/
250 long tracklength(const char *plugin, const char *track, const char *path);
252 /* collection interface *******************************************************/
254 void scan(const char *module, const char *root);
255 /* write a list of path names below @root@ to standard output. */
257 int check(const char *module, const char *root, const char *path);
258 /* Recheck a track, given its root and path name. Return 1 if it
259 * exists, 0 if it does not exist and -1 if an error occurred. */
261 /* notification interface *****************************************************/
263 void notify_play(const char *track,
264 const char *submitter);
265 /* we're going to play @track@. It was submitted by @submitter@
266 * (might be a null pointer) */
268 void notify_scratch(const char *track,
269 const char *submitter,
270 const char *scratcher,
272 /* @scratcher@ scratched @track@ after @seconds@. It was submitted by
273 * @submitter@ (might be a null pointer) */
275 void notify_not_scratched(const char *track,
276 const char *submitter);
277 /* @track@ (submitted by @submitter@, which might be a null pointer)
278 * was not scratched. */
280 void notify_queue(const char *track,
281 const char *submitter);
282 /* @track@ was queued by @submitter@ */
284 void notify_queue_remove(const char *track,
285 const char *remover);
286 /* @track@ removed from the queue by @remover@ (never a null pointer) */
288 void notify_queue_move(const char *track,
290 /* @track@ moved in the queue by @mover@ (never a null pointer) */
292 void notify_pause(const char *track,
294 /* TRACK was paused by PAUSER (might be a null pointer) */
296 void notify_resume(const char *track,
297 const char *resumer);
298 /* TRACK was resumed by PAUSER (might be a null pointer) */
300 /* track playing **************************************************************/
302 unsigned long play_get_type(const struct plugin *pl);
303 /* Get the type word for this plugin */
305 void *play_prefork(const struct plugin *pl,
307 /* Call the prefork function for PL and return the user data */
309 void play_track(const struct plugin *pl,
310 const char *const *parameters,
314 /* play a track. Called inside a fork. */
316 void play_cleanup(const struct plugin *pl, void *data);
317 /* Call the cleanup function for PL if necessary */
319 int play_pause(const struct plugin *pl, long *playedp, void *data);
322 void play_resume(const struct plugin *pl, void *data);
325 #endif /* DISORDER_SERVER_H */