ogg_afh.c: add documentation of struct ogg_datasource

[paraslash.git] / wav.c

diff --git a/wav.c b/wav.c
index b955695f70bce73aea60df566722658089f3661a..891769a5d412a38a1412680fd7529e771eb1df87 100644 (file)
--- a/wav.c
+++ b/wav.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2006 Andre Noll <maan@systemlinux.org>
+ * 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
@@ -21,21 +21,38 @@
 #include "para.h"
 
 #include "list.h"
+#include "sched.h"
 #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;
@@ -95,10 +112,15 @@ static void wav_open(struct filter_node *fn)
        fn->private_data = para_malloc(sizeof(int));
        bof = fn->private_data;
        *bof = 1;
-       PARA_DEBUG_LOG("wav filter node: %p, output buffer: %p, loaded: %zd\n",
+       PARA_INFO_LOG("wav filter node: %p, output buffer: %p, loaded: %zd\n",
                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;