X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=write.h;h=63efbfed4d381a94783bf7749a4547ba7151099e;hp=1c4a65fceefe4651af47f7e1df2aa14f55484c9a;hb=501edee5b98e4133bb64f41f78ffec1cd6f91f7e;hpb=9337bed6e84a4068e750fb6597646b45778eeba7

diff --git a/write.h b/write.h
index 1c4a65fc..63efbfed 100644
--- a/write.h
+++ b/write.h
@@ -31,9 +31,12 @@ struct writer_node {
 	void *private_data;
 	/** send that many bytes in one go */
 	int chunk_bytes;
+	/** pointer to the group this node belongs to */
 	struct writer_node_group *wng;
 	/** the writer-specific configuration of this node */
 	void *conf;
+	/** how much of the wng's buffer is already written */
+	size_t written;
 };
 
 /** describes one supported writer */
@@ -71,13 +74,19 @@ struct writer {
 	 *
 	 * write a chunk of audio data
 	 *
-	 * This is called from the driving application whenever a data block of \a
-	 * chunk_bytes is available. It must return the number of bytes consumed from
-	 * \a data on success, and negative on errors.
-	 *
+	 * 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.
 	 */
-	int (*write)(char *data, size_t nbytes, struct writer_node *);
 	int (*pre_select)(struct sched *s, struct writer_node *wn);
+	/*
+	 * Called from the post_select function of the wng task. It must keep
+	 * track of the the number of bytes consumed from the wng's buffer via
+	 * the wn->written variable (which may be modified by the wng handling
+	 * functions). This function must return positive on success and
+	 * negative on errors.
+	 */
 	int (*post_select)(struct sched *s, struct writer_node *wn);
 	/**
 	 * close one instance of the writer
@@ -102,17 +111,21 @@ struct writer_node_group {
 	unsigned num_writers;
 	/** array of pointers to the corresponding writer nodes */
 	struct writer_node *writer_nodes;
-	/** keeps track of how many bytes have been written by each node */
-	int *written;
 	/** the maximum of the chunk_bytes values of the writer nodes in this group */
 	size_t max_chunk_bytes;
-	/** non-zero if end of file was encountered */
+	/** non-zero if end of file was encountered by the feeding task */
 	int *input_eof;
+	/** non-zero if end of file was encountered */
 	int eof;
+	/** current output buffer */
 	char *buf;
+	/** number of bytes loaded in the output buffer */
+	size_t *loaded;
+	/** number of audio channels of the current stream */
 	unsigned int *channels;
+	/** sample rate of the current stream */
 	unsigned int *samplerate;
-	size_t *loaded;
+	/** the task associated to this group */
 	struct task task;
 };