Merge branch 'maint'
[paraslash.git] / write_common.c
index ff8999f..cdb67e5 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -7,7 +7,6 @@
 /** \file write_common.c common functions of para_audiod and para_write */
 
 #include <regex.h>
-#include <stdbool.h>
 
 #include "para.h"
 #include "string.h"
@@ -17,6 +16,7 @@
 #include "buffer_tree.h"
 #include "write.h"
 #include "error.h"
+#include "write_common.h"
 
 /** the array containing the names of all supported writers */
 const char *writer_names[] ={WRITER_NAMES};
@@ -24,150 +24,6 @@ const char *writer_names[] ={WRITER_NAMES};
 /** the array of supported writers */
 struct writer writers[NUM_SUPPORTED_WRITERS] = {WRITER_ARRAY};
 
-static void wng_pre_select(struct sched *s, struct task *t)
-{
-       struct writer_node_group *g = container_of(t, struct writer_node_group, task);
-       int i;
-
-       FOR_EACH_WRITER_NODE(i, g) {
-               struct writer_node *wn = &g->writer_nodes[i];
-               struct writer *w = writers + wn->writer_num;
-               if (!w->pre_select)
-                       continue;
-               t->error = w->pre_select(s, wn);
-               if (t->error < 0)
-                       return;
-       }
-       /*
-        * Force a minimal delay if something was written during the previous
-        * call to wng_post_select(). This is necessary because the filter
-        * chain might still have data for us which it couldn't convert during
-        * the previous run due to its buffer size constraints. In this case we
-        * do not want to wait until the next input data arrives as this could
-        * lead to buffer underruns.
-        */
-       if (g->last_written == 0)
-               return;
-       s->timeout.tv_sec = 0;
-       s->timeout.tv_usec = 1;
-}
-
-static void wng_post_select(struct sched *s, struct task *t)
-{
-       struct writer_node_group *g = container_of(t, struct writer_node_group, task);
-       int i;
-       size_t min_written = 0, max_written = 0;
-
-       FOR_EACH_WRITER_NODE(i, g) {
-               struct writer_node *wn = &g->writer_nodes[i];
-               struct writer *w = writers + wn->writer_num;
-               t->error = w->post_select(s, wn);
-               if (t->error < 0)
-                       return;
-               if (!i)
-                       min_written = wn->written;
-               else
-                       min_written = PARA_MIN(min_written, wn->written);
-               max_written = PARA_MAX(max_written, wn->written);
-       }
-       g->last_written = max_written;
-       //PARA_INFO_LOG("loaded: %zd, min_written: %zd bytes\n", *g->loaded, min_written);
-       if (min_written) {
-               *g->loaded -= min_written;
-               FOR_EACH_WRITER_NODE(i, g)
-                       g->writer_nodes[i].written -= min_written;
-       }
-       if (!*g->loaded && *g->input_error) {
-               t->error = *g->input_error;
-               return;
-       }
-       if (*g->loaded && min_written) {
-//             PARA_INFO_LOG("moving %zd bytes\n", *g->loaded);
-               memmove(*g->bufp, *g->bufp + min_written, *g->loaded);
-       }
-}
-
-/**
- * call the open function of each writer in the group
- *
- * \param g the writer node group
- *
- * \return If at least one open function returned an error, all successful
- * writer notes get closed and this error value is returned. Upon success, a
- * task associated with \a g is registered to the scheduler and the function
- * returns a positive value.
- * */
-int wng_open(struct writer_node_group *g)
-{
-       int i, ret = 1;
-
-       PARA_NOTICE_LOG("opening wng %p with %d writer(s)\n", g, g->num_writers);
-       FOR_EACH_WRITER_NODE(i, g) {
-               struct writer_node *wn = &g->writer_nodes[i];
-               struct writer *w = writers + wn->writer_num;
-               wn->wng = g;
-               ret = w->open(wn);
-               if (ret < 0)
-                       goto err_out;
-       }
-       sprintf(g->task.status, "%s", "writer node group");
-       register_task(&g->task);
-       g->open = 1;
-       return 1;
-err_out:
-       PARA_ERROR_LOG("%s\n", para_strerror(-ret));
-       while (i > 0) {
-               struct writer_node *wn = &g->writer_nodes[--i];
-               struct writer *w = writers + wn->writer_num;
-               w->close(wn);
-       }
-       free(g->writer_nodes);
-       g->num_writers = 0;
-       g->task.error = -E_TASK_UNREGISTERED;
-       return ret;
-}
-
-/**
- * call the close function of each writer in the given group
- *
- * \param g the writer node group to close
- *
- * This function also frees all resources of the given group.
- */
-void wng_close(struct writer_node_group *g)
-{
-       int i;
-
-       if (!g || !g->open)
-               return;
-       PARA_NOTICE_LOG("closing wng with %d writer(s)\n", g->num_writers);
-       FOR_EACH_WRITER_NODE(i, g) {
-               struct writer_node *wn = &g->writer_nodes[i];
-               struct writer *w = writers + wn->writer_num;
-               w->close(wn);
-       }
-       free(g->writer_nodes);
-       free(g);
-}
-
-/**
- * allocate and initialize a new writer_node_group struct
- *
- * \param num_writers the number of writer nodes for the new group
- *
- * \return Pointer to the new writer node group
- */
-struct writer_node_group *wng_new(unsigned num_writers)
-{
-       struct writer_node_group *g = para_calloc(sizeof(struct writer_node_group));
-       g->num_writers = num_writers;
-       g->writer_nodes = para_calloc(num_writers
-               * sizeof(struct writer_node));
-       g->task.post_select = wng_post_select;
-       g->task.pre_select = wng_pre_select;
-       return g;
-}
-
 /**
  * Call the init function of each supported paraslash writer.
  */
