/*
- * Copyright (C) 2006-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2010 Andre Noll <maan@systemlinux.org>
*
* Licensed under the GPL v2. For licencing details see COPYING.
*/
* It should check whether the command line options given by \a options are
* valid. On success, it should return a pointer to the writer-specific
* configuration data determined by \a options. Note that this might be called
- * more than once with different values of \a options.
+ * more than once with different values of \a options. \sa \ref free_config().
*/
void *(*parse_config)(const char *options);
- void (*free_config)(void *conf);
+ /**
+ * Dellocate all configuration resources.
+ *
+ * This should free whatever was allocated by \ref parse_config().
+ */
+ void (*free_config)(void *config);
/**
* Open one instance of this writer.
*
/**
* Prepare the fd sets for select.
*
- * This is called from the writer node group task's pre_select(). It
- * may use the sched pointer to add any file descriptors or to decrease
- * the select timeout. It must return positive on success and negative
- * on errors.
+ * This is called from scheduler. It may use the sched pointer to add
+ * any file descriptors or to decrease the select timeout.
*/
- int (*pre_select)(struct sched *s, struct writer_node *wn);
- void (*pre_select_btr)(struct sched *s, struct task *t);
+ void (*pre_select)(struct sched *s, struct task *t);
/**
* Write audio data.
*
- * Called from the post_select function of the wng task. It must keep
- * track of the number of bytes consumed from the wng's buffer via
- * the \p wn->written variable (which may be modified by the wng handling
- * functions). This function must return positive on success and
- * negative on errors.
+ * Called from the post_select function of the writer node's task.
*/
- int (*post_select)(struct sched *s, struct writer_node *wn);
- void (*post_select_btr)(struct sched *s, struct task *t);
+ void (*post_select)(struct sched *s, struct task *t);
/**
* Close one instance of the writer.
*