Only declare error codes that are safe to use.
[paraslash.git] / error.h
1 /*
2  * Copyright (C) 2006-2007 Andre Noll <maan@systemlinux.org>
3  *
4  * Licensed under the GPL v2. For licencing details see COPYING.
5  */
6
7 /** \file error.h list of error messages for all subsystems */
8
9 /** \cond */
10
11 /* list of all subsystems that use paraslash's error facility */
12 DEFINE_ERRLIST_OBJECT_ENUM;
13
14 /* these do not need error handling (yet) */
15 #define SERVER_ERRORS
16 #define CLIENT_ERRORS
17 #define WAV_ERRORS
18 #define COMPRESS_ERRORS
19 #define TIME_ERRORS
20 #define CLOSE_ON_FORK_ERRORS
21 #define DAEMON_ERRORS
22 #define ORTP_SEND_ERRORS
23 #define GUI_ERRORS
24 #define RINGBUFFER_ERRORS
25 #define SCORE_ERRORS
26 #define SHA1_ERRORS
27 #define RECV_ERRORS
28
29 extern const char **para_errlist[];
30
31 #define FSCK_ERRORS \
32         PARA_ERROR(FSCK_SYNTAX, "fsck syntax error"), \
33         PARA_ERROR(RANGE_VIOLATION, "range violation detected, very bad"), \
34         PARA_ERROR(NOT_A_REGULAR_FILE, "not a regular file"), \
35
36
37 #define OSL_ERRORS \
38         PARA_ERROR(BAD_DB_DIR, "invalid database directory"), \
39         PARA_ERROR(NO_COLUMN_DESC, "missing column description"), \
40         PARA_ERROR(BAD_NAME, "invalid name for a column/table"), \
41         PARA_ERROR(BAD_STORAGE_TYPE, "invalid storage type"), \
42         PARA_ERROR(BAD_STORAGE_FLAGS, "invalid storage flags"), \
43         PARA_ERROR(NO_COLUMN_NAME, "missing column name"), \
44         PARA_ERROR(NO_COLUMNS, "at least one column required"), \
45         PARA_ERROR(BAD_COLUMN_NAME, "invalid name for a table column"), \
46         PARA_ERROR(NO_UNIQUE_RBTREE_COLUMN, "need at least one mapped column with OSL_UNIQE and OSL_RBTREE OSL"), \
47         PARA_ERROR(NO_RBTREE_COL, "at least one column needs an rbtree"), \
48         PARA_ERROR(DUPLICATE_COL_NAME, "column name given twice"), \
49         PARA_ERROR(BAD_STORAGE_SIZE, "invalid storage size"), \
50         PARA_ERROR(NO_COMPARE_FUNC, "missing compare function"), \
51         PARA_ERROR(BAD_DATA_SIZE, "wrong data size for fixed-size column"), \
52         PARA_ERROR(NOT_MAPPED, "file not mapped"), \
53         PARA_ERROR(ALREADY_MAPPED, "file already mapped"), \
54         PARA_ERROR(BAD_SIZE, "invalid size specified"), \
55         PARA_ERROR(TRUNC, "failed to truncate file"), \
56         PARA_ERROR(UNLINK, "failed to remove file"), \
57         PARA_ERROR(BAD_TABLE, "table not open"), \
58         PARA_ERROR(BAD_TABLE_DESC, "invalid table description"), \
59         PARA_ERROR(RB_KEY_EXISTS, "key already exists in rbtree"), \
60         PARA_ERROR(RB_KEY_NOT_FOUND, "key not found in rbtree"), \
61         PARA_ERROR(BAD_ROW_NUM, "invalid row number"), \
62         PARA_ERROR(INDEX_CORRUPTION, "index corruption detected"), \
63         PARA_ERROR(INVALID_OBJECT, "reference to invalid object"), \
64         PARA_ERROR(STAT, "can not stat file"), \
65         PARA_ERROR(FSTAT, "fstat error"), \
66         PARA_ERROR(RENAME, "rename failed"), \
67         PARA_ERROR(EMPTY, "file empty"), \
68         PARA_ERROR(MMAP, "mmap error"), \
69         PARA_ERROR(MUNMAP, "munmap failed"), \
70         PARA_ERROR(WRITE, "write error"), \
71         PARA_ERROR(LSEEK, "lseek error"), \
72         PARA_ERROR(BUSY, "table is busy"), \
73         PARA_ERROR(SHORT_TABLE, "table too short"), \
74         PARA_ERROR(NO_MAGIC, "missing table header magic"), \
75         PARA_ERROR(VERSION_MISMATCH, "table version not suppoerted"), \
76         PARA_ERROR(BAD_COLUMN_NUM, "invalid column number"), \
77         PARA_ERROR(BAD_TABLE_FLAGS, "invalid flags in table description"), \
78         PARA_ERROR(BAD_ROW, "invalid row"), \
79
80
81 #define RBTREE_ERRORS \
82
83
84 #define AFS_ERRORS \
85         PARA_ERROR(BAD_TABLE_NAME, "invalid table"), \
86         PARA_ERROR(INPUT_TOO_LARGE, "input too large for stdin command"), \
87         PARA_ERROR(READ, "read error"), \
88         PARA_ERROR(AFS_SYNTAX, "afs syntax error"), \
89         PARA_ERROR(AFS_SIGNAL, "afs caught deadly signal"), \
90
91
92 #define MOOD_ERRORS \
93         PARA_ERROR(MOOD_SYNTAX, "mood syntax error"), \
94         PARA_ERROR(MOOD_REGEX, "invalid regular expression"), \
95         PARA_ERROR(NO_MOOD, "no mood available"), \
96         PARA_ERROR(MOOD_LOADED, "mood loaded"), \
97         PARA_ERROR(MOOD_BUSY, "mood is in use"), \
98         PARA_ERROR(NOT_ADMISSIBLE, "file is not admussible"), \
99
100
101 #define ATTRIBUTE_ERRORS \
102         PARA_ERROR(ATTR_SYNTAX, "attribute syntax error"), \
103         PARA_ERROR(ATTR_EXISTS, "attribute already exists"), \
104         PARA_ERROR(ATTR_TABLE_FULL, "attribute table full"), \
105         PARA_ERROR(NO_ATTRIBUTES, "no attributes defined yet"), \
106
107 #define BLOB_ERRORS \
108         PARA_ERROR(BLOB_SYNTAX, "blob syntax error"), \
109         PARA_ERROR(DUMMY_ROW, "attempted to access blob dummy object"), \
110
111
112 #define PLAYLIST_ERRORS \
113         PARA_ERROR(PLAYLIST_SYNTAX, "playlist syntax error"), \
114         PARA_ERROR(NO_PLAYLIST, "no valid playlist found"), \
115         PARA_ERROR(PLAYLIST_LOADED, ""), /* not really an error */ \
116         PARA_ERROR(PLAYLIST_EMPTY, "attempted to load empty playlist"), \
117
118
119 #define AFT_ERRORS \
120         PARA_ERROR(BAD_AFSI, "invaid afs info"), \
121         PARA_ERROR(LOCALTIME, "localtime() failed"), \
122         PARA_ERROR(STRFTIME, "strftime() failed"), \
123         PARA_ERROR(BAD_PATH, "invalid path"), \
124         PARA_ERROR(BAD_SORT, "invalid sorting method"), \
125         PARA_ERROR(FNMATCH, "fnmatch error"), \
126         PARA_ERROR(NO_MATCH, "no matches"), \
127         PARA_ERROR(NO_AFHI, "audio format handler info required"), \
128         PARA_ERROR(AFT_SYNTAX, "audio file table syntax error"), \
129         PARA_ERROR(HASH_MISMATCH, "hash mismatch, consider re-add"), \
130
131
132 #define USER_LIST_ERRORS \
133         PARA_ERROR(USERLIST, "failed to open user list file"), \
134
135
136 #define OSX_WRITE_ERRORS \
137         PARA_ERROR(STREAM_FORMAT, "could not set stream format"), \
138         PARA_ERROR(ADD_CALLBACK, "can not add callback"), \
139         PARA_ERROR(OPEN_COMP, "OpenAComponent() error"), \
140         PARA_ERROR(UNIT_INIT, "AudioUnitInitialize() error"), \
141         PARA_ERROR(UNIT_START, "AudioUnitStart() error"), \
142         PARA_ERROR(DEFAULT_COMP, "can not find default audio output component"), \
143
144
145 #define AUDIOC_ERRORS \
146         PARA_ERROR(AUDIOC_SYNTAX, "audioc syntax error"), \
147         PARA_ERROR(AUDIOC_READ, "audioc read error"), \
148         PARA_ERROR(AUDIOC_WRITE, "audioc write error"), \
149         PARA_ERROR(INIT_SOCK_ADDR, "can not init socket"), \
150         PARA_ERROR(AUDIOC_CONNECT, "audioc connect error"), \
151         PARA_ERROR(AUDIOC_OVERRUN, "audioc buffer overrun"), \
152
153
154
155 #define CLIENT_COMMON_ERRORS \
156         PARA_ERROR(CLIENT_SYNTAX, "syntax error"), \
157         PARA_ERROR(INVALID_CHALLENGE, "did not receive valid challenge"), \
158         PARA_ERROR(NO_CONFIG, "config file not found"), \
159         PARA_ERROR(CLIENT_AUTH, "authentication failed"), \
160         PARA_ERROR(SERVER_EOF, "connection closed by para_server"), \
161         PARA_ERROR(INPUT_EOF, "end of input"), \
162         PARA_ERROR(HANDSHAKE_COMPLETE, ""), /* not really an error */ \
163
164
165 #define SCHED_ERRORS \
166         PARA_ERROR(TASK_KILLED, "task killed"), \
167         PARA_ERROR(NO_SUCH_TASK, "task not found"), \
168         PARA_ERROR(NOT_INITIALIZED, "scheduler not yet initialized"), \
169
170
171 #define STDIN_ERRORS \
172         PARA_ERROR(STDIN_READ, "failed to read from stdin"), \
173         PARA_ERROR(STDIN_EOF, "end of file"), \
174
175
176 #define STDOUT_ERRORS \
177         PARA_ERROR(STDOUT_WRITE, "failed to write to stdout"), \
178         PARA_ERROR(STDOUT_EOF, "end of file"), \
179
180
181 #define NET_ERRORS \
182         PARA_ERROR(SEND, "send error"), \
183         PARA_ERROR(RECV, "receive error"), \
184         PARA_ERROR(SOCKET, "socket error"), \
185         PARA_ERROR(CONNECT, "connect error"), \
186         PARA_ERROR(ACCEPT, "accept error"), \
187         PARA_ERROR(SETSOCKOPT, "failed to set socket options"), \
188         PARA_ERROR(BIND, "bind error"), \
189         PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
190         PARA_ERROR(CHMOD, "failed to set socket mode"), \
191         PARA_ERROR(SENDMSG, "sendmsg() failed"), \
192         PARA_ERROR(RECVMSG, "recvmsg() failed"), \
193         PARA_ERROR(SCM_CREDENTIALS, "did not receive SCM credentials"), \
194         PARA_ERROR(LISTEN, "listen error"), \
195         PARA_ERROR(RECV_PATTERN, "did not receive expected pattern"), \
196         PARA_ERROR(HOST_INFO, "gethostbyname() failed"), \
197
198
199 #define ORTP_RECV_ERRORS \
200         PARA_ERROR(MSG_TO_BUF, "failed to extract rtp packet"), \
201         PARA_ERROR(ORTP_SYNTAX, "ottp syntax error"), \
202         PARA_ERROR(TOO_MANY_BAD_CHUNKS, "too many consecutive bad chunks"), \
203         PARA_ERROR(INVALID_HEADER, "invalid header packet"), \
204         PARA_ERROR(OVERRUN, "outout buffer overrun"), \
205         PARA_ERROR(ORTP_RECV_EOF, "ortp_recv: end of file"), \
206
207
208 #define HTTP_RECV_ERRORS \
209         PARA_ERROR(HTTP_RECV_EOF, "http_recv: end of file"), \
210         PARA_ERROR(HTTP_RECV_OVERRUN, "http_recv: outout buffer overrun"), \
211
212 #define RECV_COMMON_ERRORS \
213         PARA_ERROR(RECV_SYNTAX, "recv syntax error"), \
214
215
216 #define AUDIOD_ERRORS \
217         PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
218         PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
219         PARA_ERROR(UNSUPPORTED_AUDIO_FORMAT, "given audio format not supported"), \
220         PARA_ERROR(SIGNAL_CAUGHT, "caught signal"), \
221
222
223 #define AUDIOD_COMMAND_ERRORS \
224         PARA_ERROR(CLIENT_WRITE, "client write error"), \
225         PARA_ERROR(AUDIOD_SYNTAX, "syntax error"), \
226         PARA_ERROR(UCRED_PERM, "permission denied"), \
227         PARA_ERROR(INVALID_AUDIOD_CMD, "invalid command"), \
228
229
230 #define FILTER_CHAIN_ERRORS \
231         PARA_ERROR(UNSUPPORTED_FILTER, "given filter not supported"), \
232         PARA_ERROR(BAD_FILTER_OPTIONS, "invalid filter option given"), \
233         PARA_ERROR(FC_EOF, "filter chain: eof"), \
234
235
236 #define STAT_ERRORS \
237         PARA_ERROR(TOO_MANY_CLIENTS, "maximal number of stat clients exceeded"), \
238         PARA_ERROR(UNKNOWN_STAT_ITEM, "status item not recognized"), \
239
240
241 #define OGGDEC_ERRORS \
242         PARA_ERROR(OGGDEC_READ, "read from media returned an error"), \
243         PARA_ERROR(OGGDEC_NOTVORBIS, "bitstream is not vorbis data"), \
244         PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
245         PARA_ERROR(OGGDEC_BADHEADER, "invalid vorbis bitstream header"), \
246         PARA_ERROR(OGGDEC_FAULT, "bug or heap/stack corruption"), \
247         PARA_ERROR(OGGDEC_BADLINK, "invalid stream section or requested link corrupt"), \
248
249
250 #define GRAB_CLIENT_ERRORS \
251         PARA_ERROR(PEDANTIC_GRAB, "fd not ready and pedantic grab requested"), \
252         PARA_ERROR(GC_WRITE, "grab client write error"), \
253         PARA_ERROR(BAD_GC_SLOT, "invalid slot requested by grab client"), \
254         PARA_ERROR(BAD_GC_FILTER_NUM, "invalid filter number given"), \
255         PARA_ERROR(GC_SYNTAX, "grab client syntax error"), \
256         PARA_ERROR(GC_HELP_GIVEN, ""), /* not really an error */ \
257         PARA_ERROR(GC_VERSION_GIVEN, ""), /* not really an error */ \
258
259
260 #define MP3DEC_ERRORS \
261         PARA_ERROR(MAD_FRAME_DECODE, "mad frame decode error"), \
262         PARA_ERROR(MP3DEC_OVERRUN, "mp3 output buffer overrun"), \
263
264
265 #define FILTER_ERRORS \
266         PARA_ERROR(NO_FILTERS, "at least one filter must be given"), \
267         PARA_ERROR(FILTER_SYNTAX, "syntax error"), \
268
269
270 #define SIGNAL_ERRORS \
271         PARA_ERROR(SIGNAL_SIG_ERR, "signal() retured SIG_ERR"), \
272         PARA_ERROR(SIGNAL_READ, "read error from signal pipe"), \
273         PARA_ERROR(WAITPID, "waitpid error"), \
274         PARA_ERROR(SIGNAL_PIPE, "failed to setup signal pipe"), \
275
276
277 #define STRING_ERRORS \
278         PARA_ERROR(MKSTEMP, "mkstemp error: unable to create tmp file"), \
279         PARA_ERROR(FCHMOD, "fchmod error: can not set mode"), \
280         PARA_ERROR(ATOI_OVERFLOW, "value too large"), \
281         PARA_ERROR(STRTOLL, "unknown strtoll error"), \
282         PARA_ERROR(ATOI_NO_DIGITS, "no digits found in string"), \
283         PARA_ERROR(ATOI_JUNK_AT_END, "further characters after number"), \
284
285
286 #define EXEC_ERRORS \
287         PARA_ERROR(DUP_PIPE, "exec error: can not create pipe"), \
288         PARA_ERROR(NULL_OPEN, "can not open /dev/null"), \
289
290
291 #define MP3_AFH_ERRORS \
292         PARA_ERROR(FRAME, "invalid mp3 frame"), \
293         PARA_ERROR(FRAME_LENGTH, "invalid frame length"), \
294         PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
295         PARA_ERROR(HEADER_FREQ, "invalid header frequency"), \
296         PARA_ERROR(HEADER_BITRATE, "invalid header bitrate"), \
297
298
299 #define AAC_AFH_ERRORS \
300         PARA_ERROR(STSZ, "did not find stcz atom"), \
301         PARA_ERROR(MP4ASC, "audio spec config error"), \
302         PARA_ERROR(AAC_AFH_INIT, "failed to init aac decoder"), \
303
304
305 #define AAC_COMMON_ERRORS \
306         PARA_ERROR(ESDS, "did not find esds atom"), \
307         PARA_ERROR(STCO, "did not find stco atom"), \
308
309
310 #define OGG_AFH_ERRORS \
311         PARA_ERROR(OGG_READ, "ogg read error"), \
312         PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \
313         PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \
314         PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \
315         PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \
316         PARA_ERROR(OGG_INFO, "ov_info error"), \
317         PARA_ERROR(OGG_VERSION, "unsupported ogg version"), \
318         PARA_ERROR(OGG_BAD_HEADER, "invalid ogg vorbis header"), \
319         PARA_ERROR(OGG_UNKNOWN_ERROR, "unknown ogg vorbis error"), \
320
321
322 #define VSS_ERRORS \
323         PARA_ERROR(BAD_AUDIO_FILE_SUFFIX, "unknown suffix"), \
324         PARA_ERROR(AUDIO_FORMAT, "audio format not recognized"), \
325         PARA_ERROR(CHUNK, "unable to get chunk"), \
326
327
328 #define AFS_COMMON_ERRORS \
329         PARA_ERROR(GETCWD, "can not get current working directory"), \
330         PARA_ERROR(LSTAT, "lstat error"), \
331
332
333 #define CRYPT_ERRORS \
334         PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
335         PARA_ERROR(PUBLIC_KEY, "can not read public key"), \
336         PARA_ERROR(RSA, "RSA error"), \
337         PARA_ERROR(ENCRYPT, "encrypt error"), \
338         PARA_ERROR(DECRYPT, "decrypt error"), \
339         PARA_ERROR(CHALLENGE, "failed to read challenge"), \
340
341
342 #define HTTP_SEND_ERRORS \
343         PARA_ERROR(WRITE_OK, "can not check whether fd is writable"), \
344         PARA_ERROR(SEND_QUEUED_CHUNK, "failed to send queued chunk"), \
345
346
347 #define RANDOM_SELECTOR_ERRORS \
348         PARA_ERROR(NOTHING_FOUND, "no audio files found"), \
349
350
351 #define MYSQL_SELECTOR_ERRORS \
352         PARA_ERROR(MYSQL_SYNTAX, "mysql syntax error"), \
353         PARA_ERROR(NOTCONN, "not connected to mysql server"), \
354         PARA_ERROR(TOOBIG, "mysql: file too large"), \
355         PARA_ERROR(NAMETOOLONG, "mysql: name too long"), \
356         PARA_ERROR(QFAILED, "mysql query failed"), \
357         PARA_ERROR(NOROW, "row is NULL"), \
358         PARA_ERROR(NOATTS, "can not get attributes from mysql table"), \
359         PARA_ERROR(NORESULT, "error while fetching mysql result"), \
360         PARA_ERROR(EMPTY_RESULT, "result is empty"), \
361         PARA_ERROR(ESCAPE, "can not escape string"), \
362         PARA_ERROR(GET_AUDIO_FILE, "can not get current audio file"), \
363         PARA_ERROR(GET_STREAM, "can not get current stream"), \
364         PARA_ERROR(NO_STREAM, "no such stream"), \
365         PARA_ERROR(AUDIO_FILE, "no such audio file"), \
366         PARA_ERROR(GET_QUERY, "can not get query for specified stream"), \
367         PARA_ERROR(TMPFILE, "error while writing temporary file"), \
368         PARA_ERROR(META, "can not get meta data"), \
369         PARA_ERROR(MYSQL_INIT, "can not initialize mysql connection"), \
370         PARA_ERROR(NO_MYSQL_PASSWD, "fatal: no mysql passord given"), \
371         PARA_ERROR(NO_AF_DIR, "fatal: audio file directory not given"), \
372
373
374 #define COMMAND_ERRORS \
375         PARA_ERROR(COMMAND_SYNTAX, "syntax error in command"), \
376         PARA_ERROR(AUTH, "did not receive auth request"), \
377         PARA_ERROR(BAD_SELECTOR, "no such audio file selector"), \
378         PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
379         PARA_ERROR(BAD_CMD, "invalid command"), \
380         PARA_ERROR(PERM, "permission denied"), \
381         PARA_ERROR(LOCK, "lock error"), \
382         PARA_ERROR(SENDER_CMD, "command not supported by this sender"), \
383         PARA_ERROR(SERVER_CRASH, "para_server crashed -- can not live without it"), \
384         PARA_ERROR(BAD_USER, "you don't exist. Go away."), \
385
386
387 #define PLAYLIST_SELECTOR_ERRORS \
388         PARA_ERROR(LOAD_PLAYLIST, "failed to load playlist"), \
389
390
391 #define IPC_ERRORS \
392         PARA_ERROR(SEM_GET, "failed to create semaphore"), \
393         PARA_ERROR(SEM_REMOVE, "can not remove semaphore"), \
394         PARA_ERROR(SHM_GET, "failed to allocate shared memory area"), \
395         PARA_ERROR(SHM_DESTROY, "failed to destroy shared memory area"), \
396         PARA_ERROR(SHM_ATTACH, "can not attach shared memory area"), \
397         PARA_ERROR(SHM_DETACH, "can not detach shared memory area"), \
398
399
400 #define DCCP_ERRORS \
401         PARA_ERROR(DCCP_SOCKET, "can not create dccp socket"), \
402
403
404 #define DCCP_RECV_ERRORS \
405         PARA_ERROR(ADDR_INFO, "getaddrinfo error"), \
406         PARA_ERROR(DCCP_OVERRUN, "dccp output buffer buffer overrun"), \
407         PARA_ERROR(DCCP_CONNECT, "dccp connect error"), \
408         PARA_ERROR(DCCP_RECV_EOF, "dccp_recv: end of file"), \
409
410
411 #define DCCP_SEND_ERRORS \
412         PARA_ERROR(DCCP_BIND, "dccp bind error"), \
413         PARA_ERROR(DCCP_LISTEN, "dccp listen error"), \
414         PARA_ERROR(DCCP_WRITE, "dccp write error"), \
415
416
417 #define FD_ERRORS \
418         PARA_ERROR(NOTDIR, "error: not a directory"), \
419         PARA_ERROR(F_GETFL, "failed to get fd flags"), \
420         PARA_ERROR(F_SETFL, "failed to set fd flags"), \
421         PARA_ERROR(FGETS, "fgets error"), \
422         PARA_ERROR(EXIST, "file or directory already exists"), \
423         PARA_ERROR(ISDIR, "error: is a directory"), \
424         PARA_ERROR(NOENT, "no such file or directory"), \
425         PARA_ERROR(OPEN_PERM, "open error (permission denied)"), \
426         PARA_ERROR(MKDIR_PERM, "mkdir error (permission denied)"), \
427         PARA_ERROR(MKDIR, "failed to create directory"), \
428         PARA_ERROR(CHDIR, "failed to change directory"), \
429         PARA_ERROR(FCHDIR, "fchdir failed"), \
430         PARA_ERROR(OPENDIR, "can not open directory"), \
431         PARA_ERROR(NOSPC, "no space left on device"), \
432         PARA_ERROR(OPEN, "failed to open file"), \
433         PARA_ERROR(CHDIR_PERM, "insufficient permissions to chdir"), \
434
435
436 #define WRITE_ERRORS \
437         PARA_ERROR(WRITE_SYNTAX, "para_write syntax error"), \
438         PARA_ERROR(PREMATURE_END, "premature end of audio file"), \
439         PARA_ERROR(NO_WAV_HEADER, "wave header not found"), \
440         PARA_ERROR(WAV_HEADER_SUCCESS, "successfully read wave header"), \
441         PARA_ERROR(NO_DELAY, "no initial delay"), \
442         PARA_ERROR(DELAY_TIMEOUT, "initial delay timeout"), \
443
444
445 #define ALSA_WRITE_ERRORS \
446         PARA_ERROR(BROKEN_CONF, "Broken alsa configuration"), \
447         PARA_ERROR(ACCESS_TYPE, "alsa access type not available"), \
448         PARA_ERROR(SAMPLE_FORMAT, "sample format not available"), \
449         PARA_ERROR(CHANNEL_COUNT, "channels count not available"), \
450         PARA_ERROR(HW_PARAMS, "unable to install hw params"), \
451         PARA_ERROR(SW_PARAMS, "unable to install sw params"), \
452         PARA_ERROR(BAD_PERIOD, "can not use period equal to buffer size"), \
453         PARA_ERROR(GET_XFER, "unable to obtain xfer align"), \
454         PARA_ERROR(SET_XFER, "snd_pcm_sw_params_set_xfer_align() failed"), \
455         PARA_ERROR(ALSA_WRITE, "alsa write error"), \
456         PARA_ERROR(PCM_OPEN, "unable to open pcm"), \
457         PARA_ERROR(SND_PCM_INFO, "pcm info error"), \
458         PARA_ERROR(GET_BUFFER_TIME, "snd_pcm_hw_params_get_buffer_time_max() failed"), \
459         PARA_ERROR(SET_BUFFER_TIME, "snd_pcm_hw_params_set_buffer_time_near() failed"), \
460         PARA_ERROR(SET_RATE, "snd_pcm_hw_params_set_rate_near failed"), \
461         PARA_ERROR(START_THRESHOLD, "snd_pcm_sw_params_set_start_threshold() failed"), \
462         PARA_ERROR(STOP_THRESHOLD, "snd_pcm_sw_params_set_stop_threshold() failed"), \
463
464
465 #define FILE_WRITE_ERRORS \
466         PARA_ERROR(FW_WRITE, "file writer write error"), \
467         PARA_ERROR(FW_OPEN, "file writer: can not open output file"), \
468         PARA_ERROR(FW_NO_FILE, "task started without open file"), \
469
470
471 #define WRITE_COMMON_ERRORS \
472         PARA_ERROR(WRITE_COMMON_SYNTAX, "syntax error in write option"), \
473         PARA_ERROR(WNG_EOF, "wng: end of file"), \
474
475
476 #define AACDEC_ERRORS \
477         PARA_ERROR(AACDEC_INIT, "failed to init aac decoder"), \
478         PARA_ERROR(AAC_DECODE, "aac decode error"), \
479         PARA_ERROR(AAC_OVERRUN, "aac output buffer overrun"), \
480
481
482 #define CHUNK_QUEUE_ERRORS \
483         PARA_ERROR(QUEUE, "packet queue overrun"), \
484
485 /** \endcond */
486
487 /**
488  * the subsystem shift
489  *
490  * 255 error codes ought to be enough for every subsystem. Use the higher bits
491  * of the return value to encode the subsystem number
492  */
493 #define SS_SHIFT 8
494
495 /**
496  * compute the subsystem offset
497  *
498  * It is given by x * 2**8 where \a x is the subsystem number
499  */
500 #define SS_OFFSET(ss) (SS_ ## ss << SS_SHIFT)
501
502 /**
503  * make the enum of all errors of one subsystem
504  *
505  * As zero should not be an error, we define a dummy enum entry with value
506  * 2**ss. That lets the real errors start at 2**ss + 1.
507  */
508 #define SS_ENUM(ss) enum {\
509         E_ ## ss ## _DUMMY = SS_OFFSET(ss), \
510         ss ## _ERRORS}
511
512 /**
513  * determine the subsystem number from the error number
514  *
515  * Easy, it's just \a num / 2**8.
516  */
517 #define ERRNUM_TO_SS(num) ((num) >> SS_SHIFT)
518
519 /**
520  * determine the index of an error number
521  *
522  * Also easy: It's the lower 8 bits of num.
523  */
524 #define ERRNUM_TO_INDEX(num) (((1 << SS_SHIFT) - 1) & (num))
525
526 /**
527  * paraslash's version of strerror(3)
528  *
529  * expands to the error text of \a num (a string constant).
530  */
531 #define PARA_STRERROR(num) para_errlist[ERRNUM_TO_SS(num)] [ERRNUM_TO_INDEX(num)]
532
533 /**
534  * define the error list for one subsystem
535  #
536  * The first entry (index 0) is always the name of the subsystem
537  * Used by macros in config.h (generated by configure)
538  */
539 #define DEFINE_ERRLIST(ss) const char * ss ## _ERRLIST[] = {#ss, ss ## _ERRORS}
540
541 /**
542  * activate errors for one subsystem.
543  *
544  * Each executable needs only the error lists of those subssystems it is
545  * actually linked with. We always reserve space for NUM_SS char ** pointers,
546  * but only init those of the needed subsystems. This macro is used by macros
547  * in config.h (generated by configure).
548  */
549 #define PARA_ERRLIST(ss) [SS_ ## ss] = ss ## _ERRLIST
550
551 /**
552  * This is temporarily defined to expand to its first argument (prefixed by
553  * 'E_') and gets later redefined to expand to the error text only
554  */
555 #define PARA_ERROR(err, msg) E_ ## err
556 #include "error2.h"
557 #undef PARA_ERROR
558 /* rest of the world only sees the error text */
559 #define PARA_ERROR(err, msg) msg