crypt_common.c: Add missing doxygen documentation.
[paraslash.git] / write.c
diff --git a/write.c b/write.c
index 125df1c1d94440f7cfabad1b56ef55f1ffaa4110..6b574414b6b13c227c98b008addd28f4b2302b33 100644 (file)
--- a/write.c
+++ b/write.c
 /*
- * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2011 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 /** \file write.c Paraslash's standalone wav/raw player. */
 
+#include <regex.h>
 #include <sys/types.h>
-#include <dirent.h>
+#include <stdbool.h>
 
 #include "para.h"
 #include "string.h"
 #include "write.cmdline.h"
 #include "list.h"
 #include "sched.h"
+#include "ggo.h"
 #include "stdin.h"
+#include "buffer_tree.h"
 #include "write.h"
 #include "write_common.h"
 #include "fd.h"
 #include "error.h"
+#include "version.h"
 
 INIT_WRITE_ERRLISTS;
 
-/** Check if given buffer contains a valid wave header. */
+enum check_wav_state {
+       CWS_NEED_HEADER,
+       CWS_HAVE_HEADER,
+       CWS_NO_HEADER,
+};
+
+/* Information extracted from the wav header. */
 struct check_wav_task {
-       /** The buffer to check. */
-       char *buf;
-       /** Number of bytes loaded in \a buf. */
-       size_t *loaded;
-       /** 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. */
+       int state;
+       /** Number of channels. */
        unsigned channels;
+       unsigned sample_format;
        /** 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. */
+       unsigned sample_rate;
+       /** The task structure used by the scheduler. */
        struct task task;
+       struct btr_node *btrn;
+       size_t min_iqs;
 };
 
 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.
- *
- * \return If not, return -E_NO_WAV_HEADER, otherwise, return zero. If
- * 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)
+static void check_wav_pre_select(struct sched *s, struct task *t)
 {
-       struct check_wav_task *wt = t->private_data;
-       unsigned char *a;
+       struct check_wav_task *cwt = container_of(t, struct check_wav_task, task);
+       int ret;
 
-       if (*wt->loaded < WAV_HEADER_LEN) {
-               t->ret = *wt->error? -E_PREMATURE_END : 1;
-               return;
-       }
-       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;
-       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", wt->channels, wt->samplerate);
+       ret = btr_node_status(cwt->btrn, cwt->min_iqs, BTR_NT_INTERNAL);
+       if (ret != 0)
+               sched_min_delay(s);
 }
 
