/*
- * Copyright (C) 2005-2010 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>
*
* Licensed under the GPL v2. For licencing details see COPYING.
*/
#include <regex.h>
#include <sys/types.h>
-#include <dirent.h>
-#include <stdbool.h>
#include "para.h"
#include "list.h"
#include "error.h"
#include "string.h"
+/** Iterate over the array of supported filters. */
+#define FOR_EACH_SUPPORTED_FILTER(j) for (j = 0; j < NUM_SUPPORTED_FILTERS; j++)
+
/** The array of supported filters. */
-struct filter filters[NUM_SUPPORTED_FILTERS] = {FILTER_ARRAY};
+static struct filter filters[NUM_SUPPORTED_FILTERS] = {FILTER_ARRAY};
+
+/**
+ * Obtain a reference to a filter structure.
+ *
+ * \param filter_num Between zero and NUM_SUPPORTED_FILTERS, inclusively.
+ *
+ * \return Pointer to the filter identified by the given filter number.
+ *
+ * It is a fatal error if the given number is out of range. In this case
+ * the function aborts.
+ */
+const struct filter *filter_get(int filter_num)
+{
+ assert(filter_num >= 0);
+ assert(filter_num < NUM_SUPPORTED_FILTERS);
+ return filters + filter_num;
+}
/**
* Call the init function of each supported filter.
int i;
FOR_EACH_SUPPORTED_FILTER(i)
- filters[i].init(filters + i);
+ filter_get(i)->init((struct filter *)filter_get(i));
}
/*
*/
static int parse_filter_args(int filter_num, char *options, void **conf)
{
- struct filter *f = &filters[filter_num];
- int ret, i, argc = 2;
+ const struct filter *f = filter_get(filter_num);
+ int ret, argc;
char **argv;
-// PARA_DEBUG_LOG("%s, options: %s, parser: %p\n", f->name,
-// options? options : "(none)", f->parse_config);
if (!f->parse_config)
return strlen(options)? -E_BAD_FILTER_OPTIONS : filter_num;
-// PARA_DEBUG_LOG("options: %s\n", options);
- argc = create_argv(options, " \t", &argv);
+ argc = create_shifted_argv(options, " \t", &argv);
if (argc < 0)
return -E_BAD_FILTER_OPTIONS;
- PARA_DEBUG_LOG("argc = %d, argv[0]: %s\n", argc, argv[0]);
- for (i = argc - 1; i >= 0; i--)
- argv[i + 1] = argv[i];
argv[0] = para_strdup(f->name);
- argc++;
ret = f->parse_config(argc, argv, conf);
- free(argv[argc - 1]);
- argv[argc - 1] = NULL;
free_argv(argv);
return ret < 0? ret : filter_num;
}
/**
* Check the filter command line options.
*
- * \param fa The command line options.
+ * \param fa The filter argument.
* \param conf Points to the filter configuration upon successful return.
*
- * Check if \a fa starts with a the name of a supported filter, followed by
- * a colon. If yes, call the command line parser of that filter.
+ * Check if the given filter argument starts with the name of a supported
+ * filter, optionally followed by options for this filter. If yes, call the
+ * command line parser of that filter.
*
* \return On success, the number of the filter is returned and \a conf
* is initialized to point to the filter configuration determined by \a fa.
*conf = NULL;
// PARA_DEBUG_LOG("arg: %s\n", fa);
FOR_EACH_SUPPORTED_FILTER(j) {
- const char *name = filters[j].name;
+ const char *name = filter_get(j)->name;
size_t len = strlen(name);
char c;
if (strlen(fa) < len)
c = fa[len];
if (c && c != ' ')
continue;
- if (c && !filters[j].parse_config)
+ if (c && !filter_get(j)->parse_config)
return -E_BAD_FILTER_OPTIONS;
return parse_filter_args(j, c? fa + len + 1 :
fa + strlen(fa), conf);
return -E_UNSUPPORTED_FILTER;
}
-void print_filter_helps(int detailed)
+/**
+ * Print help text of each filter to stdout.
+ *
+ * \param flags Passed to \ref ggo_print_help().
+ */
+void print_filter_helps(unsigned flags)
{
- int i;
+ int i, num = 0;
- printf_or_die("\nAvailable filters: \n\t");
- FOR_EACH_SUPPORTED_FILTER(i)
- printf_or_die("%s%s", i? " " : "", filters[i].name);
- printf_or_die("\n\n");
+ printf_or_die("\nAvailable filters: ");
+ FOR_EACH_SUPPORTED_FILTER(i) {
+ if (num > 50) {
+ printf_or_die("\n ");
+ num = 0;
+ }
+ num += printf_or_die("%s%s", i? " " : "", filter_get(i)->name);
+ }
+ printf_or_die("\n");
FOR_EACH_SUPPORTED_FILTER(i) {
- struct filter *f = filters + i;
+ struct filter *f = (struct filter *)filter_get(i);
if (!f->help.short_help)
continue;
- printf_or_die("Options for %s:\n", f->name);
- ggo_print_help(&f->help, detailed);
+ printf_or_die("\nOptions for %s (%s):", f->name,
+ f->help.purpose);
+ ggo_print_help(&f->help, flags);
}
}
-void generic_filter_pre_select(struct sched *s, struct task *t)
+/**
+ * Set select timeout of the scheduler.
+ *
+ * \param s The scheduler.
+ * \param context Pointer to the filter node (task context).
+ *
+ * This looks at the status of the btr node of the filter. If data is available
+ * in the input queue of the filter, or if an error occurred, a minimal timeout
+ * for the next select call is requested from the scheduler. Otherwise the
+ * scheduler timeout is left unchanged.
+ */
+void generic_filter_pre_select(struct sched *s, void *context)
{
- struct filter_node *fn = container_of(t, struct filter_node, task);
+ struct filter_node *fn = context;
- t->error = 0;
if (btr_node_status(fn->btrn, fn->min_iqs, BTR_NT_INTERNAL) != 0)
sched_min_delay(s);
}
* \param sample_rate Known to the decoder.
* \param channels Known to the decoder.
* \param result Ascii representation on the answer is stored here.
+ *
+ * \return Standard.
*/
int decoder_execute(const char *cmd, unsigned sample_rate, unsigned channels,
char **result)