aac_afh.c: Fix serious memory leak.
[paraslash.git] / write.c
diff --git a/write.c b/write.c
index 7f29665..64c08d8 100644 (file)
--- a/write.c
+++ b/write.c
@@ -1,21 +1,11 @@
 /*
- * 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
- *     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 write.c Paraslash's standalone wav/raw player */
+
 #include "para.h"
 #include "string.h"
 #include "write.cmdline.h"
 
 INIT_WRITE_ERRLISTS;
 
+/**
+ * check if given buffer contains a valid wave header
+ */
 struct check_wav_task {
+       /** the buffer to check */
        char *buf;
+       /** number of bytes loaded in \a buf */
        size_t *loaded;
+       /** non-zero if end of file was reached */
        int *eof;
+       /** number of channels specified in wav header given by \a buf */
        unsigned channels;
+       /** samplerate specified in wav header given by \a buf */
        unsigned samplerate;
+       /** the task structure for this task */
        struct task task;
 };
 
+/**
+ * delay writing until given time
+ */
 struct initial_delay_task {
+       /** the time the first data should be written out */
        struct timeval start_time;
+       /** the task structure for this task */
        struct task task;
 };
 
 static struct write_args_info conf;
-struct stdin_task sit;
-struct check_wav_task cwt;
-struct initial_delay_task idt;
+static struct stdin_task sit;
+static struct check_wav_task cwt;
+static struct initial_delay_task idt;
 static struct writer_node_group *wng;
 
+/** length of a standard wav header */
 #define WAV_HEADER_LEN 44
 
 /**
@@ -96,16 +101,7 @@ static void initial_delay_pre_select(struct sched *s, struct task *t)
                s->timeout = diff;
 }
 
-void para_log(int ll, const char* fmt,...)
-{
-       va_list argp;
-
-       if (ll < conf.loglevel_arg)
-               return;
-       va_start(argp, fmt);
-       vfprintf(stderr, fmt, argp);
-       va_end(argp);
-}
+INIT_STDERR_LOGGING(conf.loglevel_arg)
 
 static struct writer_node_group *check_args(void)
 {
@@ -205,12 +201,24 @@ static void cwt_event_handler(struct task *t)
        register_task(&idt.task);
 }
 
+/**
+ * para_write's main function
+ *
+ * \param argc the usual argument counter
+ * \param argv the usual argument vector
+ *
+ * It registers the stdin task, the check_wav_task, the task for initial delay
+ * and all tasks for actually writing out the stream.
+ *
+ * \return \p EXIT_SUCCESS or EXIT_FAILURE
+ */
 int main(int argc, char *argv[])
 {
        int ret = -E_WRITE_SYNTAX;
        struct sched s;
 
        write_cmdline_parser(argc, argv, &conf);
+       HANDLE_VERSION_FLAG("write", conf);
        init_supported_writers();
 
        wng = check_args();