2 * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
20 * \file grab_client.c functions for grabbing the stream at any position
23 * \sa filter_chain filter_chain_info filter
27 #include "close_on_fork.h"
28 #include "grab_client.cmdline.h"
31 #include "grab_client.h"
37 /** grab clients that are not yet attached to a filter node */
38 struct list_head inactive_grab_client_list;
40 static int max_num_filters(void)
43 for (i = 0; audio_formats[i]; i++) {
44 PARA_INFO_LOG("%s filter chain length: %d\n", audio_formats[i],
46 ret = PARA_MAX(ret, num_filters(i));
48 PARA_INFO_LOG("maximal filter chain length: %d\n", ret);
52 static int gc_write(char *buf, size_t len, struct filter_callback *fcb)
54 struct grab_client *gc = fcb->data;
55 struct timeval tv = {0, 100};
58 // PARA_INFO_LOG("writing %d bytes to fd %d\n", len, gc->fd);
61 FD_SET(gc->fd, &wfds);
62 ret = para_select(gc->fd + 1, NULL, &wfds, &tv);
64 if (gc->mode == GRAB_PEDANTIC)
65 return -E_PEDANTIC_GRAB;
66 if (gc->mode == GRAB_SLOPPY)
70 ret = write(gc->fd, buf, len);
73 gc->error = E_GC_WRITE;
76 if (gc->mode == GRAB_PEDANTIC)
77 return -E_PEDANTIC_GRAB;
78 if (gc->mode == GRAB_AGGRESSIVE) {
80 memmove(buf, buf + ret, len);
88 /* TODO: gengetopt can handle the grab client modes */
89 static int check_gc_args(struct grab_client *gc)
92 struct grab_client_args_info *conf = gc->conf;
93 char **mv = grab_client_cmdline_parser_mode_values;
95 PARA_INFO_LOG("filter_num: %d\n", gc->conf->filter_num_arg);
96 for (i = 0; mv[i]; i++)
97 if (!strcmp(conf->mode_arg, mv[i]))
102 gc->audio_format_num = -1;
103 if (conf->audio_format_given) {
104 gc->audio_format_num = get_audio_format_num(conf->audio_format_arg);
105 if (gc->audio_format_num < 0)
106 return gc->audio_format_num;
108 if (conf->slot_arg > MAX_STREAM_SLOTS)
109 return -E_BAD_GC_SLOT;
110 if (conf->filter_num_arg <= 0)
111 return -E_BAD_GC_FILTER_NUM;
112 if (conf->audio_format_given) {
113 if (num_filters(gc->audio_format_num) < conf->filter_num_arg)
114 return -E_BAD_GC_FILTER_NUM;
116 if (conf->filter_num_arg > max_num_filters())
117 return -E_BAD_GC_FILTER_NUM;
122 static void add_inactive_gc(struct grab_client *gc)
124 PARA_INFO_LOG("adding grab client %p (fd %d) to inactive list\n",
126 list_add(&gc->node, &inactive_grab_client_list);
129 static void gc_free(struct grab_client *gc)
133 for (i = 0; i < gc->argc; i++)
141 static void gc_close(struct filter_callback *fcb)
143 struct grab_client *gc = fcb->data;
145 if (gc->conf->one_shot_given || gc->error) {
146 PARA_INFO_LOG("closing fd %d (grab client %p)\n", gc->fd, gc);
147 del_close_on_fork_list(gc->fd);
157 * move a grab client from the inactive list to a filter node
159 * \param gc the grab client to activate
160 * \param fn the filter node \a gc gets attached to
162 * \sa filter_node::callbacks, inactive_grab_client_list
164 void activate_grab_client(struct grab_client *gc, struct filter_node *fn)
166 PARA_INFO_LOG("activating %p (fd %d, filter node: %p)\n", gc, gc->fd, fn);
168 list_add(&gc->fcb.node, &fn->callbacks);
172 * activate inactive grab clients if possible
174 * \param slot audiod's slot for the new audio file
175 * \param audio_format_num the number of the audio format of the new audio file
176 * \param filter_list the list of activated filters for that new audio file
178 * This is called from audiod.c when the current audio file changes. It loops
179 * over all inactive grab clients and checks each grab client's configuration
180 * to determine if the client in question wishes to grab the new stream. If
181 * yes, this grab client is moved from the inactive grab client list to an
182 * appropriate filter_node.
184 * \sa filter_chain_info::filters, inactive_grab_client_list,
185 * activate_grab_client
187 void activate_inactive_grab_clients(int slot, int audio_format_num,
188 struct list_head *filter_list)
190 struct grab_client *gc, *tmp;
192 struct filter_node *fn;
194 list_for_each_entry_safe(gc, tmp, &inactive_grab_client_list, node) {
195 // PARA_INFO_LOG("checking inactive grab client %p\n", gc);
196 if (gc->conf->slot_arg >= 0 && gc->conf->slot_arg != slot)
198 if (gc->audio_format_num >= 0 && gc->audio_format_num !=
201 if (gc->conf->filter_num_arg >= 0 &&
202 num_filters(gc->audio_format_num)
203 < gc->conf->filter_num_arg)
206 list_for_each_entry(fn, filter_list, node) {
207 if (gc->conf->filter_num_arg <= 0
208 || i == gc->conf->filter_num_arg)
212 activate_grab_client(gc, fn);
217 * check the command line options and allocate a grab_client structure
219 * \param fd the file descriptor of the client
220 * \param argc the number of command line options
221 * \param argv pointers to the command line options
222 * \param err non-zero if an error occured
224 * If the command line options given by \a argc and \a argv are valid.
225 * allocate a struct grab_client and initialize it with this valid
226 * configuration. Moreover, add the new grab client to the inactive list.
228 * \return On success, this function returns a pointer to the newly created
229 * struct. On errors, it returns NULL and sets \a err appropriately.
231 * \sa grab_client, inactive_grab_client_list, activate_grab_client,
232 * filter_node::callbacks
235 * argc, argv get freed when com_grab() returns, so we have to make a
238 struct grab_client *grab_client_new(int fd, int argc, char **argv, int *err)
241 struct grab_client *gc = para_calloc(sizeof(struct grab_client));
243 gc->conf = para_calloc(sizeof(struct grab_client_args_info));
245 gc->argv = para_calloc((argc + 2) * sizeof(char *));
247 for (i = 0; argv[i]; i++) {
248 gc->argv[i] = para_strdup(argv[i]);
249 PARA_INFO_LOG("argc: %d, argv[%d]: %s\n", argc, i, gc->argv[i]);
251 ret = grab_client_cmdline_parser(gc->argc, gc->argv , gc->conf);
255 *err = -E_GC_HELP_GIVEN;
256 if (gc->conf->help_given)
258 *err = -E_GC_VERSION_GIVEN;
259 if (gc->conf->version_given)
261 *err = check_gc_args(gc);
264 if (gc->conf->input_grab_given) {
265 gc->fcb.input_cb = gc_write;
266 gc->fcb.output_cb = NULL;
268 gc->fcb.output_cb = gc_write;
269 gc->fcb.input_cb = NULL;
272 gc->fcb.close = gc_close;
277 for (i = 0; i < argc; i++)
285 /** initialize the grabbing subsystem.
287 * This has to be called once during startup before any other function from
288 * grab_client.c may be used. It initializes \a inactive_grab_client_list.
292 PARA_INFO_LOG("%s", "grab init\n");
293 INIT_LIST_HEAD(&inactive_grab_client_list);