fecdec: Minor cleanups.

[paraslash.git] / filter.h

diff --git a/filter.h b/filter.h
index 2a75b1864dd49348a50087c5aa7e4aa1e6edb453..da4729056a7cf8cd5c08800dc3b2ee617416d234 100644 (file)
--- a/filter.h
+++ b/filter.h
@@ -1,10 +1,10 @@
 /*
 /*

- * Copyright (C) 2005-2008 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>

  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 

-/** \file filter.h Filter-related structures and exported symbols from filter_chain.c. */
+/** \file filter.h Filter-related structures and exported symbols from filter_common.c. */

 
 /** The list of supported filters. */
 enum filter_enum {FILTER_ENUM};
 
 /** The list of supported filters. */
 enum filter_enum {FILTER_ENUM};


@@ -143,7 +143,7 @@ struct filter_callback {
  * Note: As several instances of the same filter may be running at the same
  * time, all these filter functions must be reentrant; no static non-constant
  * variables may be used.
  * Note: As several instances of the same filter may be running at the same
  * time, all these filter functions must be reentrant; no static non-constant
  * variables may be used.

- * \sa mp3dec.c, oggdec.c, wav.c, compress.c, filter_node
+ * \sa mp3dec_filter.c, oggdec_filter.c, wav_filter.c, compress_filter.c, filter_node

  */
 struct filter {
        /** The name of the filter. */
  */
 struct filter {
        /** The name of the filter. */


@@ -183,13 +183,6 @@ struct filter {
         * by the open() function.
         */
        void (*close)(struct filter_node *fn);
         * by the open() function.
         */
        void (*close)(struct filter_node *fn);

-       /**
-        * Print the help text for this filter and exit.
-        *
-        * This is optional and it is not necessary to initialize this pointer if
-        * the filter does not have a help text.
-        */
-       void (*print_help)(void);

        /**
         * A pointer to the filter's command line parser.
         *
        /**
         * A pointer to the filter's command line parser.
         *


@@ -203,13 +196,16 @@ struct filter {
         * argv. On failure, a negative paraslash error code must be returned.
         */
        int (*parse_config)(int argc, char **argv, void **config);
         * argv. On failure, a negative paraslash error code must be returned.
         */
        int (*parse_config)(int argc, char **argv, void **config);

+
+       /** The help texts for this filter. */
+       struct ggo_help help;

 };
 
 void close_filters(struct filter_chain *fc);
 };
 
 void close_filters(struct filter_chain *fc);

-void filter_init(struct filter *all_filters);
+void filter_init(void);

 int check_filter_arg(char *filter_arg, void **conf);
 void filter_pre_select(__a_unused struct sched *s, struct task *t);
 int check_filter_arg(char *filter_arg, void **conf);
 void filter_pre_select(__a_unused struct sched *s, struct task *t);

-
+void print_filter_helps(int detailed);

 
 static inline void write_int16_host_endian(char *buf, int val)
 {
 
 static inline void write_int16_host_endian(char *buf, int val)
 {