chiark / gitweb /
compute Sentence_Break as well
[disorder] / lib / configuration.h
CommitLineData
460b9539 1/*
2 * This file is part of DisOrder.
e83d0967 3 * Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
460b9539 4 *
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.
9 *
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.
14 *
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
18 * USA
19 */
0e4472a0 20/** @file lib/configuration.h
21 * @brief Configuration file support
22 */
460b9539 23
24#ifndef CONFIGURATION_H
25#define CONFIGURATION_H
26
6d2d327c 27#include "speaker-protocol.h"
9d5da576 28
460b9539 29struct real_pcre;
30
31/* Configuration is kept in a @struct config@; the live configuration
32 * is always pointed to by @config@. Values in @config@ are UTF-8 encoded.
33 */
34
3f3bb97b 35/** @brief A list of strings */
460b9539 36struct stringlist {
3f3bb97b 37 /** @brief Number of strings */
460b9539 38 int n;
3f3bb97b 39 /** @brief Array of strings */
460b9539 40 char **s;
41};
42
3f3bb97b 43/** @brief A list of list of strings */
460b9539 44struct stringlistlist {
3f3bb97b 45 /** @brief Number of string lists */
460b9539 46 int n;
3f3bb97b 47 /** @brief Array of string lists */
460b9539 48 struct stringlist *s;
49};
50
3f3bb97b 51/** @brief A collection of tracks */
460b9539 52struct collection {
3f3bb97b 53 /** @brief Module that supports this collection */
460b9539 54 char *module;
3f3bb97b 55 /** @brief Filename encoding */
460b9539 56 char *encoding;
3f3bb97b 57 /** @brief Root directory */
460b9539 58 char *root;
59};
60
3f3bb97b 61/** @brief A list of collections */
460b9539 62struct collectionlist {
3f3bb97b 63 /** @brief Number of collections */
460b9539 64 int n;
3f3bb97b 65 /** @brief Array of collections */
460b9539 66 struct collection *s;
67};
68
69struct namepart {
70 char *part; /* part */
71 struct real_pcre *re; /* regexp */
72 char *replace; /* replacement string */
73 char *context; /* context glob */
74 unsigned reflags; /* regexp flags */
75};
76
77struct namepartlist {
78 int n;
79 struct namepart *s;
80};
81
82struct transform {
83 char *type; /* track or dir */
84 char *context; /* sort or choose */
85 char *replace; /* substitution string */
86 struct real_pcre *re; /* compiled re */
87 unsigned flags; /* regexp flags */
88};
89
90struct transformlist {
91 int n;
92 struct transform *t;
93};
94
3f3bb97b 95/** @brief System configuration */
460b9539 96struct config {
97 /* server config */
3f3bb97b 98
637fdea3
RK
99 /** @brief Authorization algorithm */
100 char *authorization_algorithm;
101
3f3bb97b
RK
102 /** @brief All players */
103 struct stringlistlist player;
104
62dc3748
RK
105 /** @brief All tracklength plugins */
106 struct stringlistlist tracklength;
107
3f3bb97b
RK
108 /** @brief Allowed users */
109 struct stringlistlist allow;
110
111 /** @brief Scratch tracks */
112 struct stringlist scratch;
113
114 /** @brief Gap between tracks in seconds */
115 long gap;
116
117 /** @brief Maximum number of recent tracks to record in history */
118 long history;
119
2a10b70b
RK
120 /** @brief Expiry limit for noticed.db */
121 long noticed_history;
122
3f3bb97b
RK
123 /** @brief Trusted users */
124 struct stringlist trust;
125
126 /** @brief User for server to run as */
127 const char *user;
128
129 /** @brief Nice value for rescan subprocess */
130 long nice_rescan;
131
132 /** @brief Paths to search for plugins */
133 struct stringlist plugins;
134
135 /** @brief List of stopwords */
136 struct stringlist stopword;
137
138 /** @brief List of collections */
139 struct collectionlist collection;
140
141 /** @brief Database checkpoint byte limit */
460b9539 142 long checkpoint_kbyte;
3f3bb97b
RK
143
144 /** @brief Databsase checkpoint minimum */
460b9539 145 long checkpoint_min;
3f3bb97b
RK
146
147 /** @brief Path to mixer device */
148 char *mixer;
149
150 /** @brief Mixer channel to use */
151 char *channel;
152
153 long prefsync; /* preflog sync interval */
154
155 /** @brief Secondary listen address */
156 struct stringlist listen;
157
158 /** @brief Alias format string */
159 const char *alias;
160
161 /** @brief Enable server locking */
162 int lock;
163
164 /** @brief Nice value for server */
165 long nice_server;
166
167 /** @brief Nice value for speaker */
168 long nice_speaker;
169
170 /** @brief Command execute by speaker to play audio */
171 const char *speaker_command;
172
173 /** @brief Target sample format */
6d2d327c 174 struct stream_header sample_format;
3f3bb97b
RK
175
176 /** @brief Sox syntax generation */
177 long sox_generation;
178
179 /** @brief Speaker backend
180 *
181 * Choices are @ref BACKEND_ALSA, @ref BACKEND_COMMAND or @ref
182 * BACKEND_NETWORK.
183 */
184 int speaker_backend;
185#define BACKEND_ALSA 0 /**< Use ALSA (Linux only) */
186#define BACKEND_COMMAND 1 /**< Execute a command */
187#define BACKEND_NETWORK 2 /**< Transmit RTP */
937be4c0 188#define BACKEND_COREAUDIO 3 /**< Use Core Audio (Mac only) */
e99d42b1 189#define BACKEND_OSS 4 /**< Use OSS */
3f3bb97b
RK
190
191 /** @brief Home directory for state files */
192 const char *home;
193
194 /** @brief Login username */
195 const char *username;
196
197 /** @brief Login password */
198 const char *password;
199
200 /** @brief Address to connect to */
201 struct stringlist connect;
202
203 /** @brief Directories to search for web templates */
204 struct stringlist templates;
205
206 /** @brief Canonical URL of web interface */
207 const char *url;
208
61507e3c
RK
209 /** @brief Short display limit */
210 long short_display;
211
3f3bb97b
RK
212 /** @brief Maximum refresh interval for web interface (seconds) */
213 long refresh;
214
215 /** @brief Facilities restricted to trusted users
216 *
217 * A bitmap of @ref RESTRICT_SCRATCH, @ref RESTRICT_REMOVE and @ref
218 * RESTRICT_MOVE.
219 */
460b9539 220 unsigned restrictions; /* restrictions */
3f3bb97b
RK
221#define RESTRICT_SCRATCH 1 /**< Restrict scratching */
222#define RESTRICT_REMOVE 2 /**< Restrict removal */
223#define RESTRICT_MOVE 4 /**< Restrict rearrangement */
224
225 /** @brief Target queue length */
226 long queue_pad;
227
460b9539 228 struct namepartlist namepart; /* transformations */
3f3bb97b
RK
229
230 /** @brief Termination signal for subprocesses */
231 int signal;
232
233 /** @brief ALSA output device */
234 const char *device;
460b9539 235 struct transformlist transform; /* path name transformations */
236
23205f9c
RK
237 /** @brief Address to send audio data to */
238 struct stringlist broadcast;
239
240 /** @brief Source address for network audio transmission */
241 struct stringlist broadcast_from;
242
243 /** @brief TTL for multicast packets */
244 long multicast_ttl;
e83d0967 245
460b9539 246 /* derived values: */
247 int nparts; /* number of distinct name parts */
248 char **parts; /* name part list */
249};
250
251extern struct config *config;
252/* the current configuration */
253
c00fce3a 254int config_read(int server);
460b9539 255/* re-read config, return 0 on success or non-0 on error.
256 * Only updates @config@ if the new configuration is valid. */
257
258char *config_get_file(const char *name);
259/* get a filename within the home directory */
260
261struct passwd;
262
263char *config_userconf(const char *home, const struct passwd *pw);
264/* get the user's own private conffile, assuming their home dir is
265 * @home@ if not null and using @pw@ otherwise */
266
267char *config_usersysconf(const struct passwd *pw );
268/* get the user's conffile in /etc */
269
270char *config_private(void);
271/* get the private config file */
272
273extern char *configfile;
274
275#endif /* CONFIGURATION_H */
276
277/*
278Local Variables:
279c-basic-offset:2
280comment-column:40
281End:
282*/