Reformat gui.ggo.
[paraslash.git] / write.c
diff --git a/write.c b/write.c
index e42062038dc6d1054c80e84c2d3dd998b359bce9..c425c7cb72235ae2d8f620e04a633524fd917ea8 100644 (file)
--- a/write.c
+++ b/write.c
@@ -1,21 +1,14 @@
 /*
- * 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 <sys/types.h>
+#include <dirent.h>
+
 #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;
-       int *eof;
+       /** Non-zero if an error occurred or end of file was reached. */
+       int *error;
+       /** Number of channels specified in wav header given by \a buf. */
        unsigned channels;
-       unsigned sample_rate;
+       /** Sample rate 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 gengetopt_args_info conf;
-struct stdin_task sit;
-struct check_wav_task cwt;
-struct initial_delay_task idt;
+static struct write_args_info conf;
+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
 
 /**
- * test if audio buffer contains a valid wave header
+ * Test if audio buffer contains a valid wave header.
  *
  * \return If not, return -E_NO_WAV_HEADER, otherwise, return zero. If
- * there is less than WAV_HEADER_LEN bytes awailable, return one.
+ * there is less than WAV_HEADER_LEN bytes available, return one.
  */
 static void check_wav_pre_select(__a_unused struct sched *s, struct task *t)
 {
-       struct check_wav_task *cwt = t->private_data;
+       struct check_wav_task *wt = t->private_data;
        unsigned char *a;
 
-       if (*cwt->loaded < WAV_HEADER_LEN) {
-               t->ret = *cwt->eof? -E_PREMATURE_END : 1;
+       if (*wt->loaded < WAV_HEADER_LEN) {
+               t->ret = *wt->error? -E_PREMATURE_END : 1;
                return;
        }
-       cwt->channels = 2;
-       cwt->sample_rate = 44100;
-       a = (unsigned char*)cwt->buf;
+       wt->channels = 2;
+       wt->samplerate = 44100;
+       a = (unsigned char*)wt->buf;
        t->ret = -E_NO_WAV_HEADER;
        if (a[0] != 'R' || a[1] != 'I' || a[2] != 'F' || a[3] != 'F')
                return;
-       cwt->channels = (unsigned) a[22];
-       cwt->sample_rate = a[24] + (a[25] << 8) + (a[26] << 16) + (a[27] << 24);
-       *cwt->loaded -= WAV_HEADER_LEN;
-       memmove(cwt->buf, cwt->buf + WAV_HEADER_LEN, *cwt->loaded);
+       wt->channels = (unsigned) a[22];
+       wt->samplerate = a[24] + (a[25] << 8) + (a[26] << 16) + (a[27] << 24);
+       *wt->loaded -= WAV_HEADER_LEN;
+       memmove(wt->buf, wt->buf + WAV_HEADER_LEN, *wt->loaded);
        t->ret = -E_WAV_HEADER_SUCCESS;
-       PARA_INFO_LOG("channels: %d, sample_rate: %d\n", cwt->channels, cwt->sample_rate);
+       PARA_INFO_LOG("channels: %d, sample rate: %d\n", wt->channels, wt->samplerate);
 }
 
 static void initial_delay_pre_select(struct sched *s, struct task *t)
 {
-       struct initial_delay_task *idt = t->private_data;
+       struct initial_delay_task *dt = t->private_data;
        struct timeval diff;
 
        t->ret = -E_NO_DELAY;
-       if (!idt->start_time.tv_sec && !idt->start_time.tv_usec)
+       if (!dt->start_time.tv_sec && !dt->start_time.tv_usec)
                return;
        t->ret = -E_DELAY_TIMEOUT;
-       if (tv_diff(&s->now, &idt->start_time, &diff) > 0)
+       if (tv_diff(now, &dt->start_time, &diff) > 0)
                return;
        t->ret = 1;
        if (tv_diff(&s->timeout , &diff, NULL) > 0)
                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)
 {
        int i, ret = -E_WRITE_SYNTAX;
-       struct writer_node_group *wng = NULL;
+       struct writer_node_group *g = NULL;
 
        if (conf.list_writers_given) {
                char *msg = NULL;
@@ -126,8 +121,6 @@ static struct writer_node_group *check_args(void)
                free(msg);
                exit(EXIT_SUCCESS);
        }
-//     if (conf.prebuffer_arg < 0 || conf.prebuffer_arg > 100)
-//             goto out;
        if (conf.start_time_given) {
                long unsigned sec, usec;
                if (sscanf(conf.start_time_arg, "%lu:%lu",
@@ -137,27 +130,25 @@ static struct writer_node_group *check_args(void)
                idt.start_time.tv_usec = usec;
        }
        if (!conf.writer_given) {
-               wng = setup_default_wng();
+               g = setup_default_wng();
                ret = 1;
                goto out;
        }
-       wng = wng_new(conf.writer_given);
+       g = wng_new(conf.writer_given);
        ret = -E_WRITE_SYNTAX;
        for (i = 0; i < conf.writer_given; i++) {
                int writer_num;
-               wng->writer_nodes[i].conf = check_writer_arg(
+               g->writer_nodes[i].conf = check_writer_arg(
                        conf.writer_arg[i], &writer_num);
-               if (!wng->writer_nodes[i].conf)
+               if (!g->writer_nodes[i].conf)
                        goto out;
-               wng->writer_nodes[i].writer = &writers[writer_num];
-               sprintf(wng->writer_nodes[i].task.status, "%s",
-                       writer_names[writer_num]);
+               g->writer_nodes[i].writer = &writers[writer_num];
        }
        ret = 1;
 out:
        if (ret > 0)
-               return wng;
-       free(wng);
+               return g;
+       free(g);
        return NULL;
 }
 
@@ -165,10 +156,9 @@ static void wng_event_handler(struct task *t)
 {
        struct writer_node_group *g = t->private_data;
 
-       PARA_INFO_LOG("%s\n", PARA_STRERROR(-t->ret));
+       PARA_INFO_LOG("%s\n", para_strerror(-t->ret));
        unregister_task(t);
        wng_close(g);
-       wng_destroy(g);
 }
 
 
@@ -176,15 +166,17 @@ static void idt_event_handler(struct task *t)
 {
        int ret;
 
-       PARA_INFO_LOG("%s\n", PARA_STRERROR(-t->ret));
+       PARA_INFO_LOG("%s\n", para_strerror(-t->ret));
        unregister_task(t);
        wng->buf = sit.buf;
        wng->loaded = &sit.loaded;
-       wng->input_eof = &sit.eof;
+       wng->input_error = &sit.error;
        wng->task.event_handler = wng_event_handler;
+       wng->channels = &cwt.channels;
+       wng->samplerate = &cwt.samplerate;
        ret = wng_open(wng);
        if (ret < 0) {
-               PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
+               PARA_ERROR_LOG("%s\n", para_strerror(-ret));
                exit(EXIT_FAILURE);
        }
 }
@@ -192,10 +184,10 @@ static void idt_event_handler(struct task *t)
 static void cwt_event_handler(struct task *t)
 {
        if (t->ret != -E_NO_WAV_HEADER && t->ret != -E_WAV_HEADER_SUCCESS) {
-               PARA_ERROR_LOG("%s\n", PARA_STRERROR(-t->ret));
+               PARA_ERROR_LOG("%s\n", para_strerror(-t->ret));
                exit(EXIT_FAILURE);
        }
-       PARA_INFO_LOG("%s\n", PARA_STRERROR(-t->ret));
+       PARA_INFO_LOG("%s\n", para_strerror(-t->ret));
        unregister_task(t);
 //     if (t->ret == -E_WAV_HEADER_SUCCESS) {
 //             conf.channels_arg = cwt.channels;
@@ -208,14 +200,25 @@ 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;
 
-       cmdline_parser(argc, argv, &conf);
+       write_cmdline_parser(argc, argv, &conf);
+       HANDLE_VERSION_FLAG("write", conf);
        init_supported_writers();
-       init_sched();
 
        wng = check_args();
        if (!wng)
@@ -231,17 +234,17 @@ int main(int argc, char *argv[])
        cwt.task.event_handler = cwt_event_handler;
        cwt.buf = sit.buf;
        cwt.loaded = &sit.loaded;
-       cwt.eof = &sit.eof;
+       cwt.error = &sit.error;
        sprintf(cwt.task.status, "check wav");
        register_task(&cwt.task);
 
        s.default_timeout.tv_sec = 1;
        s.default_timeout.tv_usec = 0;
-       ret = sched(&s);
+       ret = schedule(&s);
 
 out:
        if (ret < 0) {
-               PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
+               PARA_ERROR_LOG("%s\n", para_strerror(-ret));
                ret = EXIT_FAILURE;
        } else
                ret = EXIT_SUCCESS;