chiark / gitweb /
Add missing notification when scratch queued, lost a couple of commits back
[disorder] / server / disorder-server.h
CommitLineData
05b75f8d
RK
1/*
2 * This file is part of DisOrder
b50cfb8a 3 * Copyright (C) 2008, 2009 Richard Kettlewell
05b75f8d 4 *
e7eb3a27 5 * This program is free software: you can redistribute it and/or modify
05b75f8d 6 * it under the terms of the GNU General Public License as published by
e7eb3a27 7 * the Free Software Foundation, either version 3 of the License, or
05b75f8d
RK
8 * (at your option) any later version.
9 *
e7eb3a27
RK
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.
14 *
05b75f8d 15 * You should have received a copy of the GNU General Public License
e7eb3a27 16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
05b75f8d 17 */
132a5a4a
RK
18/** @file server/disorder-server.h
19 * @brief Definitions for server and allied utilities
20 */
05b75f8d
RK
21
22#ifndef DISORDER_SERVER_H
23#define DISORDER_SERVER_H
24
25#include "common.h"
26
27#include <db.h>
28#include <errno.h>
29#include <fcntl.h>
30#include <fnmatch.h>
31#include <gcrypt.h>
32#include <getopt.h>
33#include <grp.h>
34#include <locale.h>
35#include <netinet/in.h>
36#include <pcre.h>
37#include <pwd.h>
38#include <signal.h>
39#include <stddef.h>
40#include <sys/socket.h>
41#include <sys/stat.h>
42#include <sys/time.h>
43#include <sys/types.h>
44#include <sys/un.h>
31e2a93e 45#include <sys/resource.h>
05b75f8d
RK
46#include <syslog.h>
47#include <time.h>
48#include <unistd.h>
49
50#include "addr.h"
51#include "authhash.h"
52#include "base64.h"
53#include "cache.h"
54#include "charset.h"
55#include "configuration.h"
56#include "cookies.h"
57#include "defs.h"
58#include "disorder.h"
59#include "event.h"
60#include "eventlog.h"
61#include "eventlog.h"
62#include "hash.h"
63#include "hex.h"
64#include "inputline.h"
65#include "kvp.h"
66#include "log.h"
67#include "logfd.h"
68#include "mem.h"
69#include "mime.h"
05b75f8d
RK
70#include "printf.h"
71#include "queue.h"
72#include "random.h"
73#include "rights.h"
74#include "sendmail.h"
75#include "sink.h"
76#include "speaker-protocol.h"
77#include "split.h"
78#include "syscalls.h"
79#include "table.h"
80#include "trackdb-int.h"
81#include "trackdb.h"
82#include "trackname.h"
b50cfb8a 83#include "uaudio.h"
05b75f8d
RK
84#include "unicode.h"
85#include "user.h"
86#include "vector.h"
87#include "version.h"
88#include "wstat.h"
89
b50cfb8a
RK
90extern const struct uaudio *api;
91
05b75f8d
RK
92void 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.
97 */
98
99void quit(ev_source *ev) attribute((noreturn));
100/* terminate the daemon */
101
37f29ce9
RK
102int reconfigure(ev_source *ev, unsigned flags);
103/* reconfigure */
104
105void reset_sockets(ev_source *ev);
106
107/** @brief Set when starting server */
108#define RECONFIGURE_FIRST 0x0001
109
110/** @brief Set when reloading after SIGHUP etc */
111#define RECONFIGURE_RELOADING 0x0002
05b75f8d 112
74f77840
RK
113void dbparams_check(void);
114
05b75f8d
RK
115extern struct queue_entry qhead;
116/* queue of things yet to be played. the head will be played
117 * soonest. */
118
119extern struct queue_entry phead;
120/* things that have been played in the past. the head is the oldest. */
121
122extern long pcount;
123
124void queue_read(void);
125/* read the queue in. Calls @fatal@ on error. */
126
127void queue_write(void);
128/* write the queue out. Calls @fatal@ on error. */
129
130void recent_read(void);
131/* read the recently played list in. Calls @fatal@ on error. */
132
133void recent_write(void);
134/* write the recently played list out. Calls @fatal@ on error. */
135
136struct queue_entry *queue_add(const char *track, const char *submitter,
7a853280
RK
137 int where, const char *target,
138 enum track_origin origin);
05b75f8d
RK
139#define WHERE_START 0 /* Add to head of queue */
140#define WHERE_END 1 /* Add to end of queue */
141#define WHERE_BEFORE_RANDOM 2 /* End, or before random track */
7a853280 142#define WHERE_AFTER 3 /* After the target */
4857234e 143#define WHERE_NOWHERE 4 /* Don't add to queue at all */
05b75f8d
RK
144/* add an entry to the queue. Return a pointer to the new entry. */
145
146void queue_remove(struct queue_entry *q, const char *who);
147/* remove an from the queue */
148
149struct queue_entry *queue_find(const char *key);
150/* find a track in the queue by name or ID */
151
152void queue_played(struct queue_entry *q);
153/* add @q@ to the played list */
154
155int queue_move(struct queue_entry *q, int delta, const char *who);
156/* move element @q@ in the queue towards the front (@delta@ > 0) or towards the
157 * back (@delta@ < 0). The return value is the leftover delta once we've hit
158 * the end in whichever direction we were going. */
159
160void queue_moveafter(struct queue_entry *target,
161 int nqs, struct queue_entry **qs, const char *who);
162/* Move all the elements QS to just after TARGET, or to the head if
163 * TARGET=0. */
164
165void queue_fix_sofar(struct queue_entry *q);
166/* Fix up the sofar field for standalone players */
167
168void schedule_init(ev_source *ev);
169const char *schedule_add(ev_source *ev,
170 struct kvp *actiondata);
171int schedule_del(const char *id);
172struct kvp *schedule_get(const char *id);
173char **schedule_list(int *neventsp);
174
175extern struct queue_entry *playing; /* playing track or 0 */
176extern int paused; /* non-0 if paused */
177
178void play(ev_source *ev);
179/* try to play something, if playing is enabled and nothing is playing
180 * already */
181
182int playing_is_enabled(void);
183/* return true iff playing is enabled */
184
185void enable_playing(const char *who, ev_source *ev);
186/* enable playing */
187
188void disable_playing(const char *who);
189/* disable playing. */
190
191int random_is_enabled(void);
192/* return true iff random play is enabled */
193
194void enable_random(const char *who, ev_source *ev);
195/* enable random play */
196
197void disable_random(const char *who);
198/* disable random play */
199
200void scratch(const char *who, const char *id);
201/* scratch the playing track. @who@ identifies the scratcher. @id@ is
202 * the ID or a null pointer. */
203
204void quitting(ev_source *ev);
205/* called to terminate current track and shut down speaker process
206 * when quitting */
207
208void speaker_setup(ev_source *ev);
209/* set up the speaker subprocess */
210
211void speaker_reload(void);
212/* Tell the speaker process to reload its configuration. */
213
214int pause_playing(const char *who);
215/* Pause the current track. Return 0 on success, -1 on error. WHO
216 * can be 0. */
217
218void resume_playing(const char *who);
219/* Resume after a pause. WHO can be 0. */
220
221int prepare(ev_source *ev,
222 struct queue_entry *q);
223/* Prepare to play Q */
224
225void abandon(ev_source *ev,
226 struct queue_entry *q);
227/* Abandon a possibly-prepared track. */
228
229void add_random_track(ev_source *ev);
230/* If random play is enabled then try to add a track to the queue. */
231
232int server_start(ev_source *ev, int pf,
233 size_t socklen, const struct sockaddr *sa,
234 const char *name);
235/* start listening. Return the fd. */
236
237int server_stop(ev_source *ev, int fd);
238/* Stop listening on @fd@ */
239
240extern int volume_left, volume_right; /* last known volume */
241
242extern int wideopen; /* blindly accept all logins */
243
244/* plugins */
245
246struct plugin;
247
248typedef void *plugin_handle;
249typedef void function_t(void);
250
251const struct plugin *open_plugin(const char *name,
252 unsigned flags);
253#define PLUGIN_FATAL 0x0001 /* fatal() on error */
254/* Open a plugin. Returns a null pointer on error or a handle to it
255 * on success. */
256
257function_t *get_plugin_function(const struct plugin *handle,
258 const char *symbol);
259const void *get_plugin_object(const struct plugin *handle,
260 const char *symbol);
261/* Look up a function or an object in a plugin */
262
263/* track length computation ***************************************************/
264
265long tracklength(const char *plugin, const char *track, const char *path);
266
267/* collection interface *******************************************************/
268
269void scan(const char *module, const char *root);
270/* write a list of path names below @root@ to standard output. */
271
272int check(const char *module, const char *root, const char *path);
273/* Recheck a track, given its root and path name. Return 1 if it
274 * exists, 0 if it does not exist and -1 if an error occurred. */
275
276/* notification interface *****************************************************/
277
278void notify_play(const char *track,
279 const char *submitter);
280/* we're going to play @track@. It was submitted by @submitter@
281 * (might be a null pointer) */
282
283void notify_scratch(const char *track,
284 const char *submitter,
285 const char *scratcher,
286 int seconds);
287/* @scratcher@ scratched @track@ after @seconds@. It was submitted by
288 * @submitter@ (might be a null pointer) */
289
290void notify_not_scratched(const char *track,
291 const char *submitter);
292/* @track@ (submitted by @submitter@, which might be a null pointer)
293 * was not scratched. */
294
295void notify_queue(const char *track,
296 const char *submitter);
297/* @track@ was queued by @submitter@ */
298
299void notify_queue_remove(const char *track,
300 const char *remover);
301/* @track@ removed from the queue by @remover@ (never a null pointer) */
302
303void notify_queue_move(const char *track,
304 const char *mover);
305/* @track@ moved in the queue by @mover@ (never a null pointer) */
306
307void notify_pause(const char *track,
308 const char *pauser);
309/* TRACK was paused by PAUSER (might be a null pointer) */
310
311void notify_resume(const char *track,
312 const char *resumer);
313/* TRACK was resumed by PAUSER (might be a null pointer) */
314
315/* track playing **************************************************************/
316
317unsigned long play_get_type(const struct plugin *pl);
318/* Get the type word for this plugin */
319
320void *play_prefork(const struct plugin *pl,
321 const char *track);
322/* Call the prefork function for PL and return the user data */
323
324void play_track(const struct plugin *pl,
325 const char *const *parameters,
326 int nparameters,
327 const char *path,
328 const char *track);
329/* play a track. Called inside a fork. */
330
331void play_cleanup(const struct plugin *pl, void *data);
332/* Call the cleanup function for PL if necessary */
333
334int play_pause(const struct plugin *pl, long *playedp, void *data);
335/* Pause track. */
336
337void play_resume(const struct plugin *pl, void *data);
338/* Resume track. */
339
5bac5b78
RK
340/* background process support *************************************************/
341
342/** @brief Child process parameters */
343struct pbgc_params {
344 /** @brief Length of player command */
345 int argc;
346 /** @brief Player command */
347 const char **argv;
348 /** @brief Device to wait for or NULL */
349 const char *waitdevice;
350 /** @brief Raw track name */
351 const char *rawpath;
352};
353
354/** @brief Callback to play or prepare a track
355 * @param q Track to play or decode
356 * @param bgdata User data pointer
357 * @return Exit code
358 */
359typedef int play_background_child_fn(struct queue_entry *q,
360 const struct pbgc_params *params,
361 void *bgdata);
362
363int play_background(ev_source *ev,
364 const struct stringlist *player,
365 struct queue_entry *q,
366 play_background_child_fn *child,
367 void *bgdata);
368
369/* Return values from start(), prepare() and play_background() */
370
371#define START_OK 0 /**< @brief Succeeded. */
372#define START_HARDFAIL 1 /**< @brief Track is broken. */
373#define START_SOFTFAIL 2 /**< @brief Track OK, system (temporarily?) broken */
374
05b75f8d
RK
375#endif /* DISORDER_SERVER_H */
376
377/*
378Local Variables:
379c-basic-offset:2
380comment-column:40
381fill-column:79
382indent-tabs-mode:nil
383End:
384*/