stdin.h: Add missing doxygen comment for stdin_task->btrp.

[paraslash.git] / filter.h

diff --git a/filter.h b/filter.h
index fa00a5780551374296c693a6df312f6f6c74f800..0808059dac3f7450aaa73c27d6afd4d382c62e94 100644 (file)
--- a/filter.h
+++ b/filter.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2011 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -20,12 +20,6 @@ struct filter_node {
         * instance of the filter here.
         */
        void *private_data;
-       /** The output buffer. */
-       char *buf;
-       /** The size of the output buffer. */
-       size_t bufsize;
-       /** The number of bytes currently loaded in \a buf. */
-       size_t loaded;
        /** The list of registered callbacks. */
        struct list_head callbacks;
        /** A pointer to the configuration of this instance. */
@@ -70,7 +64,8 @@ struct filter {
         * Close one instance of this filter.
         *
         * Free all resources of associated with \a fn that were previously allocated
-        * by the open() function.
+        * by the open() function. It's OK to leave this alone if the filter does not
+        * need any cleanups.
         */
        void (*close)(struct filter_node *fn);
        /**
@@ -86,19 +81,38 @@ struct filter {
         * argv. On failure, a negative paraslash error code must be returned.
         */
        int (*parse_config)(int argc, char **argv, void **config);
+       /**
+        * Deallocate the memory for the configuration.
+        *
+        * This is called to free whatever ->parse_config() has allocated.
+        */
        void (*free_config)(void *conf);
 
        /** The help texts for this filter. */
        struct ggo_help help;
+       /**
+        * Set scheduler timeout and add file descriptors to fd sets.
+        *
+        * This function is used to control the timeout value for select. It
+        * only allowed to decrease the current value. The second purpose of
+        * this function is to set file descriptors to be watched by the
+        * subsequent select call to the two fd sets.
+        */
        void (*pre_select)(struct sched *s, struct task *t);
        /**
         * Convert (filter) the given data.
         *
-        * Pointer to the converting function of the filter. It should convert as
-        * input data as possible. On errors, the post_select function is supposed
-        * to set t->error to a (negative) error code.
+        * Pointer to the converting function of the filter. On errors, the
+        * post_select function is supposed to set t->error to a (negative)
+        * error code.
         */
        void (*post_select)(struct sched *s, struct task *t);
+       /**
+        * Answer a buffer tree query.
+        *
+        * This optional function pointer is used for inter node communications
+        * of the buffer tree nodes. See \ref btr_command_handler for details.
+        */
        btr_command_handler execute;
 };
 
@@ -106,6 +120,8 @@ void filter_init(void);
 int check_filter_arg(char *filter_arg, void **conf);
 void print_filter_helps(int detailed);
 void generic_filter_pre_select(struct sched *s, struct task *t);
+int decoder_execute(const char *cmd, unsigned sample_rate, unsigned channels,
+               char **result);
 
 static inline void write_int16_host_endian(char *buf, int val)
 {