-static void initial_delay_pre_select(struct sched *s, struct task *t)
+#define HANDLE_EXEC(_cmd) \
+       if (!strcmp(cmd, #_cmd)) { \
+               if (!conf._cmd ## _given && cwt->state == CWS_NEED_HEADER) \
+                       return -E_BTR_NAVAIL; \
+               *result = make_message("%d", cwt->state == CWS_NO_HEADER || conf._cmd ## _given? \
+                       conf._cmd ## _arg : cwt->_cmd); \
+               return 1; \
+       } \
+
+
+static int check_wav_exec(struct btr_node *btrn, const char *cmd, char **result)
 {
-       struct initial_delay_task *dt = t->private_data;
-       struct timeval diff;
-
-       t->ret = -E_NO_DELAY;
-       if (!dt->start_time.tv_sec && !dt->start_time.tv_usec)
-               return;
-       t->ret = -E_DELAY_TIMEOUT;
-       if (tv_diff(now, &dt->start_time, &diff) > 0)
-               return;
-       t->ret = 1;
-       if (tv_diff(&s->timeout , &diff, NULL) > 0)
-               s->timeout = diff;
-}
+       struct check_wav_task *cwt = btr_context(btrn);
 
-INIT_STDERR_LOGGING(conf.loglevel_arg)
+       HANDLE_EXEC(sample_rate);
+       HANDLE_EXEC(channels);
+       HANDLE_EXEC(sample_format);
+       return -ERRNO_TO_PARA_ERROR(ENOTSUP);
+}
 
-static struct writer_node_group *check_args(void)
+static void check_wav_post_select(__a_unused struct sched *s, struct task *t)
 {
-       int i, ret = -E_WRITE_SYNTAX;
-       struct writer_node_group *g = NULL;
-
-       if (conf.list_writers_given) {
-               char *msg = NULL;
-               FOR_EACH_WRITER(i) {
-                       char *tmp = make_message("%s%s%s",
-                               i? msg : "",
-                               i? " " : "",
-                               writer_names[i]);
-                       free(msg);
-                       msg = tmp;
-               }
-               fprintf(stderr, "%s\n", msg);
-               free(msg);
-               exit(EXIT_SUCCESS);
-       }
-       if (conf.start_time_given) {
-               long unsigned sec, usec;
-               if (sscanf(conf.start_time_arg, "%lu:%lu",
-                               &sec, &usec) != 2)
-                       goto out;
-               idt.start_time.tv_sec = sec;
-               idt.start_time.tv_usec = usec;
-       }
-       if (!conf.writer_given) {
-               g = setup_default_wng();
-               ret = 1;
+       struct check_wav_task *cwt = container_of(t, struct check_wav_task, task);
+       struct btr_node *btrn = cwt->btrn;
+       unsigned char *a;
+       size_t sz;
+       int ret;
+       uint16_t bps; /* bits per sample */
+       const char *sample_formats[] = {SAMPLE_FORMATS};
+
+       t->error = 0;
+       ret = btr_node_status(btrn, cwt->min_iqs, BTR_NT_INTERNAL);
+       if (ret <= 0)
+               goto out;
+       if (cwt->state != CWS_NEED_HEADER)
+               goto pushdown;
+       btr_merge(btrn, cwt->min_iqs);
+       sz = btr_next_buffer(btrn, (char **)&a);
+       if (sz < cwt->min_iqs) /* file size less than WAV_HEADER_SIZE */
+               goto pushdown;
+       cwt->min_iqs = 0;
+       /*
+        * The default byte ordering assumed for WAVE data files is
+        * little-endian. Files written using the big-endian byte ordering
+        * scheme have the identifier RIFX instead of RIFF.
+        */
+       if (a[0] != 'R' || a[1] != 'I' || a[2] != 'F' ||
+                       (a[3] != 'F' && a[3] != 'X')) {
+               PARA_NOTICE_LOG("wav header not found\n");
+               cwt->state = CWS_NO_HEADER;
+               sprintf(t->status, "check wav: no header");
                goto out;
        }
-       g = wng_new(conf.writer_given);
-       ret = -E_WRITE_SYNTAX;
-       for (i = 0; i < conf.writer_given; i++) {
-               int writer_num;
-               g->writer_nodes[i].conf = check_writer_arg(
-                       conf.writer_arg[i], &writer_num);
-               if (!g->writer_nodes[i].conf)
-                       goto out;
-               g->writer_nodes[i].writer = &writers[writer_num];
+       PARA_INFO_LOG("found wav header\n");
+       cwt->state = CWS_HAVE_HEADER;
+       sprintf(t->status, "check wav: have header");
+       cwt->channels = (unsigned) a[22];
+       cwt->sample_rate = a[24] + (a[25] << 8) + (a[26] << 16) + (a[27] << 24);
+       bps = a[34] + ((unsigned)a[35] << 8);
+       if (bps != 8 && bps != 16) {
+               PARA_WARNING_LOG("%u bps not supported, assuming 16\n", bps);
+               bps = 16;
        }
-       ret = 1;
+       /*
+        * 8-bit samples are stored as unsigned bytes, ranging from 0 to 255.
+        * 16-bit samples are stored as 2's-complement signed integers, ranging
+        * from -32768 to 32767.
+        */
+       if (bps == 8)
+               cwt->sample_format = SF_U8;
+       else
+               cwt->sample_format = (a[3] == 'F')? SF_S16_LE : SF_S16_BE;
+       PARA_NOTICE_LOG("%dHz, %s, %s\n", cwt->sample_rate,
+               cwt->channels == 1? "mono" : "stereo",
+               sample_formats[cwt->sample_format]);
+       btr_consume(btrn, WAV_HEADER_LEN);
+pushdown:
+       btr_pushdown(btrn);
 out:
-       if (ret > 0)
-               return g;
-       free(g);
-       return NULL;
+       t->error = ret;
+       if (ret < 0)
+               btr_remove_node(btrn);
 }
 
-static void wng_event_handler(struct task *t)
+static int loglevel;
+INIT_STDERR_LOGGING(loglevel)
+
+__noreturn static void print_help_and_die(void)
 {
-       struct writer_node_group *g = t->private_data;
+       int d = conf.detailed_help_given;
+       const char **p = d? write_args_info_detailed_help
+               : write_args_info_help;
 
-       PARA_INFO_LOG("%s\n", PARA_STRERROR(-t->ret));
-       unregister_task(t);
-       wng_close(g);
+       printf_or_die("%s\n\n", WRITE_CMDLINE_PARSER_PACKAGE "-"
+               WRITE_CMDLINE_PARSER_VERSION);
+       printf_or_die("%s\n\n", write_args_info_usage);
+       for (; *p; p++)
+               printf_or_die("%s\n", *p);
+       print_writer_helps(d);
+       exit(0);
 }
 
-
-static void idt_event_handler(struct task *t)
+static int main_btr(struct sched *s)
 {
-       int ret;
+       int i, ret;
+       struct check_wav_task _cwt, *cwt = &_cwt;
+       struct writer_node *wns;
 
-       PARA_INFO_LOG("%s\n", PARA_STRERROR(-t->ret));
-       unregister_task(t);
-       wng->buf = sit.buf;
-       wng->loaded = &sit.loaded;
-       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));
-               exit(EXIT_FAILURE);
+       loglevel = get_loglevel_by_name(conf.loglevel_arg);
+       sit.btrn = btr_new_node(&(struct btr_node_description)
+               EMBRACE(.name = "stdin"));
+       stdin_set_defaults(&sit);
+       register_task(&sit.task);
+
+       cwt->state = CWS_NEED_HEADER;
+       cwt->min_iqs = WAV_HEADER_LEN;
+       cwt->btrn = btr_new_node(&(struct btr_node_description)
+               EMBRACE(.name = "check_wav", .parent = sit.btrn,
+               .handler = check_wav_exec, .context = cwt));
+       sprintf(cwt->task.status, "check_wav");
+       cwt->task.pre_select = check_wav_pre_select;
+       cwt->task.post_select = check_wav_post_select;
+       cwt->task.error = 0;
+       register_task(&cwt->task);
+
+       ret = -E_WRITE_SYNTAX;
+       if (!conf.writer_given) {
+               i = 0;
+               wns = para_calloc(sizeof(*wns));
+               ret = setup_writer_node(NULL, cwt->btrn, wns);
+               if (ret < 0)
+                       goto out;
+               i = 1;
+       } else {
+               wns = para_calloc(conf.writer_given * sizeof(*wns));
+               for (i = 0; i < conf.writer_given; i++) {
+                       ret = setup_writer_node(conf.writer_arg[i],
+                               cwt->btrn, wns + i);
+                       if (ret < 0)
+                               goto out;
+               }
        }
-}
 
-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));
-               exit(EXIT_FAILURE);
+       s->default_timeout.tv_sec = 10;
+       s->default_timeout.tv_usec = 50000;
+       ret = schedule(s);
+       if (ret >= 0) {
+               int j;
+               for (j = 0; j < i; j++) {
+                       struct task *t = &wns[j].task;
+                       assert(t->error < 0);
+                       if (t->error != -E_WRITE_COMMON_EOF
+                                       && t->error != -E_BTR_EOF) {
+                               PARA_ERROR_LOG("%s: %s\n", t->status,
+                                       para_strerror(-t->error));
+                               if (ret >= 0)
+                                       ret = t->error;
+                       }
+               }
        }
