X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=filter.h;h=2c546c1d21f281529fcda364987e8802b4b52036;hp=8c1c9e0d431c26e20a01fff76a2f3edb5e57c054;hb=35993f0cd49206666262cfdd2be89af41ec28a1d;hpb=591b16bbe13ca336c4cef00e8f9f808c1bb4c9a0

diff --git a/filter.h b/filter.h
index 8c1c9e0d..2c546c1d 100644
--- a/filter.h
+++ b/filter.h
@@ -1,11 +1,13 @@
 /*
- * 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.
  */
 
-/** \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};
 
 /**
  * Describes one running instance of a filter.
@@ -141,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.
- * \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. */
@@ -181,31 +183,29 @@ struct filter {
 	 * 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.
 	 *
-	 * If this optional function pointer is not NULL, any filter options are passed
-	 * from the main program to this command line parser once at application
-	 * startup. The command line parser should check its command line options given
-	 * by \a argc and \a argv and abort on errors. On success, it should return a
-	 * pointer to the filter-specific configuration data determined by \a argc and
-	 * \a argv.
+	 * If this optional function pointer is not NULL, any filter options
+	 * are passed from the main program to this command line parser once at
+	 * application startup. The command line parser should check its
+	 * command line options given by \a argc and \a argv and abort on
+	 * errors. Success must be indicated by a non-negative return value. In
+	 * this case the function should return a pointer to the
+	 * filter-specific configuration data determined by \a argc and \a
+	 * argv. On failure, a negative paraslash error code must be returned.
 	 */
-	void *(*parse_config)(int argc, char **argv);
+	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 filter_init(struct filter *all_filters);
 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)
 {
@@ -218,55 +218,9 @@ static inline void write_int16_host_endian(char *buf, int val)
 #endif
 }
 
+DECLARE_FILTER_INITS
 
-/** \cond */
-extern struct filter filters[];
-#define DECLARE_EXTERN_FILTER_INIT(name) \
-	extern void name ## _init(struct filter *f)
-
-#define FILTER_INIT(filter) { \
-	.name = #filter, \
-	.init = filter ## _init, \
-	.parse_config = NULL, \
-	.print_help = NULL \
-},
-
-/* filters that are always present */
-DECLARE_EXTERN_FILTER_INIT(wav);
-DECLARE_EXTERN_FILTER_INIT(compress);
-DECLARE_EXTERN_FILTER_INIT(amp);
-
-/* next the optional filters */
-#ifdef HAVE_MAD
-DECLARE_EXTERN_FILTER_INIT(mp3dec);
-#define MP3DEC_FILTER FILTER_INIT(mp3dec)
-#else
-#define MP3DEC_FILTER
-#endif
-
-#ifdef HAVE_FAAD
-DECLARE_EXTERN_FILTER_INIT(aacdec);
-#define AACDEC_FILTER FILTER_INIT(aacdec)
-#else
-#define AACDEC_FILTER
-#endif
-
-#ifdef HAVE_OGGVORBIS
-DECLARE_EXTERN_FILTER_INIT(oggdec);
-#define OGGDEC_FILTER FILTER_INIT(oggdec)
-#else
-#define OGGDEC_FILTER
-#endif
-/** \endcond */
-
-/** define an array of all available filters */
-#define DEFINE_FILTER_ARRAY(filters) struct filter filters[] = { \
-	FILTER_INIT(wav) \
-	FILTER_INIT(compress) \
-	FILTER_INIT(amp) \
-	MP3DEC_FILTER \
-	AACDEC_FILTER \
-	OGGDEC_FILTER \
-	{ .name = NULL } };
-
+#define FOR_EACH_SUPPORTED_FILTER(j)  for (j = 0; j < NUM_SUPPORTED_FILTERS; j++)
 
+/** The filter array, one structure for each supported filter. */
+extern struct filter filters[NUM_SUPPORTED_FILTERS];