2 * Copyright (C) 2005-2013 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file filter_common.c Common helper functions for filter input/output. */
10 #include <sys/types.h>
17 #include "buffer_tree.h"
22 /** The array of supported filters. */
23 struct filter filters
[NUM_SUPPORTED_FILTERS
] = {FILTER_ARRAY
};
26 * Call the init function of each supported filter.
29 void filter_init(void)
33 FOR_EACH_SUPPORTED_FILTER(i
)
34 filters
[i
].init(filters
+ i
);
38 * If the filter has a command line parser and options is not NULL, run it.
39 * Returns filter_num on success, negative on errors
41 static int parse_filter_args(int filter_num
, char *options
, void **conf
)
43 struct filter
*f
= &filters
[filter_num
];
48 return strlen(options
)? -E_BAD_FILTER_OPTIONS
: filter_num
;
49 argc
= create_shifted_argv(options
, " \t", &argv
);
51 return -E_BAD_FILTER_OPTIONS
;
52 argv
[0] = para_strdup(f
->name
);
53 ret
= f
->parse_config(argc
, argv
, conf
);
55 return ret
< 0? ret
: filter_num
;
59 * Check the filter command line options.
61 * \param fa The command line options.
62 * \param conf Points to the filter configuration upon successful return.
64 * Check if \a fa starts with a the name of a supported filter, followed by
65 * a colon. If yes, call the command line parser of that filter.
67 * \return On success, the number of the filter is returned and \a conf
68 * is initialized to point to the filter configuration determined by \a fa.
69 * On errors, a negative value is returned.
71 * Note: If \a fa specifies a filter that has no command line parser success is
72 * returned, and \a conf is initialized to \p NULL.
74 * \sa filter::parse_config
76 int check_filter_arg(char *fa
, void **conf
)
81 // PARA_DEBUG_LOG("arg: %s\n", fa);
82 FOR_EACH_SUPPORTED_FILTER(j
) {
83 const char *name
= filters
[j
].name
;
84 size_t len
= strlen(name
);
88 if (strncmp(name
, fa
, len
))
93 if (c
&& !filters
[j
].parse_config
)
94 return -E_BAD_FILTER_OPTIONS
;
95 return parse_filter_args(j
, c
? fa
+ len
+ 1 :
96 fa
+ strlen(fa
), conf
);
98 return -E_UNSUPPORTED_FILTER
;
102 * Print help text of each filter to stdout.
104 * \param flags Passed to \ref ggo_print_help().
106 void print_filter_helps(unsigned flags
)
110 printf_or_die("\nAvailable filters: ");
111 FOR_EACH_SUPPORTED_FILTER(i
) {
113 printf_or_die("\n ");
116 num
+= printf_or_die("%s%s", i
? " " : "", filters
[i
].name
);
120 FOR_EACH_SUPPORTED_FILTER(i
) {
121 struct filter
*f
= filters
+ i
;
123 if (!f
->help
.short_help
)
125 printf_or_die("\nOptions for %s (%s):", f
->name
,
127 ggo_print_help(&f
->help
, flags
);
132 * Set select timeout of the scheduler.
134 * \param s The scheduler.
135 * \param t The task struct of this filter.
137 * This looks at the status of the btr node of the filter. If data is available
138 * in the input queue of the filter, or if an error occurred, a minimal timeout
139 * for the next select call is requested from the scheduler. Otherwise the
140 * scheduler timeout is left unchanged.
142 void generic_filter_pre_select(struct sched
*s
, struct task
*t
)
144 struct filter_node
*fn
= container_of(t
, struct filter_node
, task
);
147 if (btr_node_status(fn
->btrn
, fn
->min_iqs
, BTR_NT_INTERNAL
) != 0)
151 #ifdef WORDS_BIGENDIAN
152 #define DECODER_SAMPLE_FORMAT SF_S16_BE
154 #define DECODER_SAMPLE_FORMAT SF_S16_LE
158 * Execute a btr command for a decoder.
160 * The buffer tree nodes of the writers ask the parent nodes about sample_rate,
161 * channels count and sample format. This function is called by all decoders to
162 * answer these queries.
164 * \param cmd The command to be executed by the child node.
165 * \param sample_rate Known to the decoder.
166 * \param channels Known to the decoder.
167 * \param result Ascii representation on the answer is stored here.
171 int decoder_execute(const char *cmd
, unsigned sample_rate
, unsigned channels
,
174 if (!strcmp(cmd
, "sample_rate")) {
175 if (sample_rate
== 0)
176 return -E_BTR_NAVAIL
;
177 *result
= make_message("%u", sample_rate
);
180 if (!strcmp(cmd
, "channels")) {
182 return -E_BTR_NAVAIL
;
183 *result
= make_message("%u", channels
);
186 if (!strcmp(cmd
, "sample_format")) {
187 *result
= make_message("%u", DECODER_SAMPLE_FORMAT
);
190 return -ERRNO_TO_PARA_ERROR(ENOTSUP
);