From: Andre Noll Date: Sun, 10 Jan 2010 04:07:59 +0000 (+0100) Subject: Major grab_client cleanups. X-Git-Tag: v0.4.2~170 X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=e2c65e016f5fb330e0360a6fcea60b6ded845460;p=paraslash.git Major grab_client cleanups. - Move struct declarations from grab_client.h to grab_client.c. - Kill init_grabbing(). We can do this at compile time. - Rename some functions and improve documentation. --- diff --git a/audiod.c b/audiod.c index 79dd6156..f805b00e 100644 --- a/audiod.c +++ b/audiod.c @@ -1266,7 +1266,6 @@ int main(int argc, char *argv[]) set_initial_status(); FOR_EACH_SLOT(i) clear_slot(i); - init_grabbing(); setup_signal_handling(); signal_setup_default(sig_task); diff --git a/grab_client.c b/grab_client.c index bce9c964..2c95022e 100644 --- a/grab_client.c +++ b/grab_client.c @@ -4,12 +4,7 @@ * Licensed under the GPL v2. For licencing details see COPYING. */ -/** - * \file grab_client.c Functions for grabbing the stream at any position - * in a filter chain. - * - * \sa filter_chain filter_chain_info filter. - */ +/** \file grab_client.c Functions for grabbing the audio stream. */ #include #include @@ -28,11 +23,46 @@ #include "string.h" #include "fd.h" -/** Grab clients that are not yet attached any btr node. */ -static struct list_head inactive_grab_client_list; +/** + * How to handle blocking writes for the grab client fds. + */ +enum grab_mode { + /** Ignore the data and do not write. */ + GM_SLOPPY, + /** Write anyway (default). */ + GM_AGGRESSIVE, + /** Close fd if write would block. */ + GM_PEDANTIC, +}; + +/** Flags specified as arguments to the grab command. */ +enum grab_flags { + /** Stop grabbing if audio file changes. */ + GF_ONE_SHOT = 1, +}; -/** Grab clients that are attached to a btr node. */ -static struct list_head active_grab_client_list; +/** Describes one active grab client. */ +struct grab_client { + /* The value of the -p option. */ + char *parent; + /** The file descriptor to send the grabbed stream to. */ + int fd; + /** See \ref grab_mode. */ + enum grab_mode mode; + /** Flags given at the command line. */ + enum grab_flags flags; + /** The point of the grab client's node in the buffer tree. */ + struct btr_node *btrn; + /* The task of this grab client. */ + struct task task; + /** Belongs to either the active or the inactive list. */ + struct list_head node; +}; + +/* Grab clients that are attached to a btr node. */ +INITIALIZED_LIST_HEAD(active_grab_client_list); +/* Grab clients that are not currently attached any btr node. */ +INITIALIZED_LIST_HEAD(inactive_grab_client_list); static int gc_write(struct grab_client *gc, char *buf, size_t len) { @@ -87,9 +117,8 @@ static void gc_post_select(struct sched *s, struct task *t); * Move a grab client to the active list and start it. * * \param gc The grab client to activate. - * */ -static void activate_grab_client(struct grab_client *gc) +static void gc_activate(struct grab_client *gc) { struct btr_node *root = audiod_get_btr_root(), *parent; @@ -98,7 +127,7 @@ static void activate_grab_client(struct grab_client *gc) parent = btr_search_node(gc->parent, root); if (!parent) return; - PARA_INFO_LOG("activating %p (fd %d)\n", gc, gc->fd); + PARA_INFO_LOG("activating fd %d\n", gc->fd); list_move(&gc->node, &active_grab_client_list); gc->btrn = btr_new_node("grab", parent, NULL, NULL); if (!gc->task.pre_select) { @@ -116,6 +145,9 @@ static void activate_grab_client(struct grab_client *gc) * over all inactive grab clients and checks each grab client's configuration * to determine if the client in question wishes to grab the new stream. If * yes, this grab client is moved from the inactive to the active grab client list. + * + * This function also garbage collects all grab clients whose tasks have been + * unscheduled. */ void activate_grab_clients(void) { @@ -127,17 +159,10 @@ void activate_grab_clients(void) free(gc); continue; } - activate_grab_client(gc); + gc_activate(gc); } } -static void add_inactive_gc(struct grab_client *gc) -{ - PARA_INFO_LOG("adding grab client %p (fd %d) to inactive list\n", - gc, gc->fd); - para_list_add(&gc->node, &inactive_grab_client_list); -} - static int gc_close(struct grab_client *gc, int err) { btr_remove_node(gc->btrn); @@ -146,11 +171,16 @@ static int gc_close(struct grab_client *gc, int err) PARA_INFO_LOG("closing gc: %s\n", para_strerror(-err)); list_move(&gc->node, &inactive_grab_client_list); if (err == -E_GC_WRITE || (gc->flags & GF_ONE_SHOT)) { + /* + * We must not free the gc structure here as it contains ->task + * which is still used because this function is called from + * post_select(). + */ close(gc->fd); free(gc->parent); return 1; } - activate_grab_client(gc); + gc_activate(gc); return 0; } @@ -180,7 +210,7 @@ err: t->error = gc_close(gc, ret)? ret : 0; } -static int check_gc_args(int argc, char **argv, struct grab_client *gc) +static int gc_check_args(int argc, char **argv, struct grab_client *gc) { int i; @@ -233,39 +263,26 @@ static int check_gc_args(int argc, char **argv, struct grab_client *gc) * * If the command line options given by \a argc and \a argv are valid. * allocate a struct grab_client and initialize it with this valid - * configuration. Moreover, add the new grab client to the inactive list. + * configuration. * - * \return Standard. + * If the new grab client can be added to an existing buffer tree, activate it. + * Otherwise, add it to the inactive list for later activation. * - * \sa grab_client, inactive_grab_client_list, activate_grab_client, - * filter_node::callbacks. + * \return Standard. */ int grab_client_new(int fd, int argc, char **argv) { int ret; struct grab_client *gc = para_calloc(sizeof(struct grab_client)); - ret = check_gc_args(argc, argv, gc); + ret = gc_check_args(argc, argv, gc); if (ret < 0) goto err_out; gc->fd = fd; - add_inactive_gc(gc); - activate_grab_client(gc); + para_list_add(&gc->node, &inactive_grab_client_list); + gc_activate(gc); return 1; err_out: free(gc); return ret; } - -/** - * Initialize the grabbing subsystem. - * - * This has to be called once during startup before any other function from - * grab_client.c may be used. It initializes \a inactive_grab_client_list. - */ -void init_grabbing(void) -{ - PARA_INFO_LOG("grab init\n"); - INIT_LIST_HEAD(&inactive_grab_client_list); - INIT_LIST_HEAD(&active_grab_client_list); -} diff --git a/grab_client.h b/grab_client.h index 59ba697e..75ba4c91 100644 --- a/grab_client.h +++ b/grab_client.h @@ -6,44 +6,5 @@ /** \file grab_client.h exported symbols from grab_client.c */ -#include "config.h" - -/** - * How to handle blocking writes for the grab client fds. - */ -enum grab_mode { - /** Ignore the data and do not write. */ - GM_SLOPPY, - /** Write anyway (default). */ - GM_AGGRESSIVE, - /** Close fd if write would block. */ - GM_PEDANTIC, -}; - -/** Flags specified as arguments to the grab command. */ -enum grab_flags { - /** Stop grabbing if audio file changes. */ - GF_ONE_SHOT = 1, -}; - -/** Describes one active grab client. */ -struct grab_client { - /* The value of the -p option. */ - char *parent; - /** The file descriptor to send the grabbed stream to. */ - int fd; - /** See \ref grab_mode. */ - enum grab_mode mode; - /** Flags given at the command line. */ - enum grab_flags flags; - /** The point of the grab client's node in the buffer tree. */ - struct btr_node *btrn; - /* The task of this grab client. */ - struct task task; - /** All grab clients belong either to a filter node or to the inactive list. */ - struct list_head node; -}; - int grab_client_new(int fd, int argc, char **argv); void activate_grab_clients(void); -void init_grabbing(void);