2 * Copyright (C) 2006-2011 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file grab_client.c Functions for grabbing the audio stream. */
10 #include <sys/types.h>
17 #include "buffer_tree.h"
19 #include "grab_client.h"
26 * How to handle blocking writes for the grab client fds.
29 /** Ignore the data and do not write. */
31 /** Write anyway (default). */
33 /** Close fd if write would block. */
37 /** Flags specified as arguments to the grab command. */
39 /** Stop grabbing if audio file changes. */
43 /** Describes one active grab client. */
45 /* The value of the -p option. */
47 /* The value of the -n option. */
49 /** The file descriptor to send the grabbed stream to. */
51 /** See \ref grab_mode. */
53 /** Flags given at the command line. */
54 enum grab_flags flags;
55 /** The point of the grab client's node in the buffer tree. */
56 struct btr_node *btrn;
57 /* The task of this grab client. */
59 /** Belongs to either the active or the inactive list. */
60 struct list_head node;
63 /* Grab clients that are attached to a btr node. */
64 static INITIALIZED_LIST_HEAD(active_grab_client_list);
65 /* Grab clients that are not currently attached any btr node. */
66 static INITIALIZED_LIST_HEAD(inactive_grab_client_list);
68 static int gc_write(struct grab_client *gc, char *buf, size_t len)
70 int ret = write_ok(gc->fd);
74 if (ret == 0) { /* fd not ready */
75 if (gc->mode == GM_PEDANTIC)
77 if (gc->mode == GM_SLOPPY)
80 ret = write_nonblock(gc->fd, buf, len);
86 if (gc->mode == GM_PEDANTIC)
88 if (gc->mode == GM_SLOPPY)
96 static void gc_pre_select(struct sched *s, struct task *t)
98 struct grab_client *gc = container_of(t, struct grab_client, task);
99 int ret = btr_node_status(gc->btrn, 0, BTR_NT_LEAF);
105 para_fd_set(gc->fd, &s->wfds, &s->max_fileno);
109 * We need this forward declaration as post_select() needs
110 * activate_grab_client and vice versa.
112 static void gc_post_select(struct sched *s, struct task *t);
115 * Move a grab client to the active list and start it.
117 * \param gc The grab client to activate.
119 static void gc_activate(struct grab_client *gc)
121 struct btr_node *root = audiod_get_btr_root(), *parent;
122 char *name = gc->name? gc->name : "grab";
126 parent = btr_search_node(gc->parent, root);
129 PARA_INFO_LOG("activating fd %d\n", gc->fd);
130 list_move(&gc->node, &active_grab_client_list);
131 gc->btrn = btr_new_node(&(struct btr_node_description)
132 EMBRACE(.name = name, .parent = parent));
133 gc->task.pre_select = gc_pre_select;
134 gc->task.post_select = gc_post_select;
135 snprintf(gc->task.status, sizeof(gc->task.status) - 1, "%s", name);
136 gc->task.status[sizeof(gc->task.status) - 1] = '\0';
138 register_task(&gc->task);
142 * Activate inactive grab clients if possible.
144 * This is called from audiod.c when the current audio file changes. It loops
145 * over all inactive grab clients and checks each grab client's configuration
146 * to determine if the client in question wishes to grab the new stream. If
147 * yes, this grab client is moved from the inactive to the active grab client list.
149 * This function also garbage collects all grab clients whose tasks have been
152 void activate_grab_clients(void)
154 struct grab_client *gc, *tmp;
156 list_for_each_entry_safe(gc, tmp, &inactive_grab_client_list, node) {
166 static int gc_close(struct grab_client *gc, int err)
168 btr_remove_node(gc->btrn);
169 btr_free_node(gc->btrn);
171 PARA_INFO_LOG("closing gc: %s\n", para_strerror(-err));
172 list_move(&gc->node, &inactive_grab_client_list);
173 if (err == -E_GC_WRITE || (gc->flags & GF_ONE_SHOT)) {
175 * We must not free the gc structure here as it contains ->task
176 * which is still used because this function is called from
188 static void gc_post_select(__a_unused struct sched *s, struct task *t)
190 struct grab_client *gc = container_of(t, struct grab_client, task);
191 struct btr_node *btrn = gc->btrn;
197 ret = btr_node_status(btrn, 0, BTR_NT_LEAF);
202 sz = btr_next_buffer(btrn, &buf);
204 ret = gc_write(gc, buf, sz);
208 btr_consume(btrn, ret);
215 static int gc_check_args(int argc, char **argv, struct grab_client *gc)
219 for (i = 1; i < argc; i++) {
220 const char *arg = argv[i];
223 if (!strcmp(arg, "--")) {
227 if (!strncmp(arg, "-m", 2)) {
232 gc->mode = GM_SLOPPY;
235 gc->mode = GM_AGGRESSIVE;
238 gc->mode = GM_PEDANTIC;
244 if (!strcmp(arg, "-o")) {
245 gc->flags |= GF_ONE_SHOT;
248 if (!strncmp(arg, "-p=", 3)) {
249 gc->parent = para_strdup(arg + 3);
252 if (!strncmp(arg, "-n=", 3)) {
253 gc->name = para_strdup(arg + 3);
264 * Check the command line options and allocate a grab_client structure.
266 * \param fd The file descriptor of the client.
267 * \param argc Argument count.
268 * \param argv Argument vector.
270 * If the command line options given by \a argc and \a argv are valid.
271 * allocate a struct grab_client and initialize it with this valid
274 * If the new grab client can be added to an existing buffer tree, activate it.
275 * Otherwise, add it to the inactive list for later activation.
279 int grab_client_new(int fd, int argc, char **argv)
282 struct grab_client *gc = para_calloc(sizeof(struct grab_client));
284 ret = gc_check_args(argc, argv, gc);
288 para_list_add(&gc->node, &inactive_grab_client_list);