@@ -179,10 +35,10 @@ void writer_init(void)
                writers[i].init(&writers[i]);
 }
 /**
- * check if given string is a valid command line for any writer
+ * Check if given string is a valid command line for any writer.
  *
- * \param \wa string of the form writer_name:options
- * \param writer_num contains the number of the writer upon success
+ * \param \wa String of the form writer_name:options.
+ * \param writer_num Contains the number of the writer upon success.
  *
  * This function checks whether \a wa starts with the name of a supported
  * paraslash writer, optionally followed by a colon and any options for that
@@ -191,132 +47,153 @@ void writer_init(void)
  *
  * \return On success, a pointer to the gengetopt args info struct is returned
  * and \a writer_num contains the number of the writer. Otherwise this function
- * returns \p NULL.
+ * prints an error message and calls exit().
  */
-void *check_writer_arg(const char *wa, int *writer_num)
+void *check_writer_arg_or_die(const char *wa, int *writer_num)
 {
-       int i;
-
-       *writer_num = -E_WRITE_COMMON_SYNTAX;
-       PARA_INFO_LOG("checking  %s\n", wa);
+       int i, ret, argc;
+       const char *cmdline;
+       char **argv;
+       void *conf;
+
+       if (!wa || !*wa) {
+               i = DEFAULT_WRITER;
+               cmdline = NULL;
+               goto check;
+       }
+       PARA_INFO_LOG("checking %s\n", wa);
        FOR_EACH_WRITER(i) {
                const char *name = writer_names[i];
                size_t len = strlen(name);
                char c;
+
                if (strlen(wa) < len)
                        continue;
                if (strncmp(name, wa, len))
                        continue;
                c = wa[len];
-               if (c && c != ' ')
-                       continue;
-               if (c && !writers[i].parse_config)
-                       return NULL;
-               *writer_num = i;
-               return writers[i].parse_config(c? wa + len + 1 : "");
+               if (!c || c == ' ') {
+                       cmdline = c? wa + len + 1 : NULL;
+                       goto check;
+               }
+       }
+       PARA_EMERG_LOG("invalid writer %s\n", wa);
+       exit(EXIT_FAILURE);
+check:
+       ret = create_shifted_argv(cmdline, " \t", &argv);
+       if (ret < 0) {
+               PARA_EMERG_LOG("%s: %s\n", wa, para_strerror(-ret));
+               exit(EXIT_FAILURE);
        }
-       PARA_ERROR_LOG("writer not found\n");
-       return NULL;
+       argc = ret;
+       argv[0] = make_message("%s_write", writer_names[i]);
+       *writer_num = i;
+       conf = writers[i].parse_config_or_die(argc, argv);
+       free_argv(argv);
+       return conf;
 }
 
 /**
- * setup a writer node group with only one writer, the default writer
+ * Open a writer node and register the corresponding task.
  *
- * The writer which is set up depends on the OS. It defaults to alsa for Linux,
- * osx_write for OS X, file writer if neither of these is supported.
+ * \param wn The writer node to open.
+ * \param parent The parent btr node (the source for the writer node).
+ * \param s The scheduler instance to register the task to.
  *
- * \return pointer to the allocated writer node group
+ * The configuration of the writer node stored in \p wn->conf must be
+ * initialized before this function may be called.
  */
-struct writer_node_group *setup_default_wng(void)
+void register_writer_node(struct writer_node *wn, struct btr_node *parent,
+               struct sched *s)
 {
-       struct writer_node_group *wng = wng_new(1);
-       wng->writer_nodes[0].writer_num = DEFAULT_WRITER;
-       PARA_INFO_LOG("using default writer: %s %p\n",
-               writer_names[DEFAULT_WRITER], writers[DEFAULT_WRITER].parse_config);
-       wng->writer_nodes[0].conf = writers[DEFAULT_WRITER].parse_config("");
-       return wng;
+       struct writer *w = writers + wn->writer_num;
+
+       wn->btrn = btr_new_node(&(struct btr_node_description)
+               EMBRACE(.name = writer_names[wn->writer_num], .parent = parent,
+               .handler = w->execute, .context = wn));
+       wn->task = task_register(&(struct task_info) {
+               .name = writer_names[wn->writer_num],
+               .pre_select = w->pre_select,
+               .post_select = w->post_select,
+               .context = wn,
+       }, s);
 }
 
