/*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2008 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 "string.h"
#include "list.h"
#include "sched.h"
+#include "ggo.h"
#include "write.h"
#include "error.h"
+/** the array containing the names of all supported writers */
const char *writer_names[] ={WRITER_NAMES};
+
+/** the array of supported writers */
struct writer writers[NUM_SUPPORTED_WRITERS] = {WRITER_ARRAY};
-static void wng_post_select(__a_unused struct sched *s, struct task *t)
+static void wng_pre_select(__a_unused 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];
+ t->error = wn->writer->pre_select(s, wn);
+ if (t->error < 0)
+ return;
+ }
+}
+
+static void wng_post_select(struct sched *s, struct task *t)
{
- struct writer_node_group *g = t->private_data;
+ 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->ret = wn->task.ret;
- if (t->ret < 0)
+ t->error = wn->writer->post_select(s, wn);
+ if (t->error < 0)
return;
if (!i)
- min_written = t->ret;
+ min_written = wn->written;
else
- min_written = PARA_MIN(min_written, t->ret);
+ 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;
}
- *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)
+ if (*g->loaded && min_written) {
+// PARA_INFO_LOG("moving %zd bytes\n", *g->loaded);
memmove(g->buf, g->buf + 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 with %d writer(s)\n", g->num_writers);
+ 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 out;
+ goto err_out;
wn->chunk_bytes = ret;
g->max_chunk_bytes = PARA_MAX(g->max_chunk_bytes, ret);
- wn->wng = g;
- PARA_DEBUG_LOG("pre_select: %p\n", &wn->writer->pre_select);
- PARA_DEBUG_LOG("post_select: %p\n", &wn->writer->post_select);
- 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;
register_task(&g->task);
-out:
+ 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;
}
-void wng_destroy(struct writer_node_group *g)
-{
- if (!g)
- return;
- free(g->written);
- free(g->writer_nodes);
- free(g);
-}
-
+/**
+ * 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];
- unregister_task(&wn->task);
wn->writer->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->written = para_calloc(num_writers * sizeof(size_t));
- g->task.private_data = g;
g->task.post_select = wng_post_select;
- g->task.flags = POST_ADD_TAIL;
+ g->task.pre_select = wng_pre_select;
return g;
}
+/**
+ * call the init function of each supported paraslash writer
+ */
void init_supported_writers(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;
}
+/**
+ * setup a writer node group with only one writer, the default writer
+ *
+ * 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.
+ *
+ * \return pointer to the allocated writer node group
+ */
struct writer_node_group *setup_default_wng(void)
{
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]);
+ 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("");
+ writer_names[DEFAULT_WRITER], writers[DEFAULT_WRITER].parse_config);
+ wng->writer_nodes[0].conf = writers[DEFAULT_WRITER].parse_config("");
return wng;
}
+
+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);
+ }
+}
projects / paraslash.git / blobdiff