Rename struct audio format to audio_format_handler
[paraslash.git] / error.h
1 /*
2 * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
17 */
18
19 /** \file error.h list of error messages for all subsystems */
20
21 /** \cond list of all subsystems that support the shiny new error facility */
22 enum para_subsystem {
23 SS_RECV,
24 SS_NET,
25 SS_ORTP_RECV,
26 SS_AUDIOD,
27 SS_EXEC,
28 SS_CLOSE_ON_FORK,
29 SS_SIGNAL,
30 SS_STRING,
31 SS_DAEMON,
32 SS_STAT,
33 SS_TIME,
34 SS_GRAB_CLIENT,
35 SS_HTTP_RECV,
36 SS_RECV_COMMON,
37 SS_FILTER_CHAIN,
38 SS_WAV,
39 SS_COMPRESS,
40 SS_OGGDEC,
41 SS_FILTER,
42 SS_COMMAND,
43 SS_RANDOM_SELECTOR,
44 SS_PLAYLIST_SELECTOR,
45 SS_CRYPT,
46 SS_HTTP_SEND,
47 SS_ORTP_SEND,
48 SS_DB,
49 SS_OGG,
50 SS_MP3,
51 SS_AAC_AFH,
52 SS_MP3DEC,
53 SS_AACDEC,
54 SS_AAC_COMMON,
55 SS_SERVER,
56 SS_AFS,
57 SS_MYSQL_SELECTOR,
58 SS_IPC,
59 SS_DCCP,
60 SS_DCCP_RECV,
61 SS_DCCP_SEND,
62 SS_FD,
63 SS_GUI,
64 SS_WRITE,
65 SS_WRITE_COMMON,
66 SS_ALSA_WRITER,
67 SS_FILE_WRITER,
68 SS_RINGBUFFER};
69
70 #define NUM_SS (SS_RINGBUFFER + 1)
71 extern const char **para_errlist[];
72 /** \endcond */
73
74 #define NET_ERRORS \
75 PARA_ERROR(SEND, "send error"), \
76 PARA_ERROR(RECV, "receive error"), \
77 PARA_ERROR(SOCKET, "socket error"), \
78 PARA_ERROR(CONNECT, "connect error"), \
79 PARA_ERROR(ACCEPT, "accept error"), \
80 PARA_ERROR(SETSOCKOPT, "failed to set socket options"), \
81 PARA_ERROR(BIND, "bind error"), \
82 PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
83 PARA_ERROR(CHMOD, "failed to set socket mode"), \
84 PARA_ERROR(SENDMSG, "sendmsg() failed"), \
85 PARA_ERROR(RECVMSG, "recvmsg() failed"), \
86 PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
87 PARA_ERROR(LISTEN, "listen error"), \
88 PARA_ERROR(RECV_PATTERN, "did not receive expected pattern"), \
89 PARA_ERROR(HOST_INFO, "gethostbyname() failed"), \
90
91
92 #define ORTP_RECV_ERRORS \
93 PARA_ERROR(MSG_TO_BUF, "failed to extract rtp packet"), \
94 PARA_ERROR(ORTP_SYNTAX, "ottp syntax error"), \
95 PARA_ERROR(TOO_MANY_BAD_CHUNKS, "too many consecutive bad chunks"), \
96 PARA_ERROR(INVALID_HEADER, "invalid header packet"), \
97 PARA_ERROR(OVERRUN, "outout buffer overrun"), \
98
99
100 #define HTTP_RECV_ERRORS \
101 PARA_ERROR(SEND_HTTP_REQUEST, "failed to send http request"), \
102 PARA_ERROR(MISSING_OK, "did not receive OK message from peer"), \
103 PARA_ERROR(HTTP_RECV_BUF, "did not receive buffer")
104
105
106 #define RECV_ERRORS \
107 PARA_ERROR(RECV_SELECT, "recv select error"), \
108 PARA_ERROR(WRITE_STDOUT, "stdout write error"), \
109
110
111 #define RECV_COMMON_ERRORS \
112 PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
113
114
115 #define AUDIOD_ERRORS \
116 PARA_ERROR(WRITE_AUDIO_DATA, "failed to write audio data"), \
117 PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
118 PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
119 PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
120 PARA_ERROR(CLIENT_WRITE, "client write error"), \
121 PARA_ERROR(UCRED_PERM, "permission denied"), \
122 PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
123
124
125 #define FILTER_CHAIN_ERRORS \
126 PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
127 PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
128
129
130 #define STAT_ERRORS \
131 PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
132 PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
133
134
135 #define OGGDEC_ERRORS \
136 PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
137 PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
138 PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
139 PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
140 PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
141 PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
142
143
144 #define GRAB_CLIENT_ERRORS \
145 PARA_ERROR(PEDANTIC_GRAB, "fd not ready and pedantic grab requested"), \
146 PARA_ERROR(GC_WRITE, "grab client write error"), \
147 PARA_ERROR(BAD_GC_SLOT, "invalid slot requested by grab client"), \
148 PARA_ERROR(BAD_GC_FILTER_NUM, "invalid filter number given"), \
149 PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
150 PARA_ERROR(GC_HELP_GIVEN, ""), /* not really an error */ \
151 PARA_ERROR(GC_VERSION_GIVEN, ""), /* not really an error */ \
152
153
154 #define MP3DEC_ERRORS \
155 PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
156 PARA_ERROR(MP3DEC_OVERRUN, "mp3 output buffer overrun"), \
157
158
159 #define FILTER_ERRORS \
160 PARA_ERROR(NO_FILTERS, "at least one filter must be given"), \
161 PARA_ERROR(FILTER_SYNTAX, "syntax error"), \
162
163
164 #define SIGNAL_ERRORS \
165 PARA_ERROR(SIGNAL_SIG_ERR, "signal() retured SIG_ERR"), \
166 PARA_ERROR(SIGNAL_READ, "read error from signal pipe"), \
167 PARA_ERROR(WAITPID, "waitpid error"), \
168 PARA_ERROR(SIGNAL_PIPE, "failed to setup signal pipe"), \
169
170
171 #define STRING_ERRORS \
172 PARA_ERROR(MKSTEMP, "mkstemp error: unable to create tmp file"), \
173 PARA_ERROR(FCHMOD, "fchmod error: can not set mode"), \
174
175
176 #define EXEC_ERRORS \
177 PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
178 PARA_ERROR(NULL_OPEN, "can not open /dev/null"), \
179
180
181 #define MP3_ERRORS \
182 PARA_ERROR(FREAD, "fread error"), \
183 PARA_ERROR(FSEEK, "fseek error"), \
184 PARA_ERROR(FRAME, "invalid mp3 frame"), \
185 PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
186 PARA_ERROR(MP3_NO_FILE, "invalid mp3 file pointer"), \
187 PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
188 PARA_ERROR(MP3_REPOS, "mp3 repositioning error"), \
189 PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
190 PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
191
192
193 #define AAC_AFH_ERRORS \
194 PARA_ERROR(AAC_REPOS, "aac repositioning error"), \
195 PARA_ERROR(AAC_READ, "aac read error"), \
196 PARA_ERROR(STSZ, "did not find stcz atom"), \
197
198
199 #define AAC_COMMON_ERRORS \
200 PARA_ERROR(AAC_BUF, "invalid buffer"), \
201 PARA_ERROR(ESDS, "did not find esds atom"), \
202 PARA_ERROR(STCO, "did not find stco atom"), \
203
204
205 #define OGG_ERRORS \
206 PARA_ERROR(OGG_READ, "ogg read error"), \
207 PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
208 PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \
209 PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \
210 PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
211 PARA_ERROR(OGG_NO_FILE, "invalid ogg file pointer"), \
212 PARA_ERROR(OGG_OPEN, "ov_open error"), \
213 PARA_ERROR(OGG_INFO, "ov_info error"), \
214 PARA_ERROR(OGG_REPOS, "ogg repositioning error"), \
215
216
217 #define AFS_ERRORS \
218 PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
219 PARA_ERROR(FSTAT, "failed to fstat() audio file"), \
220
221
222 #define DB_ERRORS \
223 PARA_ERROR(GETCWD, "can not get current working directory"), \
224 PARA_ERROR(CHDIR, "can not change directory"), \
225 PARA_ERROR(OPENDIR, "can not open directory"), \
226 PARA_ERROR(LSTAT, "lstat error"), \
227
228
229 #define CRYPT_ERRORS \
230 PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
231 PARA_ERROR(PUBLIC_KEY, "can not read public key"), \
232 PARA_ERROR(RSA, "RSA error"), \
233 PARA_ERROR(ENCRYPT, "encrypt error"), \
234 PARA_ERROR(DECRYPT, "decrypt error"), \
235 PARA_ERROR(CHALLENGE, "failed to read challenge"), \
236
237
238 #define HTTP_SEND_ERRORS \
239 PARA_ERROR(QUEUE, "packet queue overrun"), \
240 PARA_ERROR(WRITE_OK, "can not check whether fd is writable"), \
241
242
243 #define RANDOM_SELECTOR_ERRORS \
244 PARA_ERROR(FILE_COUNT, "audio file count exceeded"), \
245 PARA_ERROR(NOTHING_FOUND, "no audio files found"), \
246
247
248 #define MYSQL_SELECTOR_ERRORS \
249 PARA_ERROR(MYSQL_SYNTAX, "mysql syntax error"), \
250 PARA_ERROR(NOTCONN, "not connected to mysql server"), \
251 PARA_ERROR(TOOBIG, "mysql: file too large"), \
252 PARA_ERROR(NAMETOOLONG, "mysql: name too long"), \
253 PARA_ERROR(QFAILED, "mysql query failed"), \
254 PARA_ERROR(NOROW, "row is NULL"), \
255 PARA_ERROR(NOATTS, "can not get attributes from mysql table"), \
256 PARA_ERROR(NORESULT, "error while fetching mysql result"), \
257 PARA_ERROR(EMPTY_RESULT, "result is empty"), \
258 PARA_ERROR(ESCAPE, "can not escape string"), \
259 PARA_ERROR(GET_AUDIO_FILE, "can not get current audio file"), \
260 PARA_ERROR(GET_STREAM, "can not get current stream"), \
261 PARA_ERROR(NO_STREAM, "no such stream"), \
262 PARA_ERROR(AUDIO_FILE, "no such audio file"), \
263 PARA_ERROR(GET_QUERY, "can not get query for specified stream"), \
264 PARA_ERROR(TMPFILE, "error while writing temporary file"), \
265 PARA_ERROR(META, "can not get meta data"), \
266 PARA_ERROR(MYSQL_INIT, "can not initialize mysql connection"), \
267 PARA_ERROR(NO_MYSQL_PASSWD, "fatal: no mysql passord given"), \
268 PARA_ERROR(NO_AF_DIR, "fatal: audio file directory not given"), \
269
270
271 #define COMMAND_ERRORS \
272 PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
273 PARA_ERROR(AUTH, "did not receive auth request"), \
274 PARA_ERROR(BAD_SELECTOR, "no such audio file selector"), \
275 PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
276 PARA_ERROR(BAD_CMD, "invalid command"), \
277 PARA_ERROR(PERM, "permission denied"), \
278 PARA_ERROR(USERLIST, "failed to open user list file"), \
279 PARA_ERROR(BAD_USER, "you don't exist. Go away."), \
280 PARA_ERROR(LOCK, "lock error"), \
281 PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
282
283 #define PLAYLIST_SELECTOR_ERRORS \
284 PARA_ERROR(LOAD_PLAYLIST, "failed to load playlist"), \
285
286
287 #define IPC_ERRORS \
288 PARA_ERROR(SEM_GET, "failed to create semaphore"), \
289 PARA_ERROR(SEM_REMOVE, "can not remove semaphore"), \
290 PARA_ERROR(SHM_GET, "failed to allocate shared memory area"), \
291 PARA_ERROR(SHM_DESTROY, "failed to destroy shared memory area"), \
292 PARA_ERROR(SHM_ATTACH, "can not attach shared memory area"), \
293 PARA_ERROR(SHM_DETACH, "can not detach shared memory area"), \
294
295
296 #define DCCP_ERRORS \
297 PARA_ERROR(DCCP_SOCKET, "can not create dccp socket"), \
298 PARA_ERROR(DCCP_PACKET_SIZE, "failed to set dccp packet size"), \
299 PARA_ERROR(DCCP_SERVICE, "could not get service code"), \
300
301
302 #define DCCP_RECV_ERRORS \
303 PARA_ERROR(ADDR_INFO, "getaddrinfo error"), \
304 PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
305 PARA_ERROR(DCCP_CONNECT, "dccp connect error"), \
306
307 #define DCCP_SEND_ERRORS \
308 PARA_ERROR(DCCP_BIND, "dccp bind error"), \
309 PARA_ERROR(DCCP_LISTEN, "dccp listen error"), \
310 PARA_ERROR(DCCP_WRITE, "dccp write error"), \
311
312 #define FD_ERRORS \
313 PARA_ERROR(F_GETFL, "failed to get fd flags"), \
314 PARA_ERROR(F_SETFL, "failed to set fd flags"), \
315
316
317 #define WRITE_ERRORS \
318 PARA_ERROR(READ_HDR, "failed to read audio file header"), \
319 PARA_ERROR(READ_STDIN, "failed to read from stdin"), \
320 PARA_ERROR(WRITE_SYNTAX, "para_write syntax error"), \
321 PARA_ERROR(WRITE_OVERRUN, "buffer overrun"), \
322 PARA_ERROR(PREMATURE_END, "premature end of audio file"), \
323
324
325 #define ALSA_WRITER_ERRORS \
326 PARA_ERROR(BROKEN_CONF, "Broken alsa configuration"), \
327 PARA_ERROR(ACCESS_TYPE, "alsa access type not available"), \
328 PARA_ERROR(SAMPLE_FORMAT, "sample format not available"), \
329 PARA_ERROR(CHANNEL_COUNT, "channels count not available"), \
330 PARA_ERROR(HW_PARAMS, "unable to install hw params"), \
331 PARA_ERROR(SW_PARAMS, "unable to install sw params"), \
332 PARA_ERROR(BAD_PERIOD, "can not use period equal to buffer size"), \
333 PARA_ERROR(GET_XFER, "unable to obtain xfer align"), \
334 PARA_ERROR(SET_XFER, "snd_pcm_sw_params_set_xfer_align() failed"), \
335 PARA_ERROR(ALSA_WRITE, "alsa write error"), \
336 PARA_ERROR(PCM_OPEN, "unable to open pcm"), \
337 PARA_ERROR(SND_PCM_INFO, "pcm info error"), \
338 PARA_ERROR(GET_BUFFER_TIME, "snd_pcm_hw_params_get_buffer_time_max() failed"), \
339 PARA_ERROR(SET_BUFFER_TIME, "snd_pcm_hw_params_set_buffer_time_near() failed"), \
340 PARA_ERROR(SET_RATE, "snd_pcm_hw_params_set_rate_near failed"), \
341 PARA_ERROR(START_THRESHOLD, "snd_pcm_sw_params_set_start_threshold() failed"), \
342 PARA_ERROR(STOP_THRESHOLD, "snd_pcm_sw_params_set_stop_threshold() failed"), \
343 PARA_ERROR(ALSA_LOG, "snd_output_stdio_attach() failed"), \
344
345
346 #define FILE_WRITER_ERRORS \
347 PARA_ERROR(FW_WRITE, "file writer write error"), \
348 PARA_ERROR(FW_OPEN, "file writer: can not open output file"), \
349
350 #define WRITE_COMMON_ERRORS \
351 PARA_ERROR(WRITE_COMMON_SYNTAX, "syntax error in write option"), \
352
353 #define AACDEC_ERRORS \
354 PARA_ERROR(AACDEC_INIT, "failed to init aac decoder"), \
355 PARA_ERROR(AAC_DECODE, "aac decode error"), \
356
357 /* these do not need error handling (yet) */
358 #define SERVER_ERRORS
359 #define WAV_ERRORS
360 #define COMPRESS_ERRORS
361 #define TIME_ERRORS
362 #define CLOSE_ON_FORK_ERRORS
363 #define DAEMON_ERRORS
364 #define ORTP_SEND_ERRORS
365 #define GUI_ERRORS
366 #define RINGBUFFER_ERRORS
367
368
369 /**
370 * the subsystem shift
371 *
372 * 255 error codes ought to be enough for every subsystem. Use the higher bits
373 * of the return value to encode the subsystem number
374 */
375 #define SS_SHIFT 8
376
377 /**
378 * compute the subsystem offset
379 *
380 * It is given by x * 2**8 where \a x is the subsystem number
381 */
382 #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT)
383
384 /**
385 * make the enum of all errors of one subsystem
386 *
387 * As zero should not be an error, we define a dummy enum entry with value
388 * 2**ss. That lets the real errors start at 2**ss + 1.
389 */
390 #define SS_ENUM(ss) enum {\
391 E_ ## ss ## _DUMMY = SS_OFFSET(ss), \
392 ss ## _ERRORS}
393
394 /**
395 * determine the subsystem number from the error number
396 *
397 * Easy, it's just \a num / 2**8.
398 */
399 #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT)
400
401 /**
402 * determine the index of an error number
403 *
404 * Also easy: It's the lower 8 bits of num - 1.
405 */
406 #define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & ((num) - 1))
407
408 /**
409 * paraslash's version of strerror(3)
410 *
411 * expands to the error text of \a num (a string constant).
412 */
413 #define PARA_STRERROR(num) para_errlist[ERRNUM_TO_SS(num)] [ERRNUM_TO_INDEX(num)]
414
415 /**
416 * define the error list for one subsystem
417 *
418 * Used by macros in config.h (generated by configure)
419 */
420 #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {ss ## _ERRORS}
421
422 /**
423 * activate errors for one subsystem.
424 *
425 * Each executable needs only the error lists of those subssystems it is actually
426 * linked with. We always reserve zeroed-out space for NUM_SS char ** pointers, but
427 * only init those of the needed subsystems. This macro is used by macros in config.h
428 * (generated by configure).
429 */
430 #define PARA_ERRLIST(ss) [SS_ ## ss] = ss ## _ERRLIST
431
432 /**
433 * This is temporarily defined to expand to its second argument (prefixed by
434 * 'E_') and gets later redefined to expand to the error text only
435 */
436 #define PARA_ERROR(err, msg) E_ ## err
437
438 /** \cond popcorn time */
439 SS_ENUM(ORTP_RECV);
440 SS_ENUM(NET);
441 SS_ENUM(RECV);
442 SS_ENUM(AUDIOD);
443 SS_ENUM(EXEC);
444 SS_ENUM(CLOSE_ON_FORK);
445 SS_ENUM(SIGNAL);
446 SS_ENUM(STRING);
447 SS_ENUM(DAEMON);
448 SS_ENUM(STAT);
449 SS_ENUM(TIME);
450 SS_ENUM(GRAB_CLIENT);
451 SS_ENUM(HTTP_RECV);
452 SS_ENUM(RECV_COMMON);
453 SS_ENUM(FILTER_CHAIN);
454 SS_ENUM(WAV);
455 SS_ENUM(COMPRESS);
456 SS_ENUM(OGGDEC);
457 SS_ENUM(MP3DEC);
458 SS_ENUM(AACDEC);
459 SS_ENUM(FILTER);
460 SS_ENUM(MP3);
461 SS_ENUM(OGG);
462 SS_ENUM(AAC_AFH);
463 SS_ENUM(AAC_COMMON);
464 SS_ENUM(SERVER);
465 SS_ENUM(AFS);
466 SS_ENUM(COMMAND);
467 SS_ENUM(RANDOM_SELECTOR);
468 SS_ENUM(PLAYLIST_SELECTOR);
469 SS_ENUM(CRYPT);
470 SS_ENUM(HTTP_SEND);
471 SS_ENUM(ORTP_SEND);
472 SS_ENUM(DB);
473 SS_ENUM(MYSQL_SELECTOR);
474 SS_ENUM(IPC);
475 SS_ENUM(DCCP);
476 SS_ENUM(DCCP_RECV);
477 SS_ENUM(DCCP_SEND);
478 SS_ENUM(FD);
479 SS_ENUM(GUI);
480 SS_ENUM(WRITE);
481 SS_ENUM(WRITE_COMMON);
482 SS_ENUM(ALSA_WRITER);
483 SS_ENUM(FILE_WRITER);
484 SS_ENUM(RINGBUFFER);
485 /** \endcond */
486 #undef PARA_ERROR
487 /* rest of the world only sees the error text */
488 #define PARA_ERROR(err, msg) msg