/*
- * Copyright (C) 2006-2010 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2012 Andre Noll <maan@systemlinux.org>
*
* Licensed under the GPL v2. For licencing details see COPYING.
*/
void *private_data;
/** The writer-specific configuration of this node. */
void *conf;
+ /** The buffer tree node associated with this writer node. */
struct btr_node *btrn;
+ /** The task of this writer node. */
struct task task;
+ /** The minimal input queue size (size of one audio sample). */
size_t min_iqs;
};
* This should free whatever was allocated by \ref parse_config_or_die().
*/
void (*free_config)(void *config);
- /**
- * Open one instance of this writer.
- *
- * Perform any preparations needed to write the incoming stream.
- * Usually this function just allocates its private data structure and
- * stores a pointer to that structure in the ->private data of the
- * given parameter. This function must either succeed or terminate the
- * process.
- */
- void (*open)(struct writer_node *);
/**
* Prepare the fd sets for select.
*
*/
void (*close)(struct writer_node *);
/**
- * Shutdown the writer
+ * Shutdown the writer.
*
* This is a optional function pointer used for cleaning up.
*/
void (*shutdown)(struct writer_node *);
+ /** The short and the log help text of this writer. */
struct ggo_help help;
+ /**
+ * The callback handler.
+ *
+ * Each writer may provide an ->execute callback which can be used for
+ * inter-node communication.
+ */
btr_command_handler execute;
};