Merge commit 'remotes/fml/master'
[paraslash.git] / wav.c
diff --git a/wav.c b/wav.c
index 5ab3bb3..52a97af 100644 (file)
--- a/wav.c
+++ b/wav.c
@@ -1,19 +1,7 @@
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2008 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 wav.c a filter that inserts a wave header */
 #include "filter.h"
 #include "string.h"
 
+/** size of the output buffer */
 #define WAV_OUTBUF_SIZE 81920
+/** a wav header is always 44 bytes */
 #define WAV_HEADER_LEN 44
+/** always write 16 bit header */
 #define BITS 16
 
-/* derived from oggdec.c of the vorbis-tools-1.0.1 package */
+/**
+ * write a 32 bit unsigned value to a buffer
+ *
+ * \param buf the buffer to write to
+ * \param x the value to write
+ */
 #define WRITE_U32(buf, x) (buf)[0] = (unsigned char)((x) & 0xff);\
        (buf)[1] = (unsigned char)(((x) >> 8) & 0xff);\
        (buf)[2] = (unsigned char)(((x) >> 16) & 0xff);\
        (buf)[3] = (unsigned char)(((x) >> 24) & 0xff);
+
+/**
+ * write a 16 bit unsigned value to a buffer
+ *
+ * \param buf the buffer to write to
+ * \param x the value to write
+ */
 #define WRITE_U16(buf, x) (buf)[0] = (unsigned char)((x) & 0xff);
 
-static void make_wav_header(int channels, int samplerate, struct filter_node *fn)
+static void make_wav_header(unsigned int channels, unsigned int samplerate,
+               struct filter_node *fn)
 {
 
        char *headbuf = fn->buf;
@@ -100,6 +104,11 @@ static void wav_open(struct filter_node *fn)
                fn, fn->buf, fn->loaded);
 }
 
+/**
+ * the init function of the wav filter
+ *
+ * \param f struct to initialize
+ */
 void wav_init(struct filter *f)
 {
        f->convert = wav_convert;