/*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2010 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_common.c common functions of para_audiod and para_write */
+#include <regex.h>
+#include <stdbool.h>
+
#include "para.h"
#include "string.h"
#include "list.h"
#include "sched.h"
+#include "ggo.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};
-struct writer writers[NUM_SUPPORTED_WRITERS] = {WRITER_ARRAY};
-
-static void wng_post_select(__a_unused struct sched *s, struct task *t)
-{
- struct writer_node_group *g = t->private_data;
- int i;
- size_t min_written = 0;
-
- FOR_EACH_WRITER_NODE(i, g) {
- struct writer_node *wn = &g->writer_nodes[i];
- t->ret = wn->task.ret;
- if (t->ret < 0) {
- g->eof = 1;
- return;
- }
- if (!i)
- min_written = t->ret;
- else
- min_written = PARA_MIN(min_written, t->ret);
- }
- *g->loaded -= min_written;
- if (!*g->loaded && *g->input_eof) {
- g->eof = 1;
- t->ret = -E_WNG_EOF;
- } else
- t->ret = 1;
- if (*g->loaded && min_written)
- memmove(g->buf, g->buf + min_written, *g->loaded);
-}
-
-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);
- register_task(&g->task);
- 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);
- wn->task.pre_select = wn->writer->pre_select;
- wn->task.post_select = wn->writer->post_select;
- wn->task.private_data = wn;
- register_task(&wn->task);
- }
- sprintf(g->task.status, "%s", "writer node group");
- g->eof = 0;
- return 1;
-err_out:
- unregister_task(&g->task);
- while (i > 0) {
- struct writer_node *wn = &g->writer_nodes[--i];
- unregister_task(&wn->task);
- wn->writer->close(wn);
- }
- g->num_writers = 0;
- g->eof = 1;
- return ret;
-}
-
-void wng_unregister(struct writer_node_group *g)
-{
- int i;
- FOR_EACH_WRITER_NODE(i, g) {
- struct writer_node *wn = &g->writer_nodes[i];
- unregister_task(&wn->task);
- }
- unregister_task(&g->task);
- g->eof = 1;
-}
-
-void wng_close(struct writer_node_group *g)
-{
- int i;
-
- if (!g)
- 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->written);
- free(g->writer_nodes);
- free(g);
-}
-
-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->written = para_calloc(num_writers * sizeof(size_t));
- g->task.private_data = g;
- g->task.post_select = wng_post_select;
- return g;
-}
+/** the array of supported writers */
+struct writer writers[NUM_SUPPORTED_WRITERS] = {WRITER_ARRAY};
-void init_supported_writers(void)
+/**
+ * Call the init function of each supported paraslash writer.
+ */
+void writer_init(void)
{
int i;
FOR_EACH_WRITER(i)
writers[i].init(&writers[i]);
}
-
-void *check_writer_arg(char *wa, int *writer_num)
+/**
+ * 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
+ *
+ * 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.
+ */
+void *check_writer_arg(const char *wa, int *writer_num)
{
int i;
*writer_num = i;
return writers[i].parse_config(c? wa + len + 1 : "");
}
- PARA_ERROR_LOG("%s", "writer not found\n");
+ PARA_ERROR_LOG("writer not found\n");
return NULL;
}
-struct writer_node_group *setup_default_wng(void)
+void register_writer_node(struct writer_node *wn, struct btr_node *parent)
+{
+ struct writer *w = writers + wn->writer_num;
+ char *name = make_message("%s writer", writer_names[wn->writer_num]);
+ int ret;
+
+ wn->btrn = btr_new_node(&(struct btr_node_description)
+ EMBRACE(.name = name, .parent = parent,
+ .handler = w->execute, .context = wn));
+ strcpy(wn->task.status, name);
+ free(name);
+ ret = w->open(wn);
+ wn->task.post_select = w->post_select;
+ wn->task.pre_select = w->pre_select;
+ register_task(&wn->task);
+}
+
+/**
+ * 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.
+ */
+int setup_writer_node(const char *arg, struct btr_node *parent,
+ struct writer_node *wn)
+{
+ 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)
+ return -E_WRITE_COMMON_SYNTAX;
+ register_writer_node(wn, parent);
+ return 1;
+}
+
+
+/**
+ * Print the help text of all writers to stdout.
+ *
+ * \param detailed Whether to print the detailed help text.
+ */
+void print_writer_helps(int detailed)
+{
+ int i;
+
+ printf_or_die("\nAvailable writers: \n\t");
+ FOR_EACH_WRITER(i)
+ printf_or_die("%s%s", i? " " : "", writer_names[i]);
+ printf_or_die("\n\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);
+ }
+}
+
+static int get_btr_value(struct btr_node *btrn, const char *key, int32_t *result)
+{
+ char *buf = NULL;
+ int ret = btr_exec_up(btrn, key, &buf);
+
+ if (ret < 0)
+ return ret;
+ ret = para_atoi32(buf, result);
+ free(buf);
+ return ret;
+}
+
+/*
+ * Ask parent btr nodes for the samplerate of the current stream.
+ */
+int get_btr_samplerate(struct btr_node *btrn, int32_t *result)
+{
+ return get_btr_value(btrn, "samplerate", result);
+}
+
+/*
+ * Ask parent btr nodes for the channel count of the current stream.
+ */
+int get_btr_channels(struct btr_node *btrn, int32_t *result)
{
- struct writer_node_group *wng = wng_new(1);
- enum writer_enum default_writer;
-
- if (NUM_SUPPORTED_WRITERS == 1)
- default_writer = FILE_WRITE;
- else
- default_writer = 1;
- wng->writer_nodes[0].writer = &writers[default_writer];
- sprintf(wng->writer_nodes[0].task.status, "%s",
- writer_names[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;
+ return get_btr_value(btrn, "channels", result);
}
projects / paraslash.git / blobdiff