-/**
- * Setup a writer node with the default writer.
- *
- * If arg is \p NULL, the OS-dependent default writer is used with an empty
- * configuration string.  It defaults to alsa for Linux, osx for OS X, oss for
- * *BSD and the file writer if neither of these is supported.
- *
- * Once the writer configuration has been retrieved, a writer node is created,
- * its buffer tree node is added to the buffer tree as a child of the given
- * parent.
- *
- * Finally, the new writer node's taks structure is initialized and registered
- * to the paraslash scheduler.
- *
- * \return A pointer to the allocated writer node group.
- */
-struct writer_node *setup_writer_node(const char *arg, struct btr_node *parent)
-{
-       struct writer_node *wn = para_calloc(sizeof(*wn));
-       struct writer *w;
-       const char *name;
-
-       if (arg)
-               wn->conf = check_writer_arg(arg, &wn->writer_num);
-       else {
-               wn->writer_num = DEFAULT_WRITER;
-               wn->conf = writers[DEFAULT_WRITER].parse_config("");
-       }
-       if (!wn->conf) {
-               free(wn);
-               return NULL;
-       }
-       w = writers + wn->writer_num;
-       name = writer_names[wn->writer_num];
-       wn->btrn = btr_new_node(name, parent, w->execute, wn);
-       sprintf(wn->task.status, "%s", name);
-       w->open(wn);
-       wn->task.post_select = w->post_select_btr;
-       wn->task.pre_select = w->pre_select_btr;
-       register_task(&wn->task);
-       return wn;
-}
-
-
 /**
  * Print the help text of all writers to stdout.
  *
- * \param detailed Whether to print the detailed help text.
+ * \param flags Passed to \ref ggo_print_help().
  */
-void print_writer_helps(int detailed)
+void print_writer_helps(unsigned flags)
 {
        int i;
 
-       printf_or_die("\nAvailable writers: \n\t");
+       printf_or_die("\nAvailable writers: ");
        FOR_EACH_WRITER(i)
                printf_or_die("%s%s", i? " " : "", writer_names[i]);
-       printf_or_die("\n\n");
+       printf_or_die("\n");
        FOR_EACH_WRITER(i) {
                struct writer *w = writers + i;
 
                if (!w->help.short_help)
                        continue;
-               printf_or_die("Options for %s:\n", writer_names[i]);
-               ggo_print_help(&w->help, detailed);
+               printf_or_die("\n%s: %s", writer_names[i],
+                       w->help.purpose);
+               ggo_print_help(&w->help, flags);
+       }
+}
+
+static void get_btr_value(struct btr_node *btrn, const char *cmd,
+               int32_t *result)
+{
+       char *buf = NULL;
+       int ret = btr_exec_up(btrn, cmd, &buf);
+
+       if (ret < 0) {
+               /*
+                * This really should not happen. It means one of our parent
+                * nodes died unexpectedly. Proceed with fingers crossed.
+                */
+               PARA_CRIT_LOG("cmd %s: %s\n", cmd, para_strerror(-ret));
+               *result = 0;
+               return;
        }
+       ret = para_atoi32(buf, result);
+       assert(ret >= 0);
+       free(buf);
 }
 
-int prepare_writer_node(struct writer_node *wn)
+/**
+ * Ask parent btr nodes for the sample rate of the current stream.
+ *
+ * \param btrn Where to start the search.
+ * \param result Filled in by this function.
+ *
+ * This function is assumed to succeed and terminates on errors.
+ */
+void get_btr_sample_rate(struct btr_node *btrn, int32_t *result)
 {
-       struct btr_node *btrn = wn->btrn;
-       size_t iqs;
+       get_btr_value(btrn, "sample_rate", result);
+}
 
-       if (btr_eof(btrn))
-               return -E_WRITE_COMMON_EOF;
-       iqs = btr_get_input_queue_size(btrn);
-       if (iqs < wn->min_iqs && !btr_no_parent(btrn))
-               return 0;
-       assert(iqs != 0);
-       /* avoid "buffer too small" errors from the decoder */
-       btr_merge(btrn, wn->min_iqs);
-       return 1;
+/**
+ * Ask parent btr nodes for the channel count of the current stream.
+ *
+ * \param btrn See \ref get_btr_sample_rate.
+ * \param result See \ref get_btr_sample_rate.
+ */
+void get_btr_channels(struct btr_node *btrn, int32_t *result)
+{
+       get_btr_value(btrn, "channels", result);
 }
 
+/**
+ * Ask parent btr nodes for the number of bits per sample and the byte sex.
+ *
+ * \param btrn See \ref get_btr_sample_rate.
+ * \param result Contains the sample format as an enum sample_format type.
+ */
+void get_btr_sample_format(struct btr_node *btrn, int32_t *result)
+{
+       get_btr_value(btrn, "sample_format", result);
+}