-/*
- * Copyright (C) 2006-2008 Andre Noll <maan@systemlinux.org>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
+/* Copyright (C) 2006 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
/** \file write_common.c common functions of para_audiod and para_write */
+#include <regex.h>
+#include <lopsub.h>
+
+#include "write_cmd.lsg.h"
#include "para.h"
#include "string.h"
#include "list.h"
#include "sched.h"
+#include "buffer_tree.h"
#include "write.h"
#include "error.h"
-/** the array containing the names of all supported writers */
-const char *writer_names[] ={WRITER_NAMES};
+/** Loop over all writers. */
+#define FOR_EACH_WRITER(i) for (i = 1; lls_cmd(i, write_cmd_suite); i++)
-/** the array of supported writers */
-struct writer writers[NUM_SUPPORTED_WRITERS] = {WRITER_ARRAY};
-static void wng_pre_select(__a_unused struct sched *s, struct task *t)
+static inline bool writer_supported(int wid)
{
- 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];
- t->error = wn->writer->pre_select(s, wn);
- if (t->error < 0)
- return;
- }
+ return lls_user_data(WRITE_CMD(wid));
}
-static void wng_post_select(struct sched *s, struct task *t)
+/* simply return the first available writer */
+static int default_writer_id(void)
{
- struct writer_node_group *g = container_of(t, struct writer_node_group, task);
int i;
- size_t min_written = 0;
-
- FOR_EACH_WRITER_NODE(i, g) {
- struct writer_node *wn = &g->writer_nodes[i];
- t->error = wn->writer->post_select(s, wn);
- if (t->error < 0)
- return;
- if (!i)
- min_written = wn->written;
- else
- min_written = PARA_MIN(min_written, wn->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->buf, g->buf + min_written, *g->loaded);
- }
+
+ FOR_EACH_WRITER(i)
+ if (writer_supported(i))
+ return i;
+ assert(0); /* the file writer should always be available */
}
/**
- * call the open function of each writer in the group
+ * Return the writer structure from a writer ID.
*
- * \param g the writer node group
+ * \param wid If non-positive, a pointer to the default writer is returned.
*
- * \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)
+ * \return Pointer to a (constant) struct writer.
+ */
+const struct writer *writer_get(int wid)
{
- 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];
- wn->wng = g;
- ret = wn->writer->open(wn);
- if (ret < 0)
- goto err_out;
- wn->chunk_bytes = ret;
- g->max_chunk_bytes = PARA_MAX(g->max_chunk_bytes, ret);
- }
- 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];
- wn->writer->close(wn);
- }
- g->num_writers = 0;
- return ret;
+ if (wid < 0)
+ wid = default_writer_id();
+ return lls_user_data(WRITE_CMD(wid));
}
/**
- * call the close function of each writer in the given group
+ * Return name of the writer identified by a writer ID.
*
- * \param g the writer node group to close
+ * \param wid If non-positive, the name of the default writer is returned.
*
- * This function also frees all resources of the given group.
+ * \return The returned buffer must not be freed by the caller.
*/
-void wng_close(struct writer_node_group *g)
+const char *writer_name(int wid)
{
- 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];
- wn->writer->close(wn);
- }
- free(g->writer_nodes);
- free(g);
+ if (wid <= 0)
+ wid = default_writer_id();
+ return lls_command_name(WRITE_CMD(wid));
}
/**
- * allocate and initialize a new writer_node_group struct
+ * Check if the given string is a valid command line for any writer.
+ *
+ * \param wa String of the form writer_name options.
+ * \param lprp Contains the parsed command line on success.
*
- * \param num_writers the number of writer nodes for the new group
+ * If wa is \p NULL, the (configuration-dependent) default writer is assumed.
+ * Otherwise, the function checks whether \a wa starts with the name of a
+ * supported writer. If a valid writer name was found, the rest of the command
+ * line is passed to the config parser of this writer.
*
- * \return Pointer to the new writer node group
+ * \return On success, the positive writer ID is returned. Otherwise the
+ * function prints an error message and calls exit().
*/
-struct writer_node_group *wng_new(unsigned num_writers)
+int check_writer_arg_or_die(const char *wa, struct lls_parse_result **lprp)
{
- 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;
+ int ret, writer_num, argc;
+ char **argv = NULL, *errctx = NULL;
+ const struct lls_command *cmd;
+
+ if (!wa || !*wa) {
+ writer_num = default_writer_id();
+ cmd = WRITE_CMD(writer_num);
+ argv = para_malloc(2 * sizeof(char *));
+ argc = 1;
+ argv[0] = para_strdup(lls_command_name(cmd));
+ argv[1] = NULL;
+ goto parse;
+ }
+ ret = create_argv(wa, " \t\n", &argv);
+ if (ret < 0)
+ goto fail;
+ argc = ret;
+ ret = lls(lls_lookup_subcmd(argv[0], write_cmd_suite, &errctx));
+ if (ret < 0)
+ goto free_argv;
+ writer_num = ret;
+ cmd = WRITE_CMD(writer_num);
+ if (!writer_supported(writer_num)) {
+ ret = -ERRNO_TO_PARA_ERROR(EINVAL);
+ errctx = make_message("%s writer is not supported",
+ lls_command_name(cmd));
+ goto free_argv;
+ }
+parse:
+ ret = lls(lls_parse(argc, argv, cmd, lprp, &errctx));
+ if (ret >= 0)
+ ret = writer_num;
+free_argv:
+ free_argv(argv);
+ if (ret >= 0)
+ return ret;
+fail:
+ if (errctx)
+ PARA_ERROR_LOG("%s\n", errctx);
+ free(errctx);
+ PARA_EMERG_LOG("%s\n", para_strerror(-ret));
+ exit(EXIT_FAILURE);
}
/**
- * call the init function of each supported paraslash writer
+ * Open a writer node and register the corresponding task.
+ *
+ * \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.
*/
-void init_supported_writers(void)
+void register_writer_node(struct writer_node *wn, struct btr_node *parent,
+ struct sched *s)
{
- int i;
-
- FOR_EACH_WRITER(i)
- writers[i].init(&writers[i]);
+ const struct writer *w = writer_get(wn->wid);
+
+ wn->btrn = btr_new_node(&(struct btr_node_description)
+ EMBRACE(.name = writer_name(wn->wid), .parent = parent,
+ .handler = w->execute, .context = wn));
+ wn->task = task_register(&(struct task_info) {
+ .name = writer_name(wn->wid),
+ .pre_select = w->pre_select,
+ .post_select = w->post_select,
+ .context = wn,
+ }, s);
}
+
/**
- * check if given string is a valid command line for any writer
+ * Print the help text of all writers to stdout.
*
- * \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
- * writer. If a valid writer name was found and further are present, the
- * remaining part of \a wa is passed to that writer's config parser.
- *
- * \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.
+ * \param detailed Whether to print the short or the detailed help.
*/
-void *check_writer_arg(const char *wa, int *writer_num)
+void print_writer_helps(bool detailed)
{
int i;
- *writer_num = -E_WRITE_COMMON_SYNTAX;
- PARA_INFO_LOG("checking %s\n", wa);
+ printf("\nAvailable writers: ");
FOR_EACH_WRITER(i) {
- const char *name = writer_names[i];
- size_t len = strlen(name);
- char c;
- if (strlen(wa) < len)
+ if (!writer_supported(i))
continue;
- if (strncmp(name, wa, len))
+ printf("%s%s", i? " " : "", writer_name(i));
+ }
+ printf("\n");
+ FOR_EACH_WRITER(i) {
+ const struct lls_command *cmd = WRITE_CMD(i);
+ char *help;
+ if (!writer_supported(i))
continue;
- c = wa[len];
- if (c && c != ' ')
+ help = detailed? lls_long_help(cmd) : lls_short_help(cmd);
+ if (!help)
continue;
- if (c && !writers[i].parse_config)
- return NULL;
- *writer_num = i;
- return writers[i].parse_config(c? wa + len + 1 : "");
+ printf("%s\n", help);
+ free(help);
+ }
+}
+
+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;
}
- PARA_ERROR_LOG("writer not found\n");
- return NULL;
+ ret = para_atoi32(buf, result);
+ assert(ret >= 0);
+ free(buf);
}
/**
- * setup a writer node group with only one writer, the default writer
+ * Ask parent btr nodes for the sample rate of the current stream.
*
- * 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 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)
+{
+ get_btr_value(btrn, "sample_rate", result);
+}
+
+/**
+ * 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.
*
- * \return pointer to the allocated writer node group
+ * \param btrn See \ref get_btr_sample_rate.
+ * \param result Contains the sample format as an enum sample_format type.
*/
-struct writer_node_group *setup_default_wng(void)
+void get_btr_sample_format(struct btr_node *btrn, int32_t *result)
{
- struct writer_node_group *wng = wng_new(1);
- wng->writer_nodes[0].writer = &writers[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;
+ get_btr_value(btrn, "sample_format", result);
}