filter.h

   1 /*
   2  * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file filter.h Filter-related structures and exported symbols from filter_common.c. */
   8
   9 /** The list of supported filters. */
  10 enum filter_enum {FILTER_ENUM};
  11
  12 /**
  13  * Describes one running instance of a filter.
  14 */
  15 struct filter_node {
  16         /** The number in the array of available filters. */
  17         unsigned filter_num;
  18         /**
  19          * Each filter may store any filter-specific information about the particular
  20          * instance of the filter here.
  21          */
  22         void *private_data;
  23         /** The list of registered callbacks. */
  24         struct list_head callbacks;
  25         /** A pointer to the configuration of this instance. */
  26         void *conf;
  27         struct btr_node *btrn;
  28         struct task task;
  29         size_t min_iqs;
  30 };
  31
  32 /**
  33  * The structure associated with a paraslash filter.
  34  *
  35  * Paraslash filters are "modules" which are used to transform an audio stream.
  36  * struct filter contains pointers to functions that must be supplied by the
  37  * filter code in order to be used by the driving application (currently
  38  * para_audiod and para_filter).
  39  *
  40  * Note: As several instances of the same filter may be running at the same
  41  * time, all these filter functions must be reentrant; no static non-constant
  42  * variables may be used.
  43  * \sa mp3dec_filter.c, oggdec_filter.c, wav_filter.c, compress_filter.c, filter_node
  44  */
  45 struct filter {
  46         /** The name of the filter. */
  47         const char *name;
  48         /**
  49          * Pointer to the filter init routine.
  50          *
  51          * This function is only called once at startup. It must initialize the
  52          * other non-optional function pointers of this structure.
  53          */
  54         void (*init)(struct filter *f);
  55         /**
  56          * Open one instance of this filter.
  57          *
  58          * This should allocate the output buffer of the given filter node and do any
  59          * other filter-specific preparations like initializing the private_data member
  60          * of \a fn suitably. The open function is assumed to succeed.
  61          */
  62         void (*open)(struct filter_node *fn);
  63         /**
  64          * Close one instance of this filter.
  65          *
  66          * Free all resources of associated with \a fn that were previously allocated
  67          * by the open() function.
  68          */
  69         void (*close)(struct filter_node *fn);
  70         /**
  71          * A pointer to the filter's command line parser.
  72          *
  73          * If this optional function pointer is not NULL, any filter options
  74          * are passed from the main program to this command line parser once at
  75          * application startup. The command line parser should check its
  76          * command line options given by \a argc and \a argv and abort on
  77          * errors. Success must be indicated by a non-negative return value. In
  78          * this case the function should return a pointer to the
  79          * filter-specific configuration data determined by \a argc and \a
  80          * argv. On failure, a negative paraslash error code must be returned.
  81          */
  82         int (*parse_config)(int argc, char **argv, void **config);
  83         void (*free_config)(void *conf);
  84
  85         /** The help texts for this filter. */
  86         struct ggo_help help;
  87         void (*pre_select)(struct sched *s, struct task *t);
  88         /**
  89          * Convert (filter) the given data.
  90          *
  91          * Pointer to the converting function of the filter. It should convert as
  92          * input data as possible. On errors, the post_select function is supposed
  93          * to set t->error to a (negative) error code.
  94          */
  95         void (*post_select)(struct sched *s, struct task *t);
  96         btr_command_handler execute;
  97 };
  98
  99 void filter_init(void);
 100 int check_filter_arg(char *filter_arg, void **conf);
 101 void print_filter_helps(int detailed);
 102 void generic_filter_pre_select(struct sched *s, struct task *t);
 103
 104 static inline void write_int16_host_endian(char *buf, int val)
 105 {
 106 #ifdef WORDS_BIGENDIAN
 107         *buf = val >> 8;
 108         *(buf + 1) = val & 0xff;
 109 #else
 110         *buf = val & 0xff;
 111         *(buf + 1) = val >> 8;
 112 #endif
 113 }
 114
 115 DECLARE_FILTER_INITS
 116
 117 #define FOR_EACH_SUPPORTED_FILTER(j)  for (j = 0; j < NUM_SUPPORTED_FILTERS; j++)
 118
 119 /** The filter array, one structure for each supported filter. */
 120 extern struct filter filters[NUM_SUPPORTED_FILTERS];