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 /** this maps the enum to the text used at the command line */
38 static const char *gc_modes
[] = {
39 [GRAB_PEDANTIC
] = "pedantic",
40 [GRAB_SLOPPY
] = "sloppy",
41 [GRAB_AGGRESSIVE
] = "aggressive",
45 /** grab clients that are not yet attached to a filter node */
46 struct list_head inactive_grab_client_list
;
48 static int max_num_filters(void)
51 for (i
= 0; audio_formats
[i
]; i
++) {
52 PARA_INFO_LOG("%s filter chain length: %d\n", audio_formats
[i
],
54 ret
= MAX(ret
, num_filters(i
));
56 PARA_INFO_LOG("maximal filter chain length: %d\n", ret
);
60 static int gc_write(char *buf
, size_t len
, struct filter_callback
*fcb
)
62 struct grab_client
*gc
= fcb
->data
;
63 struct timeval tv
= {0, 100};
66 // PARA_INFO_LOG("writing %d bytes to fd %d\n", len, gc->fd);
70 FD_SET(gc
->fd
, &wfds
);
71 ret
= select(gc
->fd
+ 1, NULL
, &wfds
, NULL
, &tv
);
72 } while (ret
== EAGAIN
|| ret
== EINTR
);
74 if (gc
->mode
== GRAB_PEDANTIC
)
75 return -E_PEDANTIC_GRAB
;
76 if (gc
->mode
== GRAB_SLOPPY
)
80 ret
= write(gc
->fd
, buf
, len
);
83 gc
->error
= E_GC_WRITE
;
86 if (gc
->mode
== GRAB_PEDANTIC
)
87 return -E_PEDANTIC_GRAB
;
88 if (gc
->mode
== GRAB_AGGRESSIVE
) {
90 memmove(buf
, buf
+ ret
, len
);
98 static int check_gc_args(struct grab_client
*gc
)
101 struct grab_client_args_info
*conf
= gc
->conf
;
103 PARA_INFO_LOG("filter_num: %d\n", gc
->conf
->filter_num_arg
);
104 for (i
= 0; gc_modes
[i
]; i
++)
105 if (!strcmp(conf
->mode_arg
, gc_modes
[i
]))
108 return -E_INVALID_GRAB_MODE
;
110 if (conf
->audio_format_given
) {
111 gc
->audio_format_num
= get_audio_format_num(conf
->audio_format_arg
);
112 if (gc
->audio_format_num
< 0)
113 return gc
->audio_format_num
;
115 if (conf
->slot_arg
> MAX_STREAM_SLOTS
)
116 return -E_BAD_GC_SLOT
;
117 if (conf
->filter_num_arg
<= 0)
118 return -E_BAD_GC_FILTER_NUM
;
119 if (conf
->audio_format_given
) {
120 if (num_filters(gc
->audio_format_num
) < conf
->filter_num_arg
)
121 return -E_BAD_GC_FILTER_NUM
;
123 if (conf
->filter_num_arg
> max_num_filters())
124 return -E_BAD_GC_FILTER_NUM
;
129 static void add_inactive_gc(struct grab_client
*gc
)
131 PARA_INFO_LOG("adding grab client %p (fd %d) to inactive list\n",
133 list_add(&gc
->node
, &inactive_grab_client_list
);
136 static void gc_free(struct grab_client
*gc
)
140 for (i
= 0; i
< gc
->argc
; i
++)
148 static void gc_close(struct filter_callback
*fcb
)
150 struct grab_client
*gc
= fcb
->data
;
152 if (gc
->conf
->one_shot_given
|| gc
->error
) {
153 PARA_INFO_LOG("closing fd %d (grab client %p)\n", gc
->fd
, gc
);
154 del_close_on_fork_list(gc
->fd
);
164 * move a grab client from the inactive list to a filter node
166 * \param gc the grab client to activate
167 * \param fn the filter node \a gc gets attached to
169 * \sa filter_node::callbacks, inactive_grab_client_list
171 void activate_grab_client(struct grab_client
*gc
, struct filter_node
*fn
)
173 PARA_INFO_LOG("activating %p (fd %d, filter node: %p)\n", gc
, gc
->fd
, fn
);
175 list_add(&gc
->fcb
.node
, &fn
->callbacks
);
179 * activate inactive grab clients if possible
181 * \param slot audiod's slot for the new audio file
182 * \param audio_format_num the number of the audio format of the new audio file
183 * \param filter_list the list of activated filters for that new audio file
185 * This is called from audiod.c when the current audio file changes. It loops
186 * over all inactive grab clients and checks each grab client's configuration
187 * to determine if the client in question wishes to grab the new stream. If
188 * yes, this grab client is moved from the inactive grab client list to an
189 * appropriate filter_node.
191 * \sa filter_chain_info::filters, inactive_grab_client_list,
192 * activate_grab_client
194 void activate_inactive_grab_clients(int slot
, int audio_format_num
,
195 struct list_head
*filter_list
)
197 struct grab_client
*gc
, *tmp
;
199 struct filter_node
*fn
;
201 list_for_each_entry_safe(gc
, tmp
, &inactive_grab_client_list
, node
) {
202 // PARA_INFO_LOG("checking inactive grab client %p\n", gc);
203 if (gc
->conf
->slot_arg
>= 0 && gc
->conf
->slot_arg
!= slot
)
205 if (gc
->audio_format_num
>= 0 && gc
->audio_format_num
!=
208 if (gc
->conf
->filter_num_arg
>= 0 &&
209 num_filters(gc
->audio_format_num
)
210 < gc
->conf
->filter_num_arg
)
213 list_for_each_entry(fn
, filter_list
, node
) {
214 if (gc
->conf
->filter_num_arg
<= 0
215 || i
== gc
->conf
->filter_num_arg
)
219 activate_grab_client(gc
, fn
);
224 * check the command line options and allocate a grab_client structure
226 * \param fd the file descriptor of the client
227 * \param argc the number of command line options
228 * \param argv pointers to the command line options
229 * \param err non-zero if an error occured
231 * If the command line options given by \a argc and \a argv are valid.
232 * allocate a struct grab_client and initialize it with this valid
233 * configuration. Moreover, add the new grab client to the inactive list.
235 * \return On success, this function returns a pointer to the newly created
236 * struct. On errors, it returns NULL and sets \a err appropriately.
238 * \sa grab_client, inactive_grab_client_list, activate_grab_client,
239 * filter_node::callbacks
242 * argc, argv get freed when com_grab() returns, so we have to make a
245 __malloc
struct grab_client
*grab_client_new(int fd
, int argc
, char **argv
, int *err
)
248 struct grab_client
*gc
= para_calloc(sizeof(struct grab_client
));
250 gc
->conf
= para_calloc(sizeof(struct grab_client_args_info
));
252 gc
->argv
= para_calloc((argc
+ 1) * sizeof(char *));
254 for (i
= 0; i
< argc
; i
++) {
255 gc
->argv
[i
] = para_strdup(argv
[i
]);
256 PARA_INFO_LOG("argc: %d, argv[%d]: %s\n", argc
, i
, gc
->argv
[i
]);
258 PARA_INFO_LOG("argv[%d]: %s\n", argc
, gc
->argv
[argc
]);
259 ret
= grab_client_cmdline_parser(gc
->argc
, gc
->argv
, gc
->conf
);
263 *err
= -E_GC_HELP_GIVEN
;
264 if (gc
->conf
->help_given
)
266 *err
= -E_GC_VERSION_GIVEN
;
267 if (gc
->conf
->version_given
)
269 *err
= check_gc_args(gc
);
272 if (gc
->conf
->input_grab_given
) {
273 gc
->fcb
.input_cb
= gc_write
;
274 gc
->fcb
.output_cb
= NULL
;
276 gc
->fcb
.output_cb
= gc_write
;
277 gc
->fcb
.input_cb
= NULL
;
280 gc
->fcb
.close
= gc_close
;
285 for (i
= 0; i
< argc
; i
++)
293 /** initialize the grabbing subsystem.
295 * This has to be called once during startup before any other function from
296 * grab_client.c may be used. It initializes \a inactive_grab_client_list.
300 PARA_INFO_LOG("%s", "grab init\n");
301 INIT_LIST_HEAD(&inactive_grab_client_list
);