Merge branch 't/compress'

[paraslash.git] / filter_common.c

diff --git a/filter_common.c b/filter_common.c
index 566d97edc9ee7eca82525f7854c4b81aed93c04d..907912fd06d9f0e4a78a53c7a5026c4a0a9d4846 100644 (file)
--- a/filter_common.c
+++ b/filter_common.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2011 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2013 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -8,7 +8,6 @@
 
 #include <regex.h>
 #include <sys/types.h>
-#include <stdbool.h>
 
 #include "para.h"
 #include "list.h"
@@ -42,25 +41,16 @@ void filter_init(void)
 static int parse_filter_args(int filter_num, char *options, void **conf)
 {
        struct filter *f = &filters[filter_num];
-       int ret, i, argc = 2;
+       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;
 }
@@ -108,6 +98,11 @@ int check_filter_arg(char *fa, void **conf)
        return -E_UNSUPPORTED_FILTER;
 }
 
+/**
+ * Print help text of each filter to stdout.
+ *
+ * \param detailed If non-zero, print detailed help.
+ */
 void print_filter_helps(int detailed)
 {
        int i;
@@ -127,6 +122,17 @@ void print_filter_helps(int detailed)
        }
 }
 
+/**
+ * Set select timeout of the scheduler.
+ *
+ * \param s The scheduler.
+ * \param t The task struct of this filter.
+ *
+ * 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, struct task *t)
 {
        struct filter_node *fn = container_of(t, struct filter_node, task);
@@ -153,6 +159,8 @@ void generic_filter_pre_select(struct sched *s, struct task *t)
  * \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)