X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=filter.h;h=de8ce8e8b5d0ca128cbc2cb4f3bb568ec416c07e;hp=692020c40ca80fcd7dd008d59095d7df469d9399;hb=465f84546f810776ea6c4bd06fec34ff8452e933;hpb=4d425382c007b200121b4be5120db1acd30d292f

diff --git a/filter.h b/filter.h
index 692020c4..de8ce8e8 100644
--- a/filter.h
+++ b/filter.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2005-2010 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2014 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -24,8 +24,11 @@ struct filter_node {
 	struct list_head callbacks;
 	/** A pointer to the configuration of this instance. */
 	void *conf;
+	/** The buffer tree node. */
 	struct btr_node *btrn;
+	/** The task corresponding to this filter node. */
 	struct task task;
+	/** The minimal input queue size, see \ref btr_node_status(). */
 	size_t min_iqs;
 };
 
@@ -103,10 +106,9 @@ struct filter {
 	 * Convert (filter) the given data.
 	 *
 	 * 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.
+	 * post_select function is supposed to return a negative error code.
 	 */
-	void (*post_select)(struct sched *s, struct task *t);
+	int (*post_select)(struct sched *s, struct task *t);
 	/**
 	 * Answer a buffer tree query.
 	 *
@@ -118,7 +120,7 @@ struct filter {
 
 void filter_init(void);
 int check_filter_arg(char *filter_arg, void **conf);
-void print_filter_helps(int detailed);
+void print_filter_helps(unsigned flags);
 void generic_filter_pre_select(struct sched *s, struct task *t);
 int decoder_execute(const char *cmd, unsigned sample_rate, unsigned channels,
 		char **result);
@@ -136,6 +138,7 @@ static inline void write_int16_host_endian(char *buf, int val)
 
 DECLARE_FILTER_INITS
 
+/** Iterate over the array of supported filters. */
 #define FOR_EACH_SUPPORTED_FILTER(j)  for (j = 0; j < NUM_SUPPORTED_FILTERS; j++)
 
 /** The filter array, one structure for each supported filter. */