/*
- * Copyright (C) 2006-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2011 Andre Noll <maan@systemlinux.org>
*
* Licensed under the GPL v2. For licencing details see COPYING.
*/
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
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 : "");
+ return writers[i].parse_config_or_die(c? wa + len + 1 : "");
}
PARA_ERROR_LOG("writer not found\n");
return NULL;
}
+/**
+ * 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).
+ *
+ * The configuration of the writer node stored in \p wn->conf must be
+ * initialized before this function may be called.
+ */
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.
+ * Parse config and register a task for a writer node.
+ *
+ * \param arg Command line arguments.
+ * \param parent The new node will be a child of \a parent.
+ * \param wn The writer node.
*
- * 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.
+ * If arg is \p NULL, the OS-dependent default writer is used with no
+ * arguments. The default writers are alsa for Linux, osx for OS X, oss for
+ * *BSD, and the file writer if the default writer is not 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.
+ * Once the writer configuration has been retrieved from the ->parse_config
+ * callback 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
+ * Finally, the new writer node's task structure is initialized and registered
* to the paraslash scheduler.
*
- * \return A pointer to the allocated writer node group.
+ * \return Standard.
*/
int setup_writer_node(const char *arg, struct btr_node *parent,
struct writer_node *wn)
wn->conf = check_writer_arg(arg, &wn->writer_num);
else {
wn->writer_num = DEFAULT_WRITER;
- wn->conf = writers[DEFAULT_WRITER].parse_config("");
+ wn->conf = writers[DEFAULT_WRITER].parse_config_or_die("");
}
if (!wn->conf)
return -E_WRITE_COMMON_SYNTAX;
return 1;
}
-
/**
* Print the help text of all writers to stdout.
*
}
}
-static int get_btr_value(struct btr_node *btrn, const char *key, int32_t *result)
+static void get_btr_value(struct btr_node *btrn, const char *cmd,
+ int32_t *result)
{
char *buf = NULL;
- int ret = btr_exec_up(btrn, key, &buf);
-
- if (ret < 0)
- return ret;
+ 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);
- return ret;
}
-/*
- * Ask parent btr nodes for the samplerate of the current stream.
+/**
+ * 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.
*/
-int get_btr_samplerate(struct btr_node *btrn, int32_t *result)
+void get_btr_sample_rate(struct btr_node *btrn, int32_t *result)
{
- return get_btr_value(btrn, "samplerate", 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.
+ *
+ * \param btrn See \ref get_btr_sample_rate.
+ * \param result Contains the sample format as an enum sample_format type.
*/
-int get_btr_channels(struct btr_node *btrn, int32_t *result)
+void get_btr_sample_format(struct btr_node *btrn, int32_t *result)
{
- return get_btr_value(btrn, "channels", result);
+ get_btr_value(btrn, "sample_format", result);
}
projects / paraslash.git / blobdiff