X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=error.h;h=7c146da2076ae74d896bb82a0e931d8b5b6f49f5;hb=6bbc7c29dd69ed34ef90dac72951abbfd7cc1877;hp=8f4f9bb134027956fbd438cd102be3fe5d1bea7e;hpb=550d8e7098d76dc2cfe050401ed28b3e4c69bf87;p=paraslash.git

diff --git a/error.h b/error.h
index 8f4f9bb1..7c146da2 100644
--- a/error.h
+++ b/error.h
@@ -2,6 +2,7 @@
 
 /** \file error.h List of error codes and messages. */
 
+/** \cond para_error */
 /** Codes and messages. */
 #define PARA_ERRORS \
 	PARA_ERROR(SUCCESS, "success"), \
@@ -13,7 +14,6 @@
 	PARA_ERROR(AFS_SHORT_READ, "short read from afs socket"), \
 	PARA_ERROR(AFS_SIGNAL, "afs caught deadly signal"), \
 	PARA_ERROR(AFS_SOCKET, "afs socket not writable"), \
-	PARA_ERROR(AFT_SYNTAX, "audio file table syntax error"), \
 	PARA_ERROR(ALSA, "alsa error"), \
 	PARA_ERROR(ALSA_MIX_GET_VAL, "could not read control element state"), \
 	PARA_ERROR(ALSA_MIX_OPEN, "could not open mixer"), \
@@ -30,7 +30,6 @@
 	PARA_ERROR(AO_OPEN_LIVE, "ao: could not open audio device"), \
 	PARA_ERROR(AO_PLAY, "ao_play() failed"), \
 	PARA_ERROR(AO_PTHREAD, "pthread error"), \
-	PARA_ERROR(ARG_NOT_FOUND, "argument not found in arg vector"), \
 	PARA_ERROR(ASN1_PARSE, "could not parse ASN.1 key"), \
 	PARA_ERROR(ATOI_JUNK_AT_END, "further characters after number"), \
 	PARA_ERROR(ATOI_NO_DIGITS, "no digits found in string"), \
@@ -52,7 +51,6 @@
 	PARA_ERROR(BAD_CT, "invalid chunk table or bad FEC configuration"), \
 	PARA_ERROR(BAD_FEATURE, "invalid feature request"), \
 	PARA_ERROR(BAD_FEC_HEADER, "invalid fec header"), \
-	PARA_ERROR(BAD_LL, "invalid loglevel"), \
 	PARA_ERROR(BAD_PATH, "invalid path"), \
 	PARA_ERROR(BAD_PRIVATE_KEY, "invalid private key"), \
 	PARA_ERROR(BAD_SAMPLE_FORMAT, "sample format not supported"), \
@@ -83,6 +81,7 @@
 	PARA_ERROR(EMPTY, "file is empty"), \
 	PARA_ERROR(ENCRYPT, "encrypt error"), \
 	PARA_ERROR(EOF, "end of file"), \
+	PARA_ERROR(EOP, "end of playlist"), \
 	PARA_ERROR(FEC_BAD_IDX, "invalid index vector"), \
 	PARA_ERROR(FECDEC_EOF, "received eof packet"), \
 	PARA_ERROR(FECDEC_OVERRUN, "fecdec output buffer overrun"), \
@@ -132,19 +131,17 @@
 	PARA_ERROR(MAKESOCK, "makesock error"), \
 	PARA_ERROR(MAX_CLIENTS, "maximal number of clients exceeded"), \
 	PARA_ERROR(MISSING_COLON, "syntax error: missing colon"), \
-	PARA_ERROR(MOOD_SYNTAX, "mood syntax error"), \
 	PARA_ERROR(MOOD_PARSE, "mood parse error"), \
 	PARA_ERROR(MP3DEC_CORRUPT, "too many corrupt frames"), \
 	PARA_ERROR(MP3DEC_EOF, "mp3dec: end of file"), \
 	PARA_ERROR(MP3_INFO, "could not read mp3 info"), \