-       PARA_INFO_LOG("%s\n", PARA_STRERROR(-t->ret));
-       unregister_task(t);
-//     if (t->ret == -E_WAV_HEADER_SUCCESS) {
-//             conf.channels_arg = cwt.channels;
-//             conf.sample_rate_arg = cwt.sample_rate;
-//     }
-       idt.task.pre_select = initial_delay_pre_select;
-       idt.task.private_data = &idt;
-       idt.task.event_handler = idt_event_handler;
-       sprintf(idt.task.status, "initial_delay");
-       register_task(&idt.task);
+out:
+       for (i--; i >= 0; i--) {
+               struct writer_node *wn = wns + i;
+               struct writer *w = writers + wn->writer_num;
+
+               w->close(wn);
+               btr_free_node(wn->btrn);
+               w->free_config(wn->conf);
+               free(wn->conf);
+       }
+       free(wns);
+       btr_free_node(cwt->btrn);
+       return ret;
 }
 
 /**
@@ -206,47 +244,26 @@ static void cwt_event_handler(struct task *t)
  * \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.
+ * It sets up and starts the tasks and the buffer tree nodes determined by
+ * command line options.
  *
  * \return \p EXIT_SUCCESS or EXIT_FAILURE
  */
 int main(int argc, char *argv[])
 {
        int ret = -E_WRITE_SYNTAX;
-       struct sched s;
+       static struct sched s;
 
+       writer_init();
        write_cmdline_parser(argc, argv, &conf);
        HANDLE_VERSION_FLAG("write", conf);
-       init_supported_writers();
-
-       wng = check_args();
-       if (!wng)
-               goto out;
-       stdin_set_defaults(&sit);
-       if (conf.bufsize_given)
-               sit.bufsize = conf.bufsize_arg;
-       sit.buf = para_malloc(sit.bufsize),
-       register_task(&sit.task);
-
-       cwt.task.pre_select = check_wav_pre_select;
-       cwt.task.private_data = &cwt;
-       cwt.task.event_handler = cwt_event_handler;
-       cwt.buf = sit.buf;
-       cwt.loaded = &sit.loaded;
-       cwt.error = &sit.error;
-       sprintf(cwt.task.status, "check wav");
-       register_task(&cwt.task);
+       if (conf.help_given || conf.detailed_help_given)
+               print_help_and_die();
 
-       s.default_timeout.tv_sec = 1;
-       s.default_timeout.tv_usec = 0;
-       ret = schedule(&s);
-
-out:
+       ret = main_btr(&s);
        if (ret < 0) {
-               PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
-               ret = EXIT_FAILURE;
-       } else
-               ret = EXIT_SUCCESS;
-       return ret;
+               PARA_ERROR_LOG("%s\n", para_strerror(-ret));
+               exit(EXIT_FAILURE);
+       }
+       exit(EXIT_SUCCESS);
 }