X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=oggdec.c;h=b82f12ef8b994c605cb7f1699e0923d41738d365;hp=54586b581da2b061bde62cf7a55e60a8deaffea6;hb=d04dd06c4553ae3e1a6ead0e427f0f03836d0cd0;hpb=471684761a2039bbc89aa1e3c33c62de6bef86cf

diff --git a/oggdec.c b/oggdec.c
index 54586b58..b82f12ef 100644
--- a/oggdec.c
+++ b/oggdec.c
@@ -1,10 +1,10 @@
 /*
- * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file oggdec.c paraslash's ogg vorbis decoder */
+/** \file oggdec.c Paraslash's ogg vorbis decoder. */
 
 #include "para.h"
 
@@ -17,25 +17,22 @@
 
 #include <vorbis/vorbisfile.h>
 
-/** \cond some internal constants */
-#define BITS 16
+/** Determine byte sex. */
 #ifdef WORDS_BIGENDIAN
 #define ENDIAN 1
 #else
 #define ENDIAN 0
 #endif
-#define SIGN 1
-/** \endcond */
 
-/** data specific to the oggdec filter */
+/** Data specific to the oggdec filter. */
 struct private_oggdec_data {
-	/** describes an ogg vorbis file */
+	/** Describes an ogg vorbis file. */
 	OggVorbis_File *vf;
-	/** the input buffer */
+	/** The input buffer. */
 	char *inbuf;
-	/** the length of \a inbuf */
+	/** The length of \a inbuf. */
 	size_t inbuf_len;
-	/** the number of bytes consumed from the input buffer */
+	/** The number of bytes consumed from the input buffer. */
 	size_t converted;
 };
 
@@ -49,7 +46,7 @@ static size_t cb_read(void *buf, size_t size, size_t nmemb, void *datasource)
 //	PARA_DEBUG_LOG("pod = %p\n", pod);
 //	PARA_DEBUG_LOG("vorbis requests %d bytes, have %d\n", size * nmemb, have);
 	if (pod->inbuf_len < size) {
-		if (*fn->fc->input_eof)
+		if (*fn->fc->input_error)
 			return 0;
 		errno = EAGAIN;
 		return (size_t)-1;
@@ -61,7 +58,8 @@ static size_t cb_read(void *buf, size_t size, size_t nmemb, void *datasource)
 }
 
 /*
- * cb_seek -- custom data seeking function
+ * Custom data seeking function.
+ *
  * Since we want the data source to be treated as unseekable at all
  * times, the provided seek callback always returns -1 (failure).
  */
@@ -81,8 +79,8 @@ static const ov_callbacks ovc = {
 	.seek_func = cb_seek,
 	.close_func = cb_close,
 	/*
-	 * The tell function need not be provided if
-	 * the data IO abstraction is not seekable
+	 * The tell function need not be provided if the data IO abstraction is
+	 * not seekable
 	 */
 	.tell_func = NULL
 };
@@ -126,7 +124,7 @@ static ssize_t ogg_convert(char *inbuffer, size_t len, struct filter_node *fn)
 
 	if (!pod->vf) {
 		int ib = 1024 * conf->initial_buffer_arg; /* initial buffer */
-		if (len <ib && !*fn->fc->input_eof) {
+		if (len <ib && !*fn->fc->input_error) {
 			PARA_DEBUG_LOG("initial input buffer %zd/%d, "
 				"waiting for more data\n", len, ib);
 			return 0;
@@ -152,10 +150,10 @@ static ssize_t ogg_convert(char *inbuffer, size_t len, struct filter_node *fn)
 		PARA_NOTICE_LOG("%d channels, %d Hz\n", fn->fc->channels,
 			fn->fc->samplerate);
 	}
-	while (!*fn->fc->input_eof && fn->loaded < fn->bufsize) {
+	while (!*fn->fc->input_error && fn->loaded < fn->bufsize) {
 		int length = fn->bufsize - fn->loaded;
 		long read_ret = ov_read(pod->vf, fn->buf + fn->loaded, length,
-			ENDIAN, BITS / 8, SIGN, NULL);
+			ENDIAN, 2 /* 16 bit */, 1 /* signed */, NULL);
 		if (read_ret == OV_HOLE || !read_ret)
 			return pod->converted;
 		if (read_ret < 0)
@@ -174,7 +172,11 @@ static void *oggdec_parse_config(int argc, char **argv)
 	return NULL;
 }
 
-/** the init function of the ogg vorbis decoder */
+/**
+ * The init function of the ogg vorbis decoder.
+ *
+ * \param f Its fields are filled in by the function.
+ */
 void oggdec_init(struct filter *f)
 {
 	f->open = ogg_open;