-	PARA_ERROR(MP4FF_BAD_CHANNEL_COUNT, "mp4ff: invalid number of channels"), \
-	PARA_ERROR(MP4FF_BAD_SAMPLE, "mp4ff: invalid sample number"), \
-	PARA_ERROR(MP4FF_BAD_SAMPLERATE, "mp4ff: invalid sample rate"), \
-	PARA_ERROR(MP4FF_BAD_SAMPLE_COUNT, "mp4ff: invalid number of samples"), \
-	PARA_ERROR(MP4FF_META_READ, "mp4ff: could not read mp4 metadata"), \
-	PARA_ERROR(MP4FF_META_WRITE, "mp4ff: could not update mp4 metadata"), \
-	PARA_ERROR(MP4FF_OPEN, "mp4ff: open failed"), \
-	PARA_ERROR(MP4FF_TRACK, "mp4ff: no audio track"), \
+	PARA_ERROR(MP4_READ, "mp4: read error or unexpected end of file"), \
+	PARA_ERROR(MP4_CORRUPT, "invalid/corrupt mp4 file"), \
+	PARA_ERROR(MP4_BAD_SAMPLE, "mp4: invalid sample number"), \
+	PARA_ERROR(MP4_BAD_SAMPLERATE, "mp4: invalid sample rate"), \
+	PARA_ERROR(MP4_BAD_SAMPLE_COUNT, "mp4: invalid number of samples"), \
+	PARA_ERROR(MP4_TRACK, "mp4: no audio track"), \
+	PARA_ERROR(MP4_MISSING_ATOM, "mp4: essential atom not found"), \
 	PARA_ERROR(MPI_SCAN, "could not scan multi-precision integer"), \
 	PARA_ERROR(NAME_TOO_LONG, "name too long for struct sockaddr_un"), \
 	PARA_ERROR(NO_AFHI, "audio format handler info required"), \
@@ -152,7 +149,6 @@
 	PARA_ERROR(NO_AUDIO_FILE, "no audio file"), \
 	PARA_ERROR(NOFD, "did not receive open fd from afs"), \
 	PARA_ERROR(NO_MATCH, "no matches"), \
-	PARA_ERROR(NO_MOOD, "no mood available"), \
 	PARA_ERROR(NO_MORE_SLOTS, "no more empty slots"), \
 	PARA_ERROR(NOT_PLAYING, "not playing"), \
 	PARA_ERROR(NO_VALID_FILES, "no valid file found in playlist"), \
@@ -165,16 +161,14 @@
 	PARA_ERROR(OGGDEC_VERSION, "vorbis version mismatch"), \
 	PARA_ERROR(OGG_EMPTY, "no ogg pages found"), \
 	PARA_ERROR(OGG_PACKET_IN, "ogg_stream_packetin() failed"), \
-	PARA_ERROR(OGG_STREAM_FLUSH, "ogg_stream_flush() failed"), \
 	PARA_ERROR(OGG_SYNC, "internal ogg storage overflow"), \
+	PARA_ERROR(OPENSSH_PARSE, "could not parse openssh private key"), \
 	PARA_ERROR(OPUS_COMMENT, "invalid or corrupted opus comment"), \
 	PARA_ERROR(OPUS_DECODE, "opus decode error"), \
 	PARA_ERROR(OPUS_HEADER, "invalid opus header"), \
 	PARA_ERROR(OPUS_SET_GAIN, "opus: could not set gain"), \
 	PARA_ERROR(PATH_FOUND, ""), /* not really an error */ \
-	PARA_ERROR(PERM, "permission denied"), \
 	PARA_ERROR(PLAYLIST_EMPTY, "attempted to load empty playlist"), \
-	PARA_ERROR(PLAYLIST_LOADED, ""), /* not really an error */ \
 	PARA_ERROR(PREBUFFER_SUCCESS, "prebuffering complete"), \
 	PARA_ERROR(PRIVATE_KEY, "can not read private key"), \
 	PARA_ERROR(QUEUE, "packet queue overrun"), \
@@ -251,6 +245,14 @@
  * 'E_') and gets later redefined to expand to the error text only
  */
 #define PARA_ERROR(err, msg) E_ ## err
+/**
+ * Numeric error codes.
+ *
+ * Public functions which can fail return the negated value of one of the
+ * constants defined here to indicate the cause of the error.
+ *
+ * \sa \ref para_strerror().
+ */
 enum para_error_codes {PARA_ERRORS};
 #undef PARA_ERROR
 #define PARA_ERROR(err, msg) msg
@@ -258,6 +260,7 @@ enum para_error_codes {PARA_ERRORS};
 extern const char * const para_errlist[];
 /** Exactly one .c file per executable must define the array. */
 #define DEFINE_PARA_ERRLIST const char * const para_errlist[] = {PARA_ERRORS}
+/** \endcond para_error */
 
 /**
  * This bit indicates whether a number is considered a system error number
@@ -266,11 +269,10 @@ extern const char * const para_errlist[];
  */
 #define SYSTEM_ERROR_BIT 30
 
-/**
- * Like the SYSTEM_ERROR_BIT, but indicates an error from the osl library.
- */
+/** Like SYSTEM_ERROR_BIT, but for errors from the osl library. */
 #define OSL_ERROR_BIT 29
 
+/** Like SYSTEM_ERROR_BIT, but for errors from the lopsub library. */
 #define LLS_ERROR_BIT 28
 
 /** Check whether the system error bit is set. */