X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=write.h;h=52d6f5af0c65a057ba528fb1c9c07bfb1943d41a;hp=79531b508839ea06947873cab38e770be0daba0f;hb=ad14b0d7021aa16a71098eeb70eaba66017ec53a;hpb=b680e18c069fef1a03b83a5f906c994e1ab063a1

diff --git a/write.h b/write.h
index 79531b50..52d6f5af 100644
--- a/write.h
+++ b/write.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2007 Andre Noll <maan@systemlinux.org>
  *
  *     This program is free software; you can redistribute it and/or modify
  *     it under the terms of the GNU General Public License as published by
@@ -60,7 +60,7 @@ struct writer {
 	 * more than once with different values of \a options.
 	 *
 	 */
-		void * (*parse_config)(char *options);
+		void * (*parse_config)(const char *options);
 	/**
 	 *
 	 * open one instance of this writer
@@ -74,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
@@ -107,13 +113,19 @@ struct writer_node_group {
 	struct writer_node *writer_nodes;
 	/** 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;
 };