X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=oggdec.c;h=3dced8a0baf58baf6617498c481668944e5ad183;hp=1cd1f02853e2a1fec99c66de57514f18d680c959;hb=74cfed2536a16ca85bc0ce97f6bf307c96ae0d3d;hpb=ae0e4594c6a0312c5b4b4c0bde86f9c12253d11b

diff --git a/oggdec.c b/oggdec.c
index 1cd1f028..3dced8a0 100644
--- a/oggdec.c
+++ b/oggdec.c
@@ -1,19 +1,7 @@
 /*
  * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
  *
- *     This program is free software; you can redistribute it and/or modify
- *     it under the terms of the GNU General Public License as published by
- *     the Free Software Foundation; either version 2 of the License, or
- *     (at your option) any later version.
- *
- *     This program is distributed in the hope that it will be useful,
- *     but WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *     GNU General Public License for more details.
- *
- *     You should have received a copy of the GNU General Public License
- *     along with this program; if not, write to the Free Software
- *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 /** \file oggdec.c paraslash's ogg vorbis decoder */
@@ -29,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;
 };
 
@@ -167,7 +152,7 @@ static ssize_t ogg_convert(char *inbuffer, size_t len, struct filter_node *fn)
 	while (!*fn->fc->input_eof && 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)
@@ -186,7 +